xref: /illumos-gate/usr/src/cmd/cmd-inet/sbin/dhcpagent/dhcpagent.dfl (revision eb9a1df2aeb866bf1de4494433b6d7e5fa07b3ae)
1#
2# CDDL HEADER START
3#
4# The contents of this file are subject to the terms of the
5# Common Development and Distribution License (the "License").
6# You may not use this file except in compliance with the License.
7#
8# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9# or http://www.opensolaris.org/os/licensing.
10# See the License for the specific language governing permissions
11# and limitations under the License.
12#
13# When distributing Covered Code, include this CDDL HEADER in each
14# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15# If applicable, add the following below this CDDL HEADER, with the
16# fields enclosed by brackets "[]" replaced with your own identifying
17# information: Portions Copyright [yyyy] [name of copyright owner]
18#
19# CDDL HEADER END
20#
21
22#
23# Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
24# Use is subject to license terms.
25# Copyright (c) 2016-2017, Chris Fraire <cfraire@me.com>.
26#
27
28#
29# This file contains tunable parameters for dhcpagent(1M).
30#
31
32# All parameters can be tuned for a specific interface by prepending
33# the interface name to the parameter name.  For example, to make
34# VERIFIED_LEASE_ONLY happen on all interfaces except hme0, specify:
35#
36# hme0.VERIFIED_LEASE_ONLY=no
37# VERIFIED_LEASE_ONLY=yes
38#
39# An interface name alone specifies IPv4 DHCP.  For DHCPv6, append ".v6".
40# Some examples:
41#
42# hme0.VERIFIED_LEASE_ONLY=no		specify hme0 v4 behavior
43# hme0.v6.VERIFIED_LEASE_ONLY=no	specify hme0 v6 behavior
44# VERIFIED_LEASE_ONLY=no		match all v4 interfaces
45# .v6.VERIFIED_LEASE_ONLY=no		match all v6 interfaces
46
47# By default, when the DHCP agent is sent a SIGTERM (typically when
48# the system is shut down), all managed addresses are dropped rather
49# than released.  Dropping an address does not notify the DHCP server
50# that the address is no longer in use, leaving it possibly available
51# for subsequent use by the same client.  If DHCP is later restarted
52# on the interface, the client will ask the server if it can continue
53# to use the address.  If the server either grants the request, or
54# does not answer (and the lease has not yet expired), then the client
55# will use the original address.
56#
57# Similarly, when the system is suspended and then woken up or when
58# the link status transitions from down to up, DHCP will ask the server
59# to continue to use the managed address, in case the lease has changed.
60#
61# By uncommenting the following parameter-value pairs, all managed
62# addresses are released on SIGTERM instead, and any that may have been
63# saved but cannot be verified will not be used.  When SIGTERM is
64# received, the DHCP server is notified that the address is available
65# for use, and the address will not be saved for a later restart.  If
66# DHCP receives SIGTHAW or a link-up event, DHCP will attempt to verify
67# the previous lease, but if unable to do so, it will not attempt to
68# use that lease.  This behavior is often preferred for roaming systems.
69#
70# VERIFIED_LEASE_ONLY=yes
71# .v6.VERIFIED_LEASE_ONLY=yes
72
73# By default, the DHCP agent waits 3 seconds to collect OFFER
74# responses to a DISCOVER.  If it receives no OFFERs in this time, it
75# then waits for another 3 seconds, and so forth.  To change this
76# behavior, set and uncomment the following parameter-value pair.
77# Note: this does not control the retransmission strategy for
78# DISCOVERs, which is formally specified in RFC 2131.  This parameter
79# is specified in seconds.
80#
81# OFFER_WAIT=
82
83# By default, the DHCP agent does not send out a client identifier
84# (and hence, the chaddr field is used by the DHCP server as the
85# client identifier.)  To make the DHCP agent send a client
86# identifier, set and uncomment the following parameter-value pair.
87# Note that by default this is treated as an NVT ASCII string.  To
88# specify a binary value, prepend "0x" to a sequence of hexadecimal
89# digits (for example, the value 0xAABBCC11 would set the client
90# identifier to the 4-byte binary sequence 0xAA 0xBB 0xCC 0x11).
91#
92# CLIENT_ID=
93
94# By default, for an IPv4 interface that is not in an IP network
95# multipathing (IPMP) group, that is not IP over InfiniBand (IPoIB), and
96# that is not a logical interface, the DHCP agent will forgo sending a
97# client identifier unless CLIENT_ID is defined.
98#
99# To use a system-managed, RFC 3315-style (i.e., DHCPv6-style) binding
100# identifier as documented in RFC 4361, "Node-specific Client Identifiers
101# for DHCPv4," for all IPv4 interfaces (unless CLIENT_ID is defined),
102# uncomment the following line.
103#
104# V4_DEFAULT_IAID_DUID=yes
105
106# By default, the DHCP agent will try to request the Fully Qualified Domain
107# Name (FQDN) currently associated with the interface performing DHCP.  The
108# hostname is defined by using the -h,--reqhost option of ipadm(1M) or the
109# ncu ip-reqhost property of nwamcfg(1M) or by flagging the interface as
110# primary so that nodename(4) is used as the hostname.
111#
112# A defined hostname will be used as the FQDN if it is "rooted" (i.e., if
113# it ends with a '.') or if it consists of at least three DNS labels (e.g.,
114# srv.example.com).  If the hostname is not an FQDN, then DNS_DOMAINNAME
115# will be appended if defined or ADOPT_DOMAINNAME discernment will be used
116# if active.  If no FQDN can be determined, the option will not be used.
117#
118# If this REQUEST_FQDN option is enabled, an FQDN will be sent in messages
119# to the DHCP server along with RFC 4702 options to request that a
120# collaborating DNS server perform DNS updates for A and PTR resource
121# records.  To prevent sending FQDN and DNS options, uncomment the line
122# below.
123#
124# If an FQDN is sent, REQUEST_HOSTNAME processing will not be done, per RFC
125# 4702 (3.1):  "clients that send the Client FQDN option in their messages
126# MUST NOT also send the Host Name."
127#
128# REQUEST_FQDN=no
129
130# By default, the DHCP agent will not attempt to construct an FQDN from a
131# PQDN specified by the -h,--reqhost option of ipadm(1M), by the ncu
132# ip-reqhost property of nwamcfg(1M), or by nodename(4).  Set and
133# uncomment the following parameter to indicate a domain name to be used by
134# the DHCP agent to construct if necessary an FQDN.
135#
136# DNS_DOMAINNAME=
137
138# By default, the DHCP agent will not attempt to use a domain name returned
139# by the DHCP server or the domain in resolv.conf(4) to construct an FQDN
140# from a PQDN specified by the -h,--reqhost option of ipadm(1M), by the ncu
141# ip-reqhost property of nwamcfg(1M), or by nodename(4).  Set and uncomment
142# the following parameter to indicate that a returned DHCPv4 DNSdmain or the
143# domain from resolv.conf(4) should be adopted by the DHCP agent to
144# construct if necessary an FQDN.
145#
146# ADOPT_DOMAINNAME=yes
147
148# By default, the DHCP agent will try to request the hostname currently
149# associated with the interface performing DHCP.  If this option is
150# enabled, the agent will attempt to use an -h,--reqhost option saved with
151# ipadm(1M) or an ncu ip-reqhost property set with nwamcfg(1M); or else
152# attempt to find a host name in /etc/hostname.<if>, which must contain a
153# line of the form
154#
155#	inet name
156#
157# where "name" is a single RFC 1101-compliant token; or else use
158# nodename(4) for a DHCP interface flagged as primary.  If found in any of
159# these configurations, the token will be used to request that host name
160# from the DHCP server.  To prevent this, uncomment the following line.
161#
162# REQUEST_HOSTNAME=no
163
164# By default, a parameter request list requesting a subnet mask (1),
165# router (3), DNS server (6), hostname (12), DNS domain (15), broadcast
166# address (28), and encapsulated vendor options (43), is sent to the DHCP
167# server when the DHCP agent sends requests.  However, if desired, this
168# can be changed by altering the following parameter-value pair.  The
169# numbers correspond to the values defined in the IANA bootp-dhcp-parameters
170# registry at the time of this writing.  Site and standard option names from
171# /etc/dhcp/inittab are also accepted.
172#
173PARAM_REQUEST_LIST=1,3,6,12,15,28,43
174
175# The default DHCPv6 parameter request list has preference (7), unicast (12),
176# DNS addresses (23), DNS search list (24), NIS addresses (27), and
177# NIS domain (29).  This may be changed by altering the following parameter-
178# value pair.  The numbers correspond to the values defined in the IANA
179# dhcpv6-parameters registry at the time of this writing.  Site and standard
180# option names from /etc/dhcp/inittab6 are also accepted.
181.v6.PARAM_REQUEST_LIST=7,12,23,24,27,29
182
183# The parameter ignore list allows you to instruct the DHCP client to discard
184# optional parameters received from the DHCP server.  The format is the same
185# as the request list above.  When discarded, a parameter will not be acted
186# on by the DHCP client or returned to users via the dhcpinfo(1) command.
187PARAM_IGNORE_LIST=
188.v6.PARAM_IGNORE_LIST=
189