1 '\" te
2 .\" Copyright (c) 1992-1996 Competitive Automation, Inc. Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
3 .\" 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.
4 .\" 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
5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH DHCPAGENT 1M "Dec 11, 2015"
7 .SH NAME
8 dhcpagent \- Dynamic Host Configuration Protocol (DHCP) client daemon
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBdhcpagent\fR [\fB-a\fR] [ \fB-d\fR \fIn\fR] [\fB-f\fR] [\fB-v\fR]
13 .fi
14
15 .SH DESCRIPTION
16 .LP
17 \fBdhcpagent\fR implements the client half of the Dynamic Host Configuration
18 Protocol \fB(DHCP)\fR for machines running Solaris software.
19 .sp
20 .LP
21 The \fBdhcpagent\fR daemon obtains configuration parameters for the client
22 (local) machine's network interfaces from a \fBDHCP\fR server. These parameters
23 may include a lease on an \fBIP\fR address, which gives the client machine use
24 of the address for the period of the lease, which may be infinite. If the
25 client wishes to use the \fBIP\fR address for a period longer than the lease,
26 it must negotiate an extension using \fBDHCP\fR. For this reason,
27 \fBdhcpagent\fR must run as a daemon, terminating only when the client machine
28 powers down.
29 .sp
30 .LP
31 For IPv4, the \fBdhcpagent\fR daemon is controlled through \fBifconfig\fR(1M)
32 in much the same way that the \fBinit\fR(1M) daemon is controlled by
33 \fBtelinit\fR(1M). \fBdhcpagent\fR can be invoked as a user process, albeit one
34 requiring root privileges, but this is not necessary, as \fBifconfig\fR(1M)
35 will start it automatically.
36 .sp
37 .LP
38 For IPv6, the \fBdhcpagent\fR daemon is invoked automatically by
39 \fBin.ndpd\fR(1M). It can also be controlled through \fBifconfig\fR(1M), if
40 necessary.
41 .sp
42 .LP
43 When invoked, \fBdhcpagent\fR enters a passive state while it awaits
44 instructions from \fBifconfig\fR(1M) or \fBin.ndpd\fR(1M). When it receives a
45 command to configure an interface, it brings up the interface (if necessary)
46 and starts DHCP. Once DHCP is complete, \fBdhcpagent\fR can be queried for the
47 values of the various network parameters. In addition, if DHCP was used to
48 obtain a lease on an address for an interface, it configures the address for
49 use. When a lease is obtained, it is automatically renewed as necessary. If the
50 lease cannot be renewed, \fBdhcpagent\fR will unconfigure the address, but the
51 interface will be left up and \fBdhcpagent\fR will attempt to acquire a new
52 address lease. \fBdhcpagent\fR monitors system suspend/resume events and will
53 validate any non-permanent leases with the DHCP server upon resume. Similarly,
54 \fBdhcpagent\fR monitors link up/down events and will validate any
55 non-permanent leases with the DHCP server when the downed link is brought back
56 up. The lease validation mechanism will restart DHCP if the server indicates
57 that the existing lease is no longer valid. If the server cannot be contacted,
58 then the existing lease will continue. This behavior can be modified with the
59 \fBVERIFIED_LEASE_ONLY\fR parameter in the \fB/etc/default/dhcpagent\fR file.
60 See the description of this parameter below.
61 .sp
62 .LP
63 For IPv4, if the configured interface is found to be unplumbed, or to have a
64 different IP address, subnet mask, or broadcast address from those obtained
65 from DHCP, the interface is abandoned from DHCP control.
66 .sp
67 .LP
68 For IPv6, \fBdhcpagent\fR automatically plumbs and unplumbs logical interfaces
69 as necessary for the IPv6 addresses supplied by the server. The IPv6 prefix
70 length (netmask) is not set by the DHCPv6 protocol, but is instead set by
71 \fBin.ndpd\fR(1M) using prefix information obtained by Router Advertisements.
72 If any of the logical interfaces created by \fBdhcpagent\fR is unplumbed, or
73 configured with a different IP address, it will be abandoned from DHCP control.
85 \fBDHCP\fR also acts as a mechanism to configure other information needed by
86 the client, for example, the domain name and addresses of routers. Aside from
87 the IP address, and for IPv4 alone, the netmask, broadcast address, and default
88 router, the agent does not directly configure the workstation, but instead acts
89 as a database which may be interrogated by other programs, and in particular by
90 \fBdhcpinfo\fR(1).
91 .sp
92 .LP
93 On clients with a single interface, this is quite straightforward. Clients with
94 multiple interfaces may present difficulties, as it is possible that some
95 information arriving on different interfaces may need to be merged, or may be
96 inconsistent. Furthermore, the configuration of the interfaces is asynchronous,
97 so requests may arrive while some or all of the interfaces are still
98 unconfigured. To handle these cases, one interface may be designated as
99 primary, which makes it the authoritative source for the values of \fBDHCP\fR
100 parameters in the case where no specific interface is requested. See
101 \fBdhcpinfo\fR(1) and \fBifconfig\fR(1M) for details.
102 .sp
103 .LP
104 For IPv4, the \fBdhcpagent\fR daemon can be configured to request a particular
105 host name. See the \fBREQUEST_HOSTNAME\fR description in the \fBFILES\fR
106 section. When first configuring a client to request a host name, you must
107 perform the following steps as root to ensure that the full DHCP negotiation
108 takes place:
109 .sp
110 .in +2
111 .nf
112 # pkill dhcpagent
113 # rm /etc/dhcp/\fIinterface\fR.dhc
114 # reboot
115 .fi
116 .in -2
117 .sp
118
119 .sp
120 .LP
121 All DHCP packets sent by \fBdhcpagent\fR include a vendor class identifier (RFC
122 2132, option code 60; RFC 3315, option code 16). This identifier is the same as
123 the platform name returned by the \fBuname\fR \fB-i\fR command, except:
124 .RS +4
125 .TP
126 .ie t \(bu
127 .el o
128 Any commas in the platform name are changed to periods.
477 .ad
478 .sp .6
479 .RS 4n
480 Contains the configuration for interface. The mere existence of this file does
481 not imply that the configuration is correct, since the lease might have
482 expired. On start-up, \fBdhcpagent\fR confirms the validity of the address
483 using REQUEST (for DHCPv4) or Confirm (DHCPv6).
484 .RE
485
486 .sp
487 .ne 2
488 .na
489 \fB\fB/etc/dhcp/duid\fR\fR
490 .ad
491 .br
492 .na
493 \fB\fB/etc/dhcp/iaid\fR\fR
494 .ad
495 .sp .6
496 .RS 4n
497 Contains persistent storage for DUID (DHCP Unique Identifier) and IAID
498 (Identity Association Identifier) values. The format of these files is
499 undocumented, and applications should not read from or write to them.
500 .RE
501
502 .sp
503 .ne 2
504 .na
505 \fB\fB/etc/default/dhcpagent\fR\fR
506 .ad
507 .sp .6
508 .RS 4n
509 Contains default values for tunable parameters. All values may be qualified
510 with the interface they apply to by prepending the interface name and a period
511 (".") to the interface parameter name. The parameters include: the interface
512 parameter name.
513 .sp
514 To configure IPv6 parameters, place the string \fB\&.v6\fR between the
515 interface name (if any) and the parameter name. For example, to set the global
516 IPv6 parameter request list, use \fB\&.v6.PARAM_REQUEST_LIST\fR. To set the
517 \fBCLIENT_ID\fR (\fBDUID\fR) on \fBhme0\fR, use \fBhme0.v6.CLIENT_ID\fR.
518 .sp
519 The parameters include:
520 .sp
521 .ne 2
522 .na
523 \fB\fBVERIFIED_LEASE_ONLY\fR\fR
524 .ad
525 .sp .6
526 .RS 4n
527 Indicates that a \fBRELEASE\fR rather than a \fBDROP\fR should be performed on
528 managed interfaces when the agent terminates. Release causes the client to
529 discard the lease, and the server to make the address available again. Drop
530 causes the client to record the lease in \fB/etc/dhcp/\fIinterface\fR.dhc\fR or
531 \fB/etc/dhcp/\fIinterface\fR.dh6\fR for later use. In addition, when the link
532 status changes to \fBup\fR or when the system is resumed after a suspend, the
533 client will verify the lease with the server. If the server is unreachable for
534 verification, then the old lease will be discarded (even if it has time
535 remaining) and a new one obtained.
536 .sp
537 Enabling this option is often desirable on mobile systems, such as laptops, to
538 allow the system to recover quickly from moves.
539 .RE
540
541 .sp
542 .ne 2
543 .na
544 \fB\fBOFFER_WAIT\fR\fR
545 .ad
546 .sp .6
547 .RS 4n
548 Indicates how long to wait between checking for valid \fBOFFER\fRs after
549 sending a \fBDISCOVER\fR. For DHCPv6, sets the time to wait between checking
550 for valid Advertisements after sending a Solicit.
551 .RE
552
553 .sp
554 .ne 2
555 .na
556 \fB\fBCLIENT_ID\fR\fR
557 .ad
558 .sp .6
559 .RS 4n
560 Indicates the value that should be used to uniquely identify the client to the
561 server. This value can take one of three basic forms:
562 .sp
563 .in +2
564 .nf
565 \fIdecimal\fR,\fIdata\fR...
566 0xHHHHH...
567 "\fIstring\fR...."
568 .fi
569 .in -2
570 .sp
613
614 .sp
615 .ne 2
616 .na
617 \fB*,\fIhex\fR\fR
618 .ad
619 .sp .6
620 .RS 4n
621 Any other type value (0 or 4-65535) can be used with an even-length hexadecimal
622 string.
623 .RE
624
625 The second and third forms of \fBCLIENT_ID\fR are legal for IPv4 only. These
626 both represent raw Client ID (without RFC 4361), in hex, or NVT ASCII string
627 format. Thus, "\fBSun\fR" and \fB0x53756E\fR are equivalent.
628 .RE
629
630 .sp
631 .ne 2
632 .na
633 \fB\fBPARAM_REQUEST_LIST\fR\fR
634 .ad
635 .sp .6
636 .RS 4n
637 Specifies a list of comma-separated integer values of options for which the
638 client would like values, or symbolic \fBSite\fR or \fBOption\fR option names.
639 Symbolic option names for IPv4 are resolved through \fB/etc/dhcp/inittab\fR.
640 Option names for IPv6 are resolved by means of \fB/etc/dhcp/inittab6\fR.
641 .RE
642
643 .sp
644 .ne 2
645 .na
646 \fB\fBPARAM_IGNORE_LIST\fR\fR
647 .ad
648 .sp .6
649 .RS 4n
650 Specifies a list of options (constructed in the same manner as
651 \fBPARAM_REQUEST_LIST\fR) that the DHCP client will ignore. Ignored options are
652 treated as though the server did not return the options specified. Ignored
653 options are not visible using \fBdhcpinfo\fR(1) or acted on by the client. This
654 parameter can be used, for example, to disable an unwanted client name or
655 default router.
656 .RE
657
658 .sp
659 .ne 2
660 .na
661 \fB\fBREQUEST_HOSTNAME\fR\fR
662 .ad
663 .sp .6
664 .RS 4n
665 Indicates the client requests the DHCP server to map the client's leased IPv4
666 address to the host name associated with the network interface that performs
667 DHCP on the client. The host name must be specified in the
668 \fB/etc/hostname.\fIinterface\fR\fR file for the relevant interface on a line
669 of the form
670 .sp
671 .in +2
672 .nf
673 inet \fIhostname\fR
674 .fi
675 .in -2
676 .sp
677
678 where \fIhostname\fR is the host name requested.
679 .sp
680 This option works with DHCPv4 only.
681 .RE
682
683 .RE
684
685 .sp
686 .ne 2
687 .na
688 \fB\fB/etc/dhcp/eventhook\fR\fR
689 .ad
690 .sp .6
691 .RS 4n
692 Location of a DHCP event program.
693 .RE
694
695 .SH ATTRIBUTES
696 .LP
697 See \fBattributes\fR(5) for descriptions of the following attributes:
698 .sp
699
700 .sp
701 .TS
702 box;
703 c | c
704 l | l .
705 ATTRIBUTE TYPE ATTRIBUTE VALUE
706 _
707 Interface Stability Committed
708 .TE
709
710 .SH SEE ALSO
711 .LP
712 \fBdhcpinfo\fR(1), \fBifconfig\fR(1M), \fBinit\fR(1M), \fBin.mpathd\fR(1M),
713 \fBin.ndpd\fR(1M), \fBsyslog\fR(3C), \fBattributes\fR(5), \fBdhcp\fR(5)
714 .sp
715 .LP
716 \fI\fR
717 .sp
718 .LP
719 Croft, B. and Gilmore, J.,\fIBootstrap Protocol (BOOTP)\fRRFC 951, Network
720 Working Group, September 1985.
721 .sp
722 .LP
723 Droms, R., \fIDynamic Host Configuration Protocol\fR, RFC 2131, Network Working
724 Group, March 1997.
725 .sp
726 .LP
727 Lemon, T. and B. Sommerfeld. \fIRFC 4361, Node-specific Client Identifiers for
728 Dynamic Host Configuration Protocol Version Four (DHCPv4)\fR. Nominum and Sun
729 Microsystems. February 2006.
730 .sp
731 .LP
732 Droms, R. \fIRFC 3315, Dynamic Host Configuration Protocol for IPv6
733 (DHCPv6)\fR. Cisco Systems. July 2003.
|
1 '\" te
2 .\" Copyright (c) 1992-1996 Competitive Automation, Inc. Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
3 .\" Copyright (c) 2016, Chris Fraire <cfraire@me.com>.
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 .\" 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 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH DHCPAGENT 1M "Nov 7, 2016"
8 .SH NAME
9 dhcpagent \- Dynamic Host Configuration Protocol (DHCP) client daemon
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBdhcpagent\fR [\fB-a\fR] [ \fB-d\fR \fIn\fR] [\fB-f\fR] [\fB-v\fR]
14 .fi
15
16 .SH DESCRIPTION
17 .LP
18 \fBdhcpagent\fR implements the client half of the Dynamic Host Configuration
19 Protocol \fB(DHCP)\fR for machines running illumos software.
20 .sp
21 .LP
22 The \fBdhcpagent\fR daemon obtains configuration parameters for the client
23 (local) machine's network interfaces from a \fBDHCP\fR server. These parameters
24 may include a lease on an \fBIP\fR address, which gives the client machine use
25 of the address for the period of the lease, which may be infinite. If the
26 client wishes to use the \fBIP\fR address for a period longer than the lease,
27 it must negotiate an extension using \fBDHCP\fR. For this reason,
28 \fBdhcpagent\fR must run as a daemon, terminating only when the client machine
29 powers down.
30 .sp
31 .LP
32 For IPv4, the \fBdhcpagent\fR daemon is controlled through \fBipadm\fR(1M),
33 \fBnwamcfg\fR(1M), or \fBifconfig\fR(1M) in much the same way that the
34 \fBinit\fR(1M) daemon is controlled by \fBtelinit\fR(1M). \fBdhcpagent\fR can
35 be invoked as a user process, albeit one requiring root privileges, but this is
36 not necessary, as \fBipadm\fR(1M), \fBnwamcfg\fR(1M), or \fBifconfig\fR(1M)
37 will start \fBdhcpagent\fR automatically.
38 .sp
39 .LP
40 For IPv6, the \fBdhcpagent\fR daemon is invoked automatically by
41 \fBin.ndpd\fR(1M). It can also be controlled through \fBifconfig\fR(1M), if
42 necessary.
43 .sp
44 .LP
45 When invoked, \fBdhcpagent\fR enters a passive state while it awaits
46 instructions from \fBipadm\fR(1M), \fBnwamcfg\fR(1M), \fBifconfig\fR(1M), or
47 \fBin.ndpd\fR(1M). When \fBdhcpagent\fR receives a command to configure an
48 interface, \fBdhcpagent\fR brings up the interface (if necessary) and starts
49 DHCP. Once DHCP is complete, \fBdhcpagent\fR can be queried for the values of
50 the various network parameters. In addition, if DHCP was used to obtain a lease
51 on an address for an interface, \fBdhcpagent\fR configures the address for use.
52 When a lease is obtained, it is automatically renewed as necessary. If the
53 lease cannot be renewed, \fBdhcpagent\fR will unconfigure the address, but the
54 interface will be left up, and \fBdhcpagent\fR will attempt to acquire a new
55 address lease.
56 .sp
57 .LP
58 \fBdhcpagent\fR monitors system suspend/resume events and will validate any
59 non-permanent leases with the DHCP server upon resume. Similarly,
60 \fBdhcpagent\fR monitors link up/down events and will validate any
61 non-permanent leases with the DHCP server when the downed link is brought back
62 up. The lease validation mechanism will restart DHCP if the server indicates
63 that the existing lease is no longer valid. If the server cannot be contacted,
64 then the existing lease will continue. This behavior can be modified with the
65 \fBVERIFIED_LEASE_ONLY\fR parameter in the \fB/etc/default/dhcpagent\fR file.
66 See the description of this parameter below.
67 .sp
68 .LP
69 For IPv4, if the configured interface is found to be unplumbed, or to have a
70 different IP address, subnet mask, or broadcast address from those obtained
71 from DHCP, the interface is abandoned from DHCP control.
72 .sp
73 .LP
74 For IPv6, \fBdhcpagent\fR automatically plumbs and unplumbs logical interfaces
75 as necessary for the IPv6 addresses supplied by the server. The IPv6 prefix
76 length (netmask) is not set by the DHCPv6 protocol, but is instead set by
77 \fBin.ndpd\fR(1M) using prefix information obtained by Router Advertisements.
78 If any of the logical interfaces created by \fBdhcpagent\fR is unplumbed, or
79 configured with a different IP address, it will be abandoned from DHCP control.
91 \fBDHCP\fR also acts as a mechanism to configure other information needed by
92 the client, for example, the domain name and addresses of routers. Aside from
93 the IP address, and for IPv4 alone, the netmask, broadcast address, and default
94 router, the agent does not directly configure the workstation, but instead acts
95 as a database which may be interrogated by other programs, and in particular by
96 \fBdhcpinfo\fR(1).
97 .sp
98 .LP
99 On clients with a single interface, this is quite straightforward. Clients with
100 multiple interfaces may present difficulties, as it is possible that some
101 information arriving on different interfaces may need to be merged, or may be
102 inconsistent. Furthermore, the configuration of the interfaces is asynchronous,
103 so requests may arrive while some or all of the interfaces are still
104 unconfigured. To handle these cases, one interface may be designated as
105 primary, which makes it the authoritative source for the values of \fBDHCP\fR
106 parameters in the case where no specific interface is requested. See
107 \fBdhcpinfo\fR(1) and \fBifconfig\fR(1M) for details.
108 .sp
109 .LP
110 For IPv4, the \fBdhcpagent\fR daemon can be configured to request a particular
111 Fully Qualified Domain Name (FQDN) or host name. See the \fBREQUEST_FQDN\fR or
112 \fBREQUEST_HOSTNAME\fR description in the \fBFILES\fR section. When first
113 configuring a client to request an FQDN or host name, you must perform the
114 following steps as root to ensure that the full DHCP negotiation takes place:
115 .sp
116 .in +2
117 .nf
118 # pkill dhcpagent
119 # rm /etc/dhcp/\fIinterface\fR.dhc
120 # reboot
121 .fi
122 .in -2
123 .sp
124
125 .sp
126 .LP
127 All DHCP packets sent by \fBdhcpagent\fR include a vendor class identifier (RFC
128 2132, option code 60; RFC 3315, option code 16). This identifier is the same as
129 the platform name returned by the \fBuname\fR \fB-i\fR command, except:
130 .RS +4
131 .TP
132 .ie t \(bu
133 .el o
134 Any commas in the platform name are changed to periods.
483 .ad
484 .sp .6
485 .RS 4n
486 Contains the configuration for interface. The mere existence of this file does
487 not imply that the configuration is correct, since the lease might have
488 expired. On start-up, \fBdhcpagent\fR confirms the validity of the address
489 using REQUEST (for DHCPv4) or Confirm (DHCPv6).
490 .RE
491
492 .sp
493 .ne 2
494 .na
495 \fB\fB/etc/dhcp/duid\fR\fR
496 .ad
497 .br
498 .na
499 \fB\fB/etc/dhcp/iaid\fR\fR
500 .ad
501 .sp .6
502 .RS 4n
503 Contains persistent storage for system-generated DUID (DHCP Unique Identifier)
504 and interface-specific IAID (Identity Association Identifier) values which are
505 used if no \fBCLIENT_ID\fR is defined (see below). The format of these files is
506 undocumented, and applications should not read from or write to them. Instead,
507 \fBdhcpinfo\fR(1) can be used to query the \fBdhcpagent\fR for \fIClientID\fR.
508 For DHCPv6 interfaces, the result will contain the DUID. For DHCPv4 interfaces
509 with \fBV4_DEFAULT_IAID_DUID\fR enabled (see below), the result will contain
510 the IAID and DUID.
511 .RE
512
513 .sp
514 .ne 2
515 .na
516 \fB\fB/etc/default/dhcpagent\fR\fR
517 .ad
518 .sp .6
519 .RS 4n
520 Contains default values for tunable parameters. All values may be qualified
521 with the interface they apply to by prepending the interface name and a period
522 (".") to the interface parameter name. The parameters include: the interface
523 parameter name.
524 .sp
525 To configure IPv6 parameters, place the string \fB\&.v6\fR between the
526 interface name (if any) and the parameter name. For example, to set the global
527 IPv6 parameter request list, use \fB\&.v6.PARAM_REQUEST_LIST\fR. To set the
528 \fBCLIENT_ID\fR (\fBDUID\fR) on \fBhme0\fR, use \fBhme0.v6.CLIENT_ID\fR.
529 .sp
530 The parameters include:
531 .sp
532 .ne 2
533 .na
534 \fB\fBVERIFIED_LEASE_ONLY\fR\fR
535 .ad
536 .sp .6
537 .RS 4n
538 Indicates that a \fBRELEASE\fR rather than a \fBDROP\fR should be performed on
539 managed interfaces when the agent terminates. Release causes the client to
540 discard the lease, and the server to make the address available again. Drop
541 causes the client to record the lease in \fB/etc/dhcp/\fIinterface\fR.dhc\fR or
542 \fB/etc/dhcp/\fIinterface\fR.dh6\fR for later use. In addition, when the link
543 status changes to \fBup\fR or when the system is resumed after a suspend, the
544 client will verify the lease with the server. If the server is unreachable for
545 verification, then the old lease will be discarded (even if it has time
546 remaining) and a new one obtained.
547 .sp
548 Enabling this option is often desirable on mobile systems, such as laptops, to
549 allow the system to recover quickly from moves.
550 .sp
551 Default value of this option is \fIno\fR.
552 .RE
553
554 .sp
555 .ne 2
556 .na
557 \fB\fBOFFER_WAIT\fR\fR
558 .ad
559 .sp .6
560 .RS 4n
561 Indicates how long to wait in seconds between checking for valid
562 \fBOFFER\fRs after sending a \fBDISCOVER\fR. For DHCPv6, sets the time to
563 wait between checking for valid Advertisements after sending a Solicit.
564 .sp
565 Default value of this option is \fI3\fR.
566 .RE
567
568 .sp
569 .ne 2
570 .na
571 \fB\fBCLIENT_ID\fR\fR
572 .ad
573 .sp .6
574 .RS 4n
575 Indicates the value that should be used to uniquely identify the client to the
576 server. This value can take one of three basic forms:
577 .sp
578 .in +2
579 .nf
580 \fIdecimal\fR,\fIdata\fR...
581 0xHHHHH...
582 "\fIstring\fR...."
583 .fi
584 .in -2
585 .sp
628
629 .sp
630 .ne 2
631 .na
632 \fB*,\fIhex\fR\fR
633 .ad
634 .sp .6
635 .RS 4n
636 Any other type value (0 or 4-65535) can be used with an even-length hexadecimal
637 string.
638 .RE
639
640 The second and third forms of \fBCLIENT_ID\fR are legal for IPv4 only. These
641 both represent raw Client ID (without RFC 4361), in hex, or NVT ASCII string
642 format. Thus, "\fBSun\fR" and \fB0x53756E\fR are equivalent.
643 .RE
644
645 .sp
646 .ne 2
647 .na
648 \fB\fBV4_DEFAULT_IAID_DUID\fR\fR
649 .ad
650 .sp .6
651 .RS 4n
652 Indicates whether to use, when CLIENT_ID is not defined, a system-managed,
653 RFC 3315-style (i.e., DHCPv6-style) binding identifier as documented in
654 RFC 4361, "Node-specific Client Identifiers for DHCPv4," for IPv4
655 interfaces which for purposes of backward compatibility do not normally get
656 default binding identifiers.
657 .sp
658 An IPv4 interface that is not in an IP network multipathing (IPMP) group,
659 that is not IP over InfiniBand (IPoIB), and that is not a logical interface
660 does not normally get a default binding identifier.
661 .sp
662 Default value of this option is \fIno\fR.
663 .RE
664
665 .sp
666 .ne 2
667 .na
668 \fB\fBPARAM_REQUEST_LIST\fR\fR
669 .ad
670 .sp .6
671 .RS 4n
672 Specifies a list of comma-separated integer values of options for which the
673 client would like values, or symbolic \fBSite\fR or \fBOption\fR option names.
674 Symbolic option names for IPv4 are resolved through \fB/etc/dhcp/inittab\fR.
675 Option names for IPv6 are resolved by means of \fB/etc/dhcp/inittab6\fR.
676 .RE
677
678 .sp
679 .ne 2
680 .na
681 \fB\fBPARAM_IGNORE_LIST\fR\fR
682 .ad
683 .sp .6
684 .RS 4n
685 Specifies a list of options (constructed in the same manner as
686 \fBPARAM_REQUEST_LIST\fR) that the DHCP client will ignore. Ignored options are
687 treated as though the server did not return the options specified. Ignored
688 options are not visible using \fBdhcpinfo\fR(1) or acted on by the client. This
689 parameter can be used, for example, to disable an unwanted client name or
690 default router.
691 .RE
692
693 .sp
694 .ne 2
695 .na
696 \fB\fBREQUEST_FQDN\fR\fR
697 .ad
698 .sp .6
699 .RS 4n
700 Indicates the client requests the DHCP server to map the client's leased
701 IPv4 address to the Fully Qualified Domain Name (FQDN) associated with the
702 network interface that performs DHCP on the client and to collaborate with
703 a compatible DNS server to manage A and PTR resource records for the FQDN
704 for the life of the lease.
705 .sp .6
706 The hostname in the FQDN is determined from the following possible
707 configurations:
708 .sp
709 .ne 2
710 .na
711 1. \fBipadm\fR(1M): include the \fB-1,--primary\fR flag when creating an
712 address that uses DHCP so that \fBnodename\fR(4) is used as the
713 \fIhostname\fR.
714 .ad
715 .sp
716 .ne 2
717 .na
718 2. \fBipadm\fR(1M): include the \fB-h,--reqhost\fR \fIhostname\fR switch
719 when executing the \fBcreate-addr -T dhcp\fR subcommand, or use the
720 \fBset-addrprop -p reqhost=\fR\fIhostname\fR subcommand for any existing
721 DHCP address.
722 .ad
723 .sp
724 .ne 2
725 .na
726 3. \fBnwamcfg\fR(1M): set a property,
727 \fBip-primary=\fR\fIon\fR, for an ncu ip that uses DHCP so that
728 \fBnodename\fR(4) is used as the \fIhostname\fR.
729 .ad
730 .sp
731 .ne 2
732 .na
733 4. \fBnwamcfg\fR(1M): set a property,
734 \fBip-reqhost=\fR\fIhostname\fR, for an ncu ip that uses DHCP.
735 .ad
736 .sp
737 The \fIhostname\fR value is either a Partially Qualified Domain Name (PQDN)
738 or an FQDN (i.e., a "rooted" domain name ending with a '.' or one inferred
739 to be an FQDN if it contains at least three DNS labels such as
740 srv.example.com). If a PQDN is specified, then an FQDN is constructed if
741 either a \fBdefaultdomain\fR(4) or a \fBresolv.conf\fR(4) \fBdomain\fR is
742 defined.
743 .sp
744 If an FQDN is sent, \fBREQUEST_HOSTNAME\fR processing will not be done,
745 per RFC 4702 (3.1): "clients that send the Client FQDN option in their
746 messages MUST NOT also send the Host Name."
747 .sp
748 Default value of this option is \fIyes\fR.
749 .RE
750
751 .sp
752 .ne 2
753 .na
754 \fB\fBREQUEST_HOSTNAME\fR\fR
755 .ad
756 .sp .6
757 .RS 4n
758 Indicates the client requests the DHCP server to map the client's leased IPv4
759 address to the host name associated with the network interface that performs
760 DHCP on the client. The host name must be specified as documented for a
761 PQDN in \fBREQUEST_FQDN\fR above or specified in the
762 \fB/etc/hostname.\fIinterface\fR\fR file for the relevant interface on a line
763 of the form
764 .sp
765 .in +2
766 .nf
767 inet \fIhostname\fR
768 .fi
769 .in -2
770 .sp
771
772 where \fIhostname\fR is the host name requested.
773 .sp
774 This option works with DHCPv4 only.
775 .sp
776 Default value of this option is \fIyes\fR.
777 .RE
778
779 .RE
780
781 .sp
782 .ne 2
783 .na
784 \fB\fB/etc/dhcp/eventhook\fR\fR
785 .ad
786 .sp .6
787 .RS 4n
788 Location of a DHCP event program.
789 .RE
790
791 .SH ATTRIBUTES
792 .LP
793 See \fBattributes\fR(5) for descriptions of the following attributes:
794 .sp
795
796 .sp
797 .TS
798 box;
799 c | c
800 l | l .
801 ATTRIBUTE TYPE ATTRIBUTE VALUE
802 _
803 Interface Stability Committed
804 .TE
805
806 .SH SEE ALSO
807 .LP
808 \fBdhcpinfo\fR(1), \fBifconfig\fR(1M), \fBinit\fR(1M), \fBin.mpathd\fR(1M),
809 \fBin.ndpd\fR(1M), \fBipadm\fR(1M), \fBnwamcfg\fR(1M), \fBsyslog\fR(3C),
810 \fBdefaultdomain\fR(4), \fBnodename\fR(4), \fBresolv.conf\fR(4),
811 \fBattributes\fR(5), \fBdhcp\fR(5)
812 .sp
813 .LP
814 \fI\fR
815 .sp
816 .LP
817 Croft, B. and Gilmore, J.,\fIBootstrap Protocol (BOOTP)\fRRFC 951, Network
818 Working Group, September 1985.
819 .sp
820 .LP
821 Droms, R., \fIDynamic Host Configuration Protocol\fR, RFC 2131, Network Working
822 Group, March 1997.
823 .sp
824 .LP
825 Lemon, T. and B. Sommerfeld. \fIRFC 4361, Node-specific Client Identifiers for
826 Dynamic Host Configuration Protocol Version Four (DHCPv4)\fR. Nominum and Sun
827 Microsystems. February 2006.
828 .sp
829 .LP
830 Droms, R. \fIRFC 3315, Dynamic Host Configuration Protocol for IPv6
831 (DHCPv6)\fR. Cisco Systems. July 2003.
|