admdhcpclient(1M) DG/UX R4.11MU05 admdhcpclient(1M)
NAME
admdhcpclient - manage DHCP Server Clients
SYNOPSIS
admdhcpclient -o add -a hardwareaddress -n hardwaretype
[-b bootfile] [-c cookieservers] [-d domainnameservers]
[-e IENnameservers] [-f timeservers] [-g gateways] [-h]
[-i hostIPaddress] [-j impressservers]
[-k homedirectory] [-l LPRservers] [-m subnetmask]
[-p RLPservers] [-r logservers] [-t template]
[-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] clientname
admdhcpclient -o delete clientname
admdhcpclient -o modify [-b bootfile] [-c cookieservers]
[-d domainnameservers] [-e IENnameservers]
[-f timeservers] [-g gateways] [-h] [-i hostIPaddress]
[-j impressservers] [-k homedirectory] [-l LPRservers]
[-m subnetmask] [-p RLPservers] [-r logservers]
[-t template] [-x bootserver] [-y vendorreplytype]
[-z timeoffset] [-A leasetime] [-C meritdumpfile]
[-D domainname] [-E extensionfile] [-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] clientname
admdhcpclient -o list [ -qv p] all | clientname [...]
DESCRIPTION
Admdhcpclient manages the DHCP server (daemon) configuration file for
clients /var/dhcp/dhcp.clients.{dir,pag}. This file contains
information that is used by dhcpd by both BOOTP and DHCP clients to
discover configuration information about themselves.
Operations
add Adds an entry in the /var/dhcp/dhcp.clients database.
delete Removes an entry in the /var/dhcp/dhcp.clients database. If
this is a DHCP client then that address is available for
automatic or static reassignment.
modify Modifies an entry in the /var/dhcp/dhcp.clients database.
list Displays all or selected client entries from the
/var/dhcp/dhcp.clients database to 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 clientname. This should be the
directory where the second-stage bootstrap is located.
-b bootfile
is the name of the second-stage bootstrap that clientname
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 clientname should use this server when
downloading the file. If bootserver is specified, then no
file existence check will occur when replying to
clientname.
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
clientname 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 clientname has
available.
-n hardwaretype
defines the hardware type that clientname has. This allows
for the correct interpretation of the hardware address.
Hardware types are ethernet, ethernet3, ieee802, pronet,
chaos, arcnet, and ax.25.
-a hardwareaddress
defines the hardware address of clientname. The client's
database key is formed by concatenating the two character
hardware type (which corresponds to one of the names
described above) with the 12 character, colon stripped,
hardware address. See dhcpd(1m) for a complete description
of hardware types.
-i hostIPaddress
defines the IP address of clientname.
-m subnetmask
defines the subnet mask for clientname. The mask is in the
form of a dotted-quad IP address.
-t template
specifies a template which clientname should use for
default values.
The system administrator may define templates which provide
certain default values for many of the parameters. 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. Any parameters
which are explicitly provided in a client entry override
the values supplied by the template.
Values which are supplied by a template will not be
displayed by the list operation. It is assumed that the
system administrator knows which parameters are defined by
a particular template.
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 clientname can
use.
-l LPRservers
define the IP addresses of the LPR servers clientname can
use.
-e IEN-116servers
define the IP addresses of the IEN-116 names servers for
clientname.
-p RLPservers
define the IP addresses of the Resource Location Protocol
servers for clientname.
-z timeoffset
defines the number of seconds clientname is from the
Universal Time Coordinate (UTC) also known as Greenwich
Mean Time (GMT).
-f timeservers
define the IP addresses that clientname 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
clientname.
-K swapserver
specifies the IP address of the swap server clientname 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 clientname.
-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 clientname.
-M NISservers
specifies a list of IP addresses indicating NIS servers
available to clientname.
-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 clientname
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 client bar with a list of gateways and subnet mask:
admdhcpclient -o add -a 1b:00:2c:9c:70:0f -n ethernet
-i 130.2.8.25 -g "130.3.8.2 130.3.8.3" -m 255.255.255.0 bar
Add the client foo which uses a template.
admdhcpclient -o add -a 1b:00:2c:9c:70:10 -n ethernet -t nt foo
Delete the client foo
admdhcpclient -o delete foo
FILES
/var/dhcp/dhcp.params
File that contains the DHCP/BOOTP server parameter
database.
/var/dhcp/dhcp.clients
Files that contain the DHCP/BOOTP server client
database. (NOTE: the client database is stored in DBM
format. DBM uses an index, denoted by a suffix of
.dir, and a data portion, denoted by the suffix .pag.
Hence, there are 2 actual files
/var/dhcp/dhcp.clients.dir and
/var/dhcp/dhcp.clients.pag.
DIAGNOSTICS
Warnings
- The delete operation is requested, and clientname does not exist.
Errors
- The add operation is requested, and clientname 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), admdhcpmanaged(1M), admdhcprelay(1M), admdhcpglobal(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.
Hardware addresses take the form of hexadecimal values separated by
colons (e.g. 80:de:08:7e:1f:34).
DHCP clients added through admdhcpclient will not have their clients
addresses subject to reassignment if the address pool runs out of
available addresses.
A client's hardware type and hardware address may not be modified.
If either of these values was specified when the entry was created,
the entry will have to be deleted and re-created with the new values.
Licensed material--property of copyright holder(s)