man_VBoxManage-dhcpserver.xml@ 106001

Last change on this file since 106001 was 106001, checked in by vboxsync, 3 months ago

doc/manual/man_VBoxManage-*: Updated a variety of the VBoxManage help
files to improve readability, corrected some typos, and made various
other corrections.

src/VBox/*: Updated some comments and log messages for a variety of
source files to correct the spelling of 'suppress'. A few APIC files
and USB files use 'supress' in variable names or manifest constants but
those were not changed.

Property svn:eol-style set to native
Property svn:keywords set to Author Date Id Revision

File size: 31.3 KB

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

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-dhcpserver.xml@ 106001

Download in other formats: