System Administration Commands dhtadm(1M)
NAME
dhtadm - DHCP configuration table management utility
SYNOPSIS
dhtadm -C [-r resource] [-p path] [-u uninterpreted] [-g]
dhtadm -A -s symbolname -d definition [-r resource]
[-p path] [-u uninterpreted] [-g]
dhtadm -A -m macroname -d definition [-r resource]
[-p path] [-u uninterpreted] [-g]
dhtadm -M -s symbolname -d definition [-r resource]
[-p path] [-u uninterpreted] [-g]
dhtadm -M -s symbolname -n newname [-r resource]
[-p path] [-u uninterpreted] [-g]
dhtadm -M -m macroname -n newname [-r resource] [-p path]
[-u uninterpreted] [-g]
dhtadm -M -m macroname -d definition [-r resource]
[-p path] [-u uninterpreted] [-g]
dhtadm -M -m macroname -e symbol=value [-r resource]
[-p path] [-u uninterpreted] [-g]
dhtadm -D -s symbolname [-r resource] [-p path]
[-u uninterpreted] [-g]
dhtadm -D -m macroname [-r resource] [-p path]
[-u uninterpreted] [-g]
dhtadm -P [-r resource] [-p path] [-u uninterpreted] [-g]
dhtadm -R [-r resource] [-p path] [-u uninterpreted] [-g]
dhtadm -B [-v] [batchfile] [-g]
SunOS 5.11 Last change: 28 Aug 2004 1
System Administration Commands dhtadm(1M)
DESCRIPTION
dhtadm manages the Dynamic Host Configuration Protocol
(DHCP) service configuration table, dhcptab. You can use it
to add, delete, or modify DHCP configuration macros or
options or view the table. For a description of the table
format, see dhcptab(4).)
The dhtadm command can be run by root, or by other users
assigned to the DHCP Management profile. See rbac(5) and
userattr(4).
After you make changes with dhtadm, you should issue a
SIGHUP to the DHCP server, causing it to read the dhcptab
and pick up the changes. Do this using the -g option.
OPTIONS
One of the following function flags must be specified with
the dhtadm command: -A, -B, -C, -D, -M, -P or -R.
The following options are supported:
-A Add a symbol or macro definition
to the dhcptab table.
The following sub-options are
required:
-d definition Specify a macro
or symbol
definition.
definition must
be enclosed in
single quota-
tion marks. For
macros, use the
form -d
':symbol=value:symbol=value:'.
Enclose a value
that contains
colons in dou-
ble quotation
marks. For sym-
bols, the
definition is a
series of
fields that
define a
symbol's
SunOS 5.11 Last change: 28 Aug 2004 2
System Administration Commands dhtadm(1M)
characteris-
tics. The
fields are
separated by
commas. Use the
form -d
'context,code,type,granularity,maximum'.
See dhcptab(4)
for information
about these
fields.
-m macroname Specify the
name of the
macro to be
added.
The -d option
must be used
with the -m
option. The -s
option cannot
be used with
the -m option.
-s symbolname Specify the
name of the
symbol to be
added.
The -d option
must be used
with the -s
option. The -m
option cannot
be used with
the -s option.
-B Batch process dhtadm commands.
dhtadm reads from the specified
file or from standard input a
series of dhtadm commands and
execute them within the same pro-
cess. Processing many dhtadm com-
mands using this method is much
faster than running an executable
batchfile itself. Batch mode is
recommended for using dhtadm in
SunOS 5.11 Last change: 28 Aug 2004 3
System Administration Commands dhtadm(1M)
scripts.
The following sub-option is
optional:
-v Display commands to stan-
dard output as they are
processed.
-C Create the DHCP service confi-
guration table, dhcptab.
-D Delete a symbol or macro defini-
tion.
The following sub-options are
required:
-m macroname Delete the
specified
macro.
-s symbolname Delete the
specified sym-
bol.
-g Signal the DHCP daemon to reload
the dhcptab after successful com-
pletion of the operation.
-M Modify an existing symbol or
macro definition.
The following sub-options are
required:
-d definition Specify a macro
or symbol defin-
ition to modify.
The definition
must be enclosed
in single quota-
tion marks. For
macros, use the
SunOS 5.11 Last change: 28 Aug 2004 4
System Administration Commands dhtadm(1M)
form -d
':symbol=value:symbol=value:'.
Enclose a value
that contains
colons in double
quotation marks.
For symbols, the
definition is a
series of fields
that define a
symbol's charac-
teristics. The
fields are
separated by
commas. Use the
form -d
'context,code,type,granularity,maximum'.
See dhcptab(4)
for information
about these
fields.
-e This sub-option
uses the symbol
=value argument.
Use it to edit a
symbol/value
pair within a
macro. To add a
symbol which
does not have an
associate value,
enter:
symbol=NULVALUE
To delete a sym-
bol definition
from a macro,
enter:
symbol=
-m This sub-option
uses the
macroname argu-
ment. The -n,
SunOS 5.11 Last change: 28 Aug 2004 5
System Administration Commands dhtadm(1M)
-d, or -e sub-
options are
legal companions
for this sub-
option..
-n This sub-option
uses the
newname argu-
ment and modi-
fies the name of
the object
specified by the
-m or -s sub-
option. It is
not limited to
macros. . Use it
to specify a new
macro name or
symbol name.
-s This sub-option
uses the
symbolname
argument. Use it
to specify a
symbol. The -d
sub-option is a
legal companion.
-p path Override the dhcpsvc.conf(4) con-
figuration value for PATH= with
path. See dhcpsvc.conf(4) for
more details regarding path. See
dhcpmodules(5) for information
regarding data storage modules
for the DHCP service.
-P Print (display) the dhcptab
table.
-r datastoreresource Override the dhcpsvc.conf(4) con-
figuration value for RESOURCE=
with the datastoreresource
specified. See dhcpsvc.conf(4)
for more details on resource
SunOS 5.11 Last change: 28 Aug 2004 6
System Administration Commands dhtadm(1M)
type. See for more information
about adding support for other
data stores. See dhcpmodules(5)
for information regarding data
storage modules for the DHCP ser-
vice.
-R Remove the dhcptab table.
-u uninterpreted Data which is ignored by dhtadm,
but passed to currently config-
ured public module, to be inter-
preted by the data store. The
private layer provides for
module-specific configuration
information through the use of
the RESOURCECONFIG keyword.
Uninterpreted data is stored
within RESOURCECONFIG keyword of
dhcpsvc.conf(4). See
dhcpmodules(5) for information
regarding data storage modules
for the DHCP service.
EXAMPLES
Example 1 Creating the DHCP Service Configuration Table
The following command creates the DHCP service configuration
table, dhcptab:
# dhtadm -C
Example 2 Adding a Symbol Definition
The following command adds a Vendor option symbol definition
for a new symbol called MySym to the dhcptab table in the
SUNWfiles resource in the /var/mydhcp directory:
# dhtadm -A -s MySym
-d 'Vendor=SUNW.PCW.LAN,20,IP,1,0'
-r SUNWfiles -p /var/mydhcp
SunOS 5.11 Last change: 28 Aug 2004 7
System Administration Commands dhtadm(1M)
Example 3 Adding a Macro Definition
The following command adds the aruba macro definition to the
dhcptab table. Note that symbol/value pairs are bracketed
with colons (:).
# dhtadm -A -m aruba \
-d ':Timeserv=10.0.0.10 10.0.0.11:DNSserv=10.0.0.1:'
Example 4 Modifying a Macro Definition
The following command modifies the Locale macro definition,
setting the value of the UTCOffst symbol to 18000 seconds.
Note that any macro definition which includes the definition
of the Locale macro inherits this change.
# dhtadm -M -m Locale -e 'UTCOffst=18000'
Example 5 Deleting a Symbol
The following command deletes the Timeserv symbol from the
aruba macro. Any macro definition which includes the defini-
tion of the aruba macro inherits this change.
# dhtadm -M -m aruba -e 'Timeserv='
Example 6 Adding a Symbol to a Macro
The following command adds the Hostname symbol to the aruba
macro. Note that the Hostname symbol takes no value, and
thus requires the special value NULVALUE. Note also that
any macro definition which includes the definition of the
aruba macro inherits this change.
# dhtadm -M -m aruba -e 'Hostname=NULVALUE'
SunOS 5.11 Last change: 28 Aug 2004 8
System Administration Commands dhtadm(1M)
Example 7 Renaming a Macro
The following command renames the Locale macro to MyLocale.
Note that any Include statements in macro definitions which
include the Locale macro also need to be changed.
# dhtadm -M -m Locale -n MyLocale
Example 8 Deleting a Symbol Definition
The following command deletes the MySym symbol definition.
Note that any macro definitions which use MySym needs to be
modified.
# dhtadm -D -s MySym
Example 9 Removing a dhcptab
The following command removes the dhcptab table in the NIS]
directory specified.
# dhtadm -R -r SUNWnisplus -p Test.Nis.Plus.
Example 10 Printing a dhcptab
The following command prints to standard output the contents
of the dhcptab that is located in the data store and path
indicated in the dhcpsvc.conf file:.
# dhtadm -P
Example 11 Executing dhtadm in Batch Mode
The following command runs a series of dhtadm commands con-
tained in a batch file and signals the daemon to reload the
SunOS 5.11 Last change: 28 Aug 2004 9
System Administration Commands dhtadm(1M)
dhcptab once the commands have been executed: :
# dhtadm -B addmacros -g
EXIT STATUS
0 Successful completion.
1 Object already exists.
2 Object does not exist.
3 Non-critical error.
4 Critical error.
FILES
/etc/inet/dhcpsvc.conf
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
Availability SUNWdhcsu
Interface Stability Evolving
SEE ALSO
dhcpconfig(1M), dhcpmgr(1M), in.dhcpd(1M), dhcpsvc.conf(4),
dhcpnetwork(4), dhcptab(4), hosts(4), userattr(4), attri-
butes(5), dhcp(5), dhcpmodules(5)rbac(5)
Alexander, S., and R. Droms, DHCP Options and BOTP Vendor
Extensions, RFC 1533, Lachman Technology, Inc., Bucknell
University, October 1993.
SunOS 5.11 Last change: 28 Aug 2004 10
System Administration Commands dhtadm(1M)
Droms, R., Interoperation Between DHCP and BOTP, RFC 1534,
Bucknell University, October 1993.
Droms, R., Dynamic Host Configuration Protocol, RFC 1541,
Bucknell University, October 1993.
Wimer, W., Clarifications and Extensions for the Bootstrap
Protocol, RFC 1542, Carnegie Mellon University, October
1993.
SunOS 5.11 Last change: 28 Aug 2004 11
|
