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 symbol_name -d definition [-r resource]
[-p path] [-u uninterpreted] [-g]
dhtadm -A -m macro_name -d definition [-r resource]
[-p path] [-u uninterpreted] [-g]
dhtadm -M -s symbol_name -d definition [-r resource]
[-p path] [-u uninterpreted] [-g]
dhtadm -M -s symbol_name -n new_name [-r resource]
[-p path] [-u uninterpreted] [-g]
dhtadm -M -m macro_name -n new_name [-r resource] [-p path]
[-u uninterpreted] [-g]
dhtadm -M -m macro_name -d definition [-r resource]
[-p path] [-u uninterpreted] [-g]
dhtadm -M -m macro_name -e symbol=value [-r resource]
[-p path] [-u uninterpreted] [-g]
dhtadm -D -s symbol_name [-r resource] [-p path]
[-u uninterpreted] [-g]
dhtadm -D -m macro_name [-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: 11 Dec 2009 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) anduser_attr(4).
After you make changes with dhtadm, you should issue a
SIGHUP to the DHCP server, causing it to read the dhcptaband pick up the changes. Do this using the -g option.
OPTIONS One of the following function flags must be specified withthe 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 defin-
ition. definition must be enclosed in single quotationmarks. For mac-
ros, use theform -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 asymbol's charac-
teristics. The fields areSunOS 5.11 Last change: 11 Dec 2009 2
System Administration Commands dhtadm(1M)
separated by commas. Use theform -d
'context,code,type,granularity,maximum'. See dhcptab(4) for information about these fields.-m macro_name Specify the name
of the macro to be added.The -d option
must be usedwith the -m
option. The -s
option cannot beused with the -m
option.-s symbol_name Specify the name
of the symbol to be added.The -d option
must be usedwith the -s
option. The -m
option cannot beused with the -s
option.-B Batch process dhtadm commands.
dhtadm reads from the specified
file or from standard input aseries of dhtadm commands and exe-
cute them within the same process.Processing many dhtadm commands
using this method is much fasterthan running an executable batch-
file itself. Batch mode is recom-
mended for using dhtadm in
scripts.The following sub-option is
optional:SunOS 5.11 Last change: 11 Dec 2009 3
System Administration Commands dhtadm(1M)
-v Display commands to standard
output as they are pro-
cessed.-C Create the DHCP service configura-
tion table, dhcptab.-D Delete a symbol or macro defini-
tion.The following sub-options are
required:-m macro_name Delete the
specified macro.-s symbol_name 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 defini-
tion to modify. The definition must be enclosedin single quota-
tion marks. For macros, use theform -d
':symbol=value:symbol=value:'. Enclose a value that contains colons in double quotation marks.SunOS 5.11 Last change: 11 Dec 2009 4
System Administration Commands dhtadm(1M)
For symbols, the definition is a series of fields that define asymbol's charac-
teristics. The fields areseparated by com-
mas. 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=_NULL_VALUE_
To delete a sym-
bol definition from a macro, enter: symbol=-m This sub-option
uses themacro_name argu-
ment. The -n, -d,
or -e sub-options
are legal compan-
ions for thissub-option..
SunOS 5.11 Last change: 11 Dec 2009 5
System Administration Commands dhtadm(1M)
-n This sub-option
uses the new_name
argument and modifies the name of the object specified by the-m or -s sub-
option. It is notlimited to mac-
ros. . Use it to specify a new macro name or symbol name.-s This sub-option
uses thesymbol_name argu-
ment. Use it to specify a symbol.The -d sub-option
is a legal com-
panion.-p path Override the dhcpsvc.conf(4) con-
figuration value for PATH= with path. See dhcpsvc.conf(4) for more details regarding path. Seedhcp_modules(5) for information
regarding data storage modules for the DHCP service.-P Print (display) the dhcptab table.
-r data_store_resource Override the dhcpsvc.conf(4) con-
figuration value for RESOURCE=with the data_store_resource
specified. See dhcpsvc.conf(4) for more details on resource type. See for more information about adding support for other data stores. Seedhcp_modules(5) for information
regarding data storage modules for the DHCP service.-R Remove the dhcptab table.
SunOS 5.11 Last change: 11 Dec 2009 6
System Administration Commands dhtadm(1M)
-u uninterpreted Data which is ignored by dhtadm,
but passed to currently configured public module, to be interpreted by the data store. The privatelayer provides for module-specific
configuration information throughthe use of the RESOURCE_CONFIG
keyword. Uninterpreted data isstored within RESOURCE_CONFIG key-
word of dhcpsvc.conf(4). Seedhcp_modules(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
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:'
SunOS 5.11 Last change: 11 Dec 2009 7
System Administration Commands dhtadm(1M)
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 thearuba 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, andthus requires the special value _NULL_VALUE_. Note also that
any macro definition which includes the definition of the aruba macro inherits this change.# dhtadm -M -m aruba -e 'Hostname=_NULL_VALUE_'
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
SunOS 5.11 Last change: 11 Dec 2009 8
System Administration Commands dhtadm(1M)
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 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 10 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 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.SunOS 5.11 Last change: 11 Dec 2009 9
System Administration Commands dhtadm(1M)
FILES /etc/inet/dhcpsvc.confATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | SUNWdhcsu ||_____________________________|_____________________________|
| Interface Stability | Committed ||_____________________________|_____________________________|
SEE ALSO
dhcpconfig(1M), dhcpmgr(1M), in.dhcpd(1M), dhcpsvc.conf(4),dhcp_network(4), dhcptab(4), hosts(4), user_attr(4), attri-
butes(5), dhcp(5), dhcp_modules(5)rbac(5)
Alexander, S., and R. Droms, DHCP Options and BOOTP Vendor Extensions, RFC 1533, Lachman Technology, Inc., Bucknell University, October 1993. Droms, R., Interoperation Between DHCP and BOOTP, 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: 11 Dec 2009 10