mirror of
https://gitlab.isc.org/isc-projects/dhcp
synced 2025-08-25 11:27:31 +00:00
Put the options in the dhclient and dhcpd man pages into the standard form.
[ISC-Bugs #20264] and parts of [ISC-Bugs #17744] for dhclient.8 changes
This commit is contained in:
parent
524705e54a
commit
d6645f56ff
5
RELNOTES
5
RELNOTES
@ -55,6 +55,11 @@ work on other platforms. Please report any problems and suggested fixes to
|
|||||||
Hofman supplied to us by the Debian package maintenance team.
|
Hofman supplied to us by the Debian package maintenance team.
|
||||||
[ISC-Bugs #21691] {Debian Bug#509445}
|
[ISC-Bugs #21691] {Debian Bug#509445}
|
||||||
|
|
||||||
|
- More documentation changes - primarily to put the options in the dhclient
|
||||||
|
and dhcpd man pages into the standard form. Thanks in part to a patch
|
||||||
|
from David Cantrell at Red Hat.
|
||||||
|
[ISC-Bugs #20264] and parts of [ISC-Bugs #17744] dhclient.8 changes
|
||||||
|
|
||||||
Changes since 4.2.0b2
|
Changes since 4.2.0b2
|
||||||
|
|
||||||
- Add declaration for variable in debug code in alloc.c. [ISC-Bugs #21472]
|
- Add declaration for variable in debug code in alloc.c. [ISC-Bugs #21472]
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
.\" $Id: dhclient.8,v 1.34 2010/07/02 23:09:14 sar Exp $
|
.\" $Id: dhclient.8,v 1.35 2010/07/14 20:01:14 sar Exp $
|
||||||
.\"
|
.\"
|
||||||
.\" Copyright (c) 2004,2007-2010 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
|
.\" Copyright (c) 1996-2003 by Internet Software Consortium
|
||||||
@ -99,11 +99,11 @@ dhclient - Dynamic Host Configuration Protocol Client
|
|||||||
]
|
]
|
||||||
[
|
[
|
||||||
.B -s
|
.B -s
|
||||||
server
|
.I server
|
||||||
]
|
]
|
||||||
[
|
[
|
||||||
.B -g
|
.B -g
|
||||||
relay
|
.I relay
|
||||||
]
|
]
|
||||||
[
|
[
|
||||||
.B -n
|
.B -n
|
||||||
@ -127,7 +127,7 @@ relay
|
|||||||
]
|
]
|
||||||
]
|
]
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
The Internet Systems Consortium DHCP Client, dhclient, provides a
|
The Internet Systems Consortium DHCP Client, \fBdhclient\fR, provides a
|
||||||
means for configuring one or more network interfaces using the Dynamic
|
means for configuring one or more network interfaces using the Dynamic
|
||||||
Host Configuration Protocol, BOOTP protocol, or if these protocols
|
Host Configuration Protocol, BOOTP protocol, or if these protocols
|
||||||
fail, by statically assigning an address.
|
fail, by statically assigning an address.
|
||||||
@ -142,69 +142,35 @@ important details about the network to which it is attached, such as
|
|||||||
the location of a default router, the location of a name server, and
|
the location of a default router, the location of a name server, and
|
||||||
so on.
|
so on.
|
||||||
.PP
|
.PP
|
||||||
If given the
|
There are two versions of the DHCP protocol DHCPv4 and DHCPv6. At
|
||||||
|
startup the client may be started for one or the other via the
|
||||||
.B -4
|
.B -4
|
||||||
command line argument (default), dhclient will use the
|
or
|
||||||
DHCPv4 protocol to obtain an IPv4 address and configuration parameters.
|
|
||||||
.PP
|
|
||||||
If given the
|
|
||||||
.B -6
|
.B -6
|
||||||
command line argument, dhclient will use the DHCPv6
|
options.
|
||||||
protocol to obtain whatever IPv6 addresses are available along with
|
|
||||||
configuration parameters. But with
|
|
||||||
.B -S
|
|
||||||
it uses Information-request to get only (i.e., without address)
|
|
||||||
stateless configuration parameters.
|
|
||||||
.PP
|
.PP
|
||||||
The default DHCPv6 behavior is modified too with
|
On startup, \fBdhclient\fR reads the dhclient.conf
|
||||||
.B -T
|
|
||||||
which asks for IPv6 temporary addresses, one set per
|
|
||||||
.B -T
|
|
||||||
flag.
|
|
||||||
.B -P
|
|
||||||
enables the IPv6 prefix delegation.
|
|
||||||
As temporary addresses or prefix delegation disables the normal
|
|
||||||
address query,
|
|
||||||
.B -N
|
|
||||||
restores it. Note it is not recommended to mix queries of different types
|
|
||||||
together, or even to share the lease file between them.
|
|
||||||
.PP
|
|
||||||
By default, DHCPv6 dhclient creates an identifier based on the
|
|
||||||
link-layer address (DUID-LL) if it is running in stateless mode (with
|
|
||||||
-S, not requesting an address), or it creates an identifier based on
|
|
||||||
the link-layer address plus a timestamp (DUID-LLT) if it is running in
|
|
||||||
stateful mode (without -S, requesting an address).
|
|
||||||
.B -D
|
|
||||||
overrides this default, with a value of either "LL" or "LLT".
|
|
||||||
.PP
|
|
||||||
If given the
|
|
||||||
.B --version
|
|
||||||
command line argument, dhclient will print its
|
|
||||||
version number and exit.
|
|
||||||
.PP
|
|
||||||
On startup, dhclient reads the
|
|
||||||
.IR dhclient.conf
|
|
||||||
for configuration instructions. It then gets a list of all the
|
for configuration instructions. It then gets a list of all the
|
||||||
network interfaces that are configured in the current system. For
|
network interfaces that are configured in the current system. For
|
||||||
each interface, it attempts to configure the interface using the DHCP
|
each interface, it attempts to configure the interface using the DHCP
|
||||||
protocol.
|
protocol.
|
||||||
.PP
|
.PP
|
||||||
In order to keep track of leases across system reboots and server
|
In order to keep track of leases across system reboots and server
|
||||||
restarts, dhclient keeps a list of leases it has been assigned in the
|
restarts, \fBdhclient\fR keeps a list of leases it has been assigned in the
|
||||||
dhclient.leases(5) file. On startup, after reading the dhclient.conf
|
dhclient.leases file. On startup, after reading the dhclient.conf
|
||||||
file, dhclient reads the dhclient.leases file to refresh its memory
|
file, \fBdhclient\fR reads the dhclient.leases file to refresh its memory
|
||||||
about what leases it has been assigned.
|
about what leases it has been assigned.
|
||||||
.PP
|
.PP
|
||||||
When a new lease is acquired, it is appended to the end of the
|
When a new lease is acquired, it is appended to the end of the
|
||||||
dhclient.leases file. In order to prevent the file from becoming
|
dhclient.leases file. In order to prevent the file from becoming
|
||||||
arbitrarily large, from time to time dhclient creates a new
|
arbitrarily large, from time to time \fBdhclient\fR creates a new
|
||||||
dhclient.leases file from its in-core lease database. The old version
|
dhclient.leases file from its in-core lease database. The old version
|
||||||
of the dhclient.leases file is retained under the name
|
of the dhclient.leases file is retained under the name
|
||||||
.IR dhclient.leases~
|
.IR dhclient.leases~
|
||||||
until the next time dhclient rewrites the database.
|
until the next time \fBdhclient\fR rewrites the database.
|
||||||
.PP
|
.PP
|
||||||
Old leases are kept around in case the DHCP server is unavailable when
|
Old leases are kept around in case the DHCP server is unavailable when
|
||||||
dhclient is first invoked (generally during the initial system boot
|
\fBdhclient\fR is first invoked (generally during the initial system boot
|
||||||
process). In that event, old leases from the dhclient.leases file
|
process). In that event, old leases from the dhclient.leases file
|
||||||
which have not yet expired are tested, and if they are determined to
|
which have not yet expired are tested, and if they are determined to
|
||||||
be valid, they are used until either they expire or the DHCP server
|
be valid, they are used until either they expire or the DHCP server
|
||||||
@ -213,7 +179,7 @@ becomes available.
|
|||||||
A mobile host which may sometimes need to access a network on which no
|
A mobile host which may sometimes need to access a network on which no
|
||||||
DHCP server exists may be preloaded with a lease for a fixed
|
DHCP server exists may be preloaded with a lease for a fixed
|
||||||
address on that network. When all attempts to contact a DHCP server
|
address on that network. When all attempts to contact a DHCP server
|
||||||
have failed, dhclient will try to validate the static lease, and if it
|
have failed, \fBdhclient\fR will try to validate the static lease, and if it
|
||||||
succeeds, will use that lease until it is restarted.
|
succeeds, will use that lease until it is restarted.
|
||||||
.PP
|
.PP
|
||||||
A mobile host may also travel to some networks on which DHCP is not
|
A mobile host may also travel to some networks on which DHCP is not
|
||||||
@ -223,155 +189,209 @@ database, so that the host can boot quickly on that network rather
|
|||||||
than cycling through the list of old leases.
|
than cycling through the list of old leases.
|
||||||
.SH COMMAND LINE
|
.SH COMMAND LINE
|
||||||
.PP
|
.PP
|
||||||
The names of the network interfaces that dhclient should attempt to
|
The names of the network interfaces that \fBdhclient\fR should attempt to
|
||||||
configure may be specified on the command line. If no interface names
|
configure may be specified on the command line. If no interface names
|
||||||
are specified on the command line dhclient will normally identify all
|
are specified on the command line \fBdhclient\fR will normally identify all
|
||||||
network interfaces, eliminating non-broadcast interfaces if
|
network interfaces, eliminating non-broadcast interfaces if
|
||||||
possible, and attempt to configure each interface.
|
possible, and attempt to configure each interface.
|
||||||
.PP
|
.PP
|
||||||
It is also possible to specify interfaces by name in the
|
It is also possible to specify interfaces by name in the dhclient.conf
|
||||||
.B dhclient.conf(5)
|
|
||||||
file. If interfaces are specified in this way, then the client will
|
file. If interfaces are specified in this way, then the client will
|
||||||
only configure interfaces that are either specified in the
|
only configure interfaces that are either specified in the
|
||||||
configuration file or on the command line, and will ignore all other
|
configuration file or on the command line, and will ignore all other
|
||||||
interfaces.
|
interfaces.
|
||||||
.PP
|
.PP
|
||||||
If the DHCP client should listen and transmit on a port other than the
|
|
||||||
standard (port 68), the
|
|
||||||
.B -p
|
|
||||||
flag may used. It should be followed by the udp port number that
|
|
||||||
dhclient should use. This is mostly useful for debugging purposes.
|
|
||||||
If a different port is specified for the client to listen on and
|
|
||||||
transmit on, the client will also use a different destination port -
|
|
||||||
one less than the specified port.
|
|
||||||
.PP
|
|
||||||
The DHCP client normally transmits any protocol messages it sends
|
|
||||||
before acquiring an IP address to, 255.255.255.255, the IP limited
|
|
||||||
broadcast address. For debugging purposes, it may be useful to have
|
|
||||||
the server transmit these messages to some other address. This can
|
|
||||||
be specified with the
|
|
||||||
.B -s
|
|
||||||
flag, followed by the IP address or domain name of the destination.
|
|
||||||
This feature is not supported by DHCPv6.
|
|
||||||
.PP
|
|
||||||
For testing purposes, the giaddr field of all packets that the client
|
|
||||||
sends can be set using the
|
|
||||||
.B -g
|
|
||||||
flag, followed by the IP address to send. This is only useful for testing,
|
|
||||||
and should not be expected to work in any consistent or useful way.
|
|
||||||
.PP
|
|
||||||
The DHCP client will normally run in the foreground until it has
|
|
||||||
configured an interface, and then will revert to running in the
|
|
||||||
background. To run force dhclient to always run as a foreground
|
|
||||||
process, the
|
|
||||||
.B -d
|
|
||||||
flag should be specified. This is useful when running the client
|
|
||||||
under a debugger, or when running it out of inittab on System V
|
|
||||||
systems.
|
|
||||||
.PP
|
|
||||||
The dhclient daemon creates its own environment when executing the
|
|
||||||
dhclient-script to do the grunt work of interface configuration.
|
|
||||||
To define extra environment variables and their values, use the
|
|
||||||
.B -e
|
|
||||||
flag, followed by the environment variable name and value assignment,
|
|
||||||
just as one would assign a variable in a shell. Eg:
|
|
||||||
.B -e
|
|
||||||
.I IF_METRIC=1
|
|
||||||
.PP
|
|
||||||
The client normally prints no output during its startup sequence. It
|
The client normally prints no output during its startup sequence. It
|
||||||
can be made to emit verbose messages displaying the startup sequence events
|
can be made to emit verbose messages displaying the startup sequence events
|
||||||
until it has acquired an address by supplying the
|
until it has acquired an address by supplying the
|
||||||
.B -v
|
.B -v
|
||||||
command line argument. In either case, the client logs messages using
|
command line argument. In either case, the client logs messages using
|
||||||
the
|
the
|
||||||
.B syslog (3)
|
.B syslog(3)
|
||||||
facility. A
|
facility.
|
||||||
.B -q
|
.SH OPTIONS
|
||||||
command line argument is provided for backwards compatibility, but since
|
.TP
|
||||||
dhclient is quiet by default, it has no effect.
|
.BI \-4
|
||||||
.PP
|
Use the DHCPv4 protocol to obtain an IPv4 address and configuration
|
||||||
The client normally doesn't release the current lease as it is not
|
parameters. This is the default and cannot be combined with
|
||||||
required by the DHCP protocol. Some cable ISPs require their clients
|
\fB\-6\fR.
|
||||||
to notify the server if they wish to release an assigned IP address.
|
.TP
|
||||||
The
|
.BI \-6
|
||||||
.B -r
|
Use the DHCPv6 protocol to obtain whatever IPv6 addresses are available
|
||||||
flag explicitly releases the current lease, and once the lease has been
|
along with configuration parameters. It cannot be combined with
|
||||||
released, the client exits.
|
\fB\-4\fR. The \fB\-S -T -P -N\fR and
|
||||||
.PP
|
\fB\-D\fR arguments provide more control over aspects of the DHCPv6
|
||||||
The
|
processing. Note: it is not recommended to mix queries of different
|
||||||
.B -x
|
types together or even to share the lease file between them.
|
||||||
flag tells any currently running client to exit gracefully without
|
.TP
|
||||||
releasing leases first.
|
.BI \-1
|
||||||
.PP
|
Try to get a lease once. On failure exit with code 2. In DHCPv6 this
|
||||||
If the client is killed by a signal (for example at shutdown or reboot)
|
sets the maximum duration of the initial exchange to
|
||||||
it won't execute the
|
|
||||||
.B dhclient-script (8)
|
|
||||||
at exit. However if you shut the client down gracefully with
|
|
||||||
.B -r
|
|
||||||
or
|
|
||||||
.B -x
|
|
||||||
it will execute
|
|
||||||
.B dhclient-script (8)
|
|
||||||
at shutdown with the specific reason for calling the script set.
|
|
||||||
.PP
|
|
||||||
The
|
|
||||||
.B -1
|
|
||||||
flag will cause dhclient to try once to get a lease. If it fails, dhclient
|
|
||||||
exits with exit code two. In DHCPv6 the
|
|
||||||
.B -1
|
|
||||||
flag sets the max duration of the initial exchange to
|
|
||||||
.I timeout
|
.I timeout
|
||||||
(from
|
(from
|
||||||
.IR dhclient.conf ,
|
.IR dhclient.conf(5)
|
||||||
default sixty seconds).
|
with a default of sixty seconds).
|
||||||
.PP
|
.TP
|
||||||
The DHCP client normally gets its configuration information from
|
.BI \-d
|
||||||
.B ETCDIR/dhclient.conf,
|
.\" This is not intuitive.
|
||||||
its lease database from
|
Force
|
||||||
.B DBDIR/dhclient.leases,
|
.B dhclient
|
||||||
stores its process ID in a file called
|
to run as a foreground process. Normally the DHCP client will run
|
||||||
.B RUNDIR/dhclient.pid,
|
in the foreground until is has configured an interface at which time
|
||||||
and configures the network interface using
|
it will revert to running in the background. This option is useful
|
||||||
.B CLIENTBINDIR/dhclient-script
|
when running the client under a debugger, or when running it out of
|
||||||
To specify different names and/or locations for these files, use the
|
inittab on System V systems. This implies \fB-v\fR.
|
||||||
.B -cf,
|
.TP
|
||||||
.B -lf,
|
.BI \-nw
|
||||||
.B -pf
|
Become a daemon immediately (nowait) rather than waiting until an
|
||||||
and
|
an IP address has been acquired.
|
||||||
.B -sf
|
.TP
|
||||||
flags, respectively, followed by the name of the file. This can be
|
.BI \-q
|
||||||
particularly useful if, for example,
|
Be quiet at startup, this is the default.
|
||||||
.B DBDIR
|
.TP
|
||||||
or
|
.BI \-v
|
||||||
.B RUNDIR
|
Enable verbose log messages.
|
||||||
has not yet been mounted when the DHCP client is started.
|
.\" This prints the version, copyright and URL.
|
||||||
.PP
|
.TP
|
||||||
The DHCP client normally exits if it isn't able to identify any
|
.BI \-w
|
||||||
network interfaces to configure. On laptop computers and other
|
Continue running even if no broadcast interfaces were found. Normally
|
||||||
computers with hot-swappable I/O buses, it is possible that a
|
DHCP client will exit if it isn't able to identify any network interfaces
|
||||||
broadcast interface may be added after system startup. The
|
to configure. On laptop computers and other computers with
|
||||||
.B -w
|
hot-swappable I/O buses, it is possible that a broadcast interface may
|
||||||
flag can be used to cause the client not to exit when it doesn't find
|
be added after system startup. This flag can be used to cause the client
|
||||||
any such interfaces. The
|
not to exit when it doesn't find any such interfaces. The
|
||||||
.B omshell (1)
|
.B omshell(1)
|
||||||
program can then be used to notify the client when a network interface
|
program can then be used to notify the client when a network interface
|
||||||
has been added or removed, so that the client can attempt to configure an IP
|
has been added or removed, so that the client can attempt to configure an IP
|
||||||
address on that interface.
|
address on that interface.
|
||||||
.PP
|
.TP
|
||||||
The DHCP client can be directed not to attempt to configure any interfaces
|
.BI \-n
|
||||||
using the
|
Do not configure any interfaces. This is most likely to be useful in
|
||||||
.B -n
|
combination with the
|
||||||
flag. This is most likely to be useful in combination with the
|
|
||||||
.B -w
|
.B -w
|
||||||
flag.
|
flag.
|
||||||
|
.TP
|
||||||
|
.BI \-e \ VAR=val
|
||||||
|
Define additional environment variables for the environment where
|
||||||
|
.B dhclient-script(8)
|
||||||
|
executes. You may specify multiple
|
||||||
|
.B \-e
|
||||||
|
options on the command line.
|
||||||
|
.TP
|
||||||
|
.BI \-r
|
||||||
|
Release the current lease and stop the running DHCP client as previously
|
||||||
|
recorded in the PID file. When shutdown via this method
|
||||||
|
.B dhclient-script(8)
|
||||||
|
will be executed with the specific reason for calling the script set.
|
||||||
|
The client normally doesn't release the current lease as this is not
|
||||||
|
required by the DHCP protocol but some cable ISPs require their clients
|
||||||
|
to notify the server if they wish to release an assigned IP address.
|
||||||
|
.\" TODO what dhclient-script argument?
|
||||||
|
.\" When released,
|
||||||
|
.TP
|
||||||
|
.BI \-x
|
||||||
|
Stop the running DHCP client without releasing the current lease.
|
||||||
|
Kills existing \fBdhclient\fR process as previously recorded in the
|
||||||
|
PID file. When shutdown via this method
|
||||||
|
.B dhclient-script(8)
|
||||||
|
will be executed with the specific reason for calling the script set.
|
||||||
|
.TP
|
||||||
|
.BI \-p \ port
|
||||||
|
The UDP port number on which the DHCP client should listen and transmit.
|
||||||
|
If unspecified,
|
||||||
|
.B dhclient
|
||||||
|
uses the default port of 68. This is mostly useful for debugging purposes.
|
||||||
|
If a different port is specified on which the client should listen and
|
||||||
|
transmit, the client will also use a different destination port -
|
||||||
|
one less than the specified port.
|
||||||
|
.TP
|
||||||
|
.BI \-s \ server
|
||||||
|
Specify the server IP address or fully qualified domain name to use as
|
||||||
|
a destination for DHCP protocol messages before
|
||||||
|
.B dhclient
|
||||||
|
has acquired an IP address. Normally,
|
||||||
|
.B dhclient
|
||||||
|
transmits these messages to 255.255.255.255 (the IP limited broadcast
|
||||||
|
address). Overriding this is mostly useful for debugging purposes. This
|
||||||
|
feature is not supported in DHCPv6 (\fB-6\fR) mode.
|
||||||
|
.TP
|
||||||
|
.BI \-g \ relay
|
||||||
|
.\" mockup relay
|
||||||
|
Set the giaddr field of all packets to the \fIrelay\fR IP address
|
||||||
|
simulating a relay agent. This is for testing pruposes only and
|
||||||
|
should not be expected to work in any consistent or useful way.
|
||||||
|
.TP
|
||||||
|
.BI \--version
|
||||||
|
Print version number and exit.
|
||||||
|
.PP
|
||||||
|
.I Options available for DHCPv6 mode:
|
||||||
|
.TP
|
||||||
|
.BI \-S
|
||||||
|
.\" TODO: mention DUID?
|
||||||
|
Use Information-request to get only stateless configuration parameters
|
||||||
|
(i.e., without address). This implies \fB\-6\fR. It also doesn't
|
||||||
|
rewrite the lease database.
|
||||||
|
.\" TODO: May not be used with -N -P or -T. ??
|
||||||
|
.TP
|
||||||
|
.BI \-T
|
||||||
|
.\" TODO wanted_ia_ta++
|
||||||
|
Ask for IPv6 temporary addresses, one set per \fB\-T\fR flag. This
|
||||||
|
implies \fB\-6\fR and also disables the normal address query.
|
||||||
|
See \fB\-N\fR to restore it.
|
||||||
|
.TP
|
||||||
|
.BI \-P
|
||||||
|
Enable IPv6 prefix delegation. This implies \fB\-6\fR and also
|
||||||
|
disables the normal address query. See \fB\-N\fR to restore it.
|
||||||
|
Note only one requested interface is allowed.
|
||||||
|
.TP
|
||||||
|
.BI \-D \ LL\ or\ LLT
|
||||||
|
Override the default when selecting the type of DUID to use. By default,
|
||||||
|
DHCPv6 \fBdhclient\fR creates an identifier based on the link-layer address
|
||||||
|
(DUID-LL) if it is running in stateless mode (with \fB\-S\fR, not
|
||||||
|
requesting an address), or it creates an identifier based on the
|
||||||
|
link-layer address plus a timestamp (DUID-LLT) if it is running in
|
||||||
|
stateful mode (without \fB\-S\fR, requesting an address). \fB\-D\fR
|
||||||
|
overrides this default, with a value of either \fILL\fR or \fILLT\fR.
|
||||||
|
.TP
|
||||||
|
.BI \-N
|
||||||
|
.\" TODO: is this for telling an already running dhclient?
|
||||||
|
Restore normal address query for IPv6. This implies \fB-6\fR.
|
||||||
|
It is used to restore normal operation after using \fB-T\fR or \fB-P\fR.
|
||||||
|
.PP
|
||||||
|
.I Modifying default file locations:
|
||||||
|
The following options can be used to modify the locations a client uses
|
||||||
|
for it's files. They can be particularly useful if, for example,
|
||||||
|
.B DBDIR
|
||||||
|
or
|
||||||
|
.B RUNDIR
|
||||||
|
have not been mounted when the DHCP client is started.
|
||||||
|
.TP
|
||||||
|
.BI \-cf \ config-file
|
||||||
|
Path to the client configuration file. If unspecified, the default
|
||||||
|
.B ETCDIR/dhclient.conf
|
||||||
|
is used. See \fBdhclient.conf(5)\fR for a description of this file.
|
||||||
|
.TP
|
||||||
|
.BI \-lf \ lease-file
|
||||||
|
Path to the lease database file. If unspecified, the default
|
||||||
|
.B DBDIR/dhclient.leases
|
||||||
|
is used. See \fBdhclient.leases(5)\fR for a descriptionof this file.
|
||||||
|
.TP
|
||||||
|
.BI \-pf \ pid-file
|
||||||
|
Path to the process ID file. If unspecified, the default
|
||||||
|
.B RUNDIR/dhclient.pid
|
||||||
|
is used.
|
||||||
|
.TP
|
||||||
|
.BI \-sf \ script-file
|
||||||
|
Path to the network configuration script invoked by
|
||||||
|
.B dhclient
|
||||||
|
when it gets a lease. If unspecified, the default
|
||||||
|
.B CLIENTBINDIR/dhclient-script
|
||||||
|
is used. See \fBdhclient-script(8)\fR for a description of this file.
|
||||||
|
|
||||||
|
|
||||||
.PP
|
.PP
|
||||||
The client can also be instructed to become a daemon immediately, rather
|
|
||||||
than waiting until it has acquired an IP address. This can be done by
|
|
||||||
supplying the
|
|
||||||
.B -nw
|
|
||||||
flag.
|
|
||||||
.SH CONFIGURATION
|
.SH CONFIGURATION
|
||||||
The syntax of the dhclient.conf(5) file is discussed separately.
|
The syntax of the \fBdhclient.conf(5)\fR file is discussed separately.
|
||||||
.SH OMAPI
|
.SH OMAPI
|
||||||
The DHCP client provides some ability to control it while it is
|
The DHCP client provides some ability to control it while it is
|
||||||
running, without stopping it. This capability is provided using OMAPI,
|
running, without stopping it. This capability is provided using OMAPI,
|
||||||
@ -382,7 +402,8 @@ current status and make changes to it.
|
|||||||
Rather than implementing the underlying OMAPI protocol directly, user
|
Rather than implementing the underlying OMAPI protocol directly, user
|
||||||
programs should use the dhcpctl API or OMAPI itself. Dhcpctl is a
|
programs should use the dhcpctl API or OMAPI itself. Dhcpctl is a
|
||||||
wrapper that handles some of the housekeeping chores that OMAPI does
|
wrapper that handles some of the housekeeping chores that OMAPI does
|
||||||
not do automatically. Dhcpctl and OMAPI are documented in \fBdhcpctl(3)\fR
|
not do automatically. Dhcpctl and OMAPI are documented in
|
||||||
|
\fBdhcpctl(3)\fR
|
||||||
and \fBomapi(3)\fR. Most things you'd want to do with the client can
|
and \fBomapi(3)\fR. Most things you'd want to do with the client can
|
||||||
be done directly using the \fBomshell(1)\fR command, rather than
|
be done directly using the \fBomshell(1)\fR command, rather than
|
||||||
having to write a special program.
|
having to write a special program.
|
||||||
@ -403,6 +424,25 @@ the client down, set its state attribute to 2. It will automatically
|
|||||||
do a DHCPRELEASE. To pause it, set its state attribute to 3. To
|
do a DHCPRELEASE. To pause it, set its state attribute to 3. To
|
||||||
resume it, set its state attribute to 4.
|
resume it, set its state attribute to 4.
|
||||||
.PP
|
.PP
|
||||||
|
.SH ENVIRONMENT VARIABLES
|
||||||
|
.PP
|
||||||
|
The following environment variables may be defined
|
||||||
|
to override the builtin defaults for file locations.
|
||||||
|
Note that use of the related command-line options
|
||||||
|
will ignore the corresponding environment variable settings.
|
||||||
|
.TP
|
||||||
|
.B PATH_DHCLIENT_CONF
|
||||||
|
The dhclient.conf configuration file.
|
||||||
|
.TP
|
||||||
|
.B PATH_DHCLIENT_DB
|
||||||
|
The dhclient.leases database.
|
||||||
|
.TP
|
||||||
|
.B PATH_DHCLIENT_PID
|
||||||
|
The dhclient PID file.
|
||||||
|
.TP
|
||||||
|
.B PATH_DHCLIENT_SCRIPT
|
||||||
|
The dhclient-script file.
|
||||||
|
.PP
|
||||||
.SH FILES
|
.SH FILES
|
||||||
.B CLIENTBINDIR/dhclient-script,
|
.B CLIENTBINDIR/dhclient-script,
|
||||||
.B ETCDIR/dhclient.conf, DBDIR/dhclient.leases, RUNDIR/dhclient.pid,
|
.B ETCDIR/dhclient.conf, DBDIR/dhclient.leases, RUNDIR/dhclient.pid,
|
||||||
|
164
server/dhcpd.8
164
server/dhcpd.8
@ -28,7 +28,7 @@
|
|||||||
.\" Support and other services are available for ISC products - see
|
.\" Support and other services are available for ISC products - see
|
||||||
.\" https://www.isc.org for more information or to learn more about ISC.
|
.\" 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 $
|
.\" $Id: dhcpd.8,v 1.33 2010/07/14 20:01:14 sar Exp $
|
||||||
.\"
|
.\"
|
||||||
.TH dhcpd 8
|
.TH dhcpd 8
|
||||||
.SH NAME
|
.SH NAME
|
||||||
@ -106,6 +106,13 @@ pool of IP addresses for its network. In order for this to work, the
|
|||||||
network administrator allocates address pools in each subnet and
|
network administrator allocates address pools in each subnet and
|
||||||
enters them into the dhcpd.conf(5) file.
|
enters them into the dhcpd.conf(5) file.
|
||||||
.PP
|
.PP
|
||||||
|
There are two versions of the DHCP protocol DHCPv4 and DHCPv6. At
|
||||||
|
startup the server may be started for one or the other via the
|
||||||
|
.B -4
|
||||||
|
or
|
||||||
|
.B -6
|
||||||
|
arguments.
|
||||||
|
.PP
|
||||||
On startup, dhcpd reads the
|
On startup, dhcpd reads the
|
||||||
.IR dhcpd.conf
|
.IR dhcpd.conf
|
||||||
file and stores a list of available addresses on each subnet in
|
file and stores a list of available addresses on each subnet in
|
||||||
@ -177,87 +184,106 @@ are specified on the command line dhcpd will identify all network
|
|||||||
interfaces which are up, eliminating non-broadcast interfaces if
|
interfaces which are up, eliminating non-broadcast interfaces if
|
||||||
possible, and listen for DHCP broadcasts on each interface.
|
possible, and listen for DHCP broadcasts on each interface.
|
||||||
.PP
|
.PP
|
||||||
The server either operates as a DHCPv6 server or a DHCP server, but
|
.SH COMMAND LINE OPTIONS
|
||||||
not both at the same time. To run as a DHCPv6 server, use the
|
.TP
|
||||||
.B -6
|
.BI \-4
|
||||||
flag. To run as a DHCP server, use the
|
Run as a DHCP server. This cannot be combined with \fB\-6\fR.
|
||||||
.B -4
|
.TP
|
||||||
flag. If neither is used, the default is to run as a DHCPv6 server.
|
.BI \-6
|
||||||
.PP
|
Run as a DHCPv6 server. This is the default and cannot be combined
|
||||||
If dhcpd should listen on a port other than the standard (port 67),
|
with \fB\-4\fR.
|
||||||
the
|
.TP
|
||||||
.B -p
|
.BI \-p \ port
|
||||||
flag may used. It should be followed by the udp port number on which
|
The udp port number on which
|
||||||
dhcpd should listen. This is mostly useful for debugging purposes.
|
.B dhcpd
|
||||||
.PP
|
should listen. If unspecified
|
||||||
If dhcpd should send replies to an address other than the broadcast
|
.B dhcpd
|
||||||
address (255.255.255.255), the
|
uses the default port of 67. This is mostly useful for debugging
|
||||||
.B -s
|
purposes.
|
||||||
flag may be used. It is followed by either the IP address or the host
|
.TP
|
||||||
name to send replies to. This option is only supported in IPv4.
|
.BI \-s \ address
|
||||||
.PP
|
Specify an address or host name to which
|
||||||
To run dhcpd as a foreground process, rather than allowing it to run
|
.B dhcpd
|
||||||
as a daemon in the background, the
|
should send replies rather than the broadcast address (255.255.255.255).
|
||||||
.B -f
|
This option is only supported in IPv4.
|
||||||
flag should be specified. This is useful when running dhcpd under a
|
.TP
|
||||||
debugger, or when running it out of inittab on System V systems.
|
.BI \-f
|
||||||
.PP
|
Force
|
||||||
To have dhcpd log to the standard error descriptor, specify the
|
.B dhcpd
|
||||||
.B -d
|
to run as a foreground process instead of as a daemon in the background.
|
||||||
flag. This can be useful for debugging, and also at sites where a
|
This is useful when running
|
||||||
|
.B dhcpd
|
||||||
|
under a debugger, or when running it
|
||||||
|
out of inittab on System V systems.
|
||||||
|
.TP
|
||||||
|
.BI \-d
|
||||||
|
Send log messages to the standard error descriptor.
|
||||||
|
This can be useful for debugging, and also at sites where a
|
||||||
complete log of all dhcp activity must be kept but syslogd is not
|
complete log of all dhcp activity must be kept but syslogd is not
|
||||||
reliable or otherwise cannot be used. Normally, dhcpd will log all
|
reliable or otherwise cannot be used. Normally,
|
||||||
output using the syslog(3) function with the log facility set to
|
.B dhcpd
|
||||||
LOG_DAEMON. Note that -d implies -f (the daemon will not fork
|
will log all
|
||||||
itself into the background).
|
output using the \fBsyslog(3)\fR function with the log facility set to
|
||||||
.PP
|
LOG_DAEMON. Note that \fB\-d\fR implies \fB\-f\fR (the daemon will
|
||||||
Dhcpd can be made to use an alternate configuration file with the
|
not fork itself into the background).
|
||||||
.B -cf
|
.TP
|
||||||
flag, an alternate lease file with the
|
.BI \-q
|
||||||
.B -lf
|
Be quiet at startup. This suppresses the printing of the entire
|
||||||
flag, or an alternate pid file with the
|
copyright message during startup. This might be desirable when
|
||||||
.B -pf
|
starting
|
||||||
flag. Because of the importance of using the same lease database at
|
.B dhcpd
|
||||||
all times when running dhcpd in production, these options should be
|
from a system startup script (e.g., /etc/rc).
|
||||||
used \fBonly\fR for testing lease files or database files in a
|
.TP
|
||||||
non-production environment.
|
.BI \-t
|
||||||
.PP
|
Test the configuration file. The server tests the configuration file
|
||||||
When starting dhcpd up from a system startup script (e.g., /etc/rc),
|
|
||||||
it may not be desirable to print out the entire copyright message on
|
|
||||||
startup. To avoid printing this message, the
|
|
||||||
.B -q
|
|
||||||
flag may be specified.
|
|
||||||
.PP
|
|
||||||
The DHCP server reads two files on startup: a configuration file, and
|
|
||||||
a lease database. If the
|
|
||||||
.B -t
|
|
||||||
flag is specified, the server will simply test the configuration file
|
|
||||||
for correct syntax, but will not attempt to perform any network
|
for correct syntax, but will not attempt to perform any network
|
||||||
operations. This can be used to test the a new configuration file
|
operations. This can be used to test a new configuration file
|
||||||
automatically before installing it.
|
automatically before installing it.
|
||||||
.PP
|
.TP
|
||||||
The
|
.BI \-T
|
||||||
.B -T
|
Test the lease file. The server tests the lease file
|
||||||
flag can be used to test the lease database file in a similar way.
|
for correct syntax, but will not attempt to perform any network
|
||||||
.PP
|
operations. This can be used to test a new leaes file
|
||||||
The \fB-tf\fR and \fB-play\fR options allow you to specify a file into
|
automatically before installing it.
|
||||||
which the entire startup state of the server and all the transactions
|
.TP
|
||||||
it processes are either logged or played back from. This can be
|
.BI \-tf \ tracefile
|
||||||
|
Specify a file into which the entire startup state of the server and
|
||||||
|
all the transactions it processes are logged. This can be
|
||||||
useful in submitting bug reports - if you are getting a core dump
|
useful in submitting bug reports - if you are getting a core dump
|
||||||
every so often, you can start the server with the \fB-tf\fR option and
|
every so often, you can start the server with the \fB-tf\fR option and
|
||||||
then, when the server dumps core, the trace file will contain all the
|
then, when the server dumps core, the trace file will contain all the
|
||||||
transactions that led up to it dumping core, so that the problem can
|
transactions that led up to it dumping core, so that the problem can
|
||||||
be easily debugged with \fB-play\fR.
|
be easily debugged with \fB-play\fR.
|
||||||
.PP
|
.TP
|
||||||
The \fB-play\fR option must be specified with an alternate lease file,
|
.BI \-play \ playfile
|
||||||
|
Specify a file from which the entire startup state of the server and
|
||||||
|
all the transactions it processed are read. The \fB-play\fR option
|
||||||
|
must be specified with an alternate lease file,
|
||||||
using the \fB-lf\fR switch, so that the DHCP server doesn't wipe out
|
using the \fB-lf\fR switch, so that the DHCP server doesn't wipe out
|
||||||
your existing lease file with its test data. The DHCP server will
|
your existing lease file with its test data. The DHCP server will
|
||||||
refuse to operate in playback mode unless you specify an alternate
|
refuse to operate in playback mode unless you specify an alternate
|
||||||
lease file.
|
lease file.
|
||||||
|
.TP
|
||||||
|
.BI --version
|
||||||
|
Print version number and exit.
|
||||||
|
.PP
|
||||||
|
.I Modifying default file locations:
|
||||||
|
The following options can be used to modify the locations
|
||||||
|
.B dhcpd
|
||||||
|
uses for it's files. Because of the importance of using the same
|
||||||
|
lease database at all times when running dhcpd in production, these
|
||||||
|
options should be used \fBonly\fR for testing lease files or database
|
||||||
|
files in a non-production environment.
|
||||||
|
.TP
|
||||||
|
.BI \-cf \ config-file
|
||||||
|
Path to alternate configuration file.
|
||||||
|
.TP
|
||||||
|
.BI \-lf \ lease-file
|
||||||
|
Path to alternate lease file.
|
||||||
|
.TP
|
||||||
|
.BI \-pf \ pid-file
|
||||||
|
Path to alternate pid file.
|
||||||
.PP
|
.PP
|
||||||
To find the version of dhcpd that will run, use the
|
|
||||||
.B --version
|
|
||||||
argument. Instead of running, the version will be printed.
|
|
||||||
.SH CONFIGURATION
|
.SH CONFIGURATION
|
||||||
The syntax of the dhcpd.conf(5) file is discussed separately. This
|
The syntax of the dhcpd.conf(5) file is discussed separately. This
|
||||||
section should be used as an overview of the configuration process,
|
section should be used as an overview of the configuration process,
|
||||||
|
Loading…
x
Reference in New Issue
Block a user