1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!--
|
---|
3 | manpage, user manual, usage: VBoxManage dhcpserver
|
---|
4 |
|
---|
5 | Copyright (C) 2006-2015 Oracle Corporation
|
---|
6 |
|
---|
7 | This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
8 | available from http://www.virtualbox.org. This file is free software;
|
---|
9 | you can redistribute it and/or modify it under the terms of the GNU
|
---|
10 | General Public License (GPL) as published by the Free Software
|
---|
11 | Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
12 | VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
13 | hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
14 | -->
|
---|
15 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
|
---|
16 | <refentry id="vboxmanage-dhcpserver" lang="en">
|
---|
17 |
|
---|
18 | <refentryinfo>
|
---|
19 | <pubdate>$Date: 2019-07-18 20:33:32 +0000 (Thu, 18 Jul 2019) $</pubdate>
|
---|
20 | <title>VBoxManage dhcpserver</title>
|
---|
21 | </refentryinfo>
|
---|
22 |
|
---|
23 | <refmeta>
|
---|
24 | <refentrytitle>VBoxManage-dhcpserver</refentrytitle>
|
---|
25 | <manvolnum>1</manvolnum>
|
---|
26 | </refmeta>
|
---|
27 |
|
---|
28 | <refnamediv>
|
---|
29 | <refname>VBoxManage-dhcpserver</refname>
|
---|
30 | <refpurpose>DHCP server management</refpurpose>
|
---|
31 | <refclass>Oracle VM VirtualBox</refclass>
|
---|
32 | </refnamediv>
|
---|
33 |
|
---|
34 | <refsynopsisdiv>
|
---|
35 | <cmdsynopsis id="synopsis-vboxmanage-dhcpserver-add">
|
---|
36 | <command>VBoxManage dhcpserver add</command>
|
---|
37 | <group choice="req">
|
---|
38 | <arg choice="plain">--network=<replaceable>netname</replaceable></arg>
|
---|
39 | <arg choice="plain">--interface=<replaceable>ifname</replaceable></arg>
|
---|
40 | </group>
|
---|
41 | <arg choice="req">--server-ip=<replaceable>address</replaceable></arg>
|
---|
42 | <arg choice="req">--netmask=<replaceable>mask</replaceable></arg>
|
---|
43 | <arg choice="req">--lower-ip=<replaceable>address</replaceable></arg>
|
---|
44 | <arg choice="req">--upper-ip=<replaceable>address</replaceable></arg>
|
---|
45 | <group choice="req">
|
---|
46 | <arg choice="plain">--enable</arg>
|
---|
47 | <arg choice="plain">--disable</arg>
|
---|
48 | </group>
|
---|
49 | <sbr/>
|
---|
50 | <arg choice="opt" rep="repeat">
|
---|
51 | <arg choice="opt">--global</arg>
|
---|
52 | <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
|
---|
53 | <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
|
---|
54 | <arg choice="opt" rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
55 | <arg choice="opt" rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
56 | <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
57 | <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
58 | <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
59 | </arg>
|
---|
60 | <sbr/>
|
---|
61 | <arg choice="opt" rep="repeat">
|
---|
62 | <arg choice="req">--group=<replaceable>name</replaceable></arg>
|
---|
63 | <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
|
---|
64 | <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
|
---|
65 | <arg choice="opt" rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
66 | <arg choice="opt" rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
67 | <arg choice="opt" rep="repeat">--incl-mac=<replaceable>address</replaceable></arg>
|
---|
68 | <arg choice="opt" rep="repeat">--excl-mac=<replaceable>address</replaceable></arg>
|
---|
69 | <arg choice="opt" rep="repeat">--incl-mac-wild=<replaceable>pattern</replaceable></arg>
|
---|
70 | <arg choice="opt" rep="repeat">--excl-mac-wild=<replaceable>pattern</replaceable></arg>
|
---|
71 | <arg choice="opt" rep="repeat">--incl-vendor=<replaceable>string</replaceable></arg>
|
---|
72 | <arg choice="opt" rep="repeat">--excl-vendor=<replaceable>string</replaceable></arg>
|
---|
73 | <arg choice="opt" rep="repeat">--incl-vendor-wild=<replaceable>pattern</replaceable></arg>
|
---|
74 | <arg choice="opt" rep="repeat">--excl-vendor-wild=<replaceable>pattern</replaceable></arg>
|
---|
75 | <arg choice="opt" rep="repeat">--incl-user=<replaceable>string</replaceable></arg>
|
---|
76 | <arg choice="opt" rep="repeat">--excl-user=<replaceable>string</replaceable></arg>
|
---|
77 | <arg choice="opt" rep="repeat">--incl-user-wild=<replaceable>pattern</replaceable></arg>
|
---|
78 | <arg choice="opt" rep="repeat">--excl-user-wild=<replaceable>pattern</replaceable></arg>
|
---|
79 | <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
80 | <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
81 | <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
82 | </arg>
|
---|
83 | <sbr/>
|
---|
84 | <arg choice="opt" rep="repeat">
|
---|
85 | <arg choice="req">--vm=<replaceable>name|uuid</replaceable></arg>
|
---|
86 | <arg choice="opt">--nic=<replaceable>1-N</replaceable></arg>
|
---|
87 | <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
|
---|
88 | <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
|
---|
89 | <arg choice="opt" rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
90 | <arg choice="opt" rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
91 | <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
92 | <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
93 | <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
94 | <arg choice="opt">--fixed-address=<replaceable>address</replaceable></arg>
|
---|
95 | </arg>
|
---|
96 | <sbr/>
|
---|
97 | <arg choice="opt" rep="repeat">
|
---|
98 | <arg choice="req">--mac-address=<replaceable>address</replaceable></arg>
|
---|
99 | <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
|
---|
100 | <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
|
---|
101 | <arg choice="opt" rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
102 | <arg choice="opt" rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
103 | <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
104 | <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
105 | <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
106 | <arg choice="opt">--fixed-address=<replaceable>address</replaceable></arg>
|
---|
107 | </arg>
|
---|
108 | </cmdsynopsis>
|
---|
109 | <cmdsynopsis id="synopsis-vboxmanage-dhcpserver-modify">
|
---|
110 | <command>VBoxManage dhcpserver modify</command>
|
---|
111 | <group choice="req">
|
---|
112 | <arg choice="plain">--network=<replaceable>netname</replaceable></arg>
|
---|
113 | <arg choice="plain">--interface=<replaceable>ifname</replaceable></arg>
|
---|
114 | </group>
|
---|
115 | <arg choice="opt">--server-ip=<replaceable>address</replaceable></arg>
|
---|
116 | <arg choice="opt">--lower-ip=<replaceable>address</replaceable></arg>
|
---|
117 | <arg choice="opt">--upper-ip=<replaceable>address</replaceable></arg>
|
---|
118 | <arg choice="opt">--netmask=<replaceable>mask</replaceable></arg>
|
---|
119 | <group choice="opt">
|
---|
120 | <arg choice="plain">--enable</arg>
|
---|
121 | <arg choice="plain">--disable</arg>
|
---|
122 | </group>
|
---|
123 | <sbr/>
|
---|
124 | <arg choice="opt" rep="repeat">
|
---|
125 | <arg choice="opt">--global</arg>
|
---|
126 | <arg choice="opt" rep="repeat">--del-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
127 | <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
|
---|
128 | <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
|
---|
129 | <arg choice="opt" rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
130 | <arg choice="opt" rep="repeat">--unforce-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
131 | <arg choice="opt" rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
132 | <arg choice="opt" rep="repeat">--unsupress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
133 | <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
134 | <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
135 | <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
136 | <arg choice="opt">--remove-config</arg>
|
---|
137 | </arg>
|
---|
138 | <sbr/>
|
---|
139 | <arg choice="opt" rep="repeat">
|
---|
140 | <arg choice="req">--group=<replaceable>name</replaceable></arg>
|
---|
141 | <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
|
---|
142 | <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
|
---|
143 | <arg choice="opt" rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
144 | <arg choice="opt" rep="repeat">--unforce-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
145 | <arg choice="opt" rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
146 | <arg choice="opt" rep="repeat">--unsupress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
147 | <arg choice="opt" rep="repeat">--del-mac=<replaceable>address</replaceable></arg>
|
---|
148 | <arg choice="opt" rep="repeat">--incl-mac=<replaceable>address</replaceable></arg>
|
---|
149 | <arg choice="opt" rep="repeat">--excl-mac=<replaceable>address</replaceable></arg>
|
---|
150 | <arg choice="opt" rep="repeat">--del-mac-wild=<replaceable>pattern</replaceable></arg>
|
---|
151 | <arg choice="opt" rep="repeat">--incl-mac-wild=<replaceable>pattern</replaceable></arg>
|
---|
152 | <arg choice="opt" rep="repeat">--excl-mac-wild=<replaceable>pattern</replaceable></arg>
|
---|
153 | <arg choice="opt" rep="repeat">--del-vendor=<replaceable>string</replaceable></arg>
|
---|
154 | <arg choice="opt" rep="repeat">--incl-vendor=<replaceable>string</replaceable></arg>
|
---|
155 | <arg choice="opt" rep="repeat">--excl-vendor=<replaceable>string</replaceable></arg>
|
---|
156 | <arg choice="opt" rep="repeat">--del-vendor-wild=<replaceable>pattern</replaceable></arg>
|
---|
157 | <arg choice="opt" rep="repeat">--incl-vendor-wild=<replaceable>pattern</replaceable></arg>
|
---|
158 | <arg choice="opt" rep="repeat">--excl-vendor-wild=<replaceable>pattern</replaceable></arg>
|
---|
159 | <arg choice="opt" rep="repeat">--del-user=<replaceable>string</replaceable></arg>
|
---|
160 | <arg choice="opt" rep="repeat">--incl-user=<replaceable>string</replaceable></arg>
|
---|
161 | <arg choice="opt" rep="repeat">--excl-user=<replaceable>string</replaceable></arg>
|
---|
162 | <arg choice="opt" rep="repeat">--del-user-wild=<replaceable>pattern</replaceable></arg>
|
---|
163 | <arg choice="opt" rep="repeat">--incl-user-wild=<replaceable>pattern</replaceable></arg>
|
---|
164 | <arg choice="opt" rep="repeat">--excl-user-wild=<replaceable>pattern</replaceable></arg>
|
---|
165 | <arg choice="opt">--zap-conditions</arg>
|
---|
166 | <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
167 | <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
168 | <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
169 | <arg choice="opt">--remove-config</arg>
|
---|
170 | </arg>
|
---|
171 | <sbr/>
|
---|
172 | <arg choice="opt" rep="repeat">
|
---|
173 | <arg choice="req">--vm=<replaceable>name|uuid</replaceable></arg>
|
---|
174 | <arg choice="opt">--nic=<replaceable>1-N</replaceable></arg>
|
---|
175 | <arg choice="opt" rep="repeat">--del-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
176 | <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
|
---|
177 | <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
|
---|
178 | <arg choice="opt" rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
179 | <arg choice="opt" rep="repeat">--unforce-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
180 | <arg choice="opt" rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
181 | <arg choice="opt" rep="repeat">--unsupress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
182 | <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
183 | <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
184 | <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
185 | <arg choice="opt">--fixed-address=<replaceable>address</replaceable></arg>
|
---|
186 | <arg choice="opt">--remove-config</arg>
|
---|
187 | </arg>
|
---|
188 | <sbr/>
|
---|
189 | <arg choice="opt" rep="repeat">
|
---|
190 | <arg choice="req">--mac-address=<replaceable>address</replaceable></arg>
|
---|
191 | <arg choice="opt" rep="repeat">--del-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
192 | <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
|
---|
193 | <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
|
---|
194 | <arg choice="opt" rep="repeat">--force-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
195 | <arg choice="opt" rep="repeat">--unforce-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
196 | <arg choice="opt" rep="repeat">--supress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
197 | <arg choice="opt" rep="repeat">--unsupress-opt=<replaceable>dhcp-opt-no</replaceable></arg>
|
---|
198 | <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
199 | <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
200 | <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
|
---|
201 | <arg choice="opt">--fixed-address=<replaceable>address</replaceable></arg>
|
---|
202 | <arg choice="opt">--remove-config</arg>
|
---|
203 | </arg>
|
---|
204 | </cmdsynopsis>
|
---|
205 | <cmdsynopsis id="synopsis-vboxmanage-dhcpserver-remove">
|
---|
206 | <command>VBoxManage dhcpserver remove</command>
|
---|
207 | <group choice="req">
|
---|
208 | <arg choice="plain">--network=<replaceable>netname</replaceable></arg>
|
---|
209 | <arg choice="plain">--interface=<replaceable>ifname</replaceable></arg>
|
---|
210 | </group>
|
---|
211 | </cmdsynopsis>
|
---|
212 | <cmdsynopsis id="synopsis-vboxmanage-dhcpserver-restart">
|
---|
213 | <command>VBoxManage dhcpserver restart</command>
|
---|
214 | <group choice="req">
|
---|
215 | <arg choice="plain">--network=<replaceable>netname</replaceable></arg>
|
---|
216 | <arg choice="plain">--interface=<replaceable>ifname</replaceable></arg>
|
---|
217 | </group>
|
---|
218 | </cmdsynopsis>
|
---|
219 | <cmdsynopsis id="synopsis-vboxmanage-dhcpserver-findlease">
|
---|
220 | <command>VBoxManage dhcpserver findlease</command>
|
---|
221 | <group choice="req">
|
---|
222 | <arg choice="plain">--network=<replaceable>netname</replaceable></arg>
|
---|
223 | <arg choice="plain">--interface=<replaceable>ifname</replaceable></arg>
|
---|
224 | </group>
|
---|
225 | <arg choice="req">--mac-address=<replaceable>mac</replaceable></arg>
|
---|
226 | </cmdsynopsis>
|
---|
227 | </refsynopsisdiv>
|
---|
228 |
|
---|
229 | <refsect1>
|
---|
230 | <title>Description</title>
|
---|
231 |
|
---|
232 | <para>
|
---|
233 | The <command>dhcpserver</command> commands enable you to control the DHCP
|
---|
234 | server that is built into VirtualBox. You may find this useful when
|
---|
235 | using internal or host-only networking. Theoretically, you can also
|
---|
236 | enable it for a bridged network, but that may cause conflicts with other
|
---|
237 | DHCP servers in your physical network.
|
---|
238 | </para>
|
---|
239 |
|
---|
240 | <refsect2 id="vboxmanage-dhcpserver-common-options">
|
---|
241 | <title>Common options</title>
|
---|
242 | <remark role="help-scope" condition="GLOBAL"/>
|
---|
243 | <para>The subcommands of <command>dhcpserver</command> all operate on an
|
---|
244 | internal network that can be identified via its name or in the host-only
|
---|
245 | case via the host-only interface name:</para>
|
---|
246 | <variablelist>
|
---|
247 | <varlistentry>
|
---|
248 | <term>--network=<replaceable>netname</replaceable></term>
|
---|
249 | <listitem><para>The internal network name. This is the same as you
|
---|
250 | would use as value to the <command>VBoxManage modifyvm --intnet</command>
|
---|
251 | option when configuring a VM for internal networking. Or you see as
|
---|
252 | VBoxNetworkName in the output from
|
---|
253 | <command>VBoxManage list intnets</command>,
|
---|
254 | <command>VBoxManage list natnets</command>, or
|
---|
255 | <command>VBoxManage list hostonlyifs</command>.
|
---|
256 | </para></listitem>
|
---|
257 | </varlistentry>
|
---|
258 | <varlistentry>
|
---|
259 | <term>--interface=<replaceable>ifname</replaceable></term>
|
---|
260 | <listitem><para>The host only interface name. This would be same value
|
---|
261 | as you would use for the <command>VBoxManage modifyvm --hostonlyadapter</command>
|
---|
262 | option when configuring a VM to use a host-only network. The value
|
---|
263 | can also be found in the Name row in <command>VBoxManage list hostonlyifs</command>.
|
---|
264 | </para></listitem>
|
---|
265 | </varlistentry>
|
---|
266 | </variablelist>
|
---|
267 | </refsect2>
|
---|
268 |
|
---|
269 | <refsect2 id="vboxmanage-dhcpserver-add">
|
---|
270 | <title>dhcpserver add</title>
|
---|
271 | <remark role="help-copy-synopsis"/>
|
---|
272 | <para>
|
---|
273 | Adds a new DHCP server to a network or host-only interface.
|
---|
274 | </para>
|
---|
275 | <para>
|
---|
276 | Options configuring the DHCP server core:
|
---|
277 | </para>
|
---|
278 | <variablelist>
|
---|
279 | <varlistentry>
|
---|
280 | <term><option>--server-ip=<replaceable>address</replaceable></option></term>
|
---|
281 | <listitem><para>The IP address the DHCP server should use.</para></listitem>
|
---|
282 | </varlistentry>
|
---|
283 | <varlistentry>
|
---|
284 | <term><option>--lower-ip=<replaceable>address</replaceable></option>, <option>--upper-ip=<replaceable>address</replaceable></option></term>
|
---|
285 | <listitem><para>The IP address range for the DHCP server to manage. This
|
---|
286 | should not include the address of the DHCP server itself, but it must be
|
---|
287 | in the same network as it. The boundraries are inclusive, so both the
|
---|
288 | lower and upper addresses will be handed out to clients.</para></listitem>
|
---|
289 | </varlistentry>
|
---|
290 | <varlistentry>
|
---|
291 | <term><option>--netmask=<replaceable>mask</replaceable></option></term>
|
---|
292 | <listitem><para>The network mask. Typically 255.255.255.0.</para></listitem>
|
---|
293 | </varlistentry>
|
---|
294 | <varlistentry>
|
---|
295 | <term><option>--enable</option>, --disable</term>
|
---|
296 | <listitem><para>Whether to enable the DHCP server or disable it. If not specified,
|
---|
297 | the server will be created in disabled state and no IP addresses handed out.</para></listitem>
|
---|
298 | </varlistentry>
|
---|
299 | </variablelist>
|
---|
300 | <para>
|
---|
301 | Options selecting the scope:
|
---|
302 | </para>
|
---|
303 | <variablelist>
|
---|
304 | <varlistentry>
|
---|
305 | <term><option>--global</option></term>
|
---|
306 | <listitem><para>Set the configuration scope to global. Any subsequent
|
---|
307 | <option>--set-opt</option> options will be apply to all the DHCP clients.</para></listitem>
|
---|
308 | </varlistentry>
|
---|
309 | <varlistentry>
|
---|
310 | <term><option>--vm=<replaceable>vmname|uuid</replaceable></option></term>
|
---|
311 | <listitem><para>Set the configuration scope to the first NIC of the specified VM. Any
|
---|
312 | subsequent <option>--set-opt</option> options will apply just to that interface,
|
---|
313 | nothing else.</para></listitem>
|
---|
314 | </varlistentry>
|
---|
315 | <varlistentry>
|
---|
316 | <term><option>--nic=<replaceable>1-N</replaceable></option></term>
|
---|
317 | <listitem><para>Set the configuration scope to a NIC other than first of
|
---|
318 | the VM specified the in <option>--vm</option>.
|
---|
319 | </para></listitem>
|
---|
320 | </varlistentry>
|
---|
321 | <varlistentry>
|
---|
322 | <term><option>--mac-address=<replaceable>address</replaceable></option></term>
|
---|
323 | <listitem><para>Set the configuration scope to the specified MAC address.</para></listitem>
|
---|
324 | </varlistentry>
|
---|
325 | <varlistentry>
|
---|
326 | <term><option>--group=<replaceable>name</replaceable></option></term>
|
---|
327 | <listitem><para>Set the configuration scope to the specified group.</para></listitem>
|
---|
328 | </varlistentry>
|
---|
329 | </variablelist>
|
---|
330 | <para>
|
---|
331 | Options configuring the currently selected scope:
|
---|
332 | </para>
|
---|
333 | <variablelist>
|
---|
334 | <varlistentry>
|
---|
335 | <term><option>--set-opt=<replaceable>dhcp-opt-no value</replaceable></option></term>
|
---|
336 | <listitem><para>Adds the specified DHCP option number (0-255) and value. The
|
---|
337 | value format is option specific (typically human readable) and will be
|
---|
338 | validated by the API and the DHCP server.
|
---|
339 | </para></listitem>
|
---|
340 | </varlistentry>
|
---|
341 | <varlistentry>
|
---|
342 | <term><option>--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></option></term>
|
---|
343 | <listitem><para>Adds the specified DHCP option number (0-255) and value. The option value
|
---|
344 | is specified as a raw series of hex bytes, optionally separated by colons. No validation
|
---|
345 | is performed on these by the API or the DHCP server, they will be pass as specified to the
|
---|
346 | client.
|
---|
347 | </para></listitem>
|
---|
348 | </varlistentry>
|
---|
349 | <varlistentry>
|
---|
350 | <term><option>--force-opt=<replaceable>dhcp-opt-no</replaceable></option></term>
|
---|
351 | <listitem><para>Forces the specified DHCP option number (0-255) onto to be
|
---|
352 | sent to the client whether it requested it or not (provided the option is
|
---|
353 | configured with a value at some level).
|
---|
354 | </para></listitem>
|
---|
355 | </varlistentry>
|
---|
356 | <varlistentry>
|
---|
357 | <term><option>--suppress-opt=<replaceable>dhcp-opt-no</replaceable></option></term>
|
---|
358 | <listitem><para>Prevents the specified DHCP option number (0-255) from being
|
---|
359 | sent to the client when present in this or a high configuration scope.
|
---|
360 | </para></listitem>
|
---|
361 | </varlistentry>
|
---|
362 | <varlistentry>
|
---|
363 | <term><option>--min-lease-time=<replaceable>seconds</replaceable></option></term>
|
---|
364 | <listitem><para>Sets the minimum lease time for the current scope in seconds.
|
---|
365 | Zero means taking the value from a higher option level or use default.
|
---|
366 | </para></listitem>
|
---|
367 | </varlistentry>
|
---|
368 | <varlistentry>
|
---|
369 | <term><option>--default-lease-time=<replaceable>seconds</replaceable></option></term>
|
---|
370 | <listitem><para>Sets the default lease time for the current scope in seconds.
|
---|
371 | Zero means taking the value from a higher option level or use default.
|
---|
372 | </para></listitem>
|
---|
373 | </varlistentry>
|
---|
374 | <varlistentry>
|
---|
375 | <term><option>--max-lease-time=<replaceable>seconds</replaceable></option></term>
|
---|
376 | <listitem><para>Sets the maximum lease time for the current scope in seconds.
|
---|
377 | Zero means taking the value from a higher option level or use default.
|
---|
378 | </para></listitem>
|
---|
379 | </varlistentry>
|
---|
380 | <varlistentry>
|
---|
381 | <term><option>--fixed-address=<replaceable>address</replaceable></option></term>
|
---|
382 | <listitem><para>Fixed address assignment for a <option>--vm</option> or
|
---|
383 | <option>--mac-address</option> configuration scope. Any empty
|
---|
384 | <replaceable>address</replaceable> turns it back to dynamic address assignment.
|
---|
385 | </para></listitem>
|
---|
386 | </varlistentry>
|
---|
387 | </variablelist>
|
---|
388 |
|
---|
389 | <para>
|
---|
390 | Options configuring group membership conditions (excludes overrides includes):
|
---|
391 | </para>
|
---|
392 | <variablelist>
|
---|
393 | <varlistentry>
|
---|
394 | <term><option>--incl-mac=<replaceable>address</replaceable></option></term>
|
---|
395 | <listitem><para>Include the specific MAC address in the group.</para></listitem>
|
---|
396 | </varlistentry>
|
---|
397 | <varlistentry>
|
---|
398 | <term><option>--excl-mac=<replaceable>address</replaceable></option></term>
|
---|
399 | <listitem><para>Exclude the specific MAC address from the group.</para></listitem>
|
---|
400 | </varlistentry>
|
---|
401 | <varlistentry>
|
---|
402 | <term><option>--incl-mac-wild=<replaceable>pattern</replaceable></option></term>
|
---|
403 | <listitem><para>Include the specific MAC address pattern in the group.</para></listitem>
|
---|
404 | </varlistentry>
|
---|
405 | <varlistentry>
|
---|
406 | <term><option>--excl-mac-wild=<replaceable>pattern</replaceable></option></term>
|
---|
407 | <listitem><para>Exclude the specific MAC address pattern from the group.</para></listitem>
|
---|
408 | </varlistentry>
|
---|
409 | <varlistentry>
|
---|
410 | <term><option>--incl-vendor=<replaceable>string</replaceable></option></term>
|
---|
411 | <listitem><para>Include the specific vendor class ID in the group.</para></listitem>
|
---|
412 | </varlistentry>
|
---|
413 | <varlistentry>
|
---|
414 | <term><option>--excl-vendor=<replaceable>string</replaceable></option></term>
|
---|
415 | <listitem><para>Exclude the specific vendor class ID from the group.</para></listitem>
|
---|
416 | </varlistentry>
|
---|
417 | <varlistentry>
|
---|
418 | <term><option>--incl-vendor-wild=<replaceable>pattern</replaceable></option></term>
|
---|
419 | <listitem><para>Include the specific vendor class ID pattern in the group.</para></listitem>
|
---|
420 | </varlistentry>
|
---|
421 | <varlistentry>
|
---|
422 | <term><option>--excl-vendor-wild=<replaceable>pattern</replaceable></option></term>
|
---|
423 | <listitem><para>Exclude the specific vendor class ID pattern from the group.</para></listitem>
|
---|
424 | </varlistentry>
|
---|
425 | <varlistentry>
|
---|
426 | <term><option>--incl-user=<replaceable>string</replaceable></option></term>
|
---|
427 | <listitem><para>Include the specific user class ID in the group.</para></listitem>
|
---|
428 | </varlistentry>
|
---|
429 | <varlistentry>
|
---|
430 | <term><option>--excl-user=<replaceable>string</replaceable></option></term>
|
---|
431 | <listitem><para>Exclude the specific user class ID from the group.</para></listitem>
|
---|
432 | </varlistentry>
|
---|
433 | <varlistentry>
|
---|
434 | <term><option>--incl-user-wild=<replaceable>pattern</replaceable></option></term>
|
---|
435 | <listitem><para>Include the specific user class ID pattern in the group.</para></listitem>
|
---|
436 | </varlistentry>
|
---|
437 | <varlistentry>
|
---|
438 | <term><option>--excl-user-wild=<replaceable>pattern</replaceable></option></term>
|
---|
439 | <listitem><para>Exclude the specific user class ID pattern from the group.</para></listitem>
|
---|
440 | </varlistentry>
|
---|
441 | </variablelist>
|
---|
442 | </refsect2>
|
---|
443 |
|
---|
444 | <refsect2 id="vboxmanage-dhcpserver-modify">
|
---|
445 | <title>dhcpserver modify</title>
|
---|
446 | <remark role="help-copy-synopsis"/>
|
---|
447 | <para>
|
---|
448 | This modifies an existing DHCP server configuration. It takes the same
|
---|
449 | options as the <command>add</command> command with the addition of the following
|
---|
450 | on scope configuration:
|
---|
451 | </para>
|
---|
452 | <variablelist>
|
---|
453 | <varlistentry>
|
---|
454 | <term><option>--del-opt=<replaceable>dhcp-opt-no</replaceable></option></term>
|
---|
455 | <listitem><para>Counterpart to <option>--set-opt</option> that will cause the specified
|
---|
456 | DHCP option number (0-255) to be deleted from the server settings. Like with
|
---|
457 | <option>--set-opt</option> the scope of the deletion is governed by the
|
---|
458 | <option>--global</option>, <option>--vm</option>, <option>--mac-address</option>
|
---|
459 | and <option>--group</option> options.
|
---|
460 | </para></listitem>
|
---|
461 | </varlistentry>
|
---|
462 | <varlistentry>
|
---|
463 | <term><option>--unforce-opt=<replaceable>dhcp-opt-no</replaceable></option></term>
|
---|
464 | <listitem><para>Removes the specified DHCP option number (0-255) from the forced
|
---|
465 | option list (i.e. the reverse of <option>--force-opt</option>). Like with
|
---|
466 | <option>--set-opt</option> the scope of the deletion is governed by the
|
---|
467 | <option>--global</option>, <option>--vm</option>, <option>--mac-address</option>
|
---|
468 | and <option>--group</option> options.
|
---|
469 | </para></listitem>
|
---|
470 | </varlistentry>
|
---|
471 | <varlistentry>
|
---|
472 | <term><option>--unsuppress-opt=<replaceable>dhcp-opt-no</replaceable></option></term>
|
---|
473 | <listitem><para>Removes the specified DHCP option number (0-255) from the supressed
|
---|
474 | option list (i.e. the reverse of <option>--suppress-opt</option>). Like with
|
---|
475 | <option>--set-opt</option> the scope of the deletion is governed by the
|
---|
476 | <option>--global</option>, <option>--vm</option>, <option>--mac-address</option>
|
---|
477 | and <option>--group</option> options.
|
---|
478 | </para></listitem>
|
---|
479 | </varlistentry>
|
---|
480 | <varlistentry>
|
---|
481 | <term><option>--remove-config</option></term>
|
---|
482 | <listitem><para>Removes the configuration currently being scoped. The
|
---|
483 | <option>--global</option> scope is not removable. The configuration scope will
|
---|
484 | change to <option>--global</option> after this option.
|
---|
485 | </para></listitem>
|
---|
486 | </varlistentry>
|
---|
487 | </variablelist>
|
---|
488 | <para>
|
---|
489 | And the addition of these group membership condition options:
|
---|
490 | </para>
|
---|
491 | <variablelist>
|
---|
492 | <varlistentry>
|
---|
493 | <term><option>--del-mac=<replaceable>address</replaceable></option></term>
|
---|
494 | <listitem><para>Delete the specific MAC address from the group conditions.</para></listitem>
|
---|
495 | </varlistentry>
|
---|
496 | <varlistentry>
|
---|
497 | <term><option>--del-mac-wild=<replaceable>pattern</replaceable></option></term>
|
---|
498 | <listitem><para>Delete the specific MAC address pattern from the group conditions.</para></listitem>
|
---|
499 | </varlistentry>
|
---|
500 | <varlistentry>
|
---|
501 | <term><option>--del-vendor=<replaceable>string</replaceable></option></term>
|
---|
502 | <listitem><para>Delete the specific vendor class ID from the group conditions.</para></listitem>
|
---|
503 | </varlistentry>
|
---|
504 | <varlistentry>
|
---|
505 | <term><option>--del-vendor-wild=<replaceable>pattern</replaceable></option></term>
|
---|
506 | <listitem><para>Delete the specific vendor class ID pattern from the group conditions.</para></listitem>
|
---|
507 | </varlistentry>
|
---|
508 | <varlistentry>
|
---|
509 | <term><option>--del-user=<replaceable>string</replaceable></option></term>
|
---|
510 | <listitem><para>Delete the specific user class ID pattern from the group conditions.</para></listitem>
|
---|
511 | </varlistentry>
|
---|
512 | <varlistentry>
|
---|
513 | <term><option>--del-user-wild=<replaceable>pattern</replaceable></option></term>
|
---|
514 | <listitem><para>Delete the specific user class ID pattern from the group conditions.</para></listitem>
|
---|
515 | </varlistentry>
|
---|
516 | <varlistentry>
|
---|
517 | <term><option>--zap-conditions</option></term>
|
---|
518 | <listitem><para>Deletes all the group conditions.</para></listitem>
|
---|
519 | </varlistentry>
|
---|
520 | </variablelist>
|
---|
521 | </refsect2>
|
---|
522 |
|
---|
523 | <refsect2 id="vboxmanage-dhcpserver-remove">
|
---|
524 | <title>dhcpserver remove</title>
|
---|
525 | <remark role="help-copy-synopsis"/>
|
---|
526 | <para>
|
---|
527 | Removes the specified DHCP server.
|
---|
528 | </para>
|
---|
529 | </refsect2>
|
---|
530 |
|
---|
531 | <refsect2 id="vboxmanage-dhcpserver-restart">
|
---|
532 | <title>dhcpserver restart</title>
|
---|
533 | <remark role="help-copy-synopsis"/>
|
---|
534 | <para>
|
---|
535 | Restarts the specified DHCP server. The DHCP server must be running.
|
---|
536 | </para>
|
---|
537 | </refsect2>
|
---|
538 |
|
---|
539 | <refsect2 id="vboxmanage-dhcpserver-findlease">
|
---|
540 | <title>dhcpserver findlease</title>
|
---|
541 | <remark role="help-copy-synopsis"/>
|
---|
542 | <para>
|
---|
543 | Performs a lease database lookup. This is mainly for getting the IP
|
---|
544 | address of a running VM.
|
---|
545 | </para>
|
---|
546 | <variablelist>
|
---|
547 | <varlistentry>
|
---|
548 | <term><option>--mac-address=<replaceable>mac</replaceable></option></term>
|
---|
549 | <listitem><para>The MAC address to lookup in the lease database.</para></listitem>
|
---|
550 | </varlistentry>
|
---|
551 | </variablelist>
|
---|
552 | </refsect2>
|
---|
553 |
|
---|
554 | <refsect2 id="vboxmanage-dhcpserver-dhcpoptions">
|
---|
555 | <title>Common DHCP Options:</title>
|
---|
556 | <remark role="help-scope" condition="DHCPSERVER_ADD|DHCPSERVER_MODIFY"/>
|
---|
557 | <!-- The following file is generated from src/VBox/Main/idl/VirtualBox.xidl: -->
|
---|
558 | <xi:include href="man_VBoxManage-dhcpserver-dhcpoptions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
|
---|
559 | </refsect2>
|
---|
560 |
|
---|
561 | </refsect1>
|
---|
562 |
|
---|
563 | </refentry>
|
---|
564 |
|
---|