xref: /onnv-gate/usr/src/cmd/cmd-inet/sbin/dhcpagent/dhcpagent.dfl (revision 9633:309290318ad0)
10Sstevel@tonic-gate#
20Sstevel@tonic-gate# CDDL HEADER START
30Sstevel@tonic-gate#
40Sstevel@tonic-gate# The contents of this file are subject to the terms of the
52546Scarlsonj# Common Development and Distribution License (the "License").
62546Scarlsonj# You may not use this file except in compliance with the License.
70Sstevel@tonic-gate#
80Sstevel@tonic-gate# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
90Sstevel@tonic-gate# or http://www.opensolaris.org/os/licensing.
100Sstevel@tonic-gate# See the License for the specific language governing permissions
110Sstevel@tonic-gate# and limitations under the License.
120Sstevel@tonic-gate#
130Sstevel@tonic-gate# When distributing Covered Code, include this CDDL HEADER in each
140Sstevel@tonic-gate# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
150Sstevel@tonic-gate# If applicable, add the following below this CDDL HEADER, with the
160Sstevel@tonic-gate# fields enclosed by brackets "[]" replaced with your own identifying
170Sstevel@tonic-gate# information: Portions Copyright [yyyy] [name of copyright owner]
180Sstevel@tonic-gate#
190Sstevel@tonic-gate# CDDL HEADER END
200Sstevel@tonic-gate#
210Sstevel@tonic-gate
220Sstevel@tonic-gate#
23*9633Sjames.d.carlson@sun.com# Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
242546Scarlsonj# Use is subject to license terms.
252546Scarlsonj#
262546Scarlsonj
272546Scarlsonj#
280Sstevel@tonic-gate# This file contains tunable parameters for dhcpagent(1M).
290Sstevel@tonic-gate#
300Sstevel@tonic-gate
310Sstevel@tonic-gate# All parameters can be tuned for a specific interface by prepending
320Sstevel@tonic-gate# the interface name to the parameter name.  For example, to make
33*9633Sjames.d.carlson@sun.com# VERIFIED_LEASE_ONLY happen on all interfaces except hme0, specify:
340Sstevel@tonic-gate#
35*9633Sjames.d.carlson@sun.com# hme0.VERIFIED_LEASE_ONLY=no
36*9633Sjames.d.carlson@sun.com# VERIFIED_LEASE_ONLY=yes
373431Scarlsonj#
383431Scarlsonj# An interface name alone specifies IPv4 DHCP.  For DHCPv6, append ".v6".
393431Scarlsonj# Some examples:
403431Scarlsonj#
41*9633Sjames.d.carlson@sun.com# hme0.VERIFIED_LEASE_ONLY=no		specify hme0 v4 behavior
42*9633Sjames.d.carlson@sun.com# hme0.v6.VERIFIED_LEASE_ONLY=no	specify hme0 v6 behavior
43*9633Sjames.d.carlson@sun.com# VERIFIED_LEASE_ONLY=no		match all v4 interfaces
44*9633Sjames.d.carlson@sun.com# .v6.VERIFIED_LEASE_ONLY=no		match all v6 interfaces
450Sstevel@tonic-gate
463431Scarlsonj# By default, when the DHCP agent is sent a SIGTERM (typically when
473431Scarlsonj# the system is shut down), all managed addresses are dropped rather
483431Scarlsonj# than released.  Dropping an address does not notify the DHCP server
493431Scarlsonj# that the address is no longer in use, leaving it possibly available
503431Scarlsonj# for subsequent use by the same client.  If DHCP is later restarted
513431Scarlsonj# on the interface, the client will ask the server if it can continue
523431Scarlsonj# to use the address.  If the server either grants the request, or
533431Scarlsonj# does not answer (and the lease has not yet expired), then the client
543431Scarlsonj# will use the original address.
553431Scarlsonj#
56*9633Sjames.d.carlson@sun.com# Similarly, when the system is suspended and then woken up or when
57*9633Sjames.d.carlson@sun.com# the link status transitions from down to up, DHCP will ask the server
58*9633Sjames.d.carlson@sun.com# to continue to use the managed address, in case the lease has changed.
59*9633Sjames.d.carlson@sun.com#
603431Scarlsonj# By uncommenting the following parameter-value pairs, all managed
61*9633Sjames.d.carlson@sun.com# addresses are released on SIGTERM instead, and any that may have been
62*9633Sjames.d.carlson@sun.com# saved but cannot be verified will not be used.  When SIGTERM is
63*9633Sjames.d.carlson@sun.com# received, the DHCP server is notified that the address is available
64*9633Sjames.d.carlson@sun.com# for use, and the address will not be saved for a later restart.  If
65*9633Sjames.d.carlson@sun.com# DHCP receives SIGTHAW or a link-up event, DHCP will attempt to verify
66*9633Sjames.d.carlson@sun.com# the previous lease, but if unable to do so, it will not attempt to
67*9633Sjames.d.carlson@sun.com# use that lease.  This behavior is often preferred for roaming systems.
680Sstevel@tonic-gate#
69*9633Sjames.d.carlson@sun.com# VERIFIED_LEASE_ONLY=yes
70*9633Sjames.d.carlson@sun.com# .v6.VERIFIED_LEASE_ONLY=yes
710Sstevel@tonic-gate
720Sstevel@tonic-gate# By default, the DHCP agent waits 3 seconds to collect OFFER
730Sstevel@tonic-gate# responses to a DISCOVER.  If it receives no OFFERs in this time, it
740Sstevel@tonic-gate# then waits for another 3 seconds, and so forth.  To change this
750Sstevel@tonic-gate# behavior, set and uncomment the following parameter-value pair.
760Sstevel@tonic-gate# Note: this does not control the retransmission strategy for
770Sstevel@tonic-gate# DISCOVERs, which is formally specified in RFC 2131.  This parameter
780Sstevel@tonic-gate# is specified in seconds.
790Sstevel@tonic-gate#
800Sstevel@tonic-gate# OFFER_WAIT=
810Sstevel@tonic-gate
820Sstevel@tonic-gate# By default, the DHCP agent does not send out a client identifier
830Sstevel@tonic-gate# (and hence, the chaddr field is used by the DHCP server as the
840Sstevel@tonic-gate# client identifier.)  To make the DHCP agent send a client
850Sstevel@tonic-gate# identifier, set and uncomment the following parameter-value pair.
860Sstevel@tonic-gate# Note that by default this is treated as an NVT ASCII string.  To
870Sstevel@tonic-gate# specify a binary value, prepend "0x" to a sequence of hexadecimal
880Sstevel@tonic-gate# digits (for example, the value 0xAABBCC11 would set the client
890Sstevel@tonic-gate# identifier to the 4-byte binary sequence 0xAA 0xBB 0xCC 0x11).
900Sstevel@tonic-gate#
910Sstevel@tonic-gate# CLIENT_ID=
920Sstevel@tonic-gate
930Sstevel@tonic-gate# By default, the DHCP agent will try to request the hostname currently
940Sstevel@tonic-gate# associated with the interface performing DHCP.  If this option is
950Sstevel@tonic-gate# enabled, the agent will attempt to find a host name in /etc/hostname.<if>,
960Sstevel@tonic-gate# which must contain a line of the form
970Sstevel@tonic-gate#
980Sstevel@tonic-gate#	inet name
990Sstevel@tonic-gate#
1000Sstevel@tonic-gate# where "name" is a single RFC 1101-compliant token.  If found, the token
1010Sstevel@tonic-gate# will be used to request that host name from the DHCP server.  To prevent
1020Sstevel@tonic-gate# this, uncomment the following line.
1030Sstevel@tonic-gate#
1040Sstevel@tonic-gate# REQUEST_HOSTNAME=no
1050Sstevel@tonic-gate
1060Sstevel@tonic-gate# By default, a parameter request list requesting a subnet mask (1),
1070Sstevel@tonic-gate# router (3), DNS server (6), hostname (12), DNS domain (15), broadcast
1080Sstevel@tonic-gate# address (28), and encapsulated vendor options (43), is sent to the DHCP
1090Sstevel@tonic-gate# server when the DHCP agent sends requests.  However, if desired, this
1100Sstevel@tonic-gate# can be changed by altering the following parameter-value pair.  The
1113431Scarlsonj# numbers correspond to the values defined in the IANA bootp-dhcp-parameters
112*9633Sjames.d.carlson@sun.com# registry at the time of this writing.  Site and standard option names from
113*9633Sjames.d.carlson@sun.com# /etc/dhcp/inittab are also accepted.
1140Sstevel@tonic-gate#
1150Sstevel@tonic-gatePARAM_REQUEST_LIST=1,3,6,12,15,28,43
1163431Scarlsonj
1173431Scarlsonj# The default DHCPv6 parameter request list has preference (7), unicast (12),
1183431Scarlsonj# DNS addresses (23), DNS search list (24), NIS addresses (27), and
1193431Scarlsonj# NIS domain (29).  This may be changed by altering the following parameter-
1203431Scarlsonj# value pair.  The numbers correspond to the values defined in the IANA
121*9633Sjames.d.carlson@sun.com# dhcpv6-parameters registry at the time of this writing.  Site and standard
122*9633Sjames.d.carlson@sun.com# option names from /etc/dhcp/inittab6 are also accepted.
1233431Scarlsonj.v6.PARAM_REQUEST_LIST=7,12,23,24,27,29
124*9633Sjames.d.carlson@sun.com
125*9633Sjames.d.carlson@sun.com# The parameter ignore list allows you to instruct the DHCP client to discard
126*9633Sjames.d.carlson@sun.com# optional parameters received from the DHCP server.  The format is the same
127*9633Sjames.d.carlson@sun.com# as the request list above.  When discarded, a parameter will not be acted
128*9633Sjames.d.carlson@sun.com# on by the DHCP client or returned to users via the dhcpinfo(1) command.
129*9633Sjames.d.carlson@sun.comPARAM_IGNORE_LIST=
130*9633Sjames.d.carlson@sun.com.v6.PARAM_IGNORE_LIST=
131