summaryrefslogtreecommitdiffstats
path: root/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml
blob: d368c964199373c8459f7ebd8ab8379125278fe5 (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
<?xml version="1.0" encoding="UTF-8"?>
<!--
    Manually generated from src/VBox/Main/idl/VirtualBox.xidl by 'kmk dhcpoptions'.
    DO NOT EDIT!
-->
<!--
    Copyright (C) 2019-2023 Oracle and/or its affiliates.

    This file is part of VirtualBox base platform packages, as
    available from https://www.virtualbox.org.

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation, in version 3 of the
    License.

    This program is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, see <https://www.gnu.org/licenses>.

    SPDX-License-Identifier: GPL-3.0-only
-->

      <variablelist>
        <varlistentry>
          <term>1 - SubnetMask</term>
          <listitem><para>IPv4 netmask. Set to the value of the --netmask option by default.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>2 - TimeOffset</term>
          <listitem><para>UTC offset in seconds (32-bit decimal value).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>3 - Routers</term>
          <listitem><para>Space separated list of IPv4 router addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>4 - TimeServers</term>
          <listitem><para>Space separated list of IPv4 time server (RFC 868) addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>5 - NameServers</term>
          <listitem><para>Space separated list of IPv4 name server (IEN 116) addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>6 - DomainNameServers</term>
          <listitem><para>Space separated list of IPv4 DNS addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>7 - LogServers</term>
          <listitem><para>Space separated list of IPv4 log server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>8 - CookieServers</term>
          <listitem><para>Space separated list of IPv4 cookie server (RFC 865) addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>9 - LPRServers</term>
          <listitem><para>Space separated list of IPv4 line printer server (RFC 1179) addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>10 - ImpressServers</term>
          <listitem><para>Space separated list of IPv4 imagen impress server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>11 - ResourseLocationServers</term>
          <listitem><para>Space separated list of IPv4 resource location (RFC 887) addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>12 - HostName</term>
          <listitem><para>The client name. See RFC 1035 for character limits. </para></listitem>
        </varlistentry>        <varlistentry>
          <term>13 - BootFileSize</term>
          <listitem><para>Number of 512 byte blocks making up the boot file (16-bit decimal value).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>14 - MeritDumpFile</term>
          <listitem><para>Client core file.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>15 - DomainName</term>
          <listitem><para>Domain name for the client.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>16 - SwapServer</term>
          <listitem><para>IPv4 address of the swap server that the client should use.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>17 - RootPath</term>
          <listitem><para>The path to the root disk the client should use.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>18 - ExtensionPath</term>
          <listitem><para>Path to a file containing additional DHCP options (RFC2123).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>19 - IPForwarding</term>
          <listitem><para>Whether IP forwarding should be enabled by the client (boolean).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>20 - OptNonLocalSourceRouting</term>
          <listitem><para>Whether non-local datagrams should be forwarded by the client (boolean)</para></listitem>
        </varlistentry>        <varlistentry>
          <term>21 - PolicyFilter</term>
          <listitem><para>List of IPv4 addresses and masks paris controlling non-local source routing.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>22 - MaxDgramReassemblySize</term>
          <listitem><para>The maximum datagram size the client should reassemble (16-bit decimal value).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>23 - DefaultIPTTL</term>
          <listitem><para>The default time-to-leave on outgoing (IP) datagrams (8-bit decimal value).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>24 - PathMTUAgingTimeout</term>
          <listitem><para>RFC1191 path MTU discovery timeout value in seconds (32-bit decimal value).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>25 - PathMTUPlateauTable</term>
          <listitem><para>RFC1191 path MTU discovery size table, sorted in ascending order (list of 16-bit decimal values).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>26 - InterfaceMTU</term>
          <listitem><para>The MTU size for the interface (16-bit decimal value).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>27 - AllSubnetsAreLocal</term>
          <listitem><para>Indicates whether the MTU size is the same for all subnets (boolean).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>28 - BroadcastAddress</term>
          <listitem><para>Broadcast address (RFC1122) for the client to use (IPv4 address).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>29 - PerformMaskDiscovery</term>
          <listitem><para>Whether to perform subnet mask discovery via ICMP (boolean).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>30 - MaskSupplier</term>
          <listitem><para>Whether to respond to subnet mask requests via ICMP (boolean).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>31 - PerformRouterDiscovery</term>
          <listitem><para>Whether to perform router discovery (RFC1256) (boolean).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>32 - RouterSolicitationAddress</term>
          <listitem><para>Where to send router solicitation requests (RFC1256) (IPv4 address).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>33 - StaticRoute</term>
          <listitem><para>List of network and router address pairs addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>34 - TrailerEncapsulation</term>
          <listitem><para>Whether to negotiate the use of trailers for ARP (RTF893) (boolean).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>35 - ARPCacheTimeout</term>
          <listitem><para>The timeout in seconds for ARP cache entries (32-bit decimal value).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>36 - EthernetEncapsulation</term>
          <listitem><para>Whether to use IEEE 802.3 (RTF1042) rather than of v2 (RFC894) ethernet encapsulation (boolean).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>37 - TCPDefaultTTL</term>
          <listitem><para>Default time-to-live for TCP sends (non-zero 8-bit decimal value).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>38 - TCPKeepaliveInterval</term>
          <listitem><para>The interface in seconds between TCP keepalive messages (32-bit decimal value).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>39 - TCPKeepaliveGarbage</term>
          <listitem><para>Whether to include a byte of garbage in TCP keepalive messages for backward compatibility (boolean).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>40 - NISDomain</term>
          <listitem><para>The NIS (Sun Network Information Services) domain name (string).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>41 - NISServers</term>
          <listitem><para>Space separated list of IPv4 NIS server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>42 - NTPServers</term>
          <listitem><para>Space separated list of IPv4 NTP (RFC1035) server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>43 - VendorSpecificInfo</term>
          <listitem><para>Vendor specific information. Only accessible using --set-opt-hex.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>44 - NetBIOSNameServers</term>
          <listitem><para>Space separated list of IPv4 NetBIOS name server (NBNS) addresses (RFC1001,RFC1002).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>45 - NetBIOSDatagramServers</term>
          <listitem><para>Space separated list of IPv4 NetBIOS datagram distribution server (NBDD) addresses (RFC1001,RFC1002).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>46 - NetBIOSNodeType</term>
          <listitem><para>NetBIOS node type (RFC1001,RFC1002): 1=B-node, 2=P-node, 4=M-node, and 8=H-node (8-bit decimal value).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>47 - NetBIOSScope</term>
          <listitem><para>NetBIOS scope (RFC1001,RFC1002). Only accessible using --set-opt-hex.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>48 - XWindowsFontServers</term>
          <listitem><para>Space separated list of IPv4 X windows font server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>49 - XWindowsDisplayManager</term>
          <listitem><para>Space separated list of IPv4 X windows display manager addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>62 - NetWareIPDomainName</term>
          <listitem><para>Netware IP domain name (RFC2242) (string).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>63 - NetWareIPInformation</term>
          <listitem><para>Netware IP information (RFC2242). Only accessible using --set-opt-hex.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>64 - NISPlusDomain</term>
          <listitem><para>The NIS+ domain name (string).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>65 - NISPlusServers</term>
          <listitem><para>Space separated list of IPv4 NIS+ server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>66 - TFTPServerName</term>
          <listitem><para>TFTP server name (string).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>67 - BootfileName</term>
          <listitem><para>Bootfile name (string).</para></listitem>
        </varlistentry>        <varlistentry>
          <term>68 - MobileIPHomeAgents</term>
          <listitem><para>Space separated list of IPv4 mobile IP agent addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>69 - SMTPServers</term>
          <listitem><para>Space separated list of IPv4 simple mail transport protocol (SMPT) server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>70 - POP3Servers</term>
          <listitem><para>Space separated list of IPv4 post office protocol 3 (POP3) server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>71 - NNTPServers</term>
          <listitem><para>Space separated list of IPv4 network news transport protocol (NTTP) server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>72 - WWWServers</term>
          <listitem><para>Space separated list of default IPv4 world wide web (WWW) server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>73 - FingerServers</term>
          <listitem><para>Space separated list of default IPv4 finger server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>74 - IRCServers</term>
          <listitem><para>Space separated list of default IPv4 internet relay chat (IRC) server  addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>75 - StreetTalkServers</term>
          <listitem><para>Space separated list of IPv4 StreetTalk server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>76 - STDAServers</term>
          <listitem><para>Space separated list of IPv4 StreetTalk directory assistance (STDA) server addresses.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>78 - SLPDirectoryAgent</term>
          <listitem><para>Addresses of one or more service location protocol (SLP) directory agent, and an indicator of whether their use is mandatory. Only accessible using --set-opt-hex.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>79 - SLPServiceScope</term>
          <listitem><para>List of service scopes for the service location protocol (SLP) and whether using the list is mandator. Only accessible using --set-opt-hex.</para></listitem>
        </varlistentry>        <varlistentry>
          <term>119 - DomainSearch</term>
          <listitem><para>Domain search list, see RFC3397 and section 4.1.4 in RFC1035 for encoding.  Only accessible using --set-opt-hex.</para></listitem>
        </varlistentry>
      </variablelist>