New man pages for AIX diskless support.

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@1602 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd

xCAT-client/pods/man1/mkdsklsnode.1.pod

@@ -0,0 +1,131 @@
+=head1 NAME
+ 
+B<mkdsklsnode> - Use this xCAT command to define and initialize AIX/NIM diskless machines. 
+
+=head1 SYNOPSIS
+
+B<mkdsklsnode [-h|--help ]>
+
+B<mkdsklsnode [-V] [-f|--force] [-n|--newname] [-i osimage_name] noderange [attr=val [attr=val ...]]> 
+
+=head1 DESCRIPTION
+
+This xCAT command can be used to define and/or initialize AIX/NIM diskless machines. Once this step is completed the xCAT rnetboot command may be used to initiate a network boot of the nodes.
+	
+The command can be used to define and initialize a new NIM machine object or it may be used to reinitialize an existing machine to use a different operating system image.
+
+When creating a new NIM machine definition the default is to use the same name as the xCAT node name that is provided. 
+
+You can use the "-n" option of the mkdsklsnode command to create and initialize an alternate NIM machine definition for the same physical nodes. This option allows you to set up a new image to use when a node is next rebooted while the node is currently running.  This is possible because the NIM name for a machine definition does not have to be the hostname of the node.  This allows you to have multiple NIM machine definitions for the same physical node. The naming convention for the new NIM machine name is "<xcat_node_name>_<image_name>", (Ex. "node01_61spot"). Since all the NIM initialization can be done while the node is running the downtime for for the node is reduced to the time it takes to reboot. 
+
+You can use the force option to reinitialize a node if it already has resources allocated or it is in the wrong NIM state. This option will reset the NIM node and deallocate resources before reinititializing. Use this option with caution since reinitializing a node will stop the node if it is currently running.
+
+After the mkdsklsnode command completes you can use the lsnim command to check the NIM node definition to see if it is ready for booting the node. ("lsnim -l <nim_node_name>").
+
+=head1 OPTIONS
+
+=over 10
+
+=item B<attr=val [attr=val ...]>
+
+Specifies one or more "attribute equals value" pairs, separated by spaces. Attr=
+val pairs must be specified last on the command line. These are used to specify additional values that can be passed to the underlying NIM commands.
+
+Valid values:
+
+=over 3
+
+=item B<duplex>	
+
+Specifies the duplex setting (optional). Used when defining the NIM machine. Use this setting to configure the client's network interface. This value can be full or half. The default is full. (ex. "duplex=full")
+
+=item B<speed>	
+
+Specifies the speed setting (optional). Used when defining the NIM machine. This is the communication speed to use when configuring the client's network interface. This value can be 10, 100, or 1000. The default is 100. (ex. "speed=100")
+
+=item B<psize>	
+
+Specifies the size in Megabytes of the paging space for the diskless node.(optional) Used when initializing the NIM machine. The minimum and default size is 64 MB of paging space. (ex. "psize=64")
+
+=back
+
+=item B<-f |--force>
+
+Use the force option to reinitialize the NIM machines.  
+
+=item B<-h |--help>
+
+Display usage message.
+
+=item B<-i image_name>
+
+The name of an existing xCAT osimage definition. If this information is not provided on the command line the code checks the node definition for the value of the "profile" attribute. If the "-i" value is provided on the command line then that value will be used to set the "profile" attribute of the node definiions.
+
+=item B<-n|--newname>
+
+Create a new NIM machine object name for the xCAT node. Use the naming convention "<xcat_node_name>_<image_name>" for the new NIM machine definition.
+
+=item B<noderange>
+
+A set of comma delimited node names and/or group names. See the "noderange" man page for details on additional supported formats.
+
+=item B<-V |--verbose>
+
+Verbose mode.
+
+=back
+
+=head1 RETURN VALUE
+
+=over 3
+
+=item 0 
+
+The command completed successfully.
+
+=item 1 
+
+An error has occurred.
+
+=back
+
+=head1 EXAMPLES
+
+1) Initialize an xCAT node named "node01" as an AIX diskless machine.  The xCAT osimage named "61spot" should be used to boot the node.
+
+=over 5
+
+B<mkdsklsnode -i 61spot node01>
+
+=back
+
+2) Initialize all AIX diskless nodes contained in the xCAT node group called "aixnodes" using the image definitions pointed to by the "next_image" attribute of the xCAT node definitions.
+
+=over 5
+
+B<mkdsklsnode aixnodes>
+
+=back
+
+
+3) Initialize an xCAT node called "node02" as an AIX diskless node.  Create a new NIM machine definition name with the osimage as an extension to the xCAT node name.
+
+=over 5
+
+B<mkdsklsnode -n -i 61spot node02>
+
+=back
+
+=head1 FILES
+
+/opt/xcat/bin/mkdsklsnode
+
+=head1 NOTES
+
+This command is part of the xCAT software product.
+
+=head1 SEE ALSO 
+
+rmdsklsnode(1) 
+
+

