components/isc-dhcp/isc-dhcp.5
author Rishi Srivatsavai <Rishi.Srivatsavai@oracle.com>
Thu, 02 Jun 2011 13:26:03 -0700
changeset 280 c0dae1e3ca2f
child 5826 9c90e4a8156c
permissions -rw-r--r--
PSARC 2011/043 Import ISC DHCP 7022308 Integrate ISC DHCP server and relay agent
.TH isc-dhcp 5 "17 May 2011" "SunOS 5.11"
.SH NAME
isc\-dhcp \- ISC Dynamic Host Configuration Protocol Software

.SH DESCRIPTION
.sp
.LP
The Internet Systems Consortium (ISC) DHCP Server (dhcpd)
implements the Dynamic Host Configuration Protocol
(DHCPv4 and DHCPv6), and the Internet Bootstrap Protocol
(BOOTP). DHCP allows hosts on a TCP/IP network to request
and be assigned IP addresses, and also to discover information
about the network to which they are attached.  BOOTP
provides similar functionality, with certain restrictions.
.sp
.LP
ISC Relay Agent (dhcrelay) provides a means for relaying DHCP
and BOOTP requests from a subnet to which no DHCP server is
directly connected to one or more DHCP servers on other subnets.
.sp
.LP
The services above (dhcpd and dhcrelay) are managed using the Service
Management Facility (SMF) on Solaris, and should be administered by
the svcadm(1M) command using  the following fault management resource
identifiers (FMRIs):
.sp
.LP
.in +2
.nf
svc:/network/dhcp/server:ipv4
svc:/network/dhcp/server:ipv6
svc:/network/dhcp/relay:ipv4
svc:/network/dhcp/relay:ipv6
.fi
.sp
.LP
The following dhcpd service configuration properties can be viewed with
svcprop(1M) and modified via svccfg(1M):
.sp
.ne 2
.mk
.na
debug
.ad
.sp .6
.RS 4n
Send log messages from the DHCP daemon to  the  standard  error  descriptor.
Setting this property to true ensures the -d command-line option is
used when starting dhcpd. This property is set to false by default.
.RE

.sp
.ne 2
.mk
.na
config_file
.ad
.sp .6
.RS 4n
Path to alternate configuration file. The value of this property
is passed as an argument to the -cf command-line option of dhcpd.
The default is set to /etc/inet/dhcpd6.conf and /etc/inet/dhcpd4.conf
for DHCP v6 and v4 servers respectively.
.RE

.sp
.ne 2
.mk
.na
lease_file
.ad
.sp .6
.RS 4n
Path to alternate lease file. The value of this property is passed
as an argument to the -lf command-line option of dhcpd. The default value
is set to /var/db/isc-dhcp/v4.leases for DHCPv4 and /var/db/isc-dhcp/v6.leases for
DHCPv6.
.RE

.sp
.ne 2
.mk
.na
listen_ifnames
.ad
.sp .6
.RS 4n
optional parameter that allows users to specify one or more network
interfaces on which dhcpd should serve DHCP requests. This property
matches the "if0" command-line option of dhcpd.  Note that the
interface names must be seperated by a comma.  Please see Example 4.
.RE

.sp
.LP
The following dhcrelay options are available as
service configuration properties and can be viewed with svcprop(1M)
and modified via svccfg(1M):
.sp
.ne 2
.mk
.na
append_agent_option (v4 only)
.ad
.sp .6
.RS 4n
Setting this option to true ensures the DHCP relay appends an agent option
field to each request before forwarding the request to the DHCP
server. When this property is set to true, the -a command-line option
is used when launching dhcrelay. The default value of this property is
false. This option is only applicable to the svc:/network/dhcp/relay:ipv4 service. 
.RE

.sp
.ne 2
.mk
.na
listen_ifnames (v4 only)
.ad
.sp .6
.RS 4n
This option allows users to specify one or more interfaces on which
the DHCP relay should listen for DHCPv4/BOOTP queries. This option is
only applicable to the svc:/network/dhcp/relay:ipv4 service. 

