*** dhcp-options.5 Sun Jan 13 15:42:13 2002 --- dhcp-options.5.new Wed Jan 16 12:30:07 2002 *************** *** 138,145 **** --- 138,155 ---- such options by defining them in the configuration file. Please see the DEFINING NEW OPTIONS heading later in this document for more information. .PP + Some of the options documented here are automatically generated by + the DHCP server or by clients, and cannot be configured by the user. + The value of such an option can be used in the configuration file of + the receiving DHCP protocol agent (server or client), for example in + conditional expressions. However, the value of the option cannot be + used in the configuration file of the sending agent, because the value + is determined only \fIafter\fR the configuration file has been + processed. In the following documentation, such options will be shown + as "not user configurable" + .PP The standard options are: .PP .B option \fBall-subnets-local\fR \fIflag\fR\fB;\fR .RS 0.25i *************** *** 224,231 **** --- 234,254 ---- option dhcp-client-identifier "foo"; .fi .RE .PP + .B option \fBdhcp-lease-time\fR \fIuint32\fR\fB;\fR + .RS 0.25i + .PP + This option is used in a client request (DHCPDISCOVER or DHCPREQUEST) + to allow the client to request a lease time for the IP address. In a + server reply (DHCPOFFER), a DHCP server uses this option to specify + the lease time it is willing to offer. + .PP + This option is not directly user configurable in the server; refer to the + \fImax-lease-time\fR and \fidefault-lease-time\fR server options in + .B dhcpd.conf(5). + .RE + .PP .B option \fBdhcp-max-message-size\fR \fIuint16\fR\fB;\fR .RS 0.25i .PP This option, when sent by the client, specifies the maximum size of *************** *** 234,241 **** --- 257,320 ---- the size specified on the server is used. This works for BOOTP as well as DHCP responses. .RE .PP + .B option \fBdhcp-message\fR \fItext\fR\fB;\fR + .RS 0.25i + .PP + This option is used by a DHCP server to provide an error message to a + DHCP client in a DHCPNAK message in the event of a failure. A client + may use this option in a DHCPDECLINE message to indicate why the + client declined the offered parameters. + .PP + This option is not user configurable. + .RE + .PP + .B option \fBdhcp-message-type\fR \fIuint8\fR\fB;\fR + .RS 0.25i + .PP + This option, sent by both client and server, specifies the type of DHCP + message contained in the DHCP packet. Possible values (taken directly from + RFC2132) are: + .PP + .nf + 1 DHCPDISCOVER + 2 DHCPOFFER + 3 DHCPREQUEST + 4 DHCPDECLINE + 5 DHCPACK + 6 DHCPNAK + 7 DHCPRELEASE + 8 DHCPINFORM + .fi + .PP + This option is not user configurable. + .PP + .RE + .B option \fBdhcp-option-overload\fR \fIuint8\fR\fB;\fR + .RS 0.25i + .PP + This option is used to indicate that the DHCP 'sname' or 'file' + fields are being overloaded by using them to carry DHCP options. A + DHCP server inserts this option if the returned parameters will + exceed the usual space allotted for options. + .PP + If this option is present, the client interprets the specified + additional fields after it concludes interpretation of the standard + option fields. + .PP + Legal values for this option are: + .PP + .nf + 1 the 'file' field is used to hold options + 2 the 'sname' field is used to hold options + 3 both fields are used to hold options + .fi + .PP + This option is not user configurable. + .PP + .RE + .PP .B option \fBdhcp-parameter-request-list\fR \fIuint16\fR\fB;\fR .RS 0.25i .PP This option, when sent by the client, specifies which options the *************** *** 250,257 **** --- 329,386 ---- more limited set of options than those the server would normally return. .RE .PP + .B option \fBdhcp-rebinding-time\fR \fIuint32\fR\fB;\fR + .RS 0.25i + .PP + This option specifies the number of seconds from the time a client gets + an address until the client transitions to the REBINDING state. + .PP + This option is not user configurable. + .PP + .RE + .PP + .B option \fBdhcp-renewal-time\fR \fIuint32\fR\fB;\fR + .RS 0.25i + .PP + This option specifies the number of seconds from the time a client gets + an address until the client transitions to the RENEWING state. + .PP + This option is not user configurable. + .PP + .RE + .PP + .B option \fBdhcp-requested-address\fR \fIip-address\fR\fB;\fR + .RS 0.25i + .PP + This option is used by the client in a DHCPDISCOVER to + request that a particular IP address be assigned. + .PP + This option is not user configurable. + .PP + .RE + .PP + .B option \fBdhcp-server-identifier\fR \fIip-address\fR\fB;\fR + .RS 0.25i + .PP + This option is used in DHCPOFFER and DHCPREQUEST messages, and may + optionally be included in the DHCPACK and DHCPNAK messages. DHCP + servers include this option in the DHCPOFFER in order to allow the + client to distinguish between lease offers. DHCP clients use the + contents of the 'server identifier' field as the destination address + for any DHCP messages unicast to the DHCP server. DHCP clients also + indicate which of several lease offers is being accepted by including + this option in a DHCPREQUEST message. + .PP + The value of this option is the IP address of the server. + .PP + This option is not directly user configurable. See the + \fIserver-identifier\fR server option in + .B \fIdhcpd.conf(5). + .PP + .RE + .PP .B option \fBdomain-name\fR \fItext\fR\fB;\fR .RS 0.25i .PP This option specifies the domain name that client should use when *************** *** 266,274 **** (STD 13, RFC 1035) name servers available to the client. Servers should be listed in order of preference. .RE .PP ! .B option \fBextensions-path-name\fR \fItext\fR\fB;\fR .RS 0.25i .PP This option specifies the name of a file containing additional options to be interpreted according to the DHCP option format as specified in --- 395,403 ---- (STD 13, RFC 1035) name servers available to the client. Servers should be listed in order of preference. .RE .PP ! .B option \fBextensions-path\fR \fItext\fR\fB;\fR .RS 0.25i .PP This option specifies the name of a file containing additional options to be interpreted according to the DHCP option format as specified in *************** *** 471,494 **** parameter for the client as specified in RFC 1001/1002. See RFC1001, RFC1002, and RFC1035 for character-set restrictions. .RE .PP - .B option \fBnwip-domain\fR \fIstring\fR\fB;\fR - .RS 0.25i - .PP - The name of the NetWare/IP domain that a NetWare/IP client should - use. - .RE - .PP - .B option \fBnwip-suboptions\fR \fIstring\fR\fB;\fR - .RS 0.25i - .PP - A sequence of suboptions for NetWare/IP clients - see RFC2242 for - details. Normally this option is set by specifying specific - NetWare/IP suboptions - see the NETWARE/IP SUBOPTIONS section for more - information. - .RE - .PP .B option \fBnis-domain\fR \fItext\fR\fB;\fR .RS 0.25i .PP This option specifies the name of the client's NIS (Sun Network --- 600,607 ---- *************** *** 548,555 **** --- 661,684 ---- servers available to the client. Servers should be listed in order of preference. .RE .PP + .B option \fBnwip-domain\fR \fIstring\fR\fB;\fR + .RS 0.25i + .PP + The name of the NetWare/IP domain that a NetWare/IP client should + use. + .RE + .PP + .B option \fBnwip-suboptions\fR \fIstring\fR\fB;\fR + .RS 0.25i + .PP + A sequence of suboptions for NetWare/IP clients - see RFC2242 for + details. Normally this option is set by specifying specific + NetWare/IP suboptions - see the NETWARE/IP SUBOPTIONS section for more + information. + .RE + .PP .B option \fBpath-mtu-aging-timeout\fR \fIuint32\fR\fB;\fR .RS 0.25i .PP This option specifies the timeout (in seconds) to use when aging Path *************** *** 598,606 **** The POP3 server option specifies a list of POP3 available to the client. Servers should be listed in order of preference. .RE .PP - .nf .B option \fBresource-location-servers\fR \fIip-address\fR [\fB, \fR\fIip-address\fR...]\fB;\fR .fi .RS 0.25i --- 727,734 ---- *************** *** 744,751 **** --- 872,893 ---- assigned will override the subnet mask specified in the subnet declaration. .RE .PP + .B option \fBsubnet-selection\fR \fIstring\fR\fB;\fR + .RS 0.25i + .PP + Sent by the client if an address is required in a subnet other than the one + that would normally be selected (based on the relaying address of the + connected subnet the request is obtained from). See RFC3011. Note that the + option number used by this server is 118; this has not always been the + defined number, and some clients may use a different value. Use of this + option should be regarded as slightly experimental! + .RE + .PP + This option is not user configurable in the server. + .PP + .PP .B option \fBswap-server\fR \fIip-address\fR\fB;\fR .RS 0.25i .PP This specifies the IP address of the client's swap server. *************** *** 875,897 **** ENCAPSULATED OPTIONS section of the \fIdhcpd.conf\fI manual page for details. .RE .PP .B option \fBx-display-manager\fR \fIip-address\fR [\fB,\fR \fIip-address\fR... ]\fB;\fR .RS 0.25i .PP This option specifies a list of systems that are running the X Window System Display Manager and are available to the client. Addresses should be listed in order of preference. - .RE - .PP - .B option \fBwww-server\fR \fIip-address\fR [\fB,\fR - \fIip-address\fR... ]\fB;\fR - .RS 0.25i - .PP - The WWW server option specifies a list of WWW available to the - client. Servers should be listed in order of preference. .RE .SH RELAY AGENT INFORMATION OPTION An IETF draft, draft-ietf-dhc-agent-options-11.txt, defines a series of encapsulated options that a relay agent can add to a DHCP packet --- 1017,1039 ---- ENCAPSULATED OPTIONS section of the \fIdhcpd.conf\fI manual page for details. .RE .PP + .B option \fBwww-server\fR \fIip-address\fR [\fB,\fR + \fIip-address\fR... ]\fB;\fR + .RS 0.25i + .PP + The WWW server option specifies a list of WWW available to the + client. Servers should be listed in order of preference. + .RE + .PP .B option \fBx-display-manager\fR \fIip-address\fR [\fB,\fR \fIip-address\fR... ]\fB;\fR .RS 0.25i .PP This option specifies a list of systems that are running the X Window System Display Manager and are available to the client. Addresses should be listed in order of preference. .RE .SH RELAY AGENT INFORMATION OPTION An IETF draft, draft-ietf-dhc-agent-options-11.txt, defines a series of encapsulated options that a relay agent can add to a DHCP packet