1 <!--
   2   -- ident      "%W%    %E% SMI"
   3   --
   4     CDDL HEADER START
   5 
   6     The contents of this file are subject to the terms of the
   7     Common Development and Distribution License, Version 1.0 only
   8     (the "License").  You may not use this file except in compliance
   9     with the License.
  10 
  11     You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  12     or http://www.opensolaris.org/os/licensing.
  13     See the License for the specific language governing permissions
  14     and limitations under the License.
  15 
  16     When distributing Covered Code, include this CDDL HEADER in each
  17     file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  18     If applicable, add the following below this CDDL HEADER, with the
  19     fields enclosed by brackets "[]" replaced with your own identifying
  20     information: Portions Copyright [yyyy] [name of copyright owner]
  21 
  22     CDDL HEADER END
  23 
  24  -- Copyright (c) 2000-2001 by Sun Microsystems, Inc.
  25   -- All rights reserved.
  26   -->
  27 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
  28 <html>
  29 
  30 <head>
  31 <title>DHCP Manager Help: Options</title>
  32 <meta NAME="AUTHOR" CONTENT="smorgan">
  33 <meta NAME="KEYWORDS" CONTENT="DHCP">
  34 
  35 </head>
  36 
  37 <body bgcolor="#FFFFFF">
  38 
  39 <a name="top"></a>
  40 
  41 <table border=0 cellspacing=0 cellpadding=0 width=615>
  42 
  43 <!-- Start navigation banner -->
  44 
  45 <tr><td colspan=4  WIDTH="615" align="center" valign="top"><IMG SRC="art/bannersmc.gif" WIDTH=615 BORDER=0 ALT="DHCP Manager Help">
  46 
  47         </td>
  48         </tr>
  49 
  50 <!-- End navigation banner -->
  51 
  52 
  53 <tr>
  54 
  55 <!-- Start contents block -->
  56 
  57         <td colspan=1 valign="top" width=105>
  58         <P>&nbsp;</P>
  59 
  60         <A HREF="dhcp_main_top.html"><STRONG>Overview</STRONG></A><P>
  61         <A HREF="dhcp_relay_ref.html"><STRONG>Servers and Relays</STRONG></A><P>
  62         <A HREF="dhcp_addr_ref.html"><STRONG>IP Addresses</STRONG></A><P>
  63         <A HREF="dhcp_macro_ref.html"><STRONG>Macros</STRONG></A><P>
  64 <IMG SRC="art/tip2.gif" WIDTH=12 HEIGHT=10 BORDER=0 ALT=""><STRONG>Options</STRONG><BR>
  65         &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#name"><EM>Name</EM></A><BR>
  66         &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#cat"><EM>Category</EM></A><BR>
  67         &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#code"><EM>Code</EM></A><BR>
  68         &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#type"><EM>Type</EM></A><BR>
  69         &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#gran"><EM>Granularity</EM></A><BR>
  70         &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#max"><EM>Maximum</EM></A><BR>
  71         &nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#class"><EM>Class</EM></A><BR>
  72         
  73         &nbsp;&nbsp;<A HREF="dhcp_option_create.html">Create</A><BR>
  74         &nbsp;&nbsp;<A HREF="dhcp_option_dup.html">Duplicate</A><BR>
  75         &nbsp;&nbsp;<A HREF="dhcp_option_mod.html">Modify</A><BR>
  76         &nbsp;&nbsp;<A HREF="dhcp_option_del.html">Delete</A><BR>
  77     &nbsp;&nbsp;<A HREF="dhcp_option_tags.html">Standard options</A><P>
  78                 
  79 <A HREF="dhcp_main_how.html"><STRONG>How To..</STRONG></A><P>
  80 <A HREF="dhcp_main_menus.html"><STRONG>Menus</STRONG></A><P>
  81 <A HREF="dhcp_main_idx.html"><STRONG>Index</STRONG></A>
  82         
  83         
  84                 </td>
  85 
  86 
  87 
  88 <!-- End contents block -->
  89 
  90 <!-- Start column rule -->
  91 
  92         <td colspan=1 width=5 bgcolor="#CCCCCC">&nbsp;</td>
  93 
  94 <!-- End column spacer -->
  95 
  96 <!-- Start column spacer -->
  97 
  98         <td colspan=1 width=10 bgcolor="#FFFFFF">&nbsp;</td>
  99 
 100 <!-- End column spacer -->
 101 
 102 
 103 
 104 <!-- Start topic block -->
 105 
 106 
 107         <td colspan=1 valign="top" bgcolor="#ffffff">
 108         <P>&nbsp;</P>
 109 
 110 
 111 <h1>Options</h1>
 112 
 113 Select the Options tab in the main window to see a list of options defined
 114 for this DHCP server. Options are listed alphabetically by name.<P>
 115 
 116 Options (or symbols) define the configuration parameters that the DHCP server passes to the clients.  See <A HREF="dhcp_macros_about.html">About Macros and Options</A> for a discussion of how to use macros and options and of the relationship between them.<P>
 117 You can <A HREF="dhcp_option_create.html">add</A>, <A HREF="dhcp_option_mod.html">modify</A>, or <A HREF="dhcp_option_del.html">delete</A> an option by selecting it and
 118 clicking the appropriate entry in the Edit menu.<P>
 119 
 120 The option settings are described below.
 121 <P><HR NOSHADE><P>
 122 
 123         <table border=0 cellspacing=4 cellpadding=3>
 124 
 125         <tr>
 126         <td width=100 valign="top"><a name="name"><STRONG>Name</STRONG></a></td>
 127         <td valign="top">The name of the option.
 128         Option names can be a maximum of 128 alphanumeric characters including spaces.</td>
 129         </tr>
 130 
 131         <tr>
 132         <td width=100 valign="top"><a name="cat"><STRONG>Category</STRONG></a></td>
 133         <td valign="top">The category of the option: 
 134         The category can be one of Site, Extend, or Vendor.<P>
 135         <table border=0 cellspacing=3 cellpadding=3>
 136 
 137                 
 138                 <tr>
 139                 <td width=100 valign="top"><U>Site</U></td>
 140                 <td valign="top">User-defined option definitions, used for 
 141                 unique or custom purposes; accepts <a href="#code">Option 
 142                 Codes</a> <tt>128-254</tt>.</td>
 143                 </tr>
 144 
 145                 <tr>
 146                 <td width=100 valign="top"><U>Extend</U></td>
 147                 <td valign="top">Option definitions beyond the standard set, 
 148                 which may already be present in versions of the DHCP protocol 
 149                 being used on your server. Rather than upgrading your DHCP 
 150                 implementation, you can add extended options; accepts Option 
 151                 Codes <tt>77-127</tt>.</td>
 152                 </tr>
 153 
 154                 <tr>
 155                 <td width=100 valign="top"><U>Vendor</U></td>
 156                 <td valign="top">Hardware-, vendor-, or platform-specific option 
 157                 definitions; accepts Option Codes <tt>1-254</tt>. Selecting this 
 158                 context enables the <a href="#class">Client Class</a> 
 159                 parameter.</td>
 160                 </tr>
 161 
 162                 </table>
 163                 </td>
 164                 </tr>
 165 
 166         
 167         <tr>
 168         <td width=115 valign="top"><a name="code"><STRONG>Code</STRONG></a></td>
 169         <td valign="top">A unique numeric code to 
 170         identify the option. Valid values depend on the option <a 
 171         href="#cat">category</a>:<P>
 172 
 173         <table border=0 cellspacing=3 cellpadding=3>
 174 
 175                 <tr>
 176                 <td width=100 valign="top"><U>Extend</U></td>
 177                 <td valign="top">Accepts code values of <tt>77-127</tt><P></TD>
 178                 </tr>
 179 
 180                 <tr>
 181                 <td width=100 valign="top"><U>Site</U></td>
 182                 <td valign="top">Accepts code values of <tt>128-254</tt><P></TD>
 183                 </tr>
 184 
 185                 <tr>
 186                 <td width=100 valign="top"><U>Vendor</U></td>
 187                 <td valign="top">Accepts code values of <tt>1-254</tt></td>
 188                 </tr>
 189 
 190 </table>
 191 <P>
 192 </td>
 193 
 194         </tr>
 195 
 196         <tr>
 197         <td width=100 valign="top"><A NAME="type"><STRONG>Data Type</STRONG></A></td>
 198         <td valign="top">The type of data that is acceptable 
 199         for options values:<P>
 200 
 201                 <table border=0 cellspacing=3 cellpadding=3>
 202 
 203                 <tr>
 204                 <td width=100 valign="top"><u>Ascii</u></td>
 205                 <td valign="top">ASCII text.</td>
 206                 </tr>
 207 
 208                 <tr>
 209                 <td width=100 valign="top"><u>Boolean</u></td>
 210                 <td valign="top">No value is associated with this data type. 
 211                 Presence of options of this type denote Boolean TRUE; absence 
 212                 denotes FALSE.</td>
 213                 </tr>
 214 
 215                 <tr>
 216                 <td width=100 valign="top"><u>IP</u></td>
 217                 <td valign="top">One or more Internet addresses in dotted decimal format.</td>
 218                 </tr>
 219         <tr>
 220                 <td width=100 valign="top"><u>Octet</u></td>
 221                 <td valign="top">Uninterpreted ASCII representation of binary 
 222                 data; for example, a client ID.</td>
 223                 </tr>
 224                 <tr>
 225                 <td width=100 valign="top"><u>Unumber8</u><BR><u>Unumber16</u><BR>
 226 <u>Unumber32</u><BR><u>Unumber64</u><BR>
 227 
 228 </td>
 229                 <td valign="top">Unsigned number, where the trailing number indicates the number of bits in the number.</td>
 230                 </tr>
 231                 <tr>
 232                 <td width=100 valign="top"><u>Snumber8</u><BR><u>Snumber16</u><BR>
 233 <u>Snumber32</u><BR><u>Snumber64</u><BR>
 234 </td>
 235                 <td valign="top">Signed number, where the trailing number indicates the number of bits in the number.</td>
 236                 </tr>
 237 
 238         </table>
 239         </td>
 240         </tr>
 241         
 242 
 243         <tr>
 244         <td width=100 valign="top"><a name="gran"><STRONG>Granularity</STRONG></a></td>
 245         <td valign="top">Specifies how many values of the given <a 
 246         href="#type">data type</a> are required to make a complete option value. 
 247         For example, a data type of <tt>IP</tt> and a granularity of <tt>2</tt> would 
 248         mean that the option value would need to contain two IP addresses.</td>
 249         </tr>
 250 
 251         <tr>
 252         <td width=100 valign="top"><a name="max"><STRONG>Maximum</STRONG></a></td>
 253         <td valign="top">The maximum number of values of a 
 254         given granularity that can be specified for the option. Building on the 
 255         previous example, a maximum of <tt>2</tt>, with a granularity of 
 256         <tt>2</tt> and a data type of <tt>IP</tt> would mean that the option 
 257         value could contain a maximum of two pairs of IP addresses.<P>
 258 
 259                 <table border=0>
 260 
 261                 <tr>
 262                 <td width=100 valign="top"><U>Unlimited</U></td>
 263                 <td valign="top">No limit to the number of values; implies a 
 264                 maximum setting of <tt>0</tt>.</td>
 265                 </tr>
 266 
 267                 <tr>
 268                 <td width=100 valign="top"><U>Specify</U></td>
 269                 <td valign="top">A specific number indicating the maximum.</td>
 270                 </tr>
 271                 
 272                 </table>
 273         </td>
 274         </tr>
 275         
 276                 <tr>
 277         <td width=100 valign="top"><A NAME="class"><STRONG>Vendor Client Classes</STRONG></A></td>
 278         <td valign="top">This option is enabled only when the option 
 279         <a href="#cat">category</a> is Vendor. It identifies the client class(es) with which the Vendor option is
 280         associated.<P>
 281         The Class is an ASCII string representing the client machine type and/or operating system, for example, <TT>SUNW.Ultra5_10</TT>. This type of option makes it possible to define configuration parameters that are passed to all clients of the same class. <P>
 282         Enter the client class and then press Enter. You can
 283         specify multiple client classes. Only those DHCP clients with a client 
 284         class value matching one listed here will use the option.</td>
 285         </tr>
 286         </table>
 287 
 288 
 289         &nbsp;&nbsp;&nbsp;<A HREF="#top"><small>return to top</small></A>
 290 
 291 
 292 <p>&nbsp;</p>
 293 
 294 <!-- Don't go past this line! -->
 295 
 296         </td>
 297 
 298 <!-- End topic block -->
 299 
 300 </tr>
 301 
 302 </table>
 303 
 304 <!-- End topic table -->
 305 
 306 </body>
 307 </html>