summaryrefslogtreecommitdiff
path: root/op-mode-definitions/dhcp.xml.in
blob: 3c42c8e8f78eaf5d650207ce4ac8b0555b2a4f68 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
<?xml version="1.0" encoding="UTF-8"?>
<interfaceDefinition>
  <node name="clear">
    <children>
      <node name="dhcp-server">
        <properties>
          <help>Clear DHCP server lease</help>
        </properties>
        <children>
          <tagNode name="lease">
            <properties>
              <help>DHCP server lease</help>
            </properties>
            <command>${vyos_op_scripts_dir}/dhcp.py clear_dhcp_server_lease --family inet --address $4</command>
          </tagNode>
        </children>
      </node>
      <node name="dhcpv6-server">
        <properties>
          <help>Clear DHCPv6 server lease</help>
        </properties>
        <children>
          <tagNode name="lease">
            <properties>
              <help>DHCPv6 server lease</help>
            </properties>
            <command>${vyos_op_scripts_dir}/dhcp.py clear_dhcp_server_lease --family inet6 --address $4</command>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
  <node name="show">
    <children>
      <node name="dhcp">
        <properties>
          <help>Show DHCP (Dynamic Host Configuration Protocol) information</help>
        </properties>
        <children>
          <node name="client">
            <properties>
              <help>Show DHCP client information</help>
            </properties>
            <children>
              <node name="leases">
                <properties>
                  <help>Show DHCP client leases</help>
                </properties>
                <children>
                  <tagNode name="interface">
                    <properties>
                      <help> Show DHCP client information for a given interface</help>
                      <completionHelp>
                        <script>${vyos_completion_dir}/list_interfaces --broadcast</script>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_client_leases --family inet --interface $6</command>
                  </tagNode>
                </children>
                <command>${vyos_op_scripts_dir}/dhcp.py show_client_leases --family inet</command>
              </node>
             </children>
          </node>
          <node name="server">
            <properties>
              <help>Show DHCP server information</help>
            </properties>
            <children>
              <node name="leases">
                <properties>
                  <help>Show DHCP server leases</help>
                </properties>
                <command>${vyos_op_scripts_dir}/dhcp.py show_server_leases --family inet</command>
                <children>
                  <tagNode name="origin">
                    <properties>
                      <help>Show DHCP server leases granted by local or remote DHCP server</help>
                      <completionHelp>
                        <list>local remote</list>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_server_leases --family inet --origin $6</command>
                  </tagNode>
                  <tagNode name="pool">
                    <properties>
                      <help>Show DHCP server leases for a specific pool</help>
                      <completionHelp>
                        <path>service dhcp-server shared-network-name</path>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_server_leases --family inet --pool $6</command>
                  </tagNode>
                  <tagNode name="sort">
                    <properties>
                      <help>Show DHCP server leases sorted by the specified key</help>
                      <completionHelp>
                        <list>end hostname ip mac pool remaining start state</list>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_server_leases --family inet --sort $6</command>
                  </tagNode>
                  <tagNode name="state">
                    <properties>
                      <help>Show DHCP server leases with a specific state (can be multiple, comma-separated)</help>
                      <completionHelp>
                        <list>abandoned active all backup expired free released reset</list>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_server_leases --family inet --state $6</command>
                  </tagNode>
                </children>
              </node>
              <node name="static-mappings">
                <properties>
                  <help>Show DHCP server static mappings</help>
                </properties>
                <command>${vyos_op_scripts_dir}/dhcp.py show_server_static_mappings --family inet</command>
                <children>
                  <tagNode name="pool">
                    <properties>
                      <help>Show DHCP server static mappings for a specific pool</help>
                      <completionHelp>
                        <path>service dhcp-server shared-network-name</path>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_server_static_mappings --family inet --pool $6</command>
                  </tagNode>
                  <tagNode name="sort">
                    <properties>
                      <help>Show DHCP server static mappings sorted by the specified key</help>
                      <completionHelp>
                        <list>ip mac duid pool</list>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_server_static_mappings --family inet --sort $6</command>
                  </tagNode>
                </children>
              </node>
              <node name="statistics">
                <properties>
                  <help>Show DHCP server statistics</help>
                </properties>
                <command>${vyos_op_scripts_dir}/dhcp.py show_pool_statistics --family inet</command>
                <children>
                  <tagNode name="pool">
                    <properties>
                      <help>Show DHCP server statistics for a specific pool</help>
                      <completionHelp>
                        <path>service dhcp-server shared-network-name</path>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_pool_statistics --family inet --pool $6</command>
                  </tagNode>
                </children>
              </node>
            </children>
          </node>
        </children>
      </node>
      <node name="dhcpv6">
        <properties>
          <help>Show DHCPv6 (IPv6 Dynamic Host Configuration Protocol) information</help>
        </properties>
        <children>
          <node name="server">
            <properties>
              <help>Show DHCPv6 server information</help>
            </properties>
            <children>
              <node name="leases">
                <properties>
                  <help>Show DHCPv6 server leases</help>
                </properties>
                <command>sudo ${vyos_op_scripts_dir}/dhcp.py show_server_leases --family inet6</command>
                <children>
                  <tagNode name="pool">
                    <properties>
                      <help>Show DHCPv6 server leases for a specific pool</help>
                      <completionHelp>
                        <path>service dhcpv6-server shared-network-name</path>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_server_leases --family inet6 --pool $6</command>
                  </tagNode>
                  <tagNode name="sort">
                    <properties>
                      <help>Show DHCPv6 server leases sorted by the specified key</help>
                      <completionHelp>
                        <list>end duid ip last_communication pool remaining state type</list>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_server_leases --family inet6 --sort $6</command>
                  </tagNode>
                  <tagNode name="state">
                    <properties>
                      <help>Show DHCPv6 server leases with a specific state (can be multiple, comma-separated)</help>
                      <completionHelp>
                        <list>abandoned active all backup expired free released reset</list>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_server_leases --family inet6 --state $6</command>
                  </tagNode>
                </children>
              </node>
              <node name="static-mappings">
                <properties>
                  <help>Show DHCPv6 server static mappings</help>
                </properties>
                <command>${vyos_op_scripts_dir}/dhcp.py show_server_static_mappings --family inet6</command>
                <children>
                  <tagNode name="pool">
                    <properties>
                      <help>Show DHCPv6 server static mappings for a specific pool</help>
                      <completionHelp>
                        <path>service dhcp-server shared-network-name</path>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_server_static_mappings --family inet6 --pool $6</command>
                  </tagNode>
                  <tagNode name="sort">
                    <properties>
                      <help>Show DHCPv6 server static mappings sorted by the specified key</help>
                      <completionHelp>
                        <list>ip mac duid pool</list>
                      </completionHelp>
                    </properties>
                    <command>${vyos_op_scripts_dir}/dhcp.py show_server_static_mappings --family inet6 --sort $6</command>
                  </tagNode>
                </children>
              </node>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
  <node name="restart">
    <children>
      <node name="dhcp">
        <properties>
          <help>Restart DHCP processes</help>
        </properties>
        <children>
          <node name="server">
            <properties>
              <help>Restart DHCP server</help>
            </properties>
            <command>if cli-shell-api existsActive service dhcp-server; then sudo systemctl restart kea-dhcp4-server.service; else echo "DHCP server not configured"; fi</command>
          </node>
          <node name="relay-agent">
            <properties>
              <help>Restart DHCP relay-agent</help>
            </properties>
            <command>sudo ${vyos_op_scripts_dir}/restart_dhcp_relay.py --ipv4</command>
          </node>
        </children>
      </node>
      <node name="dhcpv6">
        <properties>
          <help>Restart DHCPv6 processes</help>
        </properties>
        <children>
          <node name="server">
            <properties>
              <help>Restart DHCPv6 server</help>
            </properties>
            <command>if cli-shell-api existsActive service dhcpv6-server; then sudo systemctl restart kea-dhcp6-server.service; else echo "DHCPv6 server not configured"; fi</command>
          </node>
          <node name="relay-agent">
            <properties>
              <help>Restart DHCPv6 relay-agent</help>
            </properties>
            <command>sudo ${vyos_op_scripts_dir}/restart_dhcp_relay.py --ipv6</command>
          </node>
        </children>
      </node>
    </children>
  </node>
  <node name="renew">
    <properties>
      <help>Renew specified variable</help>
    </properties>
    <children>
      <node name="dhcp">
        <properties>
          <help>Renew DHCP client lease</help>
        </properties>
        <children>
          <tagNode name="interface">
            <properties>
              <help>Renew DHCP client lease for specified interface</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces</script>
              </completionHelp>
            </properties>
            <command>sudo systemctl restart "dhclient@$4.service"</command>
          </tagNode>
        </children>
      </node>
      <node name="dhcpv6">
        <properties>
          <help>Renew DHCPv6 client lease</help>
        </properties>
        <children>
          <tagNode name="interface">
            <properties>
              <help>Renew DHCPv6 client lease for specified interface</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces</script>
              </completionHelp>
            </properties>
            <command>sudo systemctl restart "dhcp6c@$4.service"</command>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>