xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-08-21 02:30:21 +00:00
Code Issues Releases Wiki Activity

add usage and manpage for bmcdiscover "--sn" option

Browse Source
This commit is contained in:
ertaozh
2017-08-15 04:27:54 -04:00
parent 580b399ade
commit e4d8442e10
3 changed files with 59 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst
View File

@@ -23,7 +23,7 @@ SYNOPSIS
\ **bmcdiscover**\ [\ **-v | -**\ **-version**\ ]
\ **bmcdiscover**\ [\ **-s**\ \ *scan_method*\ ] [\ **-u**\ \ *bmc_user*\ ] [\ **-p**\ \ *bmc_passwd*\ ] [\ **-z**\ ] [\ **-w**\ ] \ **-**\ **-range**\ \ *ip_ranges*\
\ **bmcdiscover**\ [\ **-**\ **-sn**\ \ *SN_nodename*\ ] [\ **-s**\ \ *scan_method*\ ] [\ **-u**\ \ *bmc_user*\ ] [\ **-p**\ \ *bmc_passwd*\ ] [\ **-z**\ ] [\ **-w**\ ] \ **-**\ **-range**\ \ *ip_ranges*\
\ **bmcdiscover**\ \ **-u**\ \ *bmc_user*\ \ **-p**\ \ *bmc_passwd*\ \ **-i**\ \ *bmc_ip*\ \ **-**\ **-check**\
@@ -56,6 +56,12 @@ OPTIONS
\ **-**\ **-sn**\
Specify one or more service node on which bmcdiscover will run. In hierarchical cluster, the MN may not be able to access the BMC of CN directly, but SN can. With this option, bmcdiscover will be dispatched to the specified SN and set them as the 'servicenode' attribute of the discovered BMC node.
\ **-s**\
Scan method (The only supported scan method at this time is \ **nmap**\ )
@@ -142,7 +148,7 @@ EXAMPLES
Note: Input for IP range can be in the form: scanme.nmap.org, microsoft.com/24, 192.168.0.1; 10.0.0-255.1-254.
2. To get all BMSs in IP range "10.4.22-23.100-254", displayed in xCAT stanza format:
2. To get all BMCs in IP range "10.4.22-23.100-254", displayed in xCAT stanza format:
.. code-block:: perl
@@ -150,7 +156,30 @@ Note: Input for IP range can be in the form: scanme.nmap.org, microsoft.com/24,
bmcdiscover -s nmap --range "10.4.22-23.100-254" -z
3. Discover the BMCs and write the discovered-node definitions into the xCAT database and write out the stanza foramt to the console:
3. To discovery BMCs through sn01:
.. code-block:: perl
bmcdiscover --sn sn01 -s nmap --range "10.4.22-23.100-254" -z
Output is similar to:
.. code-block:: perl
node-70e28414291b:
objtype=node
groups=all
bmc=10.4.22.101
cons=openbmc
mgt=openbmc
servicenode=sn01
conserver=sn01
4. Discover the BMCs and write the discovered-node definitions into the xCAT database and write out the stanza foramt to the console:
.. code-block:: perl
@@ -158,7 +187,7 @@ Note: Input for IP range can be in the form: scanme.nmap.org, microsoft.com/24,
bmcdiscover -s nmap --range "10.4.22-23.100-254" -w -z
4. To check if the username or password is correct against the BMC:
5. To check if the username or password is correct against the BMC:
.. code-block:: perl
@@ -166,7 +195,7 @@ Note: Input for IP range can be in the form: scanme.nmap.org, microsoft.com/24,
bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD --check
5. Get BMC IP Address source, DHCP Address or static Address
6. Get BMC IP Address source, DHCP Address or static Address
.. code-block:: perl

29
xCAT-client/pods/man1/bmcdiscover.1.pod
View File

@@ -8,7 +8,7 @@ B<bmcdiscover> [B<-?>|B<-h>|B<--help>]
B<bmcdiscover> [B<-v>|B<--version>]
B<bmcdiscover> [B<-s> I<scan_method>] [B<-u> I<bmc_user>] [B<-p> I<bmc_passwd>] [B<-z>] [B<-w>] B<--range> I<ip_ranges>
B<bmcdiscover> [B<--sn> I<SN_nodename>] [B<-s> I<scan_method>] [B<-u> I<bmc_user>] [B<-p> I<bmc_passwd>] [B<-z>] [B<-w>] B<--range> I<ip_ranges>
B<bmcdiscover> B<-u> I<bmc_user> B<-p> I<bmc_passwd> B<-i> I<bmc_ip> B<--check>
@@ -33,6 +33,10 @@ Note: The scan method currently support is B<nmap>.
Specify one or more IP ranges acceptable to nmap. IP range can be hostnames, IP addresses, networks, etc. A single IP address (10.1.2.3) or an IP range (10.1.2.0/24) can be specified. If the range is very large, the B<bmcdiscover> command may take a long time to return.
=item B<--sn>
Specify one or more service node on which bmcdiscover will run. In hierarchical cluster, the MN may not be able to access the BMC of CN directly, but SN can. With this option, bmcdiscover will be dispatched to the specified SN and set them as the 'servicenode' attribute of the discovered BMC node.
=item B<-s>
Scan method (The only supported scan method at this time is B<nmap>)
@@ -90,19 +94,34 @@ Display version information
Note: Input for IP range can be in the form: scanme.nmap.org, microsoft.com/24, 192.168.0.1; 10.0.0-255.1-254.
2. To get all BMSs in IP range "10.4.22-23.100-254", displayed in xCAT stanza format:
2. To get all BMCs in IP range "10.4.22-23.100-254", displayed in xCAT stanza format:
bmcdiscover -s nmap --range "10.4.22-23.100-254" -z
3. Discover the BMCs and write the discovered-node definitions into the xCAT database and write out the stanza foramt to the console:
3. To discovery BMCs through sn01:
bmcdiscover --sn sn01 -s nmap --range "10.4.22-23.100-254" -z
Output is similar to:
node-70e28414291b:
objtype=node
groups=all
bmc=10.4.22.101
cons=openbmc
mgt=openbmc
servicenode=sn01
conserver=sn01
4. Discover the BMCs and write the discovered-node definitions into the xCAT database and write out the stanza foramt to the console:
bmcdiscover -s nmap --range "10.4.22-23.100-254" -w -z
4. To check if the username or password is correct against the BMC:
5. To check if the username or password is correct against the BMC:
bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD --check
5. Get BMC IP Address source, DHCP Address or static Address
6. Get BMC IP Address source, DHCP Address or static Address
bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD --ipsource

2
xCAT-server/lib/xcat/plugins/bmcdiscover.pm
View File

@@ -183,7 +183,7 @@ sub bmcdiscovery_usage {
push @{ $rsp->{data} }, "Usage:";
push @{ $rsp->{data} }, "\tbmcdiscover [-?|-h|--help]";
push @{ $rsp->{data} }, "\tbmcdiscover [-v|--version]";
push @{ $rsp->{data} }, "\tbmcdiscover [-s scan_method] [-u bmc_user] [-p bmc_passwd] [-z] [-w] --range ip_range\n";
push @{ $rsp->{data} }, "\tbmcdiscover [--sn <SN_nodename>] [-s scan_method] [-u bmc_user] [-p bmc_passwd] [-z] [-w] --range ip_range\n";
push @{ $rsp->{data} }, "\tCheck BMC administrator User/Password:\n";
push @{ $rsp->{data} }, "\t\tbmcdiscover -u bmc_user -p bmc_password -i bmc_ip --check\n";