xCAT-client/pods/man1/mknimimage.1.pod

@@ -0,0 +1,115 @@
+=head1 NAME
+ 
+B<mknimimage> - Use this xCAT command to create AIX image definitions. 
+
+=head1 SYNOPSIS
+
+B<mknimimage [-h | --help ]>
+
+B<mknimimage [-V] [-f|--force] [-l location] [-s image_source] [-i current_image] [-t nimtype] osimage_name [attr=val [attr=val ...]]>
+
+=head1 DESCRIPTION
+
+This command may be used to create an AIX image.  It will create both an xCAT osimage definition and the corresponding NIM resource definitions. 
+
+If a "-s image_source" is provided then new NIM resources are created.
+
+If a "-i current_image" is provided then all the resources from the "current_image" will be used in the new osimage definition except the SPOT resource.  A new SPOT resource will be created by copying the one specified in the "current_image" and the name used for the new SPOT will be the same as the new osimage name.
+
+The naming convention for the NIM SPOT resource definition is to use the same name as the xCAT osimage.
+
+To list the contents of the xCAT osimage definition use the xCAT lsdef command ("lsdef -t osimage -l -o <osimage_name>").
+
+To change the xCAT osimage definition you can use the xCAT chdef command.
+
+To remove an xCAT osimage definition along with the associated NIM resource definitions use the rmdsklsimage command.
+
+To list a NIM resource definition use the AIX lsnim command ("lsnim -l <resource_name>").
+
+To remove specific NIM resource definitons use the AIX nim command.
+
+=head1 OPTIONS
+
+=over 10
+
+=item B<attr=val [attr=val ...]>
+
+Specifies one or more "attribute equals value" pairs, separated by spaces. Attr=val pairs must be specified last on the command line. These are used to specify additional or different resource names to use when creating the the xCAT osimage definition. The naming convention is: "<nim_resource_type>=<resource_name>". (ex. "root=myrootres")
+
+=item B<-f|--force>
+
+Use the force option to re-create xCAT osimage definition. This option removes the old definition before creating the new one. It does not remove any of the NIM resource definitions named in the osimage definition.  Use the rmnimimage command to remove the NIM resources associated with an xCAT osimage definition.
+
+=item B<-h |--help>
+
+Display usage message.
+
+=item B<image_name>
+
+The name of the xCAT osimage definition to create.  This will be used as the name of the xCAT osimage definition as well as the name of the NIM SPOT(COSI) resource.
+
+=item B<-i current_image>
+
+The name of an existing xCAT osimage that should be copied to make a new xCAT osimage definition. The new definition will contain the same resources as the current_image except for the SPOT, which will be copied and given the new name. 
+
+=item B<-l location>
+
+The directory location to use when creating new NIM resources. The default location is /install/nim (recommended).
+
+=item B<-s image_source>
+
+The source of software to use when creating the new NIM lpp_source resource. This could be a source directory, (ex. /dev/cd0), or a previously defined lpp_source resource name. This option causes new NIM resources to be created and added to the xCAT osimage definition.
+
+=item B<-t nimtype>
+
+Used to specify the NIM machine type. The possible values are "standalone", "diskless" or "dataless".  The default is "standalone".
+
+=item B<-V |--verbose>
+
+Verbose mode.
+
+=back
+
+=head1 RETURN VALUE
+
+=over 3
+
+=item 0 
+
+The command completed successfully.
+
+=item 1 
+
+An error has occurred.
+
+=back
+
+=head1 EXAMPLES
+
+
+1) Create a diskless image called 61cosi using the AIX product media.
+
+B<mknimimage -t diskless -s /dev/cd0 61cosi>
+
+2) Create a new diskless image by copying an existing image.
+
+B<mknimimage -t diskless -i 61cosi 61cosi_updt1>
+
+3) Create a diskless image using an existing lpp_source resource named 61cosi_lpp_source and include the /tmp & /home resources.  This assumes that the mytmp and myhome NIM resources have already been created by using NIM commands.
+
+B<mknimimage -t diskless -s 61cosi_lpp_source 611cosi tmp=mytmp home=myhome>
+
+
+=head1 FILES
+
+/opt/xcat/bin/mknimimage
+
+=head1 NOTES
+
+This command is part of the xCAT software product.
+
+=head1 SEE ALSO 
+
+rmnimimage(1) 
+
+

