xcat-core/xCAT-client/pods/man1/xcat2nim.1.pod

=head1 NAME
 
B<xcat2nim> - Use this command to create and manage AIX NIM definitions based on xCAT object definitions.
 
=head1 SYNOPSIS
 
I<xcat2nim [-h | --help ]>

I<xcat2nim [-V | --verbose] [-a | --all] [-l | --list] [-u | --update] [-r | --remove] [-t object-types] [-o object-names] [noderange] [attr=val [attr=val...]] >

=head1 DESCRIPTION

The xcat2nim command uses xCAT node and group object definitions to create, update, list, or remove corresponding NIM machine and group definitions.

The xCAT definitions must be created and the NIM master must be installed and configured before running this command. 

xcat2nim uses xCAT database information, command line input, and default values to run the appropriate NIM commands.

The default behavior is to create new NIM definitions but not apply updates to existing definitions.  If you use wish to update existing NIM definitions then you must use the update option.

=head1 OPTIONS

B<-a |--all>             Create NIM definitions corresponding to all xCAT node and group definitions.

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.  The attribute names must correspond to the attributes supported by the relevant NIM commands.  When providing attr=val pairs on the command line you must not specify more than one object type.

B<-h |--help>            Display the usage message.

B<-l | --list>		 List NIM definitions corresponding to xCAT definitions.

B<noderange>             A set of comma delimited node names and/or group names, (must be the first parameter). See the "noderange" man page for details on supported formats.

B<-o object-names>       A set of comma delimited xCAT object names. 

B<-t object-types>       A set of comma delimited xCAT object types. Supported types include: node and group.

B<-r | --remove>         Remove NIM definitions corresponding to xCAT definitions.

B<-u | --update>         Update existing NIM definitions based on xCAT definitions. 

B<-V |--verbose>         Verbose mode.

=head1 RETURN VALUE

0 The command completed successfully.

1 An error has occurred.

=head1 EXAMPLES

1.  Convert all xCAT node and group definitions to NIM machine and group definitions.

I<xcat2nim -a>

2. To create NIM machine definitions for all xCAT node definitions.

I<xcat2nim -t node> 

3. To create a NIM machine definition corresponding to the xCAT clstrn01 node definition.

I<xcat2nim -t node -o clstrn01>

4. To create a NIM machine group definition corresponding to the xCAT aix61nodes group definition.

I<xcat2nim -t group -o aix61nodes>

5.  Convert all node definitions in the xCAT group AIXNodes to NIM machine definitions.

I<xcat2nim -t node -o AIXNodes>

4.  To create NIM 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.

I<xcat2nim -t node -o lpar_grp machinetype=standalone netboot_kernel=mp cable_type="N/A">

5. To update the NIM definition of node clstrn01 to have a "cable_type" of "bnc".

I<xcat2nim -t node -o clstrn01 cable_type=bnc>

6. To list the NIM definition for node clstrn02.

I<xcat2nim -t node -l -o clstrn02>

7. To remove the NIM definition for the group "AIXnodes".

I<xcat2nim -t group -r -o AIXnodes>


=head1 FILES
 
$XCATROOT/bin/xcat2nim

(The XCATROOT environment variable is set when xCAT is installed. The
default value is "/opt/xcat".)


=head1 NOTES

This command is part of the xCAT software product.


=head1 SEE ALSO

See the xCAT mkdef command for details on how to create the xCAT node and group object definitions.