diff --git a/xCAT-client-2.0/share/man/man1/xcat2nim.1 b/xCAT-client-2.0/share/man/man1/xcat2nim.1 index 5c57f0901..2cbc4bcf2 100644 --- a/xCAT-client-2.0/share/man/man1/xcat2nim.1 +++ b/xCAT-client-2.0/share/man/man1/xcat2nim.1 @@ -129,41 +129,42 @@ .\" ======================================================================== .\" .IX Title "XCAT2NIM.1 1" -.TH XCAT2NIM.1 1 "2007-12-09" "perl v5.8.2" "User Contributed Perl Documentation" +.TH XCAT2NIM.1 1 "2007-12-16" "perl v5.8.2" "User Contributed Perl Documentation" .SH "NAME" -\&\fBxcat2nim\fR \- Use this command to create AIX NIM definitions from xCAT object definitions. +\&\fBxcat2nim\fR \- Use this command to create and manage AIX NIM definitions based on xCAT object definitions. .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fIxcat2nim [\-h | \-\-help ]\fR .PP -\&\fIxcat2nim [\-V | \-\-verbose] [\-a | \-\-all] [\-t object\-types] [\-o object\-names]\fR -\&\fI[\-f | \-\-force] [noderange] [attr=val [attr=val...]] \fR +\&\fIxcat2nim [\-V | \-\-verbose] [\-a | \-\-all] [\-l | \-\-list] [\-u | \-\-update] [\-r | \-\-remove] [\-t object\-types] [\-o object\-names] [noderange] [attr=val [attr=val...]] \fR .SH "DESCRIPTION" .IX Header "DESCRIPTION" -The xcat2nim command uses xCAT node and group object definitions to create or update corresponding \s-1NIM\s0 machine and group definitions. +The xcat2nim command uses xCAT node and group object definitions to create, update, list, or remove corresponding \s-1NIM\s0 machine and group definitions. .PP The xCAT definitions must be created and the \s-1NIM\s0 master must be installed and configured before running this command. .PP -xcat2nim uses xCAT database information, command line input, and default values to run the appropriate \s-1NIM\s0 commands to create the \s-1NIM\s0 definitions. +xcat2nim uses xCAT database information, command line input, and default values to run the appropriate \s-1NIM\s0 commands. .PP -The default behavior is to create new \s-1NIM\s0 definitions but not apply updates to existing definitions. If you use wish to update existing \s-1NIM\s0 definitions then you must use the force option. +The default behavior is to create new \s-1NIM\s0 definitions but not apply updates to existing definitions. If you use wish to update existing \s-1NIM\s0 definitions then you must use the update option. .SH "OPTIONS" .IX Header "OPTIONS" \&\fB\-a |\-\-all\fR Create \s-1NIM\s0 definitions corresponding to all xCAT node and group definitions. .PP \&\fBattr=val [attr=val ...]\fR Specifies one or more \*(L"attribute equals value\*(R" pairs, separated by spaces. Attr=val pairs must be specified last on the command line. The attribute names must correspond to the attributes supported by the relevant \s-1NIM\s0 commands. When providing attr=val pairs on the command line you must not specify more than one object type. .PP -\&\fB\-f |\-\-force\fR Use the force option to update existing \s-1NIM\s0 definitions. +\&\fB\-h |\-\-help\fR Display the usage message. .PP -\&\fB\-h |\-\-help\fR Display usage message. +\&\fB\-l | \-\-list\fR List \s-1NIM\s0 definitions corresponding to xCAT definitions. .PP -\&\fBnoderange\fR A set of comma delimited node names and/or group names. (must be the first parameter) See the \*(L"noderange\*(R" man page for details on supported formats. +\&\fBnoderange\fR A set of comma delimited node names and/or group names, (must be the first parameter). See the \*(L"noderange\*(R" man page for details on supported formats. .PP \&\fB\-o object-names\fR A set of comma delimited xCAT object names. .PP \&\fB\-t object-types\fR A set of comma delimited xCAT object types. Supported types include: node and group. .PP -Supported types include: node and group. +\&\fB\-r | \-\-remove\fR Remove \s-1NIM\s0 definitions corresponding to xCAT definitions. +.PP +\&\fB\-u | \-\-update\fR Update existing \s-1NIM\s0 definitions based on xCAT definitions. .PP \&\fB\-V |\-\-verbose\fR Verbose mode. .SH "RETURN VALUE" @@ -183,19 +184,31 @@ Supported types include: node and group. .PP 3. To create a \s-1NIM\s0 machine definition corresponding to the xCAT clstrn01 node definition. .PP -\&\fIxcat2nim \-t node clstrn01\fR +\&\fIxcat2nim \-t node \-o clstrn01\fR .PP 4. To create a \s-1NIM\s0 machine group definition corresponding to the xCAT aix61nodes group definition. .PP -\&\fIxcat2nim \-t group aix61nodes\fR +\&\fIxcat2nim \-t group \-o aix61nodes\fR .PP 5. Convert all node definitions in the xCAT group AIXNodes to \s-1NIM\s0 machine definitions. .PP -\&\fIxcat2nim \-t node AIXNodes\fR +\&\fIxcat2nim \-t node \-o AIXNodes\fR .PP -4. To create \s-1NIM\s0 machine definitions for each node that is a member of the xCAT lpar_grp group and specify attribute values that will be applied to each definition. (In this example the name of the \s-1NIM\s0 primary network is master_net.) +4. To create \s-1NIM\s0 machine definitions for each node that is a member of the xCAT \*(L"lpar_grp\*(R" group and specify attribute values that will be applied to each definition. .PP -\&\fIxcat2nim \-t node lpar_grp machinetype=standalone netboot_kernel=mp network_name=master_net cable_type=\*(L"N/A\*(R"\fR +\&\fIxcat2nim \-t node \-o lpar_grp machinetype=standalone netboot_kernel=mp cable_type=\*(L"N/A\*(R"\fR +.PP +5. To update the \s-1NIM\s0 definition of node clstrn01 to have a \*(L"cable_type\*(R" of \*(L"bnc\*(R". +.PP +\&\fIxcat2nim \-t node \-o clstrn01 cable_type=bnc\fR +.PP +6. To list the \s-1NIM\s0 definition for node clstrn02. +.PP +\&\fIxcat2nim \-t node \-l \-o clstrn02\fR +.PP +7. To remove the \s-1NIM\s0 definition for the group \*(L"AIXnodes\*(R". +.PP +\&\fIxcat2nim \-t group \-r \-o AIXnodes\fR .SH "FILES" .IX Header "FILES" /usr/sbin/xcat2nim