xCAT-client/pods/man1/rmdsklsnode.1.pod

@@ -0,0 +1,87 @@
+=head1 NAME
+ 
+B<rmdsklsnode> - Use this xCAT command to remove AIX/NIM diskless machine definitions. 
+
+=head1 SYNOPSIS
+
+B<rmdsklsnode [-h | --help ]>
+
+B<rmdsklsnode [-V] [-f|--force] [-i image_name] noderange> 
+
+=head1 DESCRIPTION
+
+Use this command to remove all NIM machine names that were created for the specified xCAT nodes. 
+
+The xCAT node definitions will not be removed.
+
+The default is to assume that the NIM machine names are the same as the xCAT node names.  If you had used the "-n" option when you created the NIM machine definitions with the mkdsklsnode command then the NIM machine names would be a combination of the xCAT node name and the osimage name used to initialize the NIM machine. To remove these definitions you must provide the name of the osimage that was used. 
+
+Use the xCAT rmdef command to remove xCAT node definitions.
+
+=head1 OPTIONS
+
+=over 10
+
+=item B<-f |--force>
+
+Use the force option to stop and remove running nodes. This handles the situation where a NIM machine definition indicates that a node is still running even though it is not.  
+
+=item B<-h |--help>
+
+Display usage message.
+
+=item B<-i image_name>
+
+The name of an xCAT image definition.
+
+=item B<noderange>
+
+A set of comma delimited node names and/or group names. See the "noderange" man page for details on additional supported formats.
+
+=item B<-V |--verbose>
+
+Verbose mode.
+
+=back
+
+=head1 RETURN VALUE
+
+=over 3
+
+=item 0 
+
+The command completed successfully.
+
+=item 1 
+
+An error has occurred.
+
+=back
+
+=head1 EXAMPLES
+
+1) Remove the NIM machine definition for the xCAT node named "node01".
+
+B<mkdsklsnode node01>
+
+2) Remove the NIM machine definition for xCAT node "node02" and the image "61cosi". (i.e. NIM machine name "node02_61cosi".)
+
+B<mkdsklsnode -i 61cosi node02>
+
+3) Remove the NIM definitions for all xCAT nodes in the group "aixnodes". Remove the NIM definitions even if the NIM node state is set to "currently running".
+
+B<mkdsklsnode -f aixnodes>
+
+=head1 FILES
+
+/opt/xcat/bin/rmdsklsnode
+
+=head1 NOTES
+
+This command is part of the xCAT software product.
+
+=head1 SEE ALSO 
+
+mkdsklsnode(1) 
+
+

xCAT-client/pods/man1/rmnimimage.1.pod

@@ -0,0 +1,69 @@
+=head1 NAME
+ 
+B<rmnimimage> - Use this xCAT command to remove an xCAT osimage definition and the associated NIM resources. 
+
+=head1 SYNOPSIS
+
+B<rmnimimage [-h | --help ]>
+
+B<rmnimimage [-V] osimage_name> 
+
+=head1 DESCRIPTION
+
+Use this xCAT command to remove all the AIX resource definitions included in the xCAT osimage definition as well as the xCAT image definition.
+
+This command will not remove NIM resources if they are currently allocated.  Remove NIM machines and deallocate resources before running this command.
+
+To list the contents of the xCAT image definition use the xCAT lsdef command ("lsdef -t osimage -l -o <osimage_name>").
+
+See the AIX NIM documentation for details on how to deallocate and remove unwanted NIM objects.
+
+=head1 OPTIONS
+
+=over 10
+
+=item B<-h |--help>
+
+Display usage message.
+
+=item B<osimage_name>
+
+The name of the xCAT osimage definition.
+
+=item B<-V |--verbose>
+
+Verbose mode.
+
+=back
+
+=head1 RETURN VALUE
+
+=over 3
+
+=item 0 
+
+The command completed successfully.
+
+=item 1 
+
+An error has occurred.
+
+=back
+
+=head1 EXAMPLES
+
+1) Remove all the NIM resources associated with the xCAT image definition named "53cosi".
+
+B<rmnimimage 53cosi>
+
+=head1 FILES
+
+/opt/xcat/bin/rmnimimage
+
+=head1 NOTES
+
+This command is part of the xCAT software product.
+
+=head1 SEE ALSO 
+
+mknimimage(1)