xcat-core/xCAT-client/pods/man1/rmdsklsnode.1.pod
2013-06-07 17:35:38 +00:00

119 lines
4.0 KiB
Plaintext

=head1 NAME
B<rmdsklsnode> - Use this xCAT command to remove AIX/NIM diskless machine definitions.
=head1 SYNOPSIS
B<rmdsklsnode [-h | --help ]>
B<rmdsklsnode [-V|--verbose] [-f|--force] [-r|--remdef] [-i image_name] [-p|--primarySN] [-b|--backupSN] noderange>
=head1 DESCRIPTION
Use this command to remove all NIM client machine definitions that were created for the specified xCAT nodes.
The xCAT node definitions will not be removed. Use the xCAT B<rmdef> command to remove xCAT node definitions.
If you are using xCAT service nodes the B<rmdsklsnode> command will automatically determine the correct server(s) for the node and remove the NIM definitions on that server(s).
If the node you are trying to remove is currently running the B<rmdsklsnode> command will not remove the definitions. You can use the "-f" option to shut down the node and remove the definition.
B<Removing alternate NIM client definitions>
If you used the "-n" option when you created the NIM client definitions with the B<mkdsklsnode> command then the NIM client 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 using the "-i" option.
In most cases you would most likely want to remove the old client definitions without disturbing the nodes that you just booted with the new alternate client definition. The B<rmdsklsnode -r> option can be used to remove the old alternate client defintions without stopping the running node.
However, if you have NIM dump resources assign to your nodes be aware that when the old NIM alternate client definitions are removed it will leave the nodes unable to produce a system dump. This is a current limitation in the NIM support for alternate client definitions. For this reason it is recommended that you wait to do this cleanup until right before you do your next upgrade.
=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<-b |--backupSN>
When using backup service nodes only update the backup. The default is to updat
e both the primary and backup service nodes.
=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<-p|--primarySN>
When using backup service nodes only update the primary. The default is to upda
te both the primary and backup service nodes.
=item B<-r|--remdef>
Use this option to reset, deallocate, and remove NIM client definitions. This option will not attempt to shut down running nodes. This option should be used when remove alternate NIM client definitions that were created using B<mkdsklsnode -n>.
=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 client definition for the xCAT node named "node01". Give verbose output.
B<rmdsklsnode -V node01>
2) Remove the NIM client definitions for all the xCAT nodes in the group "aixnod
es". Attempt to shut down the nodes if they are running.
B<rmdsklsnode -f aixnodes>
3) Remove the NIM client machine definition for xCAT node "node02" that was created with the B<mkdsklsnode -n> option and the image "AIXdskls". (i.e. NIM client machine name "node02_AIXdskls".)
B<rmdsklsnode -i AIXdskls node02>
This assume that node02 is not currently running.
4) Remove the old alternate client definition "node27_olddskls".
B<rmdsklsnode -r -i olddskls node27>
Assuming the node was booted using an new alternate NIM client definition then this will leave the node running.
=head1 FILES
/opt/xcat/bin/rmdsklsnode
=head1 NOTES
This command is part of the xCAT software product.
=head1 SEE ALSO
L<mkdsklsnode(1)|mkdsklsnode.1>