diff --git a/xCAT-client/pods/man8/makedhcp.8.pod b/xCAT-client/pods/man8/makedhcp.8.pod index 751e1a5dd..0ec0ed686 100644 --- a/xCAT-client/pods/man8/makedhcp.8.pod +++ b/xCAT-client/pods/man8/makedhcp.8.pod @@ -4,38 +4,46 @@ B - Creates and updates DHCP configuration files. =head1 SYNOPSIS -B B<-n> +B B<-n> [B<-l>|B<--localonly>] -B B<-a> +B B<-a> [B<-l>|B<--localonly>] -B B<-a -d> +B B<-a -d> [B<-l>|B<--localonly>] -B B<-d> I +B B<-d> I [B<-l>|B<--localonly>] -B I [B<-s> I] +B I [B<-s> I] [B<-l>|B<--localonly>] B [I<-h|--help>] - =head1 DESCRIPTION -The B command creates and updates the DHCP configuration file on the local system. - +The B command creates and updates the DHCP configuration on the management node and service nodes. The B command is supported for both Linux and AIX clusters. -With the B<-n> option, B will create a new dhcp configuration file. For Linux systems the file will include network entries as well as certain general parameters such as a dynamic range and omapi configuration. For AIX systems the file will include network entries. +=over 3 -If a configuration file already exist the B command will create a backup before creating a new one. +=item 1. -On AIX systems, if there are any non-xCAT entries in the configuration file they will be preserved and added to the end of the new configuration file. +Start by filling out the L table properly. -With a noderange or the B<-a> option, B will inject configuration data pertinent to the specified nodes that immediately takes effect without a restart of DHCP. +=item 2. -On AIX systems B will not add entries for cluster nodes that will be installed using NIM. The entries for these nodes will be managed by NIM. +Then use the B option to create a new dhcp configuration file. -If the B<-d> flag is used with the B<-a> flag then B will delete all the node entries created by xCAT. The B<-d> flag followed by a I will delete the dhcp host definitons for the noderange. +=item 3. -Any entries created by NIM will not be removed. +Next, get the node IP addresses and MACs defined in the xCAT database. +Also, get the hostnames and IP addresses pushed to /etc/hosts (using L) and to DNS (using L). + +=item 4. + +Then run B with a noderange or the B<-a> option. This will inject into dhcpd configuration data pertinent to the specified nodes. +On linux, the configuration information immediately takes effect without a restart of DHCP. + +=back + +If you need to delete node entries from the DHCP configuration, use the B<-d> flag. =head1 OPTIONS @@ -43,42 +51,53 @@ Any entries created by NIM will not be removed. =item B<-n> -Create a new dhcp configuration file with a network statement for each network the dhcp daemon should listen on. The B command will automatically restart the dhcp daemon after this operation. This option will replace any existing configuration file! +Create a new dhcp configuration file with a network statement for each network the dhcp daemon should listen on. +(Which networks dhcpd should listen on can be controlled by the dhcpinterfaces attribute in the L table.) +The B command will automatically restart the dhcp daemon after this operation. +This option will replace any existing configuration file (making a backup of it first). +For Linux systems the file will include network entries as well as certain general parameters such as a dynamic range and omapi configuration. +For AIX systems the file will include network entries. +On AIX systems, if there are any non-xCAT entries in the existing configuration file they will be preserved and added to the end of the new 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. +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. +On AIX systems B will not add entries for cluster nodes that will be installed using NIM. The entries for these nodes will be managed by NIM. =item I Add the specified nodes to the DHCP server configuration. -=item [B<-s> I] +=item B<-s> I For the input noderange, the argument will be interpreted like dhcp configuration file text. -=item B<-a -d> - -Delete all node entries added by xCAT from the DHCP server configuration. - =item B<-d> I -Delete all node entries, added by xCAT, in the noderange from the DHCP server configuration. +Delete node entries from the DHCP server configuration. On AIX, any entries created by NIM will not be removed. -=item B<-h> +=item B<-a -d> + +Delete all node entries, that were added by xCAT, from the DHCP server configuration. + +=item B<-l>|B<--localonly> + +Configure dhcpd on the local machine only. Without this option, makedhcp will also send this +operation to any service nodes that service the nodes in the noderange. + +=item B<-h|--help> Display usage message. =back - =head1 RETURN VALUE 0 The command completed successfully. 1 An error has occurred. - =head1 EXAMPLES =over 3 @@ -107,7 +126,7 @@ Will cause dhcp on the next request to set root-path appropriately for only node =head1 FILES -DHCP configuration files. +DHCP configuration files: [AIX] /etc/dhcpsd.cnf