dhcptools(1M)															     dhcptools(1M)

NAME

       dhcptools - command line tool for DHCP elements of bootpd

SYNOPSIS


       []

       [] [requested_IP_address]

       [] []

       [] []

       []

       [] []

DESCRIPTION

       is  a command line tool that provides access to DHCP-related options for the server.  The options provide control for dumping internal data
       structures, generating a hosts file, previewing client address assignment, reclaiming unused addresses,	tracing  packets,  and	validating
       configuration files.

   Options
       supports the following options:

	      Dump internal
		     data  to  output  files.	The  dump output files are and The first file reports fixed address clients known to the currently
		     active server.  The second file reports global and group configuration.  The third file reports miscellaneous internal data.

	      Generate a hosts file in
		     format; see hosts(4).  The output file is The file can be incorporated into a name database in advance of	server	activation
		     so  that the server can automatically allocate a host name along with an IP address to a DHCP client.  For IP address alloca-
		     tion to DHCP clients, the server uses gethostbyaddr(3N) to find the host name associated with a particular IP address.   Each
		     host  entry  in  contains	an IP address followed by a hostname.  The IP address of the first entry is first_IP_address.  The
		     hostname of the first entry is derived from the hostname_template.  Each subsequent host entry contains a unique  IP  address
		     and  hostname  derived  from  the first_IP_address, subnet_mask, and hostname_template.  The wildcards permitted in the host-
		     name_template are A means to use a character selected sequentially from the range [a-z,0-9].  A means to use a digit selected
		     sequentially from the range [0-9].  A means to use a letter selected sequentially from the range [a-z].  A maximum of 3 wild-
		     cards can be specified.   If  a  domain_name  is  specified,  it  will  be  appended  to  the  hostname.	The  maximum  num-
		     ber_of_entries_to_generate is 1000.

	      Preview a client's address assignment based on current
		     conditions  for the server.  The output is written to stdout.  The subnet-identifier tells the subnet for which the client is
		     requesting an IP address.	Optionally, the user may request a specific IP address and lease  duration  using  the	parameters
		     lease-time  and requested-IP-address.  Use Internet address dot notation (see inet(3N) for the IP address and an integer num-
		     ber of seconds for the lease-time.

	      Preview a client's address assignment based on current
		     conditions for the server.  This option is the same as except that the client is identified  by  a  unique  client-identifer.
		     See bootpd(1M).

	      Preview a client's address assignment based on current
		     conditions  of  the server.  This option is the same as except that the class identifier is used to identify the device group
		     from which the client is requesting an IP address.  See bootpd(1M).

	      Reclaim a client's IP address for re-use by the
		     server.  This option is intended for limited use by the administrator to return an allocated but unused IP address to a  DHCP
		     allocation  pool.	 The option may be useful to clear the database of old entries (for example, for clients retired from ser-
		     vice while holding an unexpired IP address lease).  Do not reclaim  an  address  that  belongs  to  an  active  client.   See
		     bootpd(1M).  The IP_address, hardware_address, and hardware_type can be obtained from the database file.

	      Reclaim a client's IP address for re-use by the
		     server.   This  option  is the same as except that the client is identified by its unique client_identifier.  See bootpd(1M).
		     The IP_address and matching client_identifier can be obtained from the database file.

	      Establish packet tracing for
		     This will trace the inbound and outbound BOOTP/DHCP packets for the local server.	The output file is The packet trace  count
		     can be a value from 0 to 100.  To query the current count, use To turn off packet tracing use

	      Validate
		     configuration  files.   The  default configuration files that will be validated are and When a bootptabfile or dhpctabfile is
		     specified, the full pathname is required.	The output file for validate is

	      Only one of the or options is allowed per command.

RETURN VALUE

       returns zero upon successful completion or non-zero if the command failed, in which case an explanation is written to standard error.

EXAMPLES

       Dump the active server's internal data to the dump output files:

       Generate a file with 10 entries:

       Query the active daemon for the the current packet trace count:

       Set the count to 10 packets:

       Preview two clients' address assignments by hardware address:

       To preview a client's address assignment by client identifier, a unique client  identifier  value  is  needed.	This  information  can	be
       obtained  for  actual  DHCP  clients (provided they support a client identifier) from the manufacturer's documentation.	See bootpd(1M) for
       more information about the client identifier.  Assuming that is a valid client identifier, the preview command is:

       To reclaim an IP address by hardware address:

       The parameter values were obtained from this sample entry in the dhcpdb file:

       To reclaim an IP address by client identifier (see earlier example of preview by client identifier):

       To validate a bootptab and dhcptab file:

WARNINGS

       The operations of dump, packet trace, preview, and reclaim depend on communication with the local server.  If the server  is  not  running,
       you may encounter an error.

AUTHOR

       was developed by HP.

FILES

       Default			file for validate

       Default			file for validate

       Dump output file

       Dump output file

       Dump output file

       FIFO file for		to communication

       FIFO file for		to communication

       FIFO file for		to communication

       Hostgen output file in	format

       Packet trace output file

       Validate output file

       Library file

SEE ALSO

       bootpd(1M), bootpquery(1M).

       DARPA Internet Request For Comments RFC1533, RFC1534, RFC1541, RFC1542, Assigned Numbers.

																     dhcptools(1M)