xcat-core/xCAT-client/pods/man8/makedhcp.8.pod
nott a7c493a96b include AIX support
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@9645 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
2011-05-20 17:33:49 +00:00

114 lines
3.2 KiB
Plaintext

=head1 NAME
B<makedhcp> - Creates and updates dhcp configuration files.
=head1 SYNOPSIS
B<makedhcp> B<-n>
B<makedhcp> B<-a>
B<makedhcp> B<-a -d>
B<makedhcp> B<-d> I<noderange>
B<makedhcp> I<noderange> [B<-s> I<statements>]
B<makedhcp> I<noderange> B<--hfi>
B<makedhcp> [I<-h|--help>]
=head1 DESCRIPTION
The B<makedhcp> command configures the DHCP daemon on the local system so that xCAT can manage the nodes of the cluster during discovery, full install, diskless booting, and normal booting.
The B<makedhcp> command is supported for both Linux and AIX clusters.
With the B<-n> option, B<makedhcp> will create a new dhcp configuration file. For Linux systems this will include certain general parameters such as a dynamic range and omapi configuration.
Before using the B<-n> option make sure there is nothing in the configuration file that you wish to preserve. If a configuration file already exist the B<makedhcp> command will create a backup before creating a new one.
With a noderange or the B<-a> option, B<makedhcp> will inject configuration data pertinent to the specified nodes that immediately takes effect without a restart of DHCP.
If the B<-d> flag is used with the B<-a> flag then B<makedhcp> will delete all nodes' dhcp host definitions. The B<-d> flag followed by a I<noderange> will delete the dhcp host definitons for the noderange.
The B<makedhcp> command also uses the following attributes from the xCAT database:
B<site.dhcpinterfaces>, B<site.domain>, B<site.nameservers>, B<networks.dynamicrange>, B<networks.dhcpserver>, B<networks.nameservers>. See the B<xcatdb> man page for details about the database attributes.
=head1 OPTIONS
=over 12
=item B<-n>
Create a new dhcp configuration file with a network statement for each network the dhcp daemon should listen on. The B<makedhcp> command will automatically restart the dhcp daemon after this operation. This option will replace any existing configuration file!
=item B<-a>
Define all nodes to the DHCP server. (Will only add nodes that can be reached, network-wise, by this DHCP server.) The dhcp daemon does not have to be restarted after this.
=item I<noderange>
Add the specified nodes to the DHCP server configuration.
=item [B<-s> I<statements>]
For the input noderange, the argument will be interpreted like dhcp configuration file text.
=item B<-a -d>
Delete all nodes from the DHCP server configuration.
=item B<-d> I<noderange>
Delete all nodes in the noderange from the DHCP server configuration.
=item B<--hfi> I<noderange>
Add the specified nodes to the DHCP server configuration with HFI device type.
=item B<-h>
Display usage message.
=back
=head1 RETURN VALUE
0 The command completed successfully.
1 An error has occurred.
=head1 EXAMPLES
=over 3
=item 1.
Add the network definitions to DHCP by updating the dhcp configuration file:
makedhcp -n
=item 2.
Define all nodes to the dhcp server:
makedhcp -a
=item 3.
Will cause dhcp on the next request to set root-path appropriately for only node5. Note some characters (e.g. ") must be doubly escaped (once for the shell, and once for the OMAPI layer).
makedhcp node5 -s 'option root-path \"172.16.0.1:/install/freebsd6.2/x86_64\";'
=back
=head1 SEE ALSO
L<noderange(3)|noderange.3>