man_VBoxManage-dhcpserver.xml@ 92534

Last change on this file since 92534 was 92534, checked in by vboxsync, 3 years ago
VBoxManage: Dashified the modifyvm options, the leaving the wordsoup options for legacy reasons of course.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 30.7 KB

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

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

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

Download in other formats: