From 8a98c3f75de83d6f66a71a95bbb45b7d9361285d Mon Sep 17 00:00:00 2001
From: daniceexi <daniceexi@8638fb3e-16cb-4fca-ae20-7b5d299a9bcd>
Date: Thu, 16 May 2013 13:07:37 +0000
Subject: [PATCH] add the man page for nodediscoverdef command

git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@16316 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
---
 xCAT-client/pods/man1/nodediscoverdef.1.pod | 133 ++++++++++++++++++++
 1 file changed, 133 insertions(+)
 create mode 100644 xCAT-client/pods/man1/nodediscoverdef.1.pod

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<nodediscoverdef> - 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<nodediscoverdef> B<-u uuid> B<-n node>
+
+B<nodediscoverdef> B<-r> B<-u uuid>
+
+B<nodediscoverdef> B<-r> B<-t> {B<seq>|B<profile>|B<switch>|B<blade>|B<manual>|B<undef>|B<all>}
+
+B<nodediscoverdef> [B<-h>|B<--help>|B<-v>|B<--version>]
+
+=head1 DESCRIPTION
+
+The B<nodediscoverdef> command defines the discovery entry from the discoverydata table to a predefined
+xCAT node. The discovery entry can be displayed by B<nodediscoverls> command.
+
+The options B<-u> and B<-n> have to be used together to define a discovery request to a node.
+
+The B<nodediscoverdef> 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<seq> - Sequential discovery (started via nodediscoverstart noderange=<noderange> ...).
+
+=item *
+
+B<profile> - Profile discovery (started via nodediscoverstart networkprofile=<network-profile> ...).
+
+=item *
+
+B<switch> - Switch-based discovery (used when the switch and switches tables are filled in).
+
+=item *
+
+B<blade> - Blade discovery (used for IBM Flex blades).
+
+=item *
+
+B<manual> - Manually discovery (used when defining node by nodediscoverdef command).
+
+=item *
+
+B<undef> - Display the nodes that were in the discovery pool, but for which xCAT has not yet received a discovery request.
+
+=item *
+
+B<all> - 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<nodediscoverdef> -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<nodediscoverdef> -r -u 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB4
+
+ Removing discovery entries finished.
+
+=item 3
+
+Remove the discovery entries which discover type is B<seq> from the discoverydata table
+
+B<nodediscoverdef> -r -t seq
+
+ Removing discovery entries finished.
+
+=back
+
+=head1 SEE ALSO
+
+L<nodediscoverstart(1)|nodediscoverstart.1>, L<nodediscoverstatus(1)|nodediscoverstatus.1>, L<nodediscoverstop(1)|nodediscoverstop.1>, L<nodediscoverls(1)|nodediscoverls.1>