System Administration Commands dhcpconfig(1M)
NAME
dhcpconfig - DHCP service configuration utility
SYNOPSIS
dhcpconfig -D -r resource -p path [-u uninterpreted]
[-l leaselength] [-n ] [-d DNSdomain]
[-a DNSserveraddresses] [-h hostsresource]
[-y hostsdomain]
dhcpconfig -R serveraddresses
dhcpconfig -U [-f] [-x] [-h]
dhcpconfig -N networkaddress [-m subnetmask] [-b ]
[-t routeraddresses] [-y NIS-domain]
[-a NISserveraddresses] [-g]
dhcpconfig -C -r resource -p path [-f] [-k]
[-u uninterpreted]
dhcpconfig -X filename [-m macrolist] [-o optionlist]
[-a networkaddresses] [-f] [-x] [-g]
dhcpconfig -I filename [-f] [-g]
dhcpconfig -P [parameter[=value],]...
dhcpconfig -S [-f] [-e -d -r -q]
DESCRIPTION
The dhcpconfig command is used to configure and manage the
Dynamic Host Configuration Protocol (DHCP) service or BOTP
relay services. It is intended for use by experienced
Solaris system administrators and is designed for ease of
use in scripts. The dhcpmgr utility is recommended for less
experienced administrators or those preferring a graphical
utility to configure and manage the DHCP service or BOTP
relay service.
The dhcpconfig command can be run by root, or by other users
assigned to the DHCP Management profile. See rbac(5) and
userattr(4).
SunOS 5.11 Last change: 16 Jun 2004 1
System Administration Commands dhcpconfig(1M)
dhcpconfig requires one of the following function flags: -D,
-R, -U, -N, -C, -X, -I, -P or -S.
The dhcpconfig menu driven mode is supported in Solaris 8
and previous versions of Solaris.
Where dhcpconfig Obtains Configuration Information
dhcpconfig scans various configuration files on your Solaris
machine for information it can use to assign values to
options contained in macros it adds to the dhcptab confi-
guration table. The following table lists information
dhcpconfig needs, the source used, and how the information
is used:
Information Source Where Used
Timezone System date, timezone settings Locale macro
DNS parameters nsswitch.conf, /etc/resolv.conf Server macro
NIS parameters System domainname, nsswitch.conf, NIS Network macros
Subnetmask Network interface, netmasks table in Network macros
nameservice
If you have not set these parameters on your server machine,
you should do so before configuring the DHCP server with
dhcpconfig. Note that if you specify options with the
dhcpconfig -D command line, the values you supply override
the values obtained from the system files.
OPTIONS
The following options are supported:
-C Convert to using a new data store,
recreating the DHCP data tables in a
format appropriate to the new data
store, and setting up the DHCP server
to use the new data store.
The following sub-options are
required:
-p pathtodata The paths for
SUNWfiles and
SUNWbinfiles must
be absolute UNIX
pathnames. The
SunOS 5.11 Last change: 16 Jun 2004 2
System Administration Commands dhcpconfig(1M)
path for SUNWn-
isplus must be a
fully specified
NIS] directory
(including the
tailing period.)
See
dhcpmodules(5).
-r dataresource New data store
resource. One of
the following
must be speci-
fied: SUNWfiles,
SUNWbinfiles, or
SUNWnisplus. See
dhcpmodules(5).
The following sub-options are
optional:
-f Do not prompt for
confirmation. If
-f is not used, a
warning and con-
firmation prompt
are issued before
the conversion
starts.
-k Keep the old DHCP
data tables after
successful
conversion. If
any problem
occurs during
conversion,
tables are not
deleted even if
-k sub-option is
not specified.
-u uninterpreted Data which is
ignored by
dhcpconfig, but
passed on to the
datastore for
interpretation.
The private layer
SunOS 5.11 Last change: 16 Jun 2004 3
System Administration Commands dhcpconfig(1M)
provides for
module-specific
configuration
information
through the use
of the
RESOURCECONFIG
keyword. Uninter-
preted data is
stored within
RESOURCECONFIG
keyword of
dhcpsvc.conf(4).
The -u sub-option
is not used with
the SUNWfiles,
SUNWbinfiles, and
SUNWnisplus data
stores. See
dhcpmodules(5).
-D Configure the DHCP service.
The following sub-options are
required:
-r dataresource One of the fol-
lowing must be
specified:
SUNWfiles,
SUNWbinfiles, or
SUNWnisplus.
Other data stores
may be
available.See
dhcpmodules(5).
-p path The paths for
SUNWfiles and
SUNWbinfiles must
be absolute UNIX
pathnames. The
path for SUNWn-
isplus must be a
fully specified
NIS] directory
(including the
tailing period.)
. See
SunOS 5.11 Last change: 16 Jun 2004 4
System Administration Commands dhcpconfig(1M)
dhcpmodules(5).
The following sub-options are
optional:
-a DNSservers IP addresses of
DNS servers,
separated with
commas.
-d DNSdomain DNS domain name.
-h hostsresource Resource in
which to place
hosts data. Usu-
ally, the name
service in use
on the server.
Valid values are
nisplus, files,
or dns.
-l seconds Lease length
used for
addresses not
having a speci-
fied lease
length, in
seconds.
-n Non-negotiable
leases
-y hostsdomain DNS or NIS]
domain name to
be used for
hosts data.
Valid only if
dns or nisplus
is specified for
-h sub-option.
-u uninterpreted Data which is
ignored by
dhcpconfig, but
passed on to the
SunOS 5.11 Last change: 16 Jun 2004 5
System Administration Commands dhcpconfig(1M)
datastore for
interpretation.
The private
layer provides
for module-
specific confi-
guration infor-
mation through
the use of the
RESOURCECONFIG
keyword. Unin-
terpreted data
is stored within
RESOURCECONFIG
keyword of
dhcpsvc.conf(4).
The -u sub-
option is not
used with the
SUNWfiles,
SUNWbinfiles,
and SUNWnisplus
data stores. See
dhcpmodules(5).
-I filename Import data from filename, containing
data previously exported from a
Solaris DHCP server. Note that after
importing, you may have to edit mac-
ros to specify the correct domain
names, and edit network tables to
change the owning server of addresses
in imported networks. Use dhtadm and
pntadm to do this.
The following sub-options are sup-
ported:
-f Replace any conflicting data
with the data being imported.
-g Signal the daemon to reload the
dhcptab once the import has
been completed.
-N netaddress Configure an additional network for
DHCP service.
SunOS 5.11 Last change: 16 Jun 2004 6
System Administration Commands dhcpconfig(1M)
The following sub-options are sup-
ported:
-a NISserveraddresses List of IP
addresses
of NIS
servers.
-b Network is
a point-
to-point
(P) net-
work,
therefore
no broad-
cast
address
should be
config-
ured. If
-b is not
used, the
network is
assumed to
be a LAN,
and the
broadcast
address is
determined
using the
network
address
and subnet
mask.
-g Signal the
daemon to
reload the
dhcptab.
-m xxx.xxx.xxx.xxx Subnet
mask for
the net-
work; if
-m is not
used, sub-
net mask
is
obtained
SunOS 5.11 Last change: 16 Jun 2004 7
System Administration Commands dhcpconfig(1M)
from net-
masks.
-t routeraddresses List of
router IP
addresses;
if not
specified,
router
discovery
flag is
set.
-y NISdomainname If NIS is
used on
this net-
work,
specify
the NIS
domain
name.
-P Configure the DHCP service parame-
ters. Each parameter and value are
specified by the following pattern:
parameter[=value],...
Where parameter and value are:
parameter One of the DHCP service
parameters listed in
dhcpsvc.conf(4). If the
corresponding value is
not specified, the
current parameter value
is displayed. If parame-
ter is not specified,
all parameters and
current values are
displayed.
value Optional string to set
the servers parameter to
if the value is accept-
able. If the value is
SunOS 5.11 Last change: 16 Jun 2004 8
System Administration Commands dhcpconfig(1M)
missing or is empty
(""), the parameter and
its current value are
deleted.
After a parameter has changed the
DHCP server requires re-starting
before you can use new parameter
values.
-R serveraddresses Configure the BOTP relay service.
BOTP or DHCP requests are forwarded
to the list of servers specified.
serveraddresses is a comma separated
list of hostnames and/or IP
addresses.
-S Control the DHCP service.
The following sub-options are sup-
ported:
-d Disable and stop the DHCP ser-
vice.
-e Enable and start the DHCP ser-
vice.
-q Display the state of the DHCP
service. The state is encoded
into the exit status.
0 DHCP service disabled and stopped
1 DHCP service enabled and stopped
2 DHCP service disabled and running
3 DHCP service enabled and running
-r Enable and restart the DHCP
service.
-U Unconfigure the DHCP service or BOTP
relay service.
SunOS 5.11 Last change: 16 Jun 2004 9
System Administration Commands dhcpconfig(1M)
The following sub-options are sup-
ported:
-f Do not prompt for confirmation.
If -f is not used, a warning
and confirmation prompt is
issued.
-h Delete hosts entries from name
service.
-x Delete the dhcptab and network
tables.
-X filename Export data from the DHCP data
tables, saving to filename, to move
the data to another Solaris DHCP
server.
The following sub-options are
optional:
-a networkstoexport List of net-
works whose
addresses
should be
exported, or
the keyword
AL to
specify all
networks. If
-a is not
specified,
no networks
are
exported.
-g Signal the
daemon to
reload the
dhcptab
after the
export has
been com-
pleted.
SunOS 5.11 Last change: 16 Jun 2004 10
System Administration Commands dhcpconfig(1M)
-m macrostoexport List of mac-
ros to
export, or
the keyword
AL to
specify all
macros. If
-m is not
specified,
no macros
are
exported.
-o optionstoexport List of
options to
export, or
the keyword
AL to
specify all
options. If
-o is not
specified,
no options
are
exported.
-x Delete the
data from
this server
after it is
exported. If
-x is not
specified
you are in
effect copy-
ing the
data.
EXAMPLES
Example 1 Configuring DHCP Service with Binary Files Data
Store
The following command configures DHCP service, using the
binary files data store, in the DNS domain acme.eng, with a
lease time of 28800 seconds (8 hours),
SunOS 5.11 Last change: 16 Jun 2004 11
System Administration Commands dhcpconfig(1M)
example# dhcpconfig -D -r SUNWbinfiles -p /var/dhcp -l 28800\
-d acme.eng -a 120.30.33.4 -h dns -y acme.eng
Example 2 Configuring BOTP Relay Agent
The following command configures the DHCP daemon as a BOTP
relay agent, which forwards BOTP and DHCP requests to the
servers having the IP addresses 120.30.33.7 and
120.30.42.132:
example# dhcpconfig -R 120.30.33.7,120.30.42.132
Example 3 Unconfiguring DHCP Service
The following command unconfigures the DHCP service, with
confirmation, and deletes the DHCP data tables and host
table entries:
example# dhcpconfig -U -x -h
Example 4 Configuring a Network for DHCP Service
The following command configures an additional LAN network
for DHCP service, specifying that clients should use router
discovery and providing the NIS domain name and NIS server
address:
example# dhcpconfig -N 120.30.171.0 -y east.acme.eng.com\
-a 120.30.33.4
Example 5 Converting to SUNWnisplus Data Store
The following command converts a DHCP server from using a
text or binary files data store to a NIS] data store, delet-
ing the old data store's DHCP tables:
SunOS 5.11 Last change: 16 Jun 2004 12
System Administration Commands dhcpconfig(1M)
example# dhcpconfig -C -r SUNWnisplus -p whatever.com.
Example 6 Exporting a Network, Macros, and Options from a
DHCP Server
The following command exports one network (120.30.171.0) and
its addresses, the macro 120.30.171.0, and the options motd
and PSptrfrom a DHCP server, saves the exported data in file
/export/var/120301710data, and deletes the exported data
from the server.
example# dhcpconfig -X /var/dhcp/120301710export
-a 120.30.171.0 -m 120.30.171.0 -o motd,PSptr
Example 7 Importing Data on a DHCP Server
The following command imports DHCP data from a file,
/net/golduck/export/var/120301710data, containing data pre-
viously exported from a Solaris DHCP server, overwrites any
conflicting data on the importing server, and signals the
daemon to reload the dhcptab once the import is completed:
example# dhcpconfig -I /net/golduck/export/var/120301710data -f -g
Example 8 Setting DHCP Server Parameters
The following command sets the number of minutes that the
DHCP server waits before timing out when updating DNS infor-
mation on DHCP clients to five minutes.
example# example# dhcpconfig -P UPDATETIMEOUT=5
Example 9 Re-starting the DHCP server
The following command stops and re-starts the DHCP server.
SunOS 5.11 Last change: 16 Jun 2004 13
System Administration Commands dhcpconfig(1M)
example# example# dhcpconfig -S -r
DHCP server stopped
DHCP server started
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
Availability SUNWdhcsu
Interface Stability Evolving
SEE ALSO
dhcpmgr(1M), dhtadm(1M), in.dhcpd(1M), pntadm(1M),
dhcpnetwork(4), dhcptab(4), dhcpsvc.conf(4),
nsswitch.conf(4), resolv.conf(4), userattr(4), attri-
butes(5), dhcp(5), dhcpmodules(5), rbac(5)
SunOS 5.11 Last change: 16 Jun 2004 14
|
