mirror of
https://gitlab.isc.org/isc-projects/dhcp
synced 2025-08-22 18:07:25 +00:00
Documentation cleanup covering multiple tickets
[ISC-Bugs #20265] [ISC-Bugs #20259] minor cleanup [ISC-Bugs #20263] add text describing some default values [ISC-Bugs #20193] single quotes at the start of a line indicate a control line to nroff, escape them if we actually want a quote. [ISC-Bugs #18916] sync the pointer to web pages amongst the different docs
This commit is contained in:
Shawn Routhier
parent
63ff896aa5
commit
5a38e43f6f
9
RELNOTES
9
RELNOTES
@ -39,6 +39,15 @@ The system has only been tested on Linux, FreeBSD, and Solaris, and may not
|
||||
work on other platforms. Please report any problems and suggested fixes to
|
||||
<dhcp-users@isc.org>.
|
||||
|
||||
Changes since 4.2.0
|
||||
|
||||
- Documentation cleanup covering multiple tickets
|
||||
[ISC-Bugs #20265] [ISC-Bugs #20259] minor cleanup
|
||||
[ISC-Bugs #20263] add text describing some default values
|
||||
[ISC-Bugs #20193] single quotes at the start of a line indicate a control
|
||||
line to nroff, escape them if we actually want a quote.
|
||||
[ISC-Bugs #18916] sync the pointer to web pages amongst the different docs
|
||||
|
||||
Changes since 4.2.0b2
|
||||
|
||||
- Add declaration for variable in debug code in alloc.c. [ISC-Bugs #21472]
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
.\" dhclient-script.8
|
||||
.\"
|
||||
.\" Copyright (c) 2004-2005,2009 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2009-2010 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2004-2005 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 1996-2003 by Internet Software Consortium
|
||||
.\"
|
||||
.\" Permission to use, copy, modify, and distribute this software for any
|
||||
@ -23,12 +24,11 @@
|
||||
.\"
|
||||
.\" This software has been written for Internet Systems Consortium
|
||||
.\" by Ted Lemon in cooperation with Vixie Enterprises and Nominum, Inc.
|
||||
.\" To learn more about Internet Systems Consortium, see
|
||||
.\" ``https://www.isc.org/''. To learn more about Vixie Enterprises,
|
||||
.\" see ``http://www.vix.com''. To learn more about Nominum, Inc., see
|
||||
.\" ``http://www.nominum.com''.
|
||||
.\"
|
||||
.\" $Id: dhclient-script.8,v 1.13 2009/11/24 02:06:56 sar Exp $
|
||||
.\" Support and other services are available for ISC products - see
|
||||
.\" https://www.isc.org for more information or to learn more about ISC.
|
||||
.\"
|
||||
.\" $Id: dhclient-script.8,v 1.14 2010/07/02 23:09:14 sar Exp $
|
||||
.\"
|
||||
.TH dhclient-script 8
|
||||
.SH NAME
|
||||
@ -70,7 +70,7 @@ On after defining the make_resolv_conf function, the client script checks
|
||||
for the presence of an executable
|
||||
.B ETCDIR/dhclient-enter-hooks
|
||||
script, and if present, it invokes the script inline, using the Bourne
|
||||
shell '.' command. The entire environment documented under OPERATION
|
||||
shell \'.\' command. The entire environment documented under OPERATION
|
||||
is available to this script, which may modify the environment if needed
|
||||
to change the behaviour of the script. If an error occurs during the
|
||||
execution of the script, it can set the exit_status variable to a nonzero
|
||||
@ -82,7 +82,7 @@ After all processing has completed,
|
||||
.B CLIENTBINDIR/dhclient-script
|
||||
checks for the presence of an executable
|
||||
.B ETCDIR/dhclient-exit-hooks
|
||||
script, which if present is invoked using the '.' command. The exit
|
||||
script, which if present is invoked using the \'.\' command. The exit
|
||||
status of dhclient-script will be passed to dhclient-exit-hooks in the
|
||||
exit_status shell variable, and will always be zero if the script
|
||||
succeeded at the task for which it was invoked. The rest of the
|
||||
@ -122,8 +122,8 @@ The DHCP client has done an initial binding to a new address. The
|
||||
new ip address is passed in $new_ip_address, and the interface name is
|
||||
passed in $interface. The media type is passed in $medium. Any
|
||||
options acquired from the server are passed using the option name
|
||||
described in \fBdhcp-options\fR, except that dashes ('-') are replaced
|
||||
by underscores ('_') in order to make valid shell variables, and the
|
||||
described in \fBdhcp-options\fR, except that dashes (\'-\') are replaced
|
||||
by underscores (\'_\') in order to make valid shell variables, and the
|
||||
variable names start with new_. So for example, the new subnet mask
|
||||
would be passed in $new_subnet_mask.
|
||||
.PP
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" $Id: dhclient.8,v 1.33 2009/11/24 02:06:56 sar Exp $
|
||||
.\" $Id: dhclient.8,v 1.34 2010/07/02 23:09:14 sar Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2004,2007-2009 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2004,2007-2010 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 1996-2003 by Internet Software Consortium
|
||||
.\"
|
||||
.\" Permission to use, copy, modify, and distribute this software for any
|
||||
@ -22,7 +22,7 @@
|
||||
.\" https://www.isc.org/
|
||||
.\"
|
||||
.\" Support and other services are available for ISC products - see
|
||||
.\" https://www.isc.org for more information.
|
||||
.\" https://www.isc.org for more information or to learn more about ISC.
|
||||
.\"
|
||||
.TH dhclient 8
|
||||
.SH NAME
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
.\" $Id: dhclient.conf.5,v 1.28 2010/04/27 22:13:53 sar Exp $
|
||||
.\" $Id: dhclient.conf.5,v 1.29 2010/07/02 23:09:14 sar Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2009-2010 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2004,2007 by Internet Systems Consortium, Inc. ("ISC")
|
||||
@ -24,10 +24,9 @@
|
||||
.\"
|
||||
.\" This software has been written for Internet Software Consortium
|
||||
.\" by Ted Lemon in cooperation with Vixie Enterprises and Nominum, Inc.
|
||||
.\" To learn more about Internet Software Consortium, see
|
||||
.\" ``https://www.isc.org/''. To learn more about Vixie Enterprises,
|
||||
.\" see ``http://www.vix.com''. To learn more about Nominum, Inc., see
|
||||
.\" ``http://www.nominum.com''.
|
||||
.\"
|
||||
.\" Support and other services are available for ISC products - see
|
||||
.\" https://www.isc.org for more information or to learn more about ISC.
|
||||
.\"
|
||||
.TH dhclient.conf 5
|
||||
.SH NAME
|
||||
@ -189,7 +188,7 @@ statement - not option parameters. By default, the DHCPv4 client
|
||||
requests the subnet-mask, broadcast-address, time-offset, routers,
|
||||
domain-name, domain-name-servers and host-name options while the DHCPv6
|
||||
client requests the dhcp6 name-servers and domain-search options. Note
|
||||
that if you enter a 'request' statement, you over-ride these defaults
|
||||
that if you enter a \'request\' statement, you over-ride these defaults
|
||||
and these options will not be requested.
|
||||
.PP
|
||||
In some cases, it may be desirable to send no parameter request list
|
||||
@ -202,7 +201,7 @@ no parameters:
|
||||
.PP
|
||||
In most cases, it is desirable to simply add one option to the request
|
||||
list which is of interest to the client in question. In this case, it
|
||||
is best to 'also request' the additional options:
|
||||
is best to \'also request\' the additional options:
|
||||
.PP
|
||||
.nf
|
||||
also request domain-search, dhcp6.sip-servers-addresses;
|
||||
@ -658,7 +657,7 @@ statement defines the hardware MAC address to use for this interface,
|
||||
for DHCP servers or relays to direct their replies. dhclient will determine
|
||||
the interface's MAC address automatically, so use of this parameter
|
||||
is not recommended. The \fIlink-type\fR corresponds to the interface's
|
||||
link layer type (example: 'ethernet'), while the \fImac-address\fR is
|
||||
link layer type (example: \'ethernet\'), while the \fImac-address\fR is
|
||||
a string of colon-separated hexadecimal values for octets.
|
||||
.PP
|
||||
\fBanycast-mac\fR \fIlink-type mac-address\fR\fB;\fR
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
.\" $Id: dhclient.leases.5,v 1.6 2009/11/24 02:06:56 sar Exp $
|
||||
.\" $Id: dhclient.leases.5,v 1.7 2010/07/02 23:09:14 sar Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2004,2009 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2009-2010 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 1997-2003 by Internet Software Consortium
|
||||
.\"
|
||||
.\" Permission to use, copy, modify, and distribute this software for any
|
||||
@ -22,12 +23,12 @@
|
||||
.\" https://www.isc.org/
|
||||
.\"
|
||||
.\" This software has been written for Internet Systems Consortium
|
||||
.\" by Ted Lemon in cooperation with Vixie
|
||||
.\" Enterprises. To learn more about Internet Systems Consortium,
|
||||
.\" see ``https://www.isc.org/''. To learn more about Vixie
|
||||
.\" Enterprises, see ``http://www.vix.com''.
|
||||
.\" by Ted Lemon in cooperation with Vixie Enterprises.
|
||||
.\"
|
||||
.\" $Id: dhclient.leases.5,v 1.6 2009/11/24 02:06:56 sar Exp $
|
||||
.\" Support and other services are available for ISC products - see
|
||||
.\" https://www.isc.org for more information or to learn more about ISC.
|
||||
.\"
|
||||
.\" $Id: dhclient.leases.5,v 1.7 2010/07/02 23:09:14 sar Exp $
|
||||
.\"
|
||||
.TH dhclient.leases 5
|
||||
.SH NAME
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
.\" $Id: dhcp-eval.5,v 1.30 2009/11/24 02:06:56 sar Exp $
|
||||
.\" $Id: dhcp-eval.5,v 1.31 2010/07/02 23:09:14 sar Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2004,2007,2009 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2009-2010 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2004,2007 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 1996-2003 by Internet Software Consortium
|
||||
.\"
|
||||
.\" Permission to use, copy, modify, and distribute this software for any
|
||||
@ -23,10 +24,10 @@
|
||||
.\"
|
||||
.\" This software has been written for Internet Systems Consortium
|
||||
.\" by Ted Lemon in cooperation with Vixie Enterprises and Nominum, Inc.
|
||||
.\" To learn more about Internet Systems Consortium, see
|
||||
.\" ``https://www.isc.org/''. To learn more about Vixie Enterprises,
|
||||
.\" see ``http://www.vix.com''. To learn more about Nominum, Inc., see
|
||||
.\" ``http://www.nominum.com''.
|
||||
.\"
|
||||
.\" Support and other services are available for ISC products - see
|
||||
.\" https://www.isc.org for more information or to learn more about ISC.
|
||||
.\"
|
||||
.TH dhcp-eval 5
|
||||
.SH NAME
|
||||
dhcp-eval - ISC DHCP conditional evaluation
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" $Id: dhcp-options.5,v 1.47 2010/01/21 22:17:17 dhankins Exp $
|
||||
.\" $Id: dhcp-options.5,v 1.48 2010/07/02 23:09:14 sar Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2004-2009 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2004-2010 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 1996-2003 by Internet Software Consortium
|
||||
.\"
|
||||
.\" Permission to use, copy, modify, and distribute this software for any
|
||||
@ -23,10 +23,10 @@
|
||||
.\"
|
||||
.\" This software has been written for Internet Systems Consortium
|
||||
.\" by Ted Lemon in cooperation with Vixie Enterprises and Nominum, Inc.
|
||||
.\" To learn more about Internet Systems Consortium, see
|
||||
.\" ``https://www.isc.org/''. To learn more about Vixie Enterprises,
|
||||
.\" see ``http://www.vix.com''. To learn more about Nominum, Inc., see
|
||||
.\" ``http://www.nominum.com''.
|
||||
.\"
|
||||
.\" Support and other services are available for ISC products - see
|
||||
.\" https://www.isc.org for more information or to learn more about ISC.
|
||||
.\"
|
||||
.TH dhcpd-options 5
|
||||
.SH NAME
|
||||
dhcp-options - Dynamic Host Configuration Protocol options
|
||||
@ -320,7 +320,7 @@ This option is not user configurable.
|
||||
.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'
|
||||
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.
|
||||
@ -332,8 +332,8 @@ option fields.
|
||||
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
|
||||
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
|
||||
@ -403,7 +403,7 @@ 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
|
||||
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.
|
||||
@ -435,7 +435,7 @@ should be listed in order of preference.
|
||||
.B option \fBdomain-search\fR \fIdomain-list\fR\fB;\fR
|
||||
.RS 0.25i
|
||||
.PP
|
||||
The domain-search option specifies a 'search list' of Domain Names to be
|
||||
The domain-search option specifies a \'search list\' of Domain Names to be
|
||||
used by the client to locate not-fully-qualified domain names. The difference
|
||||
between this option and historic use of the domain-name option for the same
|
||||
ends is that this option is encoded in RFC1035 compressed labels on the wire.
|
||||
@ -1238,7 +1238,7 @@ The values of these fields are those defined in the DNS protocol specification.
|
||||
.PP
|
||||
Specifies the domain name that the client wishes to use. This can be a
|
||||
fully-qualified domain name, or a single label. If there is no trailing
|
||||
'.' character in the name, it is not fully-qualified, and the server will
|
||||
\'.\' character in the name, it is not fully-qualified, and the server will
|
||||
generally update that name in some locally-defined domain.
|
||||
.RE
|
||||
.PP
|
||||
@ -1404,7 +1404,7 @@ should be used instead.
|
||||
.RS 0.25i
|
||||
.PP
|
||||
The \fBpreference\fR option informs a DHCPv6 client which server is
|
||||
'preferred' for use on a given subnet. This preference is only
|
||||
\'preferred\' for use on a given subnet. This preference is only
|
||||
applied during the initial stages of configuration - once a client
|
||||
is bound to an IA, it will remain bound to that IA until it is no
|
||||
longer valid or has expired. This value may be configured on the
|
||||
@ -1720,7 +1720,7 @@ might define an option, "local-host-name", feeling some confidence
|
||||
that no official DHCP option name will ever start with "local".
|
||||
.PP
|
||||
Once you have chosen a name, you must choose a code. All codes between
|
||||
224 and 254 are reserved as 'site-local' DHCP options, so you can pick
|
||||
224 and 254 are reserved as \'site-local\' DHCP options, so you can pick
|
||||
any one of these for your site (not for your product/application). In
|
||||
RFC3942, site-local space was moved from starting at 128 to starting at
|
||||
224. In practice, some vendors have interpreted the protocol rather
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
.\" omapi.3
|
||||
.\"
|
||||
.\" Copyright (c) 2004,2009 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2009-2010 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2000-2003 by Internet Software Consortium
|
||||
.\"
|
||||
.\" Permission to use, copy, modify, and distribute this software for any
|
||||
@ -23,10 +24,10 @@
|
||||
.\"
|
||||
.\" This software has been written for Internet Systems Consortium
|
||||
.\" by Ted Lemon in cooperation with Vixie Enterprises and Nominum, Inc.
|
||||
.\" To learn more about Internet Systems Consortium, see
|
||||
.\" ``https://www.isc.org/''. To learn more about Vixie Enterprises,
|
||||
.\" see ``http://www.vix.com''. To learn more about Nominum, Inc., see
|
||||
.\" ``http://www.nominum.com''.
|
||||
.\"
|
||||
.\" Support and other services are available for ISC products - see
|
||||
.\" https://www.isc.org for more information or to learn more about ISC.
|
||||
.\"
|
||||
.TH omapi 3
|
||||
.SH NAME
|
||||
OMAPI - Object Management Application Programming Interface
|
||||
@ -37,7 +38,7 @@ applications, and for querying them for their state. It is currently
|
||||
used by the ISC DHCP server and this outline addresses the parts of
|
||||
OMAPI appropriate to the clients of DHCP server. It does this by also
|
||||
describing the use of a thin API layered on top of OMAPI called
|
||||
'dhcpctl'
|
||||
\'dhcpctl\'
|
||||
.PP
|
||||
OMAPI uses TCP/IP as the transport for server communication, and
|
||||
security can be imposed by having the client and server
|
||||
@ -220,7 +221,7 @@ the connection the user must call dhcpctl_new_authenticator.
|
||||
.fi
|
||||
.PP
|
||||
The keyname, algorithm and must all match what is specified in the server's
|
||||
dhcpd.conf file, excepting that the secret should appear in 'raw' form, not
|
||||
dhcpd.conf file, excepting that the secret should appear in \'raw\' form, not
|
||||
in base64 as it would in dhcpd.conf:
|
||||
.PP
|
||||
.nf
|
||||
@ -242,7 +243,5 @@ with the given secret string using the specified algorithm.
|
||||
dhcpctl(3), omshell(1), dhcpd(8), dhclient(8), dhcpd.conf(5), dhclient.conf(5).
|
||||
.SH AUTHOR
|
||||
.B omapi
|
||||
was created by Ted Lemon of Nominum, Inc. Information about Nominum
|
||||
and support contracts for DHCP and BIND can be found at
|
||||
.B http://www.nominum.com. This documentation was written by James
|
||||
Brister of Nominum, Inc.
|
||||
was created by Ted Lemon of Nominum, Inc. This documentation was
|
||||
written by James Brister of Nominum, Inc.
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
.\" dhcrelay.8
|
||||
.\"
|
||||
.\" Copyright (c) 2004,2007,2009 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2009-2010 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2004,2007 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 1997-2003 by Internet Software Consortium
|
||||
.\"
|
||||
.\" Permission to use, copy, modify, and distribute this software for any
|
||||
@ -22,12 +23,12 @@
|
||||
.\" https://www.isc.org/
|
||||
.\"
|
||||
.\" This software has been written for Internet Systems Consortium
|
||||
.\" by Ted Lemon in cooperation with Vixie
|
||||
.\" Enterprises. To learn more about Internet Systems Consortium,
|
||||
.\" see ``https://www.isc.org/''. To learn more about Vixie
|
||||
.\" Enterprises, see ``http://www.vix.com''.
|
||||
.\" by Ted Lemon in cooperation with Vixie Enterprises.
|
||||
.\"
|
||||
.\" $Id: dhcrelay.8,v 1.17 2009/11/24 02:06:57 sar Exp $
|
||||
.\" Support and other services are available for ISC products - see
|
||||
.\" https://www.isc.org for more information or to learn more about ISC.
|
||||
.\"
|
||||
.\" $Id: dhcrelay.8,v 1.18 2010/07/02 23:09:14 sar Exp $
|
||||
.\"
|
||||
.TH dhcrelay 8
|
||||
.SH NAME
|
||||
@ -230,3 +231,7 @@ loops, so when running this way, the maximum hop count should be set
|
||||
to a low value.
|
||||
.PP
|
||||
The loopback interface is not (yet) recognized as a valid interface.
|
||||
.SH AUTHOR
|
||||
.B dhcrelay(8)
|
||||
To learn more about Internet Systems Consortium, see
|
||||
.B https://www.isc.org
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
.\" dhcpd.8
|
||||
.\"
|
||||
.\" Copyright (c) 2004-2007,2009 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2009-2010 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2004-2007 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 1996-2003 by Internet Software Consortium
|
||||
.\"
|
||||
.\" Permission to use, copy, modify, and distribute this software for any
|
||||
@ -23,12 +24,11 @@
|
||||
.\"
|
||||
.\" This software has been written for Internet Systems Consortium
|
||||
.\" by Ted Lemon in cooperation with Vixie Enterprises and Nominum, Inc.
|
||||
.\" To learn more about Internet Systems Consortium, see
|
||||
.\" ``https://www.isc.org/''. To learn more about Vixie Enterprises,
|
||||
.\" see ``http://www.vix.com''. To learn more about Nominum, Inc., see
|
||||
.\" ``http://www.nominum.com''.
|
||||
.\"
|
||||
.\" $Id: dhcpd.8,v 1.31 2009/11/24 02:06:57 sar Exp $
|
||||
.\" Support and other services are available for ISC products - see
|
||||
.\" https://www.isc.org for more information or to learn more about ISC.
|
||||
.\"
|
||||
.\" $Id: dhcpd.8,v 1.32 2010/07/02 23:09:14 sar Exp $
|
||||
.\"
|
||||
.TH dhcpd 8
|
||||
.SH NAME
|
||||
@ -98,16 +98,6 @@ Protocol (BOOTP). DHCP allows hosts on a TCP/IP network to request
|
||||
and be assigned IP addresses, and also to discover information about
|
||||
the network to which they are attached. BOOTP provides similar
|
||||
functionality, with certain restrictions.
|
||||
.SH CONTRIBUTIONS
|
||||
.PP
|
||||
This software is free software. At various times its development has
|
||||
been underwritten by various organizations, including the ISC and
|
||||
Vixie Enterprises. The development of 3.0 has been funded almost
|
||||
entirely by Nominum, Inc.
|
||||
.PP
|
||||
At this point development is being shepherded by Ted Lemon, and hosted
|
||||
by the ISC, but the future of this project depends on you. If you
|
||||
have features you want, please consider implementing them.
|
||||
.SH OPERATION
|
||||
.PP
|
||||
The DHCP protocol allows a host which is unknown to the network
|
||||
@ -309,7 +299,7 @@ being served.
|
||||
.PP
|
||||
For example, in an office environment where systems are added from
|
||||
time to time and removed from time to time, but move relatively
|
||||
infrequently, it might make sense to allow lease times of a month of
|
||||
infrequently, it might make sense to allow lease times of a month or
|
||||
more. In a final test environment on a manufacturing floor, it may
|
||||
make more sense to assign a maximum lease length of 30 minutes -
|
||||
enough time to go through a simple test procedure on a network
|
||||
@ -779,4 +769,3 @@ Funding for this project was provided by Internet Systems
|
||||
Consortium. Version 3 of the DHCP server was funded by Nominum, Inc.
|
||||
Information about Internet Systems Consortium is available at
|
||||
.B https://www.isc.org/\fR.
|
||||
Information about Nominum can be found at \fBhttp://www.nominum.com/\fR.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" dhcpd.conf.5
|
||||
.\"
|
||||
.\" Copyright (c) 2004-2009 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 2004-2010 by Internet Systems Consortium, Inc. ("ISC")
|
||||
.\" Copyright (c) 1996-2003 by Internet Software Consortium
|
||||
.\"
|
||||
.\" Permission to use, copy, modify, and distribute this software for any
|
||||
@ -23,12 +23,11 @@
|
||||
.\"
|
||||
.\" This software has been written for Internet Systems Consortium
|
||||
.\" by Ted Lemon in cooperation with Vixie Enterprises and Nominum, Inc.
|
||||
.\" To learn more about Internet Systems Consortium, see
|
||||
.\" ``https://www.isc.org/''. To learn more about Vixie Enterprises,
|
||||
.\" see ``http://www.vix.com''. To learn more about Nominum, Inc., see
|
||||
.\" ``http://www.nominum.com''.
|
||||
.\"
|
||||
.\" $Id: dhcpd.conf.5,v 1.107 2009/11/24 02:06:57 sar Exp $
|
||||
.\" Support and other services are available for ISC products - see
|
||||
.\" https://www.isc.org for more information or to learn more about ISC.
|
||||
.\"
|
||||
.\" $Id: dhcpd.conf.5,v 1.108 2010/07/02 23:09:15 sar Exp $
|
||||
.\"
|
||||
.TH dhcpd.conf 5
|
||||
.SH NAME
|
||||
@ -414,7 +413,7 @@ allocation using the same method described here, and will typically
|
||||
try a new IP address.
|
||||
.SH DHCP FAILOVER
|
||||
This version of the ISC DHCP server supports the DHCP failover
|
||||
protocol as documented in draft-ietf-dhc-failover-07.txt. This is
|
||||
protocol as documented in draft-ietf-dhc-failover-12.txt. This is
|
||||
not a final protocol document, and we have not done interoperability
|
||||
testing with other vendors' implementations of this protocol, so you
|
||||
must not assume that this implementation conforms to the standard.
|
||||
@ -785,22 +784,23 @@ saturation...when any server ran out of leases to assign, it also lost
|
||||
its ability to notice it had run dry.
|
||||
.PP
|
||||
In order to understand pool balance, some elements of its operation
|
||||
first need to be defined. First, there are 'free' and 'backup' leases.
|
||||
Both of these are referred to as 'free state leases'. 'free' and 'backup'
|
||||
are 'the free states' for the purpose of this document. The difference
|
||||
is that only the primary may allocate from 'free' leases unless under
|
||||
special circumstances, and only the secondary may allocate 'backup' leases.
|
||||
first need to be defined. First, there are \'free\' and \'backup\' leases.
|
||||
Both of these are referred to as \'free state leases\'. \'free\' and
|
||||
\'backup\'
|
||||
are \'the free states\' for the purpose of this document. The difference
|
||||
is that only the primary may allocate from \'free\' leases unless under
|
||||
special circumstances, and only the secondary may allocate \'backup\' leases.
|
||||
.PP
|
||||
When pool balance is performed, the only plausible expectation is to
|
||||
provide a 50/50 split of the free state leases between the two servers.
|
||||
This is because no one can predict which server will fail, regardless
|
||||
of the relative load placed upon the two servers, so giving each server
|
||||
half the leases gives both servers the same amount of 'failure endurance'.
|
||||
half the leases gives both servers the same amount of \'failure endurance\'.
|
||||
Therefore, there is no way to configure any different behaviour, outside of
|
||||
some very small windows we will describe shortly.
|
||||
.PP
|
||||
The first thing calculated on any pool balance run is a value referred to
|
||||
as 'lts', or "Leases To Send". This, simply, is the difference in the
|
||||
as \'lts\', or "Leases To Send". This, simply, is the difference in the
|
||||
count of free and backup leases, divided by two. For the secondary,
|
||||
it is the difference in the backup and free leases, divided by two.
|
||||
The resulting value is signed: if it is positive, the local server is
|
||||
@ -826,7 +826,7 @@ by this time, and fit into the schedule if it falls within
|
||||
the \fBmin-balance\fR and \fBmax-balance\fR configured values. The
|
||||
scheduled pool check time is only moved in a downwards direction, it is
|
||||
never increased. Lastly, if the lts is more than double this number in
|
||||
the negative direction, the local server will 'panic' and transmit a
|
||||
the negative direction, the local server will \'panic\' and transmit a
|
||||
Failover protocol POOLREQ message, in the hopes that the remote system
|
||||
will be woken up into action.
|
||||
.PP
|
||||
@ -844,10 +844,10 @@ the \fBmax-lease-ownership\fR percentage. So it is through this value that
|
||||
you can permit a small misbalance of the lease pools - for the purpose of
|
||||
giving the peer more than a 50/50 share of leases in the hopes that their
|
||||
clients might some day return and be allocated by the peer (operating
|
||||
normally). This process is referred to as 'MAC Address Affinity', but this
|
||||
normally). This process is referred to as \'MAC Address Affinity\', but this
|
||||
is somewhat misnamed: it applies equally to DHCP Client Identifier options.
|
||||
Note also that affinity is applied to leases when they enter the state
|
||||
'free' from 'expired' or 'released'. In this case also, leases will not
|
||||
\'free\' from \'expired\' or \'released\'. In this case also, leases will not
|
||||
be moved from free to backup if the secondary already has more than its
|
||||
share.
|
||||
.PP
|
||||
@ -1932,7 +1932,7 @@ set the broadcast bit in the flags field of the BOOTP message header.
|
||||
Unfortunately, some DHCP and BOOTP clients do not do this, and
|
||||
therefore may not receive responses from the DHCP server. The DHCP
|
||||
server can be made to always broadcast its responses to clients by
|
||||
setting this flag to 'on' for the relevant scope; relevant scopes would be
|
||||
setting this flag to \'on\' for the relevant scope; relevant scopes would be
|
||||
inside a conditional statement, as a parameter for a class, or as a parameter
|
||||
for a host declaration. To avoid creating excess broadcast traffic on your
|
||||
network, we recommend that you restrict the use of this option to as few
|
||||
@ -2111,6 +2111,7 @@ should be the length in seconds that will be assigned to a lease if
|
||||
the client requesting the lease does not ask for a specific expiration
|
||||
time. This is used for both DHCPv4 and DHCPv6 leases (it is also known
|
||||
as the "valid lifetime" in DHCPv6).
|
||||
The default is 43200 seconds.
|
||||
.RE
|
||||
.PP
|
||||
The
|
||||
@ -2141,7 +2142,7 @@ a second).
|
||||
.PP
|
||||
Please note that as delayed-ack is currently experimental, the delayed-ack
|
||||
feature is not compiled in by default, but must be enabled at compile time
|
||||
with './configure --enable-delayed-ack'.
|
||||
with \'./configure --enable-delayed-ack\'.
|
||||
.RE
|
||||
.PP
|
||||
The
|
||||
@ -2326,7 +2327,7 @@ statement
|
||||
.PP
|
||||
.B infinite-is-reserved \fIflag\fB;\fR
|
||||
.PP
|
||||
ISC DHCP now supports 'reserved' leases. See the section on RESERVED LEASES
|
||||
ISC DHCP now supports \'reserved\' leases. See the section on RESERVED LEASES
|
||||
below. If this \fIflag\fR is on, the server will automatically reserve leases
|
||||
allocated to clients which requested an infinite (0xffffffff) lease-time.
|
||||
.PP
|
||||
@ -2484,7 +2485,9 @@ statement
|
||||
.PP
|
||||
.I Time
|
||||
should be the maximum length in seconds that will be assigned to a
|
||||
lease. The only exception to this is that Dynamic BOOTP lease
|
||||
lease.
|
||||
If not defined, the default maximum lease time is 86400.
|
||||
The only exception to this is that Dynamic BOOTP lease
|
||||
lengths, which are not specified by the client, are not limited by
|
||||
this maximum.
|
||||
.RE
|
||||
@ -2499,6 +2502,8 @@ statement
|
||||
.I Time
|
||||
should be the minimum length in seconds that will be assigned to a
|
||||
lease.
|
||||
The default is the minimum of 300 seconds or
|
||||
\fBmax-lease-time\fR.
|
||||
.RE
|
||||
.PP
|
||||
The
|
||||
@ -2660,7 +2665,7 @@ statement
|
||||
.B preferred-lifetime
|
||||
.I seconds\fR\fB;\fR
|
||||
.PP
|
||||
IPv6 addresses have 'valid' and 'preferred' lifetimes. The valid lifetime
|
||||
IPv6 addresses have \'valid\' and \'preferred\' lifetimes. The valid lifetime
|
||||
determines at what point at lease might be said to have expired, and is no
|
||||
longer useable. A preferred lifetime is an advisory condition to help
|
||||
applications move off of the address and onto currently valid addresses
|
||||
@ -2939,13 +2944,13 @@ For example:
|
||||
It's often useful to allocate a single address to a single client, in
|
||||
approximate perpetuity. Host statements with \fBfixed-address\fR clauses
|
||||
exist to a certain extent to serve this purpose, but because host statements
|
||||
are intended to approximate 'static configuration', they suffer from not being
|
||||
referenced in a littany of other Server Services, such as dynamic DNS,
|
||||
failover, 'on events' and so forth.
|
||||
are intended to approximate \'static configuration\', they suffer from not
|
||||
being referenced in a littany of other Server Services, such as dynamic DNS,
|
||||
failover, \'on events\' and so forth.
|
||||
.PP
|
||||
If a standard dynamic lease, as from any range statement, is marked 'reserved',
|
||||
then the server will only allocate this lease to the client it is identified
|
||||
by (be that by client identifier or hardware address).
|
||||
If a standard dynamic lease, as from any range statement, is marked
|
||||
\'reserved\', then the server will only allocate this lease to the client it
|
||||
is identified by (be that by client identifier or hardware address).
|
||||
.PP
|
||||
In practice, this means that the lease follows the normal state engine, enters
|
||||
ACTIVE state when the client is bound to it, expires, or is released, and any
|
||||
@ -2954,18 +2959,18 @@ processed normally, as with any other dynamic lease. The only difference
|
||||
is that failover servers treat reserved leases as special when they enter
|
||||
the FREE or BACKUP states - each server applies the lease into the state it
|
||||
may allocate from - and the leases are not placed on the queue for allocation
|
||||
to other clients. Instead they may only be 'found' by client identity. The
|
||||
to other clients. Instead they may only be \'found\' by client identity. The
|
||||
result is that the lease is only offered to the returning client.
|
||||
.PP
|
||||
Care should probably be taken to ensure that the client only has one lease
|
||||
within a given subnet that it is identified by.
|
||||
.PP
|
||||
Leases may be set 'reserved' either through OMAPI, or through the
|
||||
\'infinite-is-reserved' configuration option (if this is applicable to your
|
||||
Leases may be set \'reserved\' either through OMAPI, or through the
|
||||
\'infinite-is-reserved\' configuration option (if this is applicable to your
|
||||
environment and mixture of clients).
|
||||
.PP
|
||||
It should also be noted that leases marked 'reserved' are effectively treated
|
||||
the same as leases marked 'bootp'.
|
||||
It should also be noted that leases marked \'reserved\' are effectively treated
|
||||
the same as leases marked \'bootp\'.
|
||||
.RE
|
||||
.SH REFERENCE: OPTION STATEMENTS
|
||||
DHCP option statements are documented in the
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user