sbin/dhclient/dhclient.8

   1 .\" $OpenBSD: src/sbin/dhclient/dhclient.8,v 1.8 2011/03/02 07:44:42 jmc Exp $
   2 .\"
   3 .\" Copyright (c) 1997 The Internet Software Consortium.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\"
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. Neither the name of The Internet Software Consortium nor the names
  16 .\"    of its contributors may be used to endorse or promote products derived
  17 .\"    from this software without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND
  20 .\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  21 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  22 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  23 .\" DISCLAIMED.  IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR
  24 .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  27 .\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  28 .\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\" This software has been written for the Internet Software Consortium
  34 .\" by Ted Lemon <mellon@fugue.com> in cooperation with Vixie
  35 .\" Enterprises.  To learn more about the Internet Software Consortium,
  36 .\" see ``http://www.isc.org/isc''.  To learn more about Vixie
  37 .\" Enterprises, see ``http://www.vix.com''.
  38 .Dd July 23, 2013
  39 .Dt DHCLIENT 8
  40 .Os
  41 .Sh NAME
  42 .Nm dhclient
  43 .Nd Dynamic Host Configuration Protocol (DHCP) client
  44 .Sh SYNOPSIS
  45 .Nm
  46 .Op Fl dqu
  47 .Op Fl c Ar file
  48 .Op Fl l Ar file
  49 .Ar interface
  50 .Sh DESCRIPTION
  51 The Dynamic Host Configuration Protocol (DHCP) allows hosts on a TCP/IP network
  52 to configure one or more network interfaces based on information collected from
  53 a DHCP server.
  54 DHCP is often used, for example, by cable modem and DSL network
  55 providers to automate network configuration for their customers.
  56 .Pp
  57 Information typically provided via DHCP includes
  58 address and subnet mask for the interface,
  59 default route,
  60 and domain name server.
  61 .Pp
  62 To have
  63 .Dx
  64 configure an interface using DHCP
  65 (or its predecessor, BOOTP)
  66 the
  67 .Nm
  68 utility is used.
  69 .Nm
  70 is run on the command line with the name of the
  71 .Ar interface
  72 to be configured.
  73 .Pp
  74 The options are as follows:
  75 .Bl -tag -width "-p port"
  76 .It Fl c Ar file
  77 Specify an alternate location to
  78 .Pa /etc/dhclient.conf
  79 for the configuration file.
  80 .It Fl d
  81 Forces
  82 .Nm
  83 to always run as a foreground process.
  84 By default,
  85 .Nm
  86 runs in the foreground until it has configured the interface, and then
  87 will revert to running in the background.
  88 .It Fl l Ar file
  89 Specify an alternate location to
  90 .Pa /var/db/dhclient.leases. Ns Aq Ar IFNAME
  91 for the leases file.
  92 .It Fl q
  93 Forces
  94 .Nm
  95 to be less verbose on startup.
  96 .It Fl u
  97 Forces
  98 .Nm
  99 to reject leases with unknown options in them.
 100 The default behaviour is to accept such lease offers.
 101 .El
 102 .Pp
 103 The DHCP protocol allows a host to contact a central server which
 104 maintains a list of IP addresses which may be assigned on one or more
 105 subnets.
 106 A DHCP client may request an address from this pool, and
 107 then use it on a temporary basis for communication on the network.
 108 The DHCP protocol also provides a mechanism whereby a client can learn
 109 important details about the network to which it is attached, such as
 110 the location of a default router, the location of a name server, and
 111 so on.
 112 .Pp
 113 On startup,
 114 .Nm
 115 reads
 116 .Pa /etc/dhclient.conf
 117 for configuration instructions.
 118 It then attempts to configure the network interface
 119 .Ar interface
 120 with DHCP.
 121 .Pp
 122 In order to keep track of leases across system reboots and server
 123 restarts,
 124 .Nm
 125 keeps a list of leases it has been assigned in the
 126 .Pa /var/db/dhclient.leases. Ns Aq Ar IFNAME
 127 file.
 128 .Ar IFNAME
 129 represents the network interface of the DHCP client
 130 .Pq e.g. em0 ,
 131 one for each interface.
 132 On startup, after reading the
 133 .Xr dhclient.conf 5
 134 file,
 135 .Nm
 136 reads the leases file to refresh its memory about what leases it has been
 137 assigned.
 138 .Pp
 139 Old leases are kept around in case the DHCP server is unavailable when
 140 .Nm
 141 is first invoked (generally during the initial system boot
 142 process).
 143 In that event, old leases from the
 144 .Pa dhclient.leases. Ns Aq Ar IFNAME
 145 file which have not yet expired are tested, and if they are determined to
 146 be valid, they are used until either they expire or the DHCP server
 147 becomes available.
 148 .Pp
 149 A mobile host which may sometimes need to access a network on which no
 150 DHCP server exists may be preloaded with a lease for a fixed
 151 address on that network.
 152 When all attempts to contact a DHCP server have failed,
 153 .Nm
 154 will try to validate the static lease, and if it
 155 succeeds, it will use that lease until it is restarted.
 156 .Pp
 157 A mobile host may also travel to some networks on which DHCP is not
 158 available but BOOTP is.
 159 In that case, it may be advantageous to
 160 arrange with the network administrator for an entry on the BOOTP
 161 database, so that the host can boot quickly on that network rather
 162 than cycling through the list of old leases.
 163 .Pp
 164 .Nm
 165 requires at least one
 166 .Pa /dev/bpf*
 167 file for each broadcast network interface.
 168 See
 169 .Xr bpf 4
 170 for more information.
 171 .Sh FILES
 172 .Bl -tag -width "/var/db/dhclient.leases.<IFNAME>XXX" -compact
 173 .It Pa /etc/dhclient.conf
 174 DHCP client configuration file
 175 .It Pa /var/db/dhclient.leases. Ns Aq Ar IFNAME
 176 database of acquired leases
 177 .El
 178 .Sh SEE ALSO
 179 .Xr bpf 4 ,
 180 .Xr dhclient.conf 5 ,
 181 .Xr dhclient.leases 5 ,
 182 .Xr dhclient-script 8 ,
 183 .Xr dhcp 8 ,
 184 .Xr dhcpd 8 Pq Pa net/isc-dhcp42-server ,
 185 .Xr dhcrelay 8 Pq Pa net/isc-dhcp42-relay
 186 .Sh STANDARDS
 187 .Rs
 188 .%A R. Droms
 189 .%D October 1993
 190 .%R RFC 1534
 191 .%T Interoperation Between DHCP and BOOTP
 192 .Re
 193 .Pp
 194 .Rs
 195 .%A R. Droms
 196 .%D March 1997
 197 .%R RFC 2131
 198 .%T Dynamic Host Configuration Protocol
 199 .Re
 200 .Pp
 201 .Rs
 202 .%A S. Alexander
 203 .%A R. Droms
 204 .%D March 1997
 205 .%R RFC 2132
 206 .%T DHCP Options and BOOTP Vendor Extensions
 207 .Re
 208 .Pp
 209 .Rs
 210 .%A T. Lemon
 211 .%A S. Cheshire
 212 .%D November 2002
 213 .%R RFC 3396
 214 .%T Encoding Long Options in the Dynamic Host Configuration Protocol (DHCPv4)
 215 .Re
 216 .Pp
 217 .Rs
 218 .%A T. Lemon
 219 .%A S. Cheshire
 220 .%A B. Volz
 221 .%D December 2002
 222 .%R RFC 3442
 223 .%T The Classless Static Route Option for Dynamic Host Configuration Protocol (DHCP) version 4
 224 .Re
 225 .Sh HISTORY
 226 .Nm
 227 was imported into
 228 .Dx 2.1 .
 229 .Sh AUTHORS
 230 .An -nosplit
 231 .Nm
 232 was written by
 233 .An Ted Lemon Aq Mt mellon@fugue.com
 234 and
 235 .An Elliot Poger Aq Mt elliot@poger.com .
 236 .Pp
 237 The current implementation was reworked by
 238 .An Henning Brauer Aq Mt henning@openbsd.org .