Update the man page for sequential discovery support
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/branches/2.8@15898 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
daniceexi
parent
309b357920
commit
a57b1bbfa6
@ -1,16 +1,27 @@
|
||||
=head1 NAME
|
||||
|
||||
B<nodediscoverls> - List all discovered nodes
|
||||
B<nodediscoverls> - List the discovered nodes
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
B<nodediscoverls> [-h| --help | -v | --version]
|
||||
|
||||
B<nodediscoverls>
|
||||
|
||||
B<nodediscoverls> [-t seq|profile|switch|blade|undef|all] [-l]
|
||||
|
||||
B<nodediscoverls> [-u uuid] [-l]
|
||||
|
||||
B<nodediscoverls> [-h| --help | -v | --version]
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
The B<nodediscoverls> command lists all discovered nodes that use a profile in the current node discovery process
|
||||
The B<nodediscoverls> command lists the discovered nodes.
|
||||
|
||||
The B<nodediscoverls> command lists the discovered nodes which discovered by the current running discovery process.
|
||||
Or it lists all the discovered nodes if no discovery process is running.
|
||||
|
||||
Flag B<-t> can be used to list the nodes which discovered by the specific type.
|
||||
|
||||
With B<-l>, the long format information of the discovered nodes will be displayed.
|
||||
|
||||
=head1 OPTIONS
|
||||
|
||||
@ -22,6 +33,34 @@ B<-v|--version>
|
||||
|
||||
Command Version.
|
||||
|
||||
B<-t seq|profile|switch|blade|undef|all>
|
||||
|
||||
Display the nodes which discovered by the specific type.
|
||||
|
||||
=over 2
|
||||
|
||||
seq - Sequential discovery.
|
||||
|
||||
profile - Profile discovery.
|
||||
|
||||
switch - Switch discovery.
|
||||
|
||||
blade - Blade discovery.
|
||||
|
||||
undef - The discovery request has not been handled by xCAT.
|
||||
|
||||
all - All discovered nodes.
|
||||
|
||||
=back
|
||||
|
||||
B<-l>
|
||||
|
||||
Display the detail information of the discovered nodes.
|
||||
|
||||
B<-u uuid>
|
||||
|
||||
Display the discovered node which uuid equals B<uuid>.
|
||||
|
||||
=head1 RETURN VALUE
|
||||
|
||||
0 The command completed successfully.
|
||||
@ -30,9 +69,67 @@ Command Version.
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
||||
You can get a list of all discovered nodes, by using the following command:
|
||||
=item 1
|
||||
|
||||
Display the discovered nodes when sequential discovery is running:
|
||||
|
||||
B<nodediscoverls>
|
||||
|
||||
UUID NODE METHOD MTM SERIAL
|
||||
51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB2 distest1 sequential 786310X 1052EF2
|
||||
51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB3 distest2 sequential 786310X 1052EF3
|
||||
|
||||
=item 2
|
||||
|
||||
Display the nodes which have sent out discovery request but were not defined:
|
||||
|
||||
B<nodediscoverls> -t undef
|
||||
|
||||
UUID NODE METHOD MTM SERIAL
|
||||
51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB0 undef undef 786310X 1052EF0
|
||||
51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB1 undef undef 786310X 1052EF1
|
||||
|
||||
=item 3
|
||||
|
||||
Display all the discovered nodes:
|
||||
|
||||
B<nodediscoverls> -t all
|
||||
|
||||
UUID NODE METHOD MTM SERIAL
|
||||
51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB0 undef undef 786310X 1052EF0
|
||||
51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB1 undef undef 786310X 1052EF1
|
||||
51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB2 distest1 sequential 786310X 1052EF2
|
||||
51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB3 distest2 sequential 786310X 1052EF3
|
||||
|
||||
=item 4
|
||||
|
||||
Display the discovered node which uuid is B<51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB2> with detail information:
|
||||
|
||||
B<nodediscoverls> -u 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB2 -l
|
||||
|
||||
Object uuid: 51E5F2D7-0D59-11E2-A7BC-3440B5BEDBB2
|
||||
node=distest1
|
||||
method=sequential
|
||||
discoverytime=03-31-2013 17:05:12
|
||||
arch=x86_64
|
||||
cpucount=32
|
||||
cputype=Intel(R) Xeon(R) CPU E5-2690 0 @ 2.90GHz
|
||||
memory=198460852
|
||||
mtm=786310X
|
||||
serial=1052EF2
|
||||
nicdriver=eth0!be2net,eth1!be2net
|
||||
nicipv4=eth0!10.0.0.212/8
|
||||
nichwaddr=eth0!34:40:B5:BE:DB:B0,eth1!34:40:B5:BE:DB:B4
|
||||
nicpci=eth0!0000:0c:00.0,eth1!0000:0c:00.1
|
||||
nicloc=eth0!Onboard Ethernet 1,eth1!Onboard Ethernet 2
|
||||
niconboard=eth0!1,eth1!2
|
||||
nicfirm=eth0!ServerEngines BE3 Controller,eth1!ServerEngines BE3 Controller
|
||||
switchname=eth0!c909f06sw01
|
||||
switchaddr=eth0!192.168.70.120
|
||||
switchdesc=eth0!IBM Flex System Fabric EN4093 10Gb Scalable Switch, flash image: version 7.2.6, boot image: version 7.2.6
|
||||
switchport=eth0!INTA2
|
||||
|
||||
|
||||
nodediscoverls
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
|
||||
@ -6,11 +6,55 @@ B<nodediscoverstart> - starts the node discovery process
|
||||
|
||||
B<nodediscoverstart> [-h| --help | -v | --version]
|
||||
|
||||
B<Sequential Discovery Specific:>
|
||||
|
||||
=over 2
|
||||
|
||||
B<nodediscoverstart> noderange=<noderange> [hostiprange=<imageprofile>] [bmciprange=<bmciprange>] [groups=<groups>] [rack=<rack>] [chassis=<chassis>] [height=<height>] [unit=<unit>]
|
||||
|
||||
=back
|
||||
|
||||
B<Profile Discovery Specific:>
|
||||
|
||||
=over 2
|
||||
|
||||
B<nodediscoverstart> networkprofile=<network-profile> imageprofile=<image-profile> hostnameformat=<nost-name-format> [hardwareprofile=<hardware-profile>] [groups=<node-groups>] [rack=<rack-name>] [chassis=<chassis-name>] [height=<rack-server-height>] [unit=<rack-server-unit-location>] [rank=rank-num]
|
||||
|
||||
=back
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
The B<nodediscoverstart> command starts the node discovery process. All nodes discovered by this process will be associated with specified profiles and rack/chassis/unit locations.
|
||||
The B<nodediscoverstart> command starts the node discovery process.
|
||||
|
||||
The B<Sequential Discovery> and B<Profile Discovery> can NOT be run parallelly.
|
||||
|
||||
B<Sequential Discovery Specific:>
|
||||
|
||||
=over 2
|
||||
|
||||
The B<Sequential Discovery> is the simplest discovery approach that only specifying the B<noderange>, B<hostiprange> and B<bmciprange> could start the discovery process.
|
||||
|
||||
I<noderange> argument must be specified to start the B<Sequential Discovery>.
|
||||
|
||||
If you want to predefine host ip and bmc ip for the nodes, the arguments B<hostiprange> and B<bmciprange> could be ignored.
|
||||
|
||||
A free node name from the noderange will be assigned to a new discovered node. If the free node has the host ip or bmc ip predefined, the predefined ip will be used, otherwise a free host ip or bmc ip will be selected from the hostiprange or bmciprange.
|
||||
|
||||
Using the '-V' to display the free node names, ips list.
|
||||
|
||||
=back
|
||||
|
||||
B<Profile Discovery Specific:>
|
||||
|
||||
=over 2
|
||||
|
||||
The B<Profile Discovery> is the PCM associated discovery approach.
|
||||
|
||||
I<networkprofile>, I<imageprofile>, I<hostnameformat> arguments must be specified to start the B<Profile Discovery>.
|
||||
|
||||
All nodes discovered by this process will be associated with specified profiles and rack/chassis/unit locations.
|
||||
|
||||
=back
|
||||
|
||||
You can PXE boot nodes that you want to provision. PXE booting nodes launches the node discovery process. During the node discovery process, nodes are discovered automatically. Node settings are assigned automatically according to the specified profiles
|
||||
|
||||
@ -26,6 +70,22 @@ B<-v|--version>
|
||||
|
||||
Command Version.
|
||||
|
||||
B<-V|--verbose>
|
||||
|
||||
Display the free node names and host/bmc ips.
|
||||
|
||||
B<noderange=<noderange>>
|
||||
|
||||
The mandatory argument to start the B<Sequential Discovery>. The valid format is xCAT B<noderange>. e.g. node[01-10].
|
||||
|
||||
B<hostiprange=<ip range>>
|
||||
|
||||
The ip range which will be assigned to the host of new discovered node. The format could be: B<start_ip-end_ip> or B<noderange>. e.g. 192.168.0.1-192.168.0.10 or 192.168.0.[1-10].
|
||||
|
||||
B<bmciprange=<ip range>>
|
||||
|
||||
The ip range which will be assigned to the bmc of new discovered node. The format could be: B<start_ip-end_ip> or B<noderange>. e.g. 192.168.1.1-192.168.1.10 or 192.168.1.[1-10].
|
||||
|
||||
B<imageprofile=<image-profile>>
|
||||
|
||||
Sets the new image profile name used by the node, where <image-profile> is the new image profile. An image profile defines the provisioning method, OS information, kit information, and provisioning parameters for a node. If the "__ImageProfile_imgprofile" group already exists in the nodehm table, then "imgprofile" is used as the image profile name.
|
||||
@ -78,9 +138,27 @@ Specifies the starting rank number that is used in the node name format, where <
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
||||
To discover nodes using the default_cn network profile and the rhels6.3_packaged image profile, use the following command:
|
||||
=item 1
|
||||
|
||||
nodediscoverstart networkprofile=default_cn imageprofile=rhels6.3_packaged hostnameformat=compute#NNN
|
||||
B<Sequential Discovery>: To discover nodes with noderange and host/bmc ip range:
|
||||
|
||||
B<nodediscoverstart> noderange=n[1-10] hostiprange='172.20.101.1-172.20.101.10' bmciprange='172.20.102.1-172.20.102.10' -V
|
||||
|
||||
Sequential Discovery: Started:
|
||||
Number of free node names: 10
|
||||
Number of free host ips: 10
|
||||
Number of free bmc ips: 10
|
||||
------------------------------------Free Nodes------------------------------------
|
||||
NODE HOST IP BMC IP
|
||||
n01 172.20.101.1 172.20.102.1
|
||||
n02 172.20.101.2 172.20.102.2
|
||||
... ... ...
|
||||
|
||||
=item 2
|
||||
|
||||
B<Profile Discovery>: To discover nodes using the default_cn network profile and the rhels6.3_packaged image profile, use the following command:
|
||||
|
||||
B<nodediscoverstart> networkprofile=default_cn imageprofile=rhels6.3_packaged hostnameformat=compute#NNN
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user