Print this page
12305 typos in dhcp man pages
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1m/dhcpagent.1m
+++ new/usr/src/man/man1m/dhcpagent.1m
1 1 '\" te
2 2 .\" Copyright (c) 1992-1996 Competitive Automation, Inc. Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
3 3 .\" Copyright (c) 2016-2017, Chris Fraire <cfraire@me.com>.
4 4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
5 5 .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the
6 6 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 -.TH DHCPAGENT 1M "Jun 30, 2017"
7 +.TH DHCPAGENT 1M "Feb 13, 2020"
8 8 .SH NAME
9 9 dhcpagent \- Dynamic Host Configuration Protocol (DHCP) client daemon
10 10 .SH SYNOPSIS
11 -.LP
12 11 .nf
13 12 \fBdhcpagent\fR [\fB-a\fR] [ \fB-d\fR \fIn\fR] [\fB-f\fR] [\fB-v\fR]
14 13 .fi
15 14
16 15 .SH DESCRIPTION
17 -.LP
18 16 \fBdhcpagent\fR implements the client half of the Dynamic Host Configuration
19 17 Protocol \fB(DHCP)\fR for machines running illumos software.
20 18 .sp
21 19 .LP
22 20 The \fBdhcpagent\fR daemon obtains configuration parameters for the client
23 21 (local) machine's network interfaces from a \fBDHCP\fR server. These parameters
24 22 may include a lease on an \fBIP\fR address, which gives the client machine use
25 23 of the address for the period of the lease, which may be infinite. If the
26 24 client wishes to use the \fBIP\fR address for a period longer than the lease,
27 25 it must negotiate an extension using \fBDHCP\fR. For this reason,
28 26 \fBdhcpagent\fR must run as a daemon, terminating only when the client machine
29 27 powers down.
30 28 .sp
31 29 .LP
32 30 For IPv4, the \fBdhcpagent\fR daemon is controlled through \fBipadm\fR(1M),
33 31 \fBnwamcfg\fR(1M), or \fBifconfig\fR(1M) in much the same way that the
34 32 \fBinit\fR(1M) daemon is controlled by \fBtelinit\fR(1M). \fBdhcpagent\fR can
35 33 be invoked as a user process, albeit one requiring root privileges, but this is
36 34 not necessary, as \fBipadm\fR(1M), \fBnwamcfg\fR(1M), or \fBifconfig\fR(1M)
37 35 will start \fBdhcpagent\fR automatically.
38 36 .sp
39 37 .LP
40 38 For IPv6, the \fBdhcpagent\fR daemon is invoked automatically by
41 39 \fBin.ndpd\fR(1M). It can also be controlled through \fBifconfig\fR(1M), if
42 40 necessary.
43 41 .sp
44 42 .LP
45 43 When invoked, \fBdhcpagent\fR enters a passive state while it awaits
46 44 instructions from \fBipadm\fR(1M), \fBnwamcfg\fR(1M), \fBifconfig\fR(1M), or
47 45 \fBin.ndpd\fR(1M). When \fBdhcpagent\fR receives a command to configure an
48 46 interface, \fBdhcpagent\fR brings up the interface (if necessary) and starts
49 47 DHCP. Once DHCP is complete, \fBdhcpagent\fR can be queried for the values of
50 48 the various network parameters. In addition, if DHCP was used to obtain a lease
51 49 on an address for an interface, \fBdhcpagent\fR configures the address for use.
52 50 When a lease is obtained, it is automatically renewed as necessary. If the
53 51 lease cannot be renewed, \fBdhcpagent\fR will unconfigure the address, but the
54 52 interface will be left up, and \fBdhcpagent\fR will attempt to acquire a new
55 53 address lease.
56 54 .sp
57 55 .LP
58 56 \fBdhcpagent\fR monitors system suspend/resume events and will validate any
59 57 non-permanent leases with the DHCP server upon resume. Similarly,
60 58 \fBdhcpagent\fR monitors link up/down events and will validate any
61 59 non-permanent leases with the DHCP server when the downed link is brought back
62 60 up. The lease validation mechanism will restart DHCP if the server indicates
63 61 that the existing lease is no longer valid. If the server cannot be contacted,
64 62 then the existing lease will continue. This behavior can be modified with the
65 63 \fBVERIFIED_LEASE_ONLY\fR parameter in the \fB/etc/default/dhcpagent\fR file.
66 64 See the description of this parameter below.
67 65 .sp
68 66 .LP
69 67 For IPv4, if the configured interface is found to be unplumbed, or to have a
70 68 different IP address, subnet mask, or broadcast address from those obtained
71 69 from DHCP, the interface is abandoned from DHCP control.
72 70 .sp
73 71 .LP
74 72 For IPv6, \fBdhcpagent\fR automatically plumbs and unplumbs logical interfaces
75 73 as necessary for the IPv6 addresses supplied by the server. The IPv6 prefix
76 74 length (netmask) is not set by the DHCPv6 protocol, but is instead set by
77 75 \fBin.ndpd\fR(1M) using prefix information obtained by Router Advertisements.
78 76 If any of the logical interfaces created by \fBdhcpagent\fR is unplumbed, or
79 77 configured with a different IP address, it will be abandoned from DHCP control.
80 78 If the link-local interface is unplumbed, then all addresses configured by DHCP
81 79 on that physical interface will be removed.
82 80 .sp
83 81 .LP
84 82 In addition to \fBDHCP\fR, \fBdhcpagent\fR also supports \fBBOOTP\fR (IPv4
85 83 only). See \fIRFC 951, Bootstrap Protocol\fR. Configuration parameters obtained
86 84 from a \fBBOOTP\fR server are treated identically to those received from a
87 85 \fBDHCP\fR server, except that the \fBIP\fR address received from a \fBBOOTP\fR
88 86 server always has an infinite lease.
89 87 .sp
90 88 .LP
91 89 \fBDHCP\fR also acts as a mechanism to configure other information needed by
92 90 the client, for example, the domain name and addresses of routers. Aside from
93 91 the IP address, and for IPv4 alone, the netmask, broadcast address, and default
94 92 router, the agent does not directly configure the workstation, but instead acts
95 93 as a database which may be interrogated by other programs, and in particular by
96 94 \fBdhcpinfo\fR(1).
97 95 .sp
98 96 .LP
99 97 On clients with a single interface, this is quite straightforward. Clients with
100 98 multiple interfaces may present difficulties, as it is possible that some
101 99 information arriving on different interfaces may need to be merged, or may be
102 100 inconsistent. Furthermore, the configuration of the interfaces is asynchronous,
103 101 so requests may arrive while some or all of the interfaces are still
104 102 unconfigured. To handle these cases, one interface may be designated as
105 103 primary, which makes it the authoritative source for the values of \fBDHCP\fR
106 104 parameters in the case where no specific interface is requested. See
107 105 \fBdhcpinfo\fR(1) and \fBifconfig\fR(1M) for details.
108 106 .sp
109 107 .LP
110 108 For IPv4, the \fBdhcpagent\fR daemon can be configured to request a particular
111 109 Fully Qualified Domain Name (FQDN) or host name. See the \fBREQUEST_FQDN\fR or
112 110 \fBREQUEST_HOSTNAME\fR description in the \fBFILES\fR section. When first
113 111 configuring a client to request an FQDN or host name, you must perform the
114 112 following steps as root to ensure that the full DHCP negotiation takes place:
115 113 .sp
116 114 .in +2
117 115 .nf
118 116 # pkill dhcpagent
119 117 # rm /etc/dhcp/\fIinterface\fR.dhc
120 118 # reboot
121 119 .fi
122 120 .in -2
123 121 .sp
124 122
125 123 .sp
126 124 .LP
127 125 All DHCP packets sent by \fBdhcpagent\fR include a vendor class identifier (RFC
128 126 2132, option code 60; RFC 3315, option code 16). This identifier is the same as
129 127 the platform name returned by the \fBuname\fR \fB-i\fR command, except:
130 128 .RS +4
131 129 .TP
132 130 .ie t \(bu
133 131 .el o
|
↓ open down ↓ |
106 lines elided |
↑ open up ↑ |
134 132 Any commas in the platform name are changed to periods.
135 133 .RE
136 134 .RS +4
137 135 .TP
138 136 .ie t \(bu
139 137 .el o
140 138 If the name does not start with a stock symbol and a comma, it is automatically
141 139 prefixed with \fBSUNW\fR.
142 140 .RE
143 141 .SS "Messages"
144 -.LP
145 142 The \fBdhcpagent\fR daemon writes information and error messages in five
146 143 categories:
147 144 .sp
148 145 .ne 2
149 146 .na
150 147 \fBcritical\fR
151 148 .ad
152 149 .sp .6
153 150 .RS 4n
154 151 Critical messages indicate severe conditions that prevent proper operation.
155 152 .RE
156 153
157 154 .sp
158 155 .ne 2
159 156 .na
160 157 \fBerrors\fR
161 158 .ad
162 159 .sp .6
163 160 .RS 4n
164 161 Error messages are important, sometimes unrecoverable events due to resource
165 162 exhaustion and other unexpected failure of system calls; ignoring errors may
166 163 lead to degraded functionality.
167 164 .RE
168 165
169 166 .sp
170 167 .ne 2
171 168 .na
172 169 \fBwarnings\fR
173 170 .ad
174 171 .sp .6
175 172 .RS 4n
176 173 Warnings indicate less severe problems, and in most cases, describe unusual or
177 174 incorrect datagrams received from servers, or requests for service that cannot
178 175 be provided.
179 176 .RE
180 177
181 178 .sp
182 179 .ne 2
183 180 .na
184 181 \fBinformational\fR
185 182 .ad
186 183 .sp .6
187 184 .RS 4n
188 185 Informational messages provide key pieces of information that can be useful to
189 186 debugging a \fBDHCP\fR configuration at a site. Informational messages are
190 187 generally controlled by the \fB-v\fR option. However, certain critical pieces
191 188 of information, such as the IP address obtained, are always provided.
192 189 .RE
193 190
194 191 .sp
195 192 .ne 2
196 193 .na
197 194 \fBdebug\fR
198 195 .ad
199 196 .sp .6
200 197 .RS 4n
201 198 Debugging messages, which may be generated at two different levels of
202 199 verbosity, are chiefly of benefit to persons having access to source code, but
203 200 may be useful as well in debugging difficult DHCP configuration problems.
|
↓ open down ↓ |
49 lines elided |
↑ open up ↑ |
204 201 Debugging messages are only generated when using the \fB-d\fR option.
205 202 .RE
206 203
207 204 .sp
208 205 .LP
209 206 When \fBdhcpagent\fR is run without the \fB-f\fR option, all messages are sent
210 207 to the system logger \fBsyslog\fR(3C) at the appropriate matching priority and
211 208 with a facility identifier \fBLOG_DAEMON\fR. When \fBdhcpagent\fR is run with
212 209 the \fB-f\fR option, all messages are directed to standard error.
213 210 .SS "DHCP Events and User-Defined Actions"
214 -.LP
215 211 If an executable (binary or script) is placed at \fB/etc/dhcp/eventhook\fR, the
216 212 \fBdhcpagent\fR daemon will automatically run that program when any of the
217 213 following events occur:
218 214 .sp
219 215 .ne 2
220 216 .na
221 217 \fB\fBBOUND\fR and \fBBOUND6\fR\fR
222 218 .ad
223 219 .sp .6
224 220 .RS 4n
225 221 These events occur during interface configuration. The event program is invoked
226 222 when \fBdhcpagent\fR receives the DHCPv4 ACK or DHCPv6 Reply message from the
227 223 DHCP server for the lease request of an address, indicating successful initial
228 224 configuration of the interface. (See also the \fBINFORM\fR and \fBINFORM6\fR
229 225 events, which occur when configuration parameters are obtained without address
230 226 leases.)
231 227 .RE
232 228
233 229 .sp
234 230 .ne 2
235 231 .na
236 232 \fB\fBEXTEND\fR and \fBEXTEND6\fR\fR
237 233 .ad
238 234 .sp .6
239 235 .RS 4n
240 236 These events occur during lease extension. The event program is invoked just
241 237 after \fBdhcpagent\fR receives the DHCPv4 ACK or DHCPv6 Reply from the DHCP
242 238 server for the DHCPv4 REQUEST (renew) message or the DHCPv6 Renew or Rebind
243 239 message.
244 240 .sp
245 241 Note that with DHCPv6, the server might choose to remove some addresses, add
246 242 new address leases, and ignore (allow to expire) still other addresses in a
247 243 given Reply message. The \fBEXTEND6\fR event occurs when a Reply is received
248 244 that leaves one or more address leases still valid, even if the Reply message
249 245 does not extend the lease for any address. The event program is invoked just
250 246 before any addresses are removed, but just after any new addresses are added.
251 247 Those to be removed will be marked with the \fBIFF_DEPRECATED\fR flag.
252 248 .RE
253 249
254 250 .sp
255 251 .ne 2
256 252 .na
257 253 \fB\fBEXPIRE\fR and \fBEXPIRE6\fR\fR
258 254 .ad
259 255 .sp .6
260 256 .RS 4n
261 257 These events occur during lease expiration. For DHCPv4, the event program is
262 258 invoked just before the leased address is removed from an interface. For
263 259 DHCPv6, the event program is invoked just before the last remaining leased
264 260 addresses are removed from the interface.
265 261 .RE
266 262
267 263 .sp
268 264 .ne 2
269 265 .na
270 266 \fB\fBDROP\fR and \fBDROP6\fR\fR
271 267 .ad
272 268 .sp .6
273 269 .RS 4n
274 270 These events occur during the period when an interface is dropped. The event
275 271 program is invoked just before the interface is removed from DHCP control. If
276 272 the interface has been abandoned due the user unplumbing the interface, then
277 273 this event will occur after the user's action has taken place. The interface
278 274 might not be present.
279 275 .RE
280 276
281 277 .sp
282 278 .ne 2
283 279 .na
284 280 \fB\fBINFORM\fR and \fBINFORM6\fR\fR
285 281 .ad
286 282 .sp .6
287 283 .RS 4n
288 284 These events occur when an interface acquires new or updated configuration
289 285 information from a DHCP server by means of the DHCPv4 \fBINFORM\fR or the
290 286 DHCPv6 Information-Request message. These messages are sent using an
291 287 \fBifconfig\fR(1M) \fBdhcp inform\fR command or when the DHCPv6 Router
292 288 Advertisement \fBO\fR (letter 0) bit is set and the \fBM\fR bit is not set.
293 289 Thus, these events occur when the DHCP client does not obtain an IP address
294 290 lease from the server, and instead obtains only configuration parameters.
295 291 .RE
296 292
297 293 .sp
298 294 .ne 2
299 295 .na
300 296 \fB\fBLOSS6\fR\fR
301 297 .ad
302 298 .sp .6
303 299 .RS 4n
304 300 This event occurs during lease expiration when one or more valid leases still
305 301 remain. The event program is invoked just before expired addresses are removed.
306 302 Those being removed will be marked with the \fBIFF_DEPRECATED\fR flag.
307 303 .sp
308 304 Note that this event is not associated with the receipt of the Reply message,
309 305 which occurs only when one or more valid leases remain, and occurs only with
310 306 DHCPv6. If all leases have expired, then the EXPIRE6 event occurs instead.
311 307 .RE
312 308
313 309 .sp
314 310 .ne 2
315 311 .na
316 312 \fB\fBRELEASE\fR and \fBRELEASE6\fR\fR
317 313 .ad
318 314 .sp .6
319 315 .RS 4n
320 316 This event occurs during the period when a leased address is released. The
321 317 event program is invoked just before \fBdhcpagent\fR relinquishes the address
322 318 on an interface and sends the DHCPv4 \fBRELEASE\fR or DHCPv6 Release packet to
323 319 the DHCP server.
324 320 .RE
325 321
326 322 .sp
327 323 .LP
328 324 The system does not provide a default event program. The file
329 325 \fB/etc/dhcp/eventhook\fR is expected to be owned by root and have a mode of
330 326 755.
331 327 .sp
332 328 .LP
333 329 The event program will be passed two arguments, the interface name and the
334 330 event name, respectively. For DHCPv6, the interface name is the name of the
335 331 physical interface.
336 332 .sp
337 333 .LP
338 334 The event program can use the \fBdhcpinfo\fR(1) utility to fetch additional
339 335 information about the interface. While the event program is invoked on every
340 336 event defined above, it can ignore those events in which it is not interested.
341 337 The event program runs with the same privileges and environment as
342 338 \fBdhcpagent\fR itself, except that \fBstdin\fR, \fBstdout\fR, and \fBstderr\fR
343 339 are redirected to \fB/dev/null\fR. Note that this means that the event program
|
↓ open down ↓ |
119 lines elided |
↑ open up ↑ |
344 340 runs with root privileges.
345 341 .sp
346 342 .LP
347 343 If an invocation of the event program does not exit after 55 seconds, it is
348 344 sent a \fBSIGTERM\fR signal. If does not exit within the next three seconds, it
349 345 is terminated by a \fBSIGKILL\fR signal.
350 346 .sp
351 347 .LP
352 348 See EXAMPLES for an example event program.
353 349 .SH OPTIONS
354 -.LP
355 350 The following options are supported:
356 351 .sp
357 352 .ne 2
358 353 .na
359 354 \fB\fB-a\fR\fR
360 355 .ad
361 356 .sp .6
362 357 .RS 4n
363 358 Adopt a configured IPv4 interface. This option is for use with diskless
364 359 \fBDHCP\fR clients. In the case of diskless \fBDHCP\fR, \fBDHCP\fR has already
365 360 been performed on the network interface providing the operating system image
366 361 prior to running \fBdhcpagent\fR. This option instructs the agent to take over
367 362 control of the interface. It is intended primarily for use in boot scripts.
368 363 .sp
369 364 The effect of this option depends on whether the interface is being adopted.
370 365 .sp
371 366 If the interface is being adopted, the following conditions apply:
372 367 .sp
373 368 \fBdhcpagent\fR uses the client id specified in
374 369 \fB/chosen\fR:\fI<client_id>\fR, as published by the PROM or as specified on a
375 370 \fBboot\fR(1M) command line. If this value is not present, the client id is
376 371 undefined. The DHCP server then determines what to use as a client id. It is an
377 372 error condition if the interface is an Infiniband interface and the PROM value
378 373 is not present.
379 374 .sp
380 375 If the interface is not being adopted:
381 376 .sp
382 377 \fBdhcpagent\fR uses the value stored in \fB/etc/default/dhcpagent\fR. If this
383 378 value is not present, the client id is undefined. If the interface is
384 379 Infiniband and there is no value in \fB/etc/default/dhcpagent\fR, a client id
385 380 is generated as described by the draft document on DHCP over Infiniband,
386 381 available at:
387 382 .sp
388 383 .in +2
389 384 .nf
390 385 http://www.ietf.org
391 386 .fi
392 387 .in -2
393 388
394 389 .RE
395 390
396 391 .sp
397 392 .ne 2
398 393 .na
399 394 \fB\fB-d\fR \fIn\fR\fR
400 395 .ad
401 396 .sp .6
402 397 .RS 4n
403 398 Set debug level to \fIn\fR. Two levels of debugging are currently available, 1
404 399 and 2; the latter is more verbose.
405 400 .RE
406 401
407 402 .sp
408 403 .ne 2
409 404 .na
410 405 \fB\fB-f\fR\fR
411 406 .ad
412 407 .sp .6
413 408 .RS 4n
414 409 Run in the foreground instead of as a daemon process. When this option is used,
415 410 messages are sent to standard error instead of to \fBsyslog\fR(3C).
416 411 .RE
417 412
418 413 .sp
|
↓ open down ↓ |
54 lines elided |
↑ open up ↑ |
419 414 .ne 2
420 415 .na
421 416 \fB\fB-v\fR\fR
422 417 .ad
423 418 .sp .6
424 419 .RS 4n
425 420 Provide verbose output useful for debugging site configuration problems.
426 421 .RE
427 422
428 423 .SH EXAMPLES
429 -.LP
430 424 \fBExample 1 \fRExample Event Program
431 425 .sp
432 426 .LP
433 427 The following script is stored in the file \fB/etc/dhcp/eventhook\fR, owned by
434 428 root with a mode of 755. It is invoked upon the occurrence of the events listed
435 429 in the file.
436 430
437 431 .sp
438 432 .in +2
439 433 .nf
440 434 #!/bin/sh
441 435
442 436 (
443 437 echo "Interface name: " $1
444 438 echo "Event: " $2
445 439
446 440 case $2 in
|
↓ open down ↓ |
7 lines elided |
↑ open up ↑ |
447 441 "BOUND")
448 442 echo "Address acquired from server "\e
449 443 `/sbin/dhcpinfo -i $1 ServerID`
450 444 ;;
451 445 "BOUND6")
452 446 echo "Addresses acquired from server " \e
453 447 `/sbin/dhcpinfo -v6 -i $1 ServerID`
454 448 ;;
455 449 "EXTEND")
456 450 echo "Lease extended for " \e
457 - `sbin/dhcpinfo -i $1 LeaseTim`" seconds"
451 + `/sbin/dhcpinfo -i $1 LeaseTim`" seconds"
458 452 ;;
459 453 "EXTEND6")
460 454 echo "New lease information obtained on $i"
461 455 ;;
462 456 "EXPIRE" | "DROP" | "RELEASE")
463 457 ;;
464 458
465 459 esac
466 460 ) >/var/run/dhcp_eventhook_output 2>&1
467 461 .fi
468 462 .in -2
469 463 .sp
470 464
471 465 .sp
472 466 .LP
473 467 Note the redirection of stdout and stderr to a file.
474 468
475 469 .SH FILES
476 470 .ne 2
477 471 .na
478 472 \fB\fB/etc/dhcp/\fIif\fR.dhc\fR\fR
479 473 .ad
480 474 .br
481 475 .na
482 476 \fB\fB/etc/dhcp/\fIif\fR.dh6\fR\fR
483 477 .ad
484 478 .sp .6
485 479 .RS 4n
486 480 Contains the configuration for interface. The mere existence of this file does
487 481 not imply that the configuration is correct, since the lease might have
488 482 expired. On start-up, \fBdhcpagent\fR confirms the validity of the address
489 483 using REQUEST (for DHCPv4) or Confirm (DHCPv6).
490 484 .RE
491 485
492 486 .sp
493 487 .ne 2
494 488 .na
495 489 \fB\fB/etc/dhcp/duid\fR\fR
496 490 .ad
497 491 .br
498 492 .na
499 493 \fB\fB/etc/dhcp/iaid\fR\fR
500 494 .ad
501 495 .sp .6
502 496 .RS 4n
503 497 Contains persistent storage for system-generated DUID (DHCP Unique Identifier)
504 498 and interface-specific IAID (Identity Association Identifier) values which are
505 499 used if no \fBCLIENT_ID\fR is defined (see below). The format of these files is
506 500 undocumented, and applications should not read from or write to them. Instead,
507 501 \fBdhcpinfo\fR(1) can be used to query the \fBdhcpagent\fR for \fIClientID\fR.
508 502 For DHCPv6 interfaces, the result will contain the DUID. For DHCPv4 interfaces
509 503 with \fBV4_DEFAULT_IAID_DUID\fR enabled (see below), the result will contain
510 504 the IAID and DUID.
511 505 .RE
512 506
513 507 .sp
514 508 .ne 2
515 509 .na
516 510 \fB\fB/etc/default/dhcpagent\fR\fR
517 511 .ad
518 512 .sp .6
519 513 .RS 4n
520 514 Contains default values for tunable parameters. All values may be qualified
521 515 with the interface they apply to by prepending the interface name and a period
522 516 (".") to the interface parameter name. The parameters include: the interface
523 517 parameter name.
524 518 .sp
525 519 To configure IPv6 parameters, place the string \fB\&.v6\fR between the
526 520 interface name (if any) and the parameter name. For example, to set the global
527 521 IPv6 parameter request list, use \fB\&.v6.PARAM_REQUEST_LIST\fR. To set the
528 522 \fBCLIENT_ID\fR (\fBDUID\fR) on \fBhme0\fR, use \fBhme0.v6.CLIENT_ID\fR.
529 523 .sp
530 524 The parameters include:
531 525 .sp
532 526 .ne 2
533 527 .na
534 528 \fB\fBVERIFIED_LEASE_ONLY\fR\fR
535 529 .ad
536 530 .sp .6
537 531 .RS 4n
538 532 Indicates that a \fBRELEASE\fR rather than a \fBDROP\fR should be performed on
539 533 managed interfaces when the agent terminates. Release causes the client to
540 534 discard the lease, and the server to make the address available again. Drop
541 535 causes the client to record the lease in \fB/etc/dhcp/\fIinterface\fR.dhc\fR or
542 536 \fB/etc/dhcp/\fIinterface\fR.dh6\fR for later use. In addition, when the link
543 537 status changes to \fBup\fR or when the system is resumed after a suspend, the
544 538 client will verify the lease with the server. If the server is unreachable for
545 539 verification, then the old lease will be discarded (even if it has time
546 540 remaining) and a new one obtained.
547 541 .sp
548 542 Enabling this option is often desirable on mobile systems, such as laptops, to
549 543 allow the system to recover quickly from moves.
550 544 .sp
551 545 Default value of this option is \fIno\fR.
552 546 .RE
553 547
554 548 .sp
555 549 .ne 2
556 550 .na
557 551 \fB\fBOFFER_WAIT\fR\fR
558 552 .ad
559 553 .sp .6
560 554 .RS 4n
561 555 Indicates how long to wait in seconds between checking for valid
562 556 \fBOFFER\fRs after sending a \fBDISCOVER\fR. For DHCPv6, sets the time to
563 557 wait between checking for valid Advertisements after sending a Solicit.
564 558 .sp
565 559 Default value of this option is \fI3\fR.
566 560 .RE
567 561
568 562 .sp
569 563 .ne 2
570 564 .na
571 565 \fB\fBCLIENT_ID\fR\fR
572 566 .ad
573 567 .sp .6
574 568 .RS 4n
575 569 Indicates the value that should be used to uniquely identify the client to the
576 570 server. This value can take one of three basic forms:
577 571 .sp
578 572 .in +2
579 573 .nf
580 574 \fIdecimal\fR,\fIdata\fR...
581 575 0xHHHHH...
582 576 "\fIstring\fR...."
583 577 .fi
584 578 .in -2
585 579 .sp
586 580
587 581 The first form is an RFC 3315 DUID. This is legal for both IPv4 DHCP and
588 582 DHCPv6. For IPv4, an RFC 4361 Client ID is constructed from this value. In this
589 583 first form, the format of \fIdata\fR... depends on the decimal value. The
590 584 following formats are defined for this first form:
591 585 .sp
592 586 .ne 2
593 587 .na
594 588 \fB1,\fIhwtype\fR,\fItime\fR,\fIlla\fR\fR
595 589 .ad
596 590 .sp .6
597 591 .RS 4n
598 592 Type 1, DUID-LLT. The \fIhwtype\fR value is an integer in the range 0-65535,
599 593 and indicates the type of hardware. The \fItime\fR value is the number of
600 594 seconds since midnight, January 1st, 2000 UTC, and can be omitted to use the
601 595 current system time. The \fIlla\fR value is either a colon-separated MAC
602 596 address or the name of a physical interface. If the name of an interface is
603 597 used, the \fIhwtype\fR value can be omitted. For example: \fB1,,,hme0\fR
604 598 .RE
605 599
606 600 .sp
607 601 .ne 2
608 602 .na
609 603 \fB2,\fIenterprise\fR,\fIhex\fR...\fR
610 604 .ad
611 605 .sp .6
612 606 .RS 4n
613 607 Type 2, DUID-EN. The \fIenterprise\fR value is an integer in the range
614 608 0-4294967295 and represents the SMI Enterprise number for an organization. The
615 609 \fIhex\fR string is an even-length sequence of hexadecimal digits.
616 610 .RE
617 611
618 612 .sp
619 613 .ne 2
620 614 .na
621 615 \fB3,\fIhwtype\fR,\fIlla\fR\fR
622 616 .ad
623 617 .sp .6
624 618 .RS 4n
625 619 Type 3, DUID-LL. This is the same as DUID-LLT (type 1), except that a time
626 620 stamp is not used.
627 621 .RE
628 622
629 623 .sp
630 624 .ne 2
631 625 .na
632 626 \fB*,\fIhex\fR\fR
633 627 .ad
634 628 .sp .6
635 629 .RS 4n
636 630 Any other type value (0 or 4-65535) can be used with an even-length hexadecimal
637 631 string.
638 632 .RE
639 633
640 634 The second and third forms of \fBCLIENT_ID\fR are legal for IPv4 only. These
641 635 both represent raw Client ID (without RFC 4361), in hex, or NVT ASCII string
642 636 format. Thus, "\fBSun\fR" and \fB0x53756E\fR are equivalent.
643 637 .RE
644 638
645 639 .sp
646 640 .ne 2
647 641 .na
648 642 \fB\fBV4_DEFAULT_IAID_DUID\fR\fR
649 643 .ad
650 644 .sp .6
651 645 .RS 4n
652 646 Indicates whether to use, when CLIENT_ID is not defined, a system-managed,
653 647 RFC 3315-style (i.e., DHCPv6-style) binding identifier as documented in
654 648 RFC 4361, "Node-specific Client Identifiers for DHCPv4," for IPv4
655 649 interfaces which for purposes of backward compatibility do not normally get
656 650 default binding identifiers.
657 651 .sp
658 652 An IPv4 interface that is not in an IP network multipathing (IPMP) group,
659 653 that is not IP over InfiniBand (IPoIB), and that is not a logical interface
660 654 does not normally get a default binding identifier.
661 655 .sp
662 656 Default value of this option is \fIno\fR.
663 657 .RE
664 658
665 659 .sp
666 660 .ne 2
667 661 .na
668 662 \fB\fBPARAM_REQUEST_LIST\fR\fR
669 663 .ad
670 664 .sp .6
671 665 .RS 4n
672 666 Specifies a list of comma-separated integer values of options for which the
673 667 client would like values, or symbolic \fBSite\fR or \fBOption\fR option names.
674 668 Symbolic option names for IPv4 are resolved through \fB/etc/dhcp/inittab\fR.
675 669 Option names for IPv6 are resolved by means of \fB/etc/dhcp/inittab6\fR.
676 670 .RE
677 671
678 672 .sp
679 673 .ne 2
680 674 .na
681 675 \fB\fBPARAM_IGNORE_LIST\fR\fR
682 676 .ad
683 677 .sp .6
684 678 .RS 4n
685 679 Specifies a list of options (constructed in the same manner as
686 680 \fBPARAM_REQUEST_LIST\fR) that the DHCP client will ignore. Ignored options are
687 681 treated as though the server did not return the options specified. Ignored
688 682 options are not visible using \fBdhcpinfo\fR(1) or acted on by the client. This
689 683 parameter can be used, for example, to disable an unwanted client name or
690 684 default router.
691 685 .RE
692 686
693 687 .sp
694 688 .ne 2
695 689 .na
696 690 \fB\fBREQUEST_FQDN\fR\fR
697 691 .ad
698 692 .sp .6
699 693 .RS 4n
700 694 Indicates the client requests the DHCP server to map the client's leased
701 695 IPv4 address to the Fully Qualified Domain Name (FQDN) associated with the
702 696 network interface that performs DHCP on the client and to collaborate with
703 697 a compatible DNS server to manage A and PTR resource records for the FQDN
704 698 for the life of the lease.
705 699 .sp .6
706 700 The \fIhostname\fR in the FQDN is determined from the following possible
707 701 configurations:
708 702 .sp
709 703 .ne 2
710 704 .na
711 705 1. \fBipadm\fR(1M): include the \fB-1,--primary\fR flag when creating an
712 706 address that uses DHCP so that \fBnodename\fR(4) is used as the
713 707 \fIhostname\fR.
714 708 .ad
715 709 .sp
716 710 .ne 2
717 711 .na
718 712 2. \fBipadm\fR(1M): include the \fB-h,--reqhost\fR \fIhostname\fR switch
719 713 when executing the \fBcreate-addr -T dhcp\fR subcommand, or use the
720 714 \fBset-addrprop -p reqhost=\fR\fIhostname\fR subcommand for any existing
721 715 DHCP address.
722 716 .ad
723 717 .sp
724 718 .ne 2
725 719 .na
726 720 3. \fBnwamcfg\fR(1M): set a property,
727 721 \fBip-primary=\fR\fIon\fR, for an ncu ip that uses DHCP so that
728 722 \fBnodename\fR(4) is used as the \fIhostname\fR.
729 723 .ad
730 724 .sp
731 725 .ne 2
732 726 .na
733 727 4. \fBnwamcfg\fR(1M): set a property,
734 728 \fBip-reqhost=\fR\fIhostname\fR, for an ncu ip that uses DHCP.
735 729 .ad
736 730 .sp
737 731 The \fIhostname\fR value is either a Partially Qualified Domain Name (PQDN)
738 732 or an FQDN (i.e., a "rooted" domain name ending with a '.' or one inferred
739 733 to be an FQDN if it contains at least three DNS labels such as
740 734 srv.example.com). If a PQDN is specified, then an FQDN is constructed if
741 735 \fBDNS_DOMAINNAME\fR is defined or if \fBADOPT_DOMAINNAME\fR is set to
742 736 \fIyes\fR and an eligible domain name (as described below) is available.
743 737 .sp
744 738 If an FQDN is sent, \fBREQUEST_HOSTNAME\fR processing will not be done,
745 739 per RFC 4702 (3.1): "clients that send the Client FQDN option in their
746 740 messages MUST NOT also send the Host Name."
747 741 .sp
748 742 Default value of this option is \fIyes\fR.
749 743 .RE
750 744
751 745 .sp
752 746 .ne 2
753 747 .na
754 748 \fB\fBDNS_DOMAINNAME\fR\fR
755 749 .ad
756 750 .sp .6
757 751 .RS 4n
758 752 Indicates the value that should be appended to a PQDN specified by the
759 753 \fB-h,--reqhost\fR option of \fBipadm\fR(1M), by the ncu \fBip-reqhost\fR
760 754 property of \fBnwamcfg\fR(1M), or by \fBnodename\fR(4) to construct an FQDN
761 755 for \fBREQUEST_FQDN\fR processing.
762 756 If the \fIhostname\fR value is already an FQDN, then the value of this
763 757 option is not used.
764 758 .RE
765 759
766 760 .sp
767 761 .ne 2
768 762 .na
769 763 \fB\fBADOPT_DOMAINNAME\fR\fR
770 764 .ad
771 765 .sp .6
772 766 .RS 4n
773 767 Indicates that a domain name returned by the DHCP server or the \fBdomain\fR
774 768 from \fBresolv.conf\fR(4) should be adopted if needed to construct an FQDN
775 769 from a PQDN specified by the \fB-h,--reqhost\fR option of \fBipadm\fR(1M),
776 770 by the ncu \fBip-reqhost\fR property of \fBnwamcfg\fR(1M), or by
777 771 \fBnodename\fR(4).
778 772 If the \fIhostname\fR value is already an FQDN, then the value of this
779 773 option is not applicable.
780 774 The eligible DHCP option for domain name is DHCPv4 \fBDNSdmain\fR.
781 775 .sp
782 776 Default value of this option is \fIno\fR.
783 777 .RE
784 778
785 779 .sp
786 780 .ne 2
787 781 .na
788 782 \fB\fBREQUEST_HOSTNAME\fR\fR
789 783 .ad
790 784 .sp .6
791 785 .RS 4n
792 786 Indicates the client requests the DHCP server to map the client's leased IPv4
793 787 address to the host name associated with the network interface that performs
794 788 DHCP on the client. The host name must be specified as documented for a
795 789 PQDN in \fBREQUEST_FQDN\fR above or specified in the
796 790 \fB/etc/hostname.\fIinterface\fR\fR file for the relevant interface on a line
797 791 of the form
798 792 .sp
799 793 .in +2
800 794 .nf
801 795 inet \fIhostname\fR
802 796 .fi
803 797 .in -2
804 798 .sp
805 799
806 800 where \fIhostname\fR is the host name requested.
807 801 .sp
808 802 This option works with DHCPv4 only.
809 803 .sp
810 804 Default value of this option is \fIyes\fR.
811 805 .RE
812 806
813 807 .RE
814 808
815 809 .sp
|
↓ open down ↓ |
348 lines elided |
↑ open up ↑ |
816 810 .ne 2
817 811 .na
818 812 \fB\fB/etc/dhcp/eventhook\fR\fR
819 813 .ad
820 814 .sp .6
821 815 .RS 4n
822 816 Location of a DHCP event program.
823 817 .RE
824 818
825 819 .SH ATTRIBUTES
826 -.LP
827 820 See \fBattributes\fR(5) for descriptions of the following attributes:
828 821 .sp
829 822
830 823 .sp
831 824 .TS
832 825 box;
833 826 c | c
834 827 l | l .
835 828 ATTRIBUTE TYPE ATTRIBUTE VALUE
836 829 _
837 830 Interface Stability Committed
838 831 .TE
839 832
840 833 .SH SEE ALSO
841 -.LP
842 834 \fBdhcpinfo\fR(1), \fBifconfig\fR(1M), \fBinit\fR(1M), \fBin.mpathd\fR(1M),
843 835 \fBin.ndpd\fR(1M), \fBipadm\fR(1M), \fBnwamcfg\fR(1M), \fBsyslog\fR(3C),
844 836 \fBnodename\fR(4), \fBresolv.conf\fR(4), \fBattributes\fR(5), \fBdhcp\fR(5)
845 837 .sp
846 838 .LP
847 839 \fI\fR
848 840 .sp
849 841 .LP
850 842 Croft, B. and Gilmore, J. \fIRFC 951, Bootstrap Protocol (BOOTP)\fR, Network
851 843 Working Group, September 1985.
852 844 .sp
853 845 .LP
854 846 Droms, R. \fIRFC 2131, Dynamic Host Configuration Protocol\fR, Network Working
855 847 Group, March 1997.
|
↓ open down ↓ |
4 lines elided |
↑ open up ↑ |
856 848 .sp
857 849 .LP
858 850 Lemon, T. and B. Sommerfeld. \fIRFC 4361, Node-specific Client Identifiers for
859 851 Dynamic Host Configuration Protocol Version Four (DHCPv4)\fR. Nominum and Sun
860 852 Microsystems. February 2006.
861 853 .sp
862 854 .LP
863 855 Droms, R. \fIRFC 3315, Dynamic Host Configuration Protocol for IPv6
864 856 (DHCPv6)\fR. Cisco Systems. July 2003.
865 857 .SH NOTES
866 -.LP
867 858 The \fBdhcpagent\fR daemon can be used on IPv4 logical interfaces, just as with
868 859 physical interfaces. When used on a logical interface, the daemon automatically
869 860 constructs a Client ID value based on the DUID and IAID values, according to
870 861 RFC 4361. The \fB/etc/default/dhcpagent\fR \fBCLIENT_ID\fR value, if any,
871 862 overrides this automatic identifier.
872 863 .sp
873 864 .LP
874 865 As with physical IPv4 interfaces, the \fB/etc/hostname.hme0:1\fR and
875 866 \fB/etc/dhcp.hme0:1\fR files must also be created in order for \fBhme0:1\fR to
876 867 be automatically plumbed and configured at boot. In addition, unlike physical
877 868 IPv4 interfaces, \fBdhcpagent\fR does not add or remove default routes
878 869 associated with logical interfaces.
879 870 .sp
880 871 .LP
881 872 DHCP can be performed on IPMP IP interfaces to acquire and maintain IPMP data
882 873 addresses. Because an IPMP IP interface has no hardware address, the daemon
883 874 automatically constructs a Client ID using the same approach described above
884 875 for IPv4 logical interfaces. In addition, the lack of a hardware address means
885 876 the daemon must set the "broadcast" flag in all \fBDISCOVER\fR and
886 877 \fBREQUEST\fR messages on IPMP IP interfaces. Some DHCP servers may refuse such
887 878 requests.
888 879 .sp
889 880 .LP
890 881 DHCP can be performed on IP interfaces that are part of an IPMP group (to
891 882 acquire and maintain test addresses). The daemon will automatically set the
892 883 \fBNOFAILOVER\fR and \fBDEPRECATED\fR flags on each test address. Additionally,
893 884 the daemon will not add or remove default routes in this case. Note that the
894 885 actual DHCP packet exchange may be performed over any active IP interface in
895 886 the IPMP group. It is strongly recommended that test addresses have infinite
896 887 leases. Otherwise, an extended network outage detectable only by probes may
897 888 cause test address leases to expire, causing \fBin.mpathd\fR(1M) to revert to
898 889 link-based failure detection and trigger an erroneous repair.
899 890 .sp
900 891 .LP
901 892 With DHCPv6, the link-local interface must be configured using
902 893 \fB/etc/hostname6.hme0\fR in order for DHCPv6 to run on \fBhme0\fR at boot
903 894 time. The logical interfaces for each address are plumbed by \fBdhcpagent\fR
904 895 automatically.
|
↓ open down ↓ |
28 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX