1 '\" te
   2 .\"  Copyright (c) 2003 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.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" 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 fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH DHCPSVC.CONF 4 "Jun 26, 2003"
   7 .SH NAME
   8 dhcpsvc.conf \- file containing service configuration parameters for the DHCP
   9 service
  10 .SH DESCRIPTION
  11 .sp
  12 .LP
  13 The \fBdhcpsvc.conf\fR file resides in directory \fB/etc/inet\fR and contains
  14 parameters for specifying Dynamic Host Configuration Protocol (\fBDHCP\fR)
  15 service configuration settings, including the type and location of \fBDHCP\fR
  16 data store used.
  17 .sp
  18 .LP
  19 The description of the \fBdhcpsvc.conf\fR file in this man page is
  20 informational only. The preferred method of setting or modifying values within
  21 the \fBdhcpsvc.conf\fR file is by using \fBdhcpconfig\fR(1M) or the
  22 \fBdhcpmgr\fR(1M) utility. Do not edit the \fBdhcpsvc.conf\fR file.
  23 .sp
  24 .LP
  25 The \fBdhcpsvc.conf\fR file format is \fBASCII\fR; comment lines begin with the
  26 crosshatch (\fB#\fR) character. Parameters consist of a keyword followed by an
  27 equals (\fB=\fR) sign followed by the parameter value, of the form:
  28 .sp
  29 .in +2
  30 .nf
  31 \fIKeyword\fR=\fIValue\fR
  32 .fi
  33 .in -2
  34 .sp
  35 
  36 .sp
  37 .LP
  38 The following \fIKeyword\fR and \fIValue\fR parameters are supported:
  39 .sp
  40 .ne 2
  41 .na
  42 \fBBOOTP_COMPAT\fR
  43 .ad
  44 .RS 28n
  45 String. \fBautomatic\fR or \fBmanual\fR. Enables support of \fBBOOTP\fR
  46 clients. Default is no \fBBOOTP\fR. Value selects \fBBOOTP\fR address
  47 allocation method. \fBautomatic\fR to support all BOOTP clients, \fBmanual\fR
  48 to support only registered \fBBOOTP\fR clients. \fBserver\fR mode only
  49 parameter.
  50 .RE
  51 
  52 .sp
  53 .ne 2
  54 .na
  55 \fBCACHE_TIMEOUT\fR
  56 .ad
  57 .RS 28n
  58 Integer. Number of seconds the server caches data from data store. Used to
  59 improve performance. Default is 10 seconds. \fBserver\fR mode only parameter.
  60 .RE
  61 
  62 .sp
  63 .ne 2
  64 .na
  65 \fBCONVER\fR
  66 .ad
  67 .RS 28n
  68 Integer. Container version. Used by DHCP administrative tools to identify which
  69 version of the public module is being used to administer the data store.
  70 \fBCONVER\fR should \fBnot\fR be changed manually.
  71 .RE
  72 
  73 .sp
  74 .ne 2
  75 .na
  76 \fBDAEMON_ENABLED\fR
  77 .ad
  78 .RS 28n
  79 \fBTRUE\fR/\fBFALSE\fR. If \fBTRUE\fR, the DHCP daemon can be run. If
  80 \fBFALSE\fR, DHCP daemon process exits immediately if the daemon is started.
  81 Default is \fBTRUE\fR. Generic parameter.
  82 .RE
  83 
  84 .sp
  85 .ne 2
  86 .na
  87 \fBHOSTS_DOMAIN\fR
  88 .ad
  89 .RS 28n
  90 String. Defines name service domain that DHCP administration tools use when
  91 managing the hosts table. Valid only when \fBHOSTS_RESOURCE\fR is set to
  92 \fBnisplus\fR or \fBdns\fR.
  93 .RE
  94 
  95 .sp
  96 .ne 2
  97 .na
  98 \fBHOSTS_RESOURCE\fR
  99 .ad
 100 .RS 28n
 101 String. Defines what name service resource should be used by the DHCP
 102 administration tools when managing the hosts table. Current valid values are
 103 \fBfiles\fR, \fBnisplus\fR, and \fBdns\fR.
 104 .RE
 105 
 106 .sp
 107 .ne 2
 108 .na
 109 \fBICMP_VERIFY\fR
 110 .ad
 111 .RS 28n
 112 \fBTRUE\fR/\fBFALSE\fR. Toggles \fBICMP\fR echo verification of IP addresses.
 113 Default is \fBTRUE\fR. \fBserver\fR mode only parameter.
 114 .RE
 115 
 116 .sp
 117 .ne 2
 118 .na
 119 \fBINTERFACES\fR
 120 .ad
 121 .RS 28n
 122 String. Comma-separated list of interface names to listen to. Generic
 123 parameter.
 124 .RE
 125 
 126 .sp
 127 .ne 2
 128 .na
 129 \fBLOGGING_FACILITY\fR
 130 .ad
 131 .RS 28n
 132 Integer. Local facility number (\fB0\fR-\fB7\fR inclusive) to log \fBDHCP\fR
 133 events to. Default is not to log transactions. Generic parameter.
 134 .RE
 135 
 136 .sp
 137 .ne 2
 138 .na
 139 \fBOFFER_CACHE_TIMEOUT\fR
 140 .ad
 141 .RS 28n
 142 Integer. Number of seconds before \fBOFFER\fR cache timeouts occur. Default is
 143 \fB10\fR seconds. \fBserver\fR mode only parameter.
 144 .RE
 145 
 146 .sp
 147 .ne 2
 148 .na
 149 \fBOWNER_IP\fR
 150 .ad
 151 .RS 28n
 152 String. List of supplemental ownership addresses  that will be used by the DHCP
 153 server in determining the \fBdhcp_network\fR records that are under its
 154 management. Addresses are in the dotted Internet form of an IPv4 address.
 155 Primary value is the IP address associated with the system's primary interface
 156 (\fInodename\fR == \fIhostname\fR). Server-mode-only parameter. Note that using
 157 \fBOWNER_IP\fR has some performance impact, thus using a large number might not
 158 be advisable.
 159 .RE
 160 
 161 .sp
 162 .ne 2
 163 .na
 164 \fBPATH\fR
 165 .ad
 166 .RS 28n
 167 Path to DHCP data tables within the data store specified by the RESOURCE
 168 parameter. The value of the \fBPATH\fR keyword is specific to the RESOURCE.
 169 .RE
 170 
 171 .sp
 172 .ne 2
 173 .na
 174 \fBRELAY_DESTINATIONS\fR
 175 .ad
 176 .RS 28n
 177 String. Comma-separated list of host names and/or \fBIP\fR addresses of relay
 178 destinations. \fBrelay\fR mode only parameter.
 179 .RE
 180 
 181 .sp
 182 .ne 2
 183 .na
 184 \fBRELAY_HOPS \fR
 185 .ad
 186 .RS 28n
 187 Integer. Max number of \fBBOOTP\fR relay hops before packet is dropped. Default
 188 is \fB4\fR. Generic parameter.
 189 .RE
 190 
 191 .sp
 192 .ne 2
 193 .na
 194 \fBRESCAN_INTERVAL\fR
 195 .ad
 196 .RS 28n
 197 Integer. Number of minutes between automatic \fBdhcptab\fR rescans. Default is
 198 not to do rescans. \fBserver\fR mode only parameter.
 199 .RE
 200 
 201 .sp
 202 .ne 2
 203 .na
 204 \fBRESOURCE\fR
 205 .ad
 206 .RS 28n
 207 Data store resource used. Use this parameter to name the public module. See the
 208 \fBPATH\fR keyword in \fBdhcp_modules\fR(5).
 209 .RE
 210 
 211 .sp
 212 .ne 2
 213 .na
 214 \fBRESOURCE_CONFIG\fR
 215 .ad
 216 .RS 28n
 217 String. The private layer provides for module-specific configuration
 218 information through the use of the \fBRESOURCE_CONFIG\fR keyword. See
 219 \fBdhcp_modules\fR(5).
 220 .sp
 221 Providers can access \fBRESOURCE_CONFIG\fR using the configure function by
 222 specifying an optional service provider layer API function:
 223 .sp
 224 .in +2
 225 .nf
 226 int configure(const char *configp);
 227 .fi
 228 .in -2
 229 
 230 If this function is defined by the public module provider, it is called during
 231 module load time by the private layer, with the contents of the
 232 \fBRESOURCE_CONFIG\fR string acquired by the administrative interface (in the
 233 case of the \fBdhcpmgr\fR, through the use of a public module-specific java
 234 bean extending the \fBdhcpmgr\fR to provide a configuration dialog for this
 235 information.
 236 .RE
 237 
 238 .sp
 239 .ne 2
 240 .na
 241 \fBRUN_MODE\fR
 242 .ad
 243 .RS 28n
 244 \fBserver\fR or \fBrelay\fR. Selects daemon run mode. Default is \fBserver\fR.
 245 .RE
 246 
 247 .sp
 248 .ne 2
 249 .na
 250 \fBSECONDARY_SERVER_TIMEOUT\fR
 251 .ad
 252 .RS 28n
 253 Integer. The number of seconds a secondary server waits for a primary server to
 254 respond before responding itself. Default is \fB20\fR seconds. This is a server
 255 mode only parameter.
 256 .RE
 257 
 258 .sp
 259 .ne 2
 260 .na
 261 \fBUPDATE_TIMEOUT\fR
 262 .ad
 263 .RS 28n
 264 Integer. Number of seconds to wait for a response from the DNS server before
 265 timing out. If this parameter is present, the DHCP daemon updates DNS on behalf
 266 of DHCP clients, and waits the number of seconds specified for a response
 267 before timing out. You can use \fBUPDATE_TIMEOUT\fR without specifying a number
 268 to enable DNS updates with the default timeout of 15 seconds. If this parameter
 269 is not present, the DHCP daemon does not update DNS for DHCP clients.
 270 .RE
 271 
 272 .sp
 273 .ne 2
 274 .na
 275 \fBVERBOSE\fR
 276 .ad
 277 .RS 28n
 278 \fBTRUE\fR/\fBFALSE\fR. Toggles verbose mode, determining amount of status and
 279 error messages reported by the daemon. Default is \fBFALSE\fR. Set to
 280 \fBTRUE\fR only for debugging. Generic parameter.
 281 .RE
 282 
 283 .SH SEE ALSO
 284 .sp
 285 .LP
 286 \fBdhcpmgr\fR(1M), \fBin.dhcpd\fR(1M), \fBdhcp\fR(5), \fBdhcp_modules\fR(5)
 287 .sp
 288 .LP
 289 \fISystem Administration Guide: IP Services\fR