.RE

.sp
.ne 2
.mk
.na
servers (v4 only)
.ad
.sp .6
.RS 4n
Users must set this property to the IP addresses of one or more
servers before enabling the relay service
(svc:/network/dhcp/relay:ipv4). The servers property value must be a
comma-separated list of IP addresses. This option is
only applicable to the svc:/network/dhcp/relay:ipv4 service. 

.RE

.sp
.ne 2
.mk
.na
receive_query_links (v6 only)
.ad
.sp .6
.RS 4n
Users must set this property value to specify the interface(s) on which
queries will be received from clients or from other relay agents
before enabling the relay service (svc:/network/dhcp/relay:ipv6).
This option is only applicable to the svc:/network/dhcp/relay:ipv6 service. 
See also Example 3.
.RE

.sp
.ne 2
.mk
.na
forward_query_links (v6 only)
.ad
.sp .6
.RS 4n
Users must set this property value to specify the interface(s) on which
queries from clients and other relay agents should be forwarded before
enabling the relay service (svc:/network/dhcp/relay:ipv6).  The
property value is passed as the argument for the -u command-line
option to the dhcrelay program. The interface(s) specified must be
comma-separated. This option is only applicable to the
svc:/network/dhcp/relay:ipv6 service. 
.RE

.sp
.LP
Since dhcpd and dhcrelay are managed using SMF no pid files are created.  
.sp
.LP

.SH EXAMPLES
.sp
.LP
\fBExample 1 \fR Enabling DHCPv4 Server 
ISC DHCPv4 server service is disabled by default. The following
command enables the ISC DHCPv4 service:

.in +2
.nf
example# svcadm enable svc:/network/dhcp/server:ipv4
.fi
.in -2

\fBExample 2 \fR Displaying the configurable properties of DHCPv6 Relay
Agent service.  The following command displays all configurable properties of 
DHCPv6 Relay Agent Service:

.in +2
.nf
example# svccfg -s dhcp/relay:ipv6 listprop config
config                      application
config/forward_query_links  astring  
config/listen_ifnames       astring  
config/receive_query_links  astring  
config/value_authorization  astring  solaris.smf.value.dhcp
.fi
.in -2

.PP
\fBExample 3 \fR Setting the receive_query_links property value of DHCPv6 Relay
Agent service.  The following commands will set the receive_links property value to the
following values: 10.0.0.1%e10000g#0,bge0,iprb#1

.in +2
.nf
example# svccfg -s dhcp/relay:ipv6 setprop \\
    config/receive_query_links= \\
    \\(\\"10.0.0.1%e10000g#0\\"\\"bge0\\"\\"iprb#1\\"\\)
example# svccfg -s dhcp/relay:ipv6 refresh

NOTE: spaces are not allowed in the string within quotes in the
      setprop command 

To verify that the property values are set type either
the svccfg command or the svcprop command below:

example# svccfg -s dhcp/relay:ipv6 listprop config/receive_query_links
config/receive_query_links  astring  "10.0.0.1%e10000g#0" "bge0" "iprb#1"

example# svcprop -p config/receive_query_links dhcp/relay:ipv6
10.0.0.1%e10000g#0 bge0 iprb#1
.fi
.in -2

\fBExample 4 \fR Setting the listen_ifnames property value for dhcpd.
The following commands will set the listen_ifnames property to 
"bge0, bge1" and then display the updated values.

.in +2
.nf
example# svccfg -s dhcp/server:ipv4 setprop \\
    config/listen_ifnames = \\(\\"bge0\\"\\"bge1\\"\\) 
example# svccfg -s dhcp/server:ipv4 refresh

NOTE: spaces are not allowed in the string within quotes in the
      setprop command 

To verify that the property values are set type:

example# svccfg -s dhcp/server:ipv4 listprop config/listen_ifnames
config/listen_ifnames  astring  "bge0" "bge1" 
.fi
.in -2

.SH SEE ALSO
.sp
.LP
svccfg(1M), svcprop(1), svcadm(1M), dhcpd(8), dhcrelay(8)