components/isc-dhcp/isc-dhcp.5
changeset 280 c0dae1e3ca2f
child 5826 9c90e4a8156c
equal deleted inserted replaced
279:c6af843791cd 280:c0dae1e3ca2f
       
     1 .TH isc-dhcp 5 "17 May 2011" "SunOS 5.11"
       
     2 .SH NAME
       
     3 isc\-dhcp \- ISC Dynamic Host Configuration Protocol Software
       
     4 
       
     5 .SH DESCRIPTION
       
     6 .sp
       
     7 .LP
       
     8 The Internet Systems Consortium (ISC) DHCP Server (dhcpd)
       
     9 implements the Dynamic Host Configuration Protocol
       
    10 (DHCPv4 and DHCPv6), and the Internet Bootstrap Protocol
       
    11 (BOOTP). DHCP allows hosts on a TCP/IP network to request
       
    12 and be assigned IP addresses, and also to discover information
       
    13 about the network to which they are attached.  BOOTP
       
    14 provides similar functionality, with certain restrictions.
       
    15 .sp
       
    16 .LP
       
    17 ISC Relay Agent (dhcrelay) provides a means for relaying DHCP
       
    18 and BOOTP requests from a subnet to which no DHCP server is
       
    19 directly connected to one or more DHCP servers on other subnets.
       
    20 .sp
       
    21 .LP
       
    22 The services above (dhcpd and dhcrelay) are managed using the Service
       
    23 Management Facility (SMF) on Solaris, and should be administered by
       
    24 the svcadm(1M) command using  the following fault management resource
       
    25 identifiers (FMRIs):
       
    26 .sp
       
    27 .LP
       
    28 .in +2
       
    29 .nf
       
    30 svc:/network/dhcp/server:ipv4
       
    31 svc:/network/dhcp/server:ipv6
       
    32 svc:/network/dhcp/relay:ipv4
       
    33 svc:/network/dhcp/relay:ipv6
       
    34 .fi
       
    35 .sp
       
    36 .LP
       
    37 The following dhcpd service configuration properties can be viewed with
       
    38 svcprop(1M) and modified via svccfg(1M):
       
    39 .sp
       
    40 .ne 2
       
    41 .mk
       
    42 .na
       
    43 debug
       
    44 .ad
       
    45 .sp .6
       
    46 .RS 4n
       
    47 Send log messages from the DHCP daemon to  the  standard  error  descriptor.
       
    48 Setting this property to true ensures the -d command-line option is
       
    49 used when starting dhcpd. This property is set to false by default.
       
    50 .RE
       
    51 
       
    52 .sp
       
    53 .ne 2
       
    54 .mk
       
    55 .na
       
    56 config_file
       
    57 .ad
       
    58 .sp .6
       
    59 .RS 4n
       
    60 Path to alternate configuration file. The value of this property
       
    61 is passed as an argument to the -cf command-line option of dhcpd.
       
    62 The default is set to /etc/inet/dhcpd6.conf and /etc/inet/dhcpd4.conf
       
    63 for DHCP v6 and v4 servers respectively.
       
    64 .RE
       
    65 
       
    66 .sp
       
    67 .ne 2
       
    68 .mk
       
    69 .na
       
    70 lease_file
       
    71 .ad
       
    72 .sp .6
       
    73 .RS 4n
       
    74 Path to alternate lease file. The value of this property is passed
       
    75 as an argument to the -lf command-line option of dhcpd. The default value
       
    76 is set to /var/db/isc-dhcp/v4.leases for DHCPv4 and /var/db/isc-dhcp/v6.leases for
       
    77 DHCPv6.
       
    78 .RE
       
    79 
       
    80 .sp
       
    81 .ne 2
       
    82 .mk
       
    83 .na
       
    84 listen_ifnames
       
    85 .ad
       
    86 .sp .6
       
    87 .RS 4n
       
    88 optional parameter that allows users to specify one or more network
       
    89 interfaces on which dhcpd should serve DHCP requests. This property
       
    90 matches the "if0" command-line option of dhcpd.  Note that the
       
    91 interface names must be seperated by a comma.  Please see Example 4.
       
    92 .RE
       
    93 
       
    94 .sp
       
    95 .LP
       
    96 The following dhcrelay options are available as
       
    97 service configuration properties and can be viewed with svcprop(1M)
       
    98 and modified via svccfg(1M):
       
    99 .sp
       
   100 .ne 2
       
   101 .mk
       
   102 .na
       
   103 append_agent_option (v4 only)
       
   104 .ad
       
   105 .sp .6
       
   106 .RS 4n
       
   107 Setting this option to true ensures the DHCP relay appends an agent option
       
   108 field to each request before forwarding the request to the DHCP
       
   109 server. When this property is set to true, the -a command-line option
       
   110 is used when launching dhcrelay. The default value of this property is
       
   111 false. This option is only applicable to the svc:/network/dhcp/relay:ipv4 service. 
       
   112 .RE
       
   113 
       
   114 .sp
       
   115 .ne 2
       
   116 .mk
       
   117 .na
       
   118 listen_ifnames (v4 only)
       
   119 .ad
       
   120 .sp .6
       
   121 .RS 4n
       
   122 This option allows users to specify one or more interfaces on which
       
   123 the DHCP relay should listen for DHCPv4/BOOTP queries. This option is
       
   124 only applicable to the svc:/network/dhcp/relay:ipv4 service. 
       
   125 
       
   126 .RE
       
   127 
       
   128 .sp
       
   129 .ne 2
       
   130 .mk
       
   131 .na
       
   132 servers (v4 only)
       
   133 .ad
       
   134 .sp .6
       
   135 .RS 4n
       
   136 Users must set this property to the IP addresses of one or more
       
   137 servers before enabling the relay service
       
   138 (svc:/network/dhcp/relay:ipv4). The servers property value must be a
       
   139 comma-separated list of IP addresses. This option is
       
   140 only applicable to the svc:/network/dhcp/relay:ipv4 service. 
       
   141 
       
   142 .RE
       
   143 
       
   144 .sp
       
   145 .ne 2
       
   146 .mk
       
   147 .na
       
   148 receive_query_links (v6 only)
       
   149 .ad
       
   150 .sp .6
       
   151 .RS 4n
       
   152 Users must set this property value to specify the interface(s) on which
       
   153 queries will be received from clients or from other relay agents
       
   154 before enabling the relay service (svc:/network/dhcp/relay:ipv6).
       
   155 This option is only applicable to the svc:/network/dhcp/relay:ipv6 service. 
       
   156 See also Example 3.
       
   157 .RE
       
   158 
       
   159 .sp
       
   160 .ne 2
       
   161 .mk
       
   162 .na
       
   163 forward_query_links (v6 only)
       
   164 .ad
       
   165 .sp .6
       
   166 .RS 4n
       
   167 Users must set this property value to specify the interface(s) on which
       
   168 queries from clients and other relay agents should be forwarded before
       
   169 enabling the relay service (svc:/network/dhcp/relay:ipv6).  The
       
   170 property value is passed as the argument for the -u command-line
       
   171 option to the dhcrelay program. The interface(s) specified must be
       
   172 comma-separated. This option is only applicable to the
       
   173 svc:/network/dhcp/relay:ipv6 service. 
       
   174 .RE
       
   175 
       
   176 .sp
       
   177 .LP
       
   178 Since dhcpd and dhcrelay are managed using SMF no pid files are created.  
       
   179 .sp
       
   180 .LP
       
   181 
       
   182 .SH EXAMPLES
       
   183 .sp
       
   184 .LP
       
   185 \fBExample 1 \fR Enabling DHCPv4 Server 
       
   186 ISC DHCPv4 server service is disabled by default. The following
       
   187 command enables the ISC DHCPv4 service:
       
   188 
       
   189 .in +2
       
   190 .nf
       
   191 example# svcadm enable svc:/network/dhcp/server:ipv4
       
   192 .fi
       
   193 .in -2
       
   194 
       
   195 \fBExample 2 \fR Displaying the configurable properties of DHCPv6 Relay
       
   196 Agent service.  The following command displays all configurable properties of 
       
   197 DHCPv6 Relay Agent Service:
       
   198 
       
   199 .in +2
       
   200 .nf
       
   201 example# svccfg -s dhcp/relay:ipv6 listprop config
       
   202 config                      application
       
   203 config/forward_query_links  astring  
       
   204 config/listen_ifnames       astring  
       
   205 config/receive_query_links  astring  
       
   206 config/value_authorization  astring  solaris.smf.value.dhcp
       
   207 .fi
       
   208 .in -2
       
   209 
       
   210 .PP
       
   211 \fBExample 3 \fR Setting the receive_query_links property value of DHCPv6 Relay
       
   212 Agent service.  The following commands will set the receive_links property value to the
       
   213 following values: 10.0.0.1%e10000g#0,bge0,iprb#1
       
   214 
       
   215 .in +2
       
   216 .nf
       
   217 example# svccfg -s dhcp/relay:ipv6 setprop \\
       
   218     config/receive_query_links= \\
       
   219     \\(\\"10.0.0.1%e10000g#0\\"\\"bge0\\"\\"iprb#1\\"\\)
       
   220 example# svccfg -s dhcp/relay:ipv6 refresh
       
   221 
       
   222 NOTE: spaces are not allowed in the string within quotes in the
       
   223       setprop command 
       
   224 
       
   225 To verify that the property values are set type either
       
   226 the svccfg command or the svcprop command below:
       
   227 
       
   228 example# svccfg -s dhcp/relay:ipv6 listprop config/receive_query_links
       
   229 config/receive_query_links  astring  "10.0.0.1%e10000g#0" "bge0" "iprb#1"
       
   230 
       
   231 example# svcprop -p config/receive_query_links dhcp/relay:ipv6
       
   232 10.0.0.1%e10000g#0 bge0 iprb#1
       
   233 .fi
       
   234 .in -2
       
   235 
       
   236 \fBExample 4 \fR Setting the listen_ifnames property value for dhcpd.
       
   237 The following commands will set the listen_ifnames property to 
       
   238 "bge0, bge1" and then display the updated values.
       
   239 
       
   240 .in +2
       
   241 .nf
       
   242 example# svccfg -s dhcp/server:ipv4 setprop \\
       
   243     config/listen_ifnames = \\(\\"bge0\\"\\"bge1\\"\\) 
       
   244 example# svccfg -s dhcp/server:ipv4 refresh
       
   245 
       
   246 NOTE: spaces are not allowed in the string within quotes in the
       
   247       setprop command 
       
   248 
       
   249 To verify that the property values are set type:
       
   250 
       
   251 example# svccfg -s dhcp/server:ipv4 listprop config/listen_ifnames
       
   252 config/listen_ifnames  astring  "bge0" "bge1" 
       
   253 .fi
       
   254 .in -2
       
   255 
       
   256 .SH SEE ALSO
       
   257 .sp
       
   258 .LP
       
   259 svccfg(1M), svcprop(1), svcadm(1M), dhcpd(8), dhcrelay(8)