summaryrefslogtreecommitdiff
path: root/interface-definitions/include/dhcp/option-v4.xml.i
blob: bd6fc6043b2d07a5352e15dd4d33c4ee51adf1c0 (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
<!-- include start from dhcp/option-v4.xml.i -->
<node name="option">
  <properties>
    <help>DHCP option</help>
  </properties>
  <children>
    #include <include/dhcp/captive-portal.xml.i>
    #include <include/dhcp/domain-name.xml.i>
    #include <include/dhcp/domain-search.xml.i>
    #include <include/dhcp/ntp-server.xml.i>
    #include <include/name-server-ipv4.xml.i>
    <leafNode name="bootfile-name">
      <properties>
        <help>Bootstrap file name</help>
        <constraint>
          <regex>[[:ascii:]]{1,253}</regex>
        </constraint>
      </properties>
    </leafNode>
    <leafNode name="bootfile-server">
      <properties>
        <help>Server from which the initial boot file is to be loaded</help>
        <valueHelp>
          <format>ipv4</format>
          <description>Bootfile server IPv4 address</description>
        </valueHelp>
        <valueHelp>
          <format>hostname</format>
          <description>Bootfile server FQDN</description>
        </valueHelp>
        <constraint>
          <validator name="ipv4-address"/>
          <validator name="fqdn"/>
        </constraint>
      </properties>
    </leafNode>
    <leafNode name="bootfile-size">
      <properties>
        <help>Bootstrap file size</help>
        <valueHelp>
          <format>u32:1-16</format>
          <description>Bootstrap file size in 512 byte blocks</description>
        </valueHelp>
        <constraint>
          <validator name="numeric" argument="--range 1-16"/>
        </constraint>
      </properties>
    </leafNode>
    <leafNode name="client-prefix-length">
      <properties>
        <help>Specifies the clients subnet mask as per RFC 950. If unset, subnet declaration is used.</help>
        <valueHelp>
          <format>u32:0-32</format>
          <description>DHCP client prefix length must be 0 to 32</description>
        </valueHelp>
        <constraint>
          <validator name="numeric" argument="--range 0-32"/>
        </constraint>
        <constraintErrorMessage>DHCP client prefix length must be 0 to 32</constraintErrorMessage>
      </properties>
    </leafNode>
    <leafNode name="default-router">
      <properties>
        <help>IP address of default router</help>
        <valueHelp>
          <format>ipv4</format>
          <description>Default router IPv4 address</description>
        </valueHelp>
        <constraint>
          <validator name="ipv4-address"/>
        </constraint>
      </properties>
    </leafNode>
    <leafNode name="ip-forwarding">
      <properties>
        <help>Enable IP forwarding on client</help>
        <valueless/>
      </properties>
    </leafNode>
    <leafNode name="ipv6-only-preferred">
      <properties>
        <help>Disable IPv4 on IPv6 only hosts (RFC 8925)</help>
        <valueHelp>
          <format>u32</format>
          <description>Seconds</description>
        </valueHelp>
        <constraint>
          <validator name="numeric" argument="--range 0-4294967295"/>
        </constraint>
        <constraintErrorMessage>Seconds must be between 0 and 4294967295 (49 days)</constraintErrorMessage>
      </properties>
    </leafNode>
    <leafNode name="pop-server">
      <properties>
        <help>IP address of POP3 server</help>
        <valueHelp>
          <format>ipv4</format>
          <description>POP3 server IPv4 address</description>
        </valueHelp>
        <constraint>
          <validator name="ipv4-address"/>
        </constraint>
        <multi/>
      </properties>
    </leafNode>
    <leafNode name="server-identifier">
      <properties>
        <help>Address for DHCP server identifier</help>
        <valueHelp>
          <format>ipv4</format>
          <description>DHCP server identifier IPv4 address</description>
        </valueHelp>
        <constraint>
          <validator name="ipv4-address"/>
        </constraint>
      </properties>
    </leafNode>
    <leafNode name="smtp-server">
      <properties>
        <help>IP address of SMTP server</help>
        <valueHelp>
          <format>ipv4</format>
          <description>SMTP server IPv4 address</description>
        </valueHelp>
        <constraint>
          <validator name="ipv4-address"/>
        </constraint>
        <multi/>
      </properties>
    </leafNode>
    <tagNode name="static-route">
      <properties>
        <help>Classless static route destination subnet</help>
        <valueHelp>
          <format>ipv4net</format>
          <description>IPv4 address and prefix length</description>
        </valueHelp>
        <constraint>
          <validator name="ipv4-prefix"/>
        </constraint>
      </properties>
      <children>
        <leafNode name="next-hop">
          <properties>
            <help>IP address of router to be used to reach the destination subnet</help>
            <valueHelp>
              <format>ipv4</format>
              <description>IPv4 address of router</description>
            </valueHelp>
            <constraint>
              <validator name="ip-address"/>
            </constraint>
          </properties>
        </leafNode>
      </children>
    </tagNode >
    <leafNode name="tftp-server-name">
      <properties>
        <help>TFTP server name</help>
        <valueHelp>
          <format>ipv4</format>
          <description>TFTP server IPv4 address</description>
        </valueHelp>
        <valueHelp>
          <format>hostname</format>
          <description>TFTP server FQDN</description>
        </valueHelp>
        <constraint>
          <validator name="ipv4-address"/>
          <validator name="fqdn"/>
        </constraint>
      </properties>
    </leafNode>
    <leafNode name="time-offset">
      <properties>
        <help>Client subnet offset in seconds from Coordinated Universal Time (UTC)</help>
        <valueHelp>
          <format>[-]N</format>
          <description>Time offset (number, may be negative)</description>
        </valueHelp>
        <constraint>
          <regex>-?[0-9]+</regex>
        </constraint>
        <constraintErrorMessage>Invalid time offset value</constraintErrorMessage>
      </properties>
    </leafNode>
    <leafNode name="time-server">
      <properties>
        <help>IP address of time server</help>
        <valueHelp>
          <format>ipv4</format>
          <description>Time server IPv4 address</description>
        </valueHelp>
        <constraint>
          <validator name="ipv4-address"/>
        </constraint>
        <multi/>
      </properties>
    </leafNode>
    <leafNode name="time-zone">
      <properties>
        <help>Time zone to send to clients. Uses RFC4833 options 100 and 101</help>
        <completionHelp>
          <script>timedatectl list-timezones</script>
        </completionHelp>
        <constraint>
          <validator name="timezone" argument="--validate"/>
        </constraint>
      </properties>
    </leafNode>
    <node name="vendor-option">
      <properties>
        <help>Vendor Specific Options</help>
      </properties>
      <children>
        <node name="ubiquiti">
          <properties>
            <help>Ubiquiti specific parameters</help>
          </properties>
          <children>
            <leafNode name="unifi-controller">
              <properties>
                <help>Address of UniFi controller</help>
                <valueHelp>
                  <format>ipv4</format>
                  <description>IP address of UniFi controller</description>
                </valueHelp>
                <constraint>
                  <validator name="ipv4-address"/>
                </constraint>
              </properties>
            </leafNode>
          </children>
        </node>
      </children>
    </node>
    <leafNode name="wins-server">
      <properties>
        <help>IP address for Windows Internet Name Service (WINS) server</help>
        <valueHelp>
          <format>ipv4</format>
          <description>WINS server IPv4 address</description>
        </valueHelp>
        <constraint>
          <validator name="ipv4-address"/>
        </constraint>
        <multi/>
      </properties>
    </leafNode>
    <leafNode name="wpad-url">
      <properties>
        <help>Web Proxy Autodiscovery (WPAD) URL</help>
      </properties>
    </leafNode>
  </children>
</node>
<!-- include end -->