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