VirtualBox

Changeset 79776 in vbox for trunk/doc


Ignore:
Timestamp:
Jul 15, 2019 12:27:54 AM (6 years ago)
Author:
vboxsync
Message:

VBoxManage: Brought the dhcpserver man page up to speed. bugref:9288

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/en_US/man_VBoxManage-dhcpserver.xml

    r79619 r79776  
    5050      <arg choice="opt" rep="repeat">
    5151        <arg choice="opt">--global</arg>
    52         <arg choice="opt" rep="repeat">--add-opt=<replaceable>dhcp-opt-no value</replaceable></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">--min-lease-time=<replaceable>seconds</replaceable></arg>
     55        <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
     56        <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
     57      </arg>
     58      <sbr/>
     59      <arg choice="opt" rep="repeat">
     60        <arg choice="req">--group=<replaceable>name</replaceable></arg>
     61        <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
     62        <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
     63        <arg choice="opt" rep="repeat">--incl-mac=<replaceable>address</replaceable></arg>
     64        <arg choice="opt" rep="repeat">--excl-mac=<replaceable>address</replaceable></arg>
     65        <arg choice="opt" rep="repeat">--incl-mac-wild=<replaceable>pattern</replaceable></arg>
     66        <arg choice="opt" rep="repeat">--excl-mac-wild=<replaceable>pattern</replaceable></arg>
     67        <arg choice="opt" rep="repeat">--incl-vendor=<replaceable>string</replaceable></arg>
     68        <arg choice="opt" rep="repeat">--excl-vendor=<replaceable>string</replaceable></arg>
     69        <arg choice="opt" rep="repeat">--incl-vendor-wild=<replaceable>pattern</replaceable></arg>
     70        <arg choice="opt" rep="repeat">--excl-vendor-wild=<replaceable>pattern</replaceable></arg>
     71        <arg choice="opt" rep="repeat">--incl-user=<replaceable>string</replaceable></arg>
     72        <arg choice="opt" rep="repeat">--excl-user=<replaceable>string</replaceable></arg>
     73        <arg choice="opt" rep="repeat">--incl-user-wild=<replaceable>pattern</replaceable></arg>
     74        <arg choice="opt" rep="repeat">--excl-user-wild=<replaceable>pattern</replaceable></arg>
     75        <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
     76        <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
     77        <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
    5378      </arg>
    5479      <sbr/>
    … …  
    5681        <arg choice="req">--vm=<replaceable>name|uuid</replaceable></arg>
    5782        <arg choice="opt">--nic=<replaceable>1-N</replaceable></arg>
    58         <arg choice="opt" rep="repeat">--add-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
     83        <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
     84        <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
     85        <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
     86        <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
     87        <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
     88        <arg choice="opt">--fixed-address=<replaceable>address</replaceable></arg>
     89      </arg>
     90      <sbr/>
     91      <arg choice="opt" rep="repeat">
     92        <arg choice="req">--mac-address=<replaceable>address</replaceable></arg>
     93        <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
     94        <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
     95        <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
     96        <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
     97        <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
     98        <arg choice="opt">--fixed-address=<replaceable>address</replaceable></arg>
    5999      </arg>
    60100    </cmdsynopsis>
    … …  
    75115      <sbr/>
    76116      <arg choice="opt" rep="repeat">
     117        <arg choice="req">--group=<replaceable>name</replaceable></arg>
     118        <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
     119        <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
     120        <arg choice="opt" rep="repeat">--del-mac=<replaceable>address</replaceable></arg>
     121        <arg choice="opt" rep="repeat">--incl-mac=<replaceable>address</replaceable></arg>
     122        <arg choice="opt" rep="repeat">--excl-mac=<replaceable>address</replaceable></arg>
     123        <arg choice="opt" rep="repeat">--del-mac-wild=<replaceable>pattern</replaceable></arg>
     124        <arg choice="opt" rep="repeat">--incl-mac-wild=<replaceable>pattern</replaceable></arg>
     125        <arg choice="opt" rep="repeat">--excl-mac-wild=<replaceable>pattern</replaceable></arg>
     126        <arg choice="opt" rep="repeat">--del-vendor=<replaceable>string</replaceable></arg>
     127        <arg choice="opt" rep="repeat">--incl-vendor=<replaceable>string</replaceable></arg>
     128        <arg choice="opt" rep="repeat">--excl-vendor=<replaceable>string</replaceable></arg>
     129        <arg choice="opt" rep="repeat">--del-vendor-wild=<replaceable>pattern</replaceable></arg>
     130        <arg choice="opt" rep="repeat">--incl-vendor-wild=<replaceable>pattern</replaceable></arg>
     131        <arg choice="opt" rep="repeat">--excl-vendor-wild=<replaceable>pattern</replaceable></arg>
     132        <arg choice="opt" rep="repeat">--del-user=<replaceable>string</replaceable></arg>
     133        <arg choice="opt" rep="repeat">--incl-user=<replaceable>string</replaceable></arg>
     134        <arg choice="opt" rep="repeat">--excl-user=<replaceable>string</replaceable></arg>
     135        <arg choice="opt" rep="repeat">--del-user-wild=<replaceable>pattern</replaceable></arg>
     136        <arg choice="opt" rep="repeat">--incl-user-wild=<replaceable>pattern</replaceable></arg>
     137        <arg choice="opt" rep="repeat">--excl-user-wild=<replaceable>pattern</replaceable></arg>
     138        <arg choice="opt">--zap-conditions</arg>
     139        <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
     140        <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
     141        <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
     142        <arg choice="opt">--remove-config</arg>
     143      </arg>
     144      <sbr/>
     145      <arg choice="opt" rep="repeat">
    77146        <arg choice="opt">--global</arg>
    78         <arg choice="plain">--del-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    79         <arg choice="plain">--add-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
     147        <arg choice="opt" rep="repeat">--del-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     148        <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
     149        <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
     150        <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
     151        <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
     152        <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
     153        <arg choice="opt">--remove-config</arg>
    80154      </arg>
    81155      <sbr/>
    … …  
    84158        <arg choice="opt">--nic=<replaceable>1-N</replaceable></arg>
    85159        <arg choice="opt" rep="repeat">--del-opt=<replaceable>dhcp-opt-no</replaceable></arg>
    86         <arg choice="opt" rep="repeat">--add-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
     160        <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
     161        <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
     162        <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
     163        <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
     164        <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
     165        <arg choice="opt">--fixed-address=<replaceable>address</replaceable></arg>
     166        <arg choice="opt">--remove-config</arg>
     167      </arg>
     168      <sbr/>
     169      <arg choice="opt" rep="repeat">
     170        <arg choice="req">--mac-address=<replaceable>address</replaceable></arg>
     171        <arg choice="opt" rep="repeat">--del-opt=<replaceable>dhcp-opt-no</replaceable></arg>
     172        <arg choice="opt" rep="repeat">--set-opt=<replaceable>dhcp-opt-no value</replaceable></arg>
     173        <arg choice="opt" rep="repeat">--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></arg>
     174        <arg choice="opt">--min-lease-time=<replaceable>seconds</replaceable></arg>
     175        <arg choice="opt">--default-lease-time=<replaceable>seconds</replaceable></arg>
     176        <arg choice="opt">--max-lease-time=<replaceable>seconds</replaceable></arg>
     177        <arg choice="opt">--fixed-address=<replaceable>address</replaceable></arg>
     178        <arg choice="opt">--remove-config</arg>
    87179      </arg>
    88180    </cmdsynopsis>
    … …  
    157249        Adds a new DHCP server to a network or host-only interface.
    158250      </para>
     251      <para>
     252        Options configuring the DHCP server core:
     253      </para>
    159254      <variablelist>
    160255        <varlistentry>
    … …  
    178273            the server will be created in disabled state and no IP addresses handed out.</para></listitem>
    179274        </varlistentry>
     275      </variablelist>
     276      <para>
     277        Options selecting the scope:
     278      </para>
     279      <variablelist>
    180280        <varlistentry>
    181281          <term><option>--global</option></term>
    182           <listitem><para>Set the option scope to global.  Any subsequent <option>--add-opt</option>
    183             options will be apply to all the DHCP clients.</para></listitem>
     282          <listitem><para>Set the configuration scope to global.  Any subsequent
     283            <option>--set-opt</option> options will be apply to all the DHCP clients.</para></listitem>
    184284        </varlistentry>
    185285        <varlistentry>
    186286          <term><option>--vm=<replaceable>vmname|uuid</replaceable></option></term>
    187           <listitem><para>Set the option scope to the first NIC of the specified VM.  Any
    188             subsequent <option>-add-opt</option> options will apply just to that interface,
     287          <listitem><para>Set the configuration scope to the first NIC of the specified VM.  Any
     288            subsequent <option>--set-opt</option> options will apply just to that interface,
    189289            nothing else.</para></listitem>
    190290        </varlistentry>
    191291        <varlistentry>
    192292          <term><option>--nic=<replaceable>1-N</replaceable></option></term>
    193           <listitem><para>Set the option scope to a NIC other than first of the VM specified
    194             the in <option>--vm</option>.</para></listitem>
    195         </varlistentry>
    196         <varlistentry>
    197           <term><option>--add-opt=<replaceable>dhcp-opt-no value</replaceable></option></term>
    198           <listitem><para>Adds the specified DHCP option number (0-255) and value.  The scope of
    199             the option is decided by the <option>--vm</option> and <option>global</option> options.
    200             The value format is option specific.
    201           </para></listitem>
     293          <listitem><para>Set the configuration scope to a NIC other than first of
     294            the VM specified the in <option>--vm</option>.
     295          </para></listitem>
     296        </varlistentry>
     297        <varlistentry>
     298          <term><option>--mac-address=<replaceable>address</replaceable></option></term>
     299          <listitem><para>Set the configuration scope to the specified MAC address.</para></listitem>
     300        </varlistentry>
     301        <varlistentry>
     302          <term><option>--group=<replaceable>name</replaceable></option></term>
     303          <listitem><para>Set the configuration scope to the specified group.</para></listitem>
     304        </varlistentry>
     305      </variablelist>
     306      <para>
     307        Options configuring the currently selected scope:
     308      </para>
     309      <variablelist>
     310        <varlistentry>
     311          <term><option>--set-opt=<replaceable>dhcp-opt-no value</replaceable></option></term>
     312          <listitem><para>Adds the specified DHCP option number (0-255) and value.  The
     313            value format is option specific (typically human readable) and will be
     314            validated by the API and the DHCP server.
     315          </para></listitem>
     316        </varlistentry>
     317        <varlistentry>
     318          <term><option>--set-opt-hex=<replaceable>dhcp-opt-no hexstring</replaceable></option></term>
     319          <listitem><para>Adds the specified DHCP option number (0-255) and value.  The option value
     320            is specified as a raw series of hex bytes, optionally separated by colons.  No validation
     321            is performed on these by the API or the DHCP server, they will be pass as specified to the
     322            client.
     323          </para></listitem>
     324        </varlistentry>
     325        <varlistentry>
     326          <term><option>--min-lease-time=<replaceable>seconds</replaceable></option></term>
     327          <listitem><para>Sets the minimum lease time for the current scope in seconds.
     328            Zero means taking the value from a higher option level or use default.
     329          </para></listitem>
     330        </varlistentry>
     331        <varlistentry>
     332          <term><option>--default-lease-time=<replaceable>seconds</replaceable></option></term>
     333          <listitem><para>Sets the default lease time for the current scope in seconds.
     334            Zero means taking the value from a higher option level or use default.
     335          </para></listitem>
     336        </varlistentry>
     337        <varlistentry>
     338          <term><option>--max-lease-time=<replaceable>seconds</replaceable></option></term>
     339          <listitem><para>Sets the maximum lease time for the current scope in seconds.
     340            Zero means taking the value from a higher option level or use default.
     341          </para></listitem>
     342        </varlistentry>
     343        <varlistentry>
     344          <term><option>--fixed-address=<replaceable>address</replaceable></option></term>
     345          <listitem><para>Fixed address assignment for a <option>--vm</option> or
     346            <option>--mac-address</option> configuration scope.  Any empty
     347            <replaceable>address</replaceable> turns it back to dynamic address assignment.
     348          </para></listitem>
     349        </varlistentry>
     350      </variablelist>
     351
     352      <para>
     353        Options configuring group membership conditions (excludes overrides includes):
     354      </para>
     355      <variablelist>
     356        <varlistentry>
     357          <term><option>--incl-mac=<replaceable>address</replaceable></option></term>
     358          <listitem><para>Include the specific MAC address in the group.</para></listitem>
     359        </varlistentry>
     360        <varlistentry>
     361          <term><option>--excl-mac=<replaceable>address</replaceable></option></term>
     362          <listitem><para>Exclude the specific MAC address from the group.</para></listitem>
     363        </varlistentry>
     364        <varlistentry>
     365          <term><option>--incl-mac-wild=<replaceable>pattern</replaceable></option></term>
     366          <listitem><para>Include the specific MAC address pattern in the group.</para></listitem>
     367        </varlistentry>
     368        <varlistentry>
     369          <term><option>--excl-mac-wild=<replaceable>pattern</replaceable></option></term>
     370          <listitem><para>Exclude the specific MAC address pattern from the group.</para></listitem>
     371        </varlistentry>
     372        <varlistentry>
     373          <term><option>--incl-vendor=<replaceable>string</replaceable></option></term>
     374          <listitem><para>Include the specific vendor class ID  in the group.</para></listitem>
     375        </varlistentry>
     376        <varlistentry>
     377          <term><option>--excl-vendor=<replaceable>string</replaceable></option></term>
     378          <listitem><para>Exclude the specific vendor class ID from the group.</para></listitem>
     379        </varlistentry>
     380        <varlistentry>
     381          <term><option>--incl-vendor-wild=<replaceable>pattern</replaceable></option></term>
     382          <listitem><para>Include the specific vendor class ID pattern in the group.</para></listitem>
     383        </varlistentry>
     384        <varlistentry>
     385          <term><option>--excl-vendor-wild=<replaceable>pattern</replaceable></option></term>
     386          <listitem><para>Exclude the specific vendor class ID pattern from the group.</para></listitem>
     387        </varlistentry>
     388        <varlistentry>
     389          <term><option>--incl-user=<replaceable>string</replaceable></option></term>
     390          <listitem><para>Include the specific user class ID  in the group.</para></listitem>
     391        </varlistentry>
     392        <varlistentry>
     393          <term><option>--excl-user=<replaceable>string</replaceable></option></term>
     394          <listitem><para>Exclude the specific user class ID from the group.</para></listitem>
     395        </varlistentry>
     396        <varlistentry>
     397          <term><option>--incl-user-wild=<replaceable>pattern</replaceable></option></term>
     398          <listitem><para>Include the specific user class ID pattern in the group.</para></listitem>
     399        </varlistentry>
     400        <varlistentry>
     401          <term><option>--excl-user-wild=<replaceable>pattern</replaceable></option></term>
     402          <listitem><para>Exclude the specific user class ID pattern from the group.</para></listitem>
    202403        </varlistentry>
    203404      </variablelist>
    … …  
    209410      <para>
    210411        This modifies an existing DHCP server configuration.  It takes the same
    211         options as the <command>add</command> command with the addition of:
     412        options as the <command>add</command> command with the addition of the following
     413        on scope configuration:
    212414      </para>
    213415      <variablelist>
    214416        <varlistentry>
    215417          <term><option>--del-opt=<replaceable>dhcp-opt-no</replaceable></option></term>
    216           <listitem><para>Counterpart to <option>--add-opt</option> that will cause the specified
     418          <listitem><para>Counterpart to <option>--set-opt</option> that will cause the specified
    217419            DHCP option number (0-255) to be deleted from the server settings.  Like with
    218             <option>--add-opt</option> the scope of the deletion is governed by the
    219             <option>--vm</option> and <option>global</option> options.
    220           </para></listitem>
     420            <option>--set-opt</option> the scope of the deletion is governed by the
     421            <option>--global</option>, <option>--vm</option>, <option>--mac-address</option>
     422            and <option>--group</option> options.
     423          </para></listitem>
     424        </varlistentry>
     425        <varlistentry>
     426          <term><option>--remove-config</option></term>
     427          <listitem><para>Removes the configuration currently being scoped.  The
     428          <option>--global</option> scope is not removable.  The configuration scope will
     429           change to <option>--global</option> after this option.
     430          </para></listitem>
     431        </varlistentry>
     432      </variablelist>
     433      <para>
     434        And the addition of these group membership condition options:
     435      </para>
     436      <variablelist>
     437        <varlistentry>
     438          <term><option>--del-mac=<replaceable>address</replaceable></option></term>
     439          <listitem><para>Delete the specific MAC address from the group conditions.</para></listitem>
     440        </varlistentry>
     441        <varlistentry>
     442          <term><option>--del-mac-wild=<replaceable>pattern</replaceable></option></term>
     443          <listitem><para>Delete the specific MAC address pattern from the group conditions.</para></listitem>
     444        </varlistentry>
     445        <varlistentry>
     446          <term><option>--del-vendor=<replaceable>string</replaceable></option></term>
     447          <listitem><para>Delete the specific vendor class ID from the group conditions.</para></listitem>
     448        </varlistentry>
     449        <varlistentry>
     450          <term><option>--del-vendor-wild=<replaceable>pattern</replaceable></option></term>
     451          <listitem><para>Delete the specific vendor class ID pattern from the group conditions.</para></listitem>
     452        </varlistentry>
     453        <varlistentry>
     454          <term><option>--del-user=<replaceable>string</replaceable></option></term>
     455          <listitem><para>Delete the specific user class ID pattern from the group conditions.</para></listitem>
     456        </varlistentry>
     457        <varlistentry>
     458          <term><option>--del-user-wild=<replaceable>pattern</replaceable></option></term>
     459          <listitem><para>Delete the specific user class ID pattern from the group conditions.</para></listitem>
     460        </varlistentry>
     461        <varlistentry>
     462          <term><option>--zap-conditions</option></term>
     463          <listitem><para>Deletes all the group conditions.</para></listitem>
    221464        </varlistentry>
    222465      </variablelist>
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette