admdhcpglobal(1M) TCP/IP R4.11 admdhcpglobal(1M)
NAME
admdhcpglobal - manage DHCP Configuration Templates
SYNOPSIS
admdhcpglobal -o add [-b bootfile] [-c cookieservers]
[-d domainnameservers] [-e IENnameservers]
[-f timeservers] [-g gateways] [-h] [-j impressservers]
[-k homedirectory] [-l LPRservers] [-m subnetmask]
[-n hardwaretype] [-p RLPservers] [-r logservers]
[-x bootserver] [-y vendorreplytype] [-z timeoffset]
[-A leasetime] [-C meritdumpfile] [-D domainname]
[-E extensionsfile] [-F messagesize] [-G minimumwait]
[-H ntpserver] [-I replyaddressoverride] [-J rootpath]
[-K swapserver] [-L NISdomain] [-M NISservers]
[-N bootsize] [-O TFTPdirectory] [-P netBIOSnameserver]
[-Q netBIOSdatagramdistributionserver]
[-R netBIOSnodetype] [-S netBIOSscope] templatename
admdhcpglobal -o delete templatename
admdhcpglobal -o modify [-b bootfile] [-c cookieservers]
[-d domainnameservers] [-e IENnameservers]
[-f timeservers] [-g gateways] [-h] [-j impressservers]
[-k homedirectory] [-l LPRservers] [-m subnetmask]
[-n hardwaretype] [-p RLPservers] [-r logservers]
[-x bootserver] [-y vendorreplytype] [-z timeoffset]
[-A leasetime] [-C meritdumpfile] [-D domainname]
[-E extensionsfile] [-F messagesize] [-G minimumwait]
[-H ntpserver] [-I replyaddressoverride] [-J rootpath]
[-K swapserver] [-L NISdomain] [-M NISservers]
[-N bootsize] [-O TFTPdirectory] [-P netBIOSnameserver]
[-Q netBIOSdatagramdistributionserver]
[-R netBIOSnodetype] [-S netBIOSscope] templatename
admdhcpglobal -o list [ -qv ] all | templatename [...]
DESCRIPTION
Admdhcpglobal manages the GLOBAL section of the DHCP server (daemon)
configuration file /var/dhcp/dhcp.params. This section consists of
named entries used to group common parameters which are
characteristic of a particular type of DHCP client. DHCP clients and
IP address ranges can reference these parameters via the template
name. Template parameters provide default values; any parameters
explicitly provided in a client entry or an IP address range entry
override the template values.
Once template entries are set up, the system administrator need only
provide specific information for a client or an IP address range.
Template values will be applied to a client when the DHCP daemon
(dhcpd) reads the /var/dhcp/dhcp.params file at start up.
The GLOBAL section is delimited by the #>STARTGLOBAL and
#>STOPGLOBAL delimiters.
Operations
add Adds a template entry to the /var/dhcp/dhcp.params file.
delete Removes a template entry from the /var/dhcp/dhcp.params
file.
modify Modifies a template entry in the /var/dhcp/dhcp.params
file.
list Displays all or selected template entries from
/var/dhcp/dhcp.params file to the standard output.
Options
-v lists the specified clients in aligned columns with column
headers.
-q lists the specified clients, unformatted.
BOOTP Options
-k homedirectory
is the home directory for a client. This should be the
directory where the second-stage bootstrap is located.
-b bootfile
is the name of the second-stage bootstrap that a client
uses if the client does not supply a filename in the
request.
-x bootserver
is the IP address of the server that holds the second-stage
bootstrap. The client should use this server when
downloading the file. If bootserver is specified, then no
file existence check will occur when replying to the
client.
DHCP Options
-A leasetime
is the amount of time in seconds for which a DHCP client's
lease is valid. A value of -1 represents an infinite lease.
-P netBIOSnameserver
define the IP addresses of NetBIOS over TCP/IP Name Server
-Q netBIOSdatagramdistserver
specifies a list of RFC 1001/1002 NetBios Datagram
Distribution servers listed in order of preference that a
client can use.
-R netBIOSnodetype
the NetBIOS node type option allows NetBIOS over TCP/IP
clients which are configurable to be configured as
described in RFC 1001/1002. The value is specified as a
small integer which identifies the client type. Valid types
are: 1 (B-node), 2 (P-node), 4 (M-node), and 8 (H-node).
-S netBIOSscope
the NetBIOS scope option specifies the NetBIOS over TCP/IP
scope parameter for the client as specified in RFC
1001/1002.
-F messagesize
specifies the maximum length DHCP message that it is
willing to accept. The length is specified as an unsigned
16-bit integer which must be greater than 576 and less then
65536. -I replyaddressoverride is used in support of HP
clients.
Options Common to DHCP and BOOTP
-g gateways
define the IP addresses of the gateways that a client has
available.
-n hardwaretype
defines the hardware type that a client has. This allows
for the correct interpretation of the hardware address.
Hardware types are ethernet, ethernet3, ieee802, pronet,
chaos, arcnet, and ax.25.
-m subnetmask
defines the subnet mask for a client. The mask is in the
form of a dotted-quad IP address.
Other Options
-c cookieservers
define the IP addresses of cookie servers on the network.
These servers can provide keys for encryption or licensing.
-d domainnameservers
define the IP addresses of the network name servers.
-j impressservers
define the IP addresses of the impress servers.
-r logservers
define the IP addresses of the log servers a client can
use.
-l LPRservers
define the IP addresses of the LPR servers a client can
use.
-e IEN-116servers
define the IP addresses of the IEN-116 names servers for a
client.
-p RLPservers
define the IP addresses of the Resource Location Protocol
servers for a client.
-z timeoffset
defines the number of seconds a client is from the
Universal Time Coordinate (UTC) also known as Greenwich
Mean Time (GMT).
-f timeservers
define the IP addresses that a client can use to
synchronize its time.
-G minimumwait
is the number of seconds expected between requests.
-J rootpath
specifies the path name that contains the root disk for a
client.
-K swapserver
specifies the IP address of the swap server a client can
use.
-O TFTPdirectory
is the directory name used for TFTP.
-E extensionsfile
specifies a file, retrievable via TFTP, which contains
information which can be interpreted in the same way as the
64-octet vendor-extension field within the BOOTP response,
with the following exceptions. The length of the file is
unconstrained; all references to Tag 18 (i.e., instances of
the BOOTP Extensions Path field) within the file are
ignored.
-H NTPservers
specifies a list of IP addresses indicating NTP servers
available to a client.
-C meritdumpfile
specifies the path name of a file to which clientname's
core image should be dumped in the event the client
crashes.
-L NISdomain
specifies NIS domain of a client.
-M NISservers
specifies a list of IP addresses indicating NIS servers
available to a client.
-N bootsize
specifies the length in 512-octet blocks of the default
boot image for the client. The file length is specified as
an unsigned 16-bit integer.
-D domainname
This option specifies the domain name that a client should
use when resolving hostnames via the Domain Name System.
-y vendorreplytype
defines the format of the BOOTP response packet. This
information should be found in the documentation that came
with the client machine. `rfc1048' refers to the BOOTP
Reply that is defined in RFC-1048. `cmu' refers to a
specialized BOOTP Reply that Carnegie-Mellon University
uses. `auto' indicates that the type of reply will be
based on the client's request.
-h indicates that the client name should be returned in the
reply.
EXAMPLES
Add the template bar with a list of gateways, a hardware type, and a
subnet mask:
admdhcpglobal -o add -g "130.3.8.2 130.3.8.3" -n "ethernet"
-m "255.255.255.0" bar
Add the template foo with an infinite lease time, a home directory,
and a boot server:
admdhcpglobal -o add -A "-1" -k "/home/foo" -x "130.3.8.25" foo
Delete the template foo:
admdhcpglobal -o delete foo
FILES
/var/dhcp/dhcp.params
File that contains the DHCP/BOOTP server parameters
database.
DIAGNOSTICS
Warnings
- The delete operation is requested, and templatename does not
exist.
Errors
- The add operation is requested, and templatename already exists.
Exit Codes
0 The operation was successful.
1 The operation was unsuccessful.
2 The operation failed due to access restrictions.
3 There was an error in the command line.
SEE ALSO
dhcpd(1M), admdhcpclient(1M), admdhcpmanaged(1M), admdhcprelay(1M),
tftpd(1M), termcap(5).
NOTES
All IP addresses are in the dotted-quad format (eg. 130.30.8.25).
Multiple IP addresses must be enclosed in quotation marks with each
IP address separated by a space.
There is no mechanism to prevent deletion of templates which have
references to them. It is assumed that the system administrator
knows what each of the templates defines and which client and IP
address range entries make reference to them.
Licensed material--property of copyright holder(s)