diff --git a/xCAT-client/pods/man1/nodediscoverdef.1.pod b/xCAT-client/pods/man1/nodediscoverdef.1.pod new file mode 100644 index 000000000..00522f1c9 --- /dev/null +++ b/xCAT-client/pods/man1/nodediscoverdef.1.pod @@ -0,0 +1,133 @@ +=head1 NAME + +B - Define the undefined discovery request to a predefined xCAT node, +or clean up the discovery entries from the discoverydata table +(which can be displayed by nodediscoverls command) + +=head1 SYNOPSIS + +B B<-u uuid> B<-n node> + +B B<-r> B<-u uuid> + +B B<-r> B<-t> {B|B|B|B|B|B|B} + +B [B<-h>|B<--help>|B<-v>|B<--version>] + +=head1 DESCRIPTION + +The B command defines the discovery entry from the discoverydata table to a predefined +xCAT node. The discovery entry can be displayed by B command. + +The options B<-u> and B<-n> have to be used together to define a discovery request to a node. + +The B command also can be used to clean up the discovery entries from the +discoverydata table. + +The option B<-r> is used to remove discovery entries. If working with B<-u>, the specific entry +which uuid specified by B<-u> will be removed. + +You also can use the B<-r> B<-t> option to limit that only remove the nodes that were discovered in a +particular method of discovery. + +=head1 OPTIONS + +=over 10 + +=item B<-t seq|profile|switch|blade|manual|undef|all> + +Specify the nodes that have been discovered by the specified discovery method: + +=over 3 + +=item * + +B - Sequential discovery (started via nodediscoverstart noderange= ...). + +=item * + +B - Profile discovery (started via nodediscoverstart networkprofile= ...). + +=item * + +B - Switch-based discovery (used when the switch and switches tables are filled in). + +=item * + +B - Blade discovery (used for IBM Flex blades). + +=item * + +B - Manually discovery (used when defining node by nodediscoverdef command). + +=item * + +B - Display the nodes that were in the discovery pool, but for which xCAT has not yet received a discovery request. + +=item * + +B - All discovered nodes. + +=back + +=item B<-n node> + +The xCAT node that the discovery entry will be defined to. + +=item B<-r> + +Remove the discovery entries from discoverydata table. + +=item B<-u uuid> + +The uuid of the discovered entry. + +=item B<-h|--help> + +Display usage message. + +=item B<-v|--version> + +Command version. + +=back + +=head1 RETURN VALUE + +0 The command completed successfully. + +1 An error has occurred. + +=head1 EXAMPLES + +=over 3 + +=item 1 + +Define the discovery entry which uuid is 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB4 to node node1 + +B -u 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB4 -n node1 + + Defined [51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB4] to node node1. + +=item 2 + +Remove the discovery entry which uuid is 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB4 from the discoverydata table + +B -r -u 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB4 + + Removing discovery entries finished. + +=item 3 + +Remove the discovery entries which discover type is B from the discoverydata table + +B -r -t seq + + Removing discovery entries finished. + +=back + +=head1 SEE ALSO + +L, L, L, L