xref: /titanic_50/usr/src/cmd/cmd-inet/sbin/dhcpagent/dhcpagent.dfl (revision a1196271e1d6e6ce9cc40c8b94f5b659935e82bc)
17c478bd9Sstevel@tonic-gate#
27c478bd9Sstevel@tonic-gate# CDDL HEADER START
37c478bd9Sstevel@tonic-gate#
47c478bd9Sstevel@tonic-gate# The contents of this file are subject to the terms of the
569bb4bb4Scarlsonj# Common Development and Distribution License (the "License").
669bb4bb4Scarlsonj# You may not use this file except in compliance with the License.
77c478bd9Sstevel@tonic-gate#
87c478bd9Sstevel@tonic-gate# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
97c478bd9Sstevel@tonic-gate# or http://www.opensolaris.org/os/licensing.
107c478bd9Sstevel@tonic-gate# See the License for the specific language governing permissions
117c478bd9Sstevel@tonic-gate# and limitations under the License.
127c478bd9Sstevel@tonic-gate#
137c478bd9Sstevel@tonic-gate# When distributing Covered Code, include this CDDL HEADER in each
147c478bd9Sstevel@tonic-gate# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
157c478bd9Sstevel@tonic-gate# If applicable, add the following below this CDDL HEADER, with the
167c478bd9Sstevel@tonic-gate# fields enclosed by brackets "[]" replaced with your own identifying
177c478bd9Sstevel@tonic-gate# information: Portions Copyright [yyyy] [name of copyright owner]
187c478bd9Sstevel@tonic-gate#
197c478bd9Sstevel@tonic-gate# CDDL HEADER END
207c478bd9Sstevel@tonic-gate#
217c478bd9Sstevel@tonic-gate
227c478bd9Sstevel@tonic-gate#
23*a1196271SJames Carlson# Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
2469bb4bb4Scarlsonj# Use is subject to license terms.
2569bb4bb4Scarlsonj#
2669bb4bb4Scarlsonj
2769bb4bb4Scarlsonj#
287c478bd9Sstevel@tonic-gate# This file contains tunable parameters for dhcpagent(1M).
297c478bd9Sstevel@tonic-gate#
307c478bd9Sstevel@tonic-gate
317c478bd9Sstevel@tonic-gate# All parameters can be tuned for a specific interface by prepending
327c478bd9Sstevel@tonic-gate# the interface name to the parameter name.  For example, to make
33*a1196271SJames Carlson# VERIFIED_LEASE_ONLY happen on all interfaces except hme0, specify:
347c478bd9Sstevel@tonic-gate#
35*a1196271SJames Carlson# hme0.VERIFIED_LEASE_ONLY=no
36*a1196271SJames Carlson# VERIFIED_LEASE_ONLY=yes
37d04ccbb3Scarlsonj#
38d04ccbb3Scarlsonj# An interface name alone specifies IPv4 DHCP.  For DHCPv6, append ".v6".
39d04ccbb3Scarlsonj# Some examples:
40d04ccbb3Scarlsonj#
41*a1196271SJames Carlson# hme0.VERIFIED_LEASE_ONLY=no		specify hme0 v4 behavior
42*a1196271SJames Carlson# hme0.v6.VERIFIED_LEASE_ONLY=no	specify hme0 v6 behavior
43*a1196271SJames Carlson# VERIFIED_LEASE_ONLY=no		match all v4 interfaces
44*a1196271SJames Carlson# .v6.VERIFIED_LEASE_ONLY=no		match all v6 interfaces
457c478bd9Sstevel@tonic-gate
46d04ccbb3Scarlsonj# By default, when the DHCP agent is sent a SIGTERM (typically when
47d04ccbb3Scarlsonj# the system is shut down), all managed addresses are dropped rather
48d04ccbb3Scarlsonj# than released.  Dropping an address does not notify the DHCP server
49d04ccbb3Scarlsonj# that the address is no longer in use, leaving it possibly available
50d04ccbb3Scarlsonj# for subsequent use by the same client.  If DHCP is later restarted
51d04ccbb3Scarlsonj# on the interface, the client will ask the server if it can continue
52d04ccbb3Scarlsonj# to use the address.  If the server either grants the request, or
53d04ccbb3Scarlsonj# does not answer (and the lease has not yet expired), then the client
54d04ccbb3Scarlsonj# will use the original address.
55d04ccbb3Scarlsonj#
56*a1196271SJames Carlson# Similarly, when the system is suspended and then woken up or when
57*a1196271SJames Carlson# the link status transitions from down to up, DHCP will ask the server
58*a1196271SJames Carlson# to continue to use the managed address, in case the lease has changed.
597c478bd9Sstevel@tonic-gate#
60*a1196271SJames Carlson# By uncommenting the following parameter-value pairs, all managed
61*a1196271SJames Carlson# addresses are released on SIGTERM instead, and any that may have been
62*a1196271SJames Carlson# saved but cannot be verified will not be used.  When SIGTERM is
63*a1196271SJames Carlson# received, the DHCP server is notified that the address is available
64*a1196271SJames Carlson# for use, and the address will not be saved for a later restart.  If
65*a1196271SJames Carlson# DHCP receives SIGTHAW or a link-up event, DHCP will attempt to verify
66*a1196271SJames Carlson# the previous lease, but if unable to do so, it will not attempt to
67*a1196271SJames Carlson# use that lease.  This behavior is often preferred for roaming systems.
68*a1196271SJames Carlson#
69*a1196271SJames Carlson# VERIFIED_LEASE_ONLY=yes
70*a1196271SJames Carlson# .v6.VERIFIED_LEASE_ONLY=yes
717c478bd9Sstevel@tonic-gate
727c478bd9Sstevel@tonic-gate# By default, the DHCP agent waits 3 seconds to collect OFFER
737c478bd9Sstevel@tonic-gate# responses to a DISCOVER.  If it receives no OFFERs in this time, it
747c478bd9Sstevel@tonic-gate# then waits for another 3 seconds, and so forth.  To change this
757c478bd9Sstevel@tonic-gate# behavior, set and uncomment the following parameter-value pair.
767c478bd9Sstevel@tonic-gate# Note: this does not control the retransmission strategy for
777c478bd9Sstevel@tonic-gate# DISCOVERs, which is formally specified in RFC 2131.  This parameter
787c478bd9Sstevel@tonic-gate# is specified in seconds.
797c478bd9Sstevel@tonic-gate#
807c478bd9Sstevel@tonic-gate# OFFER_WAIT=
817c478bd9Sstevel@tonic-gate
827c478bd9Sstevel@tonic-gate# By default, the DHCP agent does not send out a client identifier
837c478bd9Sstevel@tonic-gate# (and hence, the chaddr field is used by the DHCP server as the
847c478bd9Sstevel@tonic-gate# client identifier.)  To make the DHCP agent send a client
857c478bd9Sstevel@tonic-gate# identifier, set and uncomment the following parameter-value pair.
867c478bd9Sstevel@tonic-gate# Note that by default this is treated as an NVT ASCII string.  To
877c478bd9Sstevel@tonic-gate# specify a binary value, prepend "0x" to a sequence of hexadecimal
887c478bd9Sstevel@tonic-gate# digits (for example, the value 0xAABBCC11 would set the client
897c478bd9Sstevel@tonic-gate# identifier to the 4-byte binary sequence 0xAA 0xBB 0xCC 0x11).
907c478bd9Sstevel@tonic-gate#
917c478bd9Sstevel@tonic-gate# CLIENT_ID=
927c478bd9Sstevel@tonic-gate
937c478bd9Sstevel@tonic-gate# By default, the DHCP agent will try to request the hostname currently
947c478bd9Sstevel@tonic-gate# associated with the interface performing DHCP.  If this option is
957c478bd9Sstevel@tonic-gate# enabled, the agent will attempt to find a host name in /etc/hostname.<if>,
967c478bd9Sstevel@tonic-gate# which must contain a line of the form
977c478bd9Sstevel@tonic-gate#
987c478bd9Sstevel@tonic-gate#	inet name
997c478bd9Sstevel@tonic-gate#
1007c478bd9Sstevel@tonic-gate# where "name" is a single RFC 1101-compliant token.  If found, the token
1017c478bd9Sstevel@tonic-gate# will be used to request that host name from the DHCP server.  To prevent
1027c478bd9Sstevel@tonic-gate# this, uncomment the following line.
1037c478bd9Sstevel@tonic-gate#
1047c478bd9Sstevel@tonic-gate# REQUEST_HOSTNAME=no
1057c478bd9Sstevel@tonic-gate
1067c478bd9Sstevel@tonic-gate# By default, a parameter request list requesting a subnet mask (1),
1077c478bd9Sstevel@tonic-gate# router (3), DNS server (6), hostname (12), DNS domain (15), broadcast
1087c478bd9Sstevel@tonic-gate# address (28), and encapsulated vendor options (43), is sent to the DHCP
1097c478bd9Sstevel@tonic-gate# server when the DHCP agent sends requests.  However, if desired, this
1107c478bd9Sstevel@tonic-gate# can be changed by altering the following parameter-value pair.  The
111d04ccbb3Scarlsonj# numbers correspond to the values defined in the IANA bootp-dhcp-parameters
112*a1196271SJames Carlson# registry at the time of this writing.  Site and standard option names from
113*a1196271SJames Carlson# /etc/dhcp/inittab are also accepted.
1147c478bd9Sstevel@tonic-gate#
1157c478bd9Sstevel@tonic-gatePARAM_REQUEST_LIST=1,3,6,12,15,28,43
116d04ccbb3Scarlsonj
117d04ccbb3Scarlsonj# The default DHCPv6 parameter request list has preference (7), unicast (12),
118d04ccbb3Scarlsonj# DNS addresses (23), DNS search list (24), NIS addresses (27), and
119d04ccbb3Scarlsonj# NIS domain (29).  This may be changed by altering the following parameter-
120d04ccbb3Scarlsonj# value pair.  The numbers correspond to the values defined in the IANA
121*a1196271SJames Carlson# dhcpv6-parameters registry at the time of this writing.  Site and standard
122*a1196271SJames Carlson# option names from /etc/dhcp/inittab6 are also accepted.
123d04ccbb3Scarlsonj.v6.PARAM_REQUEST_LIST=7,12,23,24,27,29
124*a1196271SJames Carlson
125*a1196271SJames Carlson# The parameter ignore list allows you to instruct the DHCP client to discard
126*a1196271SJames Carlson# optional parameters received from the DHCP server.  The format is the same
127*a1196271SJames Carlson# as the request list above.  When discarded, a parameter will not be acted
128*a1196271SJames Carlson# on by the DHCP client or returned to users via the dhcpinfo(1) command.
129*a1196271SJames CarlsonPARAM_IGNORE_LIST=
130*a1196271SJames Carlson.v6.PARAM_IGNORE_LIST=
131