diff --git a/docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst b/docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst index 5d80c9eaf..702cb084a 100644 --- a/docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst +++ b/docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst @@ -11,7 +11,7 @@ NAME **** -\ **bmcdiscover**\ - Discover bmc using scan method, now scan_method can be nmap. +\ **bmcdiscover**\ - Discover Baseboard Management Controllers (BMCs) using a scan method ******** @@ -33,13 +33,13 @@ DESCRIPTION *********** -The \ **bmcdiscover**\ command will discover bmc using scan method. +The \ **bmcdiscover**\ command will discover Baseboard Management Controllers (BMCs) using a scan mathod. -This command will use nmap scan active nodes, ip range format should be the same format with that is used by nmap. +The command uses \ **nmap**\ to scan active nodes over a specified IP range. The IP range format should be a format that is acceptable by \ **nmap**\ . -Note: scan method can only be nmap now, default scan method is nmap. +The \ **bmcdiscover**\ command can also obtain some information about the BMC. (Check username/password, IP address source, DHCP/static configuration) -This command can check if bmc username or password is correct or not. It can get BMC IP Address source, DHCP Address or static Address. +Note: The scan method currently support is \ **nmap**\ . ******* @@ -50,37 +50,37 @@ OPTIONS \ **--range**\ - Specify one or more IP ranges. Ip ranges should be a string, can pass hostnames, IP addresses, networks, etc. Each can be an ip address (10.1.2.3) or an ip range (10.1.2.0/24). If the range is huge, for example, 192.168.1.1/8, the bmcdiscover may take a very long time to scan. So the range should be exactly specified. For nmap scan method, it accepts multiple formats. For example, 192.168.1.1/24, 40-41.1-2.3-4.1-100, scanme.nmap.org, microsoft.com/24. + Specify one or more IP ranges acceptable to nmap. IP rance 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 \ **bmcdiscover**\ command may take a long time to return. \ **-s**\ - Scan method, now it is nmap. + Scan method (The only supported scan method at this time is 'nmap') \ **-z**\ - List the stanza formate data. + List the data returned in xCAT stanza format \ **-w**\ - Write to the database. + Write to the xCAT database \ **-t**\ - Genereate a BMC type node object. + Generate a BMC type node object \ **-i|--bmcip**\ - BMC ip. + BMC IP @@ -98,25 +98,25 @@ OPTIONS \ **-c|--check**\ - Check. + Check \ **--ipsource**\ - BMC IP source. + BMC IP source \ **-h|--help**\ - Display usage message. + Display usage message \ **-v|--version**\ - Command version. + Display version information @@ -136,16 +136,24 @@ EXAMPLES ******** -1. To get all bmc from ip range +1. To get all bmc from IP range + + +.. code-block:: perl + + bmcdiscover -s nmap --range "10.4.23.100-254 50.3.15.1-2" -bmcdiscover -s nmap --range "10.4.23.100-254 50.3.15.1-2" Output is similar to: -10.4.23.254 -50.3.15.1 -Note: input for ip range can also be like scanme.nmap.org, microsoft.com/24, 192.168.0.1; 10.0.0-255.1-254. +.. code-block:: perl + + 10.4.23.254 + 50.3.15.1 + + +Note: input for IP range can also be like scanme.nmap.org, microsoft.com/24, 192.168.0.1; 10.0.0-255.1-254. 2. After discover bmc, list the stanza format data @@ -153,73 +161,113 @@ bmcdiscover -s nmap --range "10.4.22-23.100-254" -z Output is similar to: -node10422254: - objtype=node - groups=all - bmc=10.4.22.254 - cons=ipmi - mgt=ipmi -node10423254: - objtype=node - groups=all - bmc=10.4.23.254 - cons=ipmi - mgt=ipmi +.. code-block:: perl + + node10422254: + objtype=node + groups=all + bmc=10.4.22.254 + cons=ipmi + mgt=ipmi + + node10423254: + objtype=node + groups=all + bmc=10.4.23.254 + cons=ipmi + mgt=ipmi + 3. After discover bmc, write host node definition into the database, and the same time, give out stanza format data -bmcdiscover -s nmap --range "10.4.22-23.100-254" -w + +.. code-block:: perl + + bmcdiscover -s nmap --range "10.4.22-23.100-254" -w + Output is similar to: -node10422254: - objtype=node - groups=all - bmc=10.4.22.254 - cons=ipmi - mgt=ipmi -node10423254: - objtype=node - groups=all - bmc=10.4.23.254 - cons=ipmi - mgt=ipmi +.. code-block:: perl + + node10422254: + objtype=node + groups=all + bmc=10.4.22.254 + cons=ipmi + mgt=ipmi + + node10423254: + objtype=node + groups=all + bmc=10.4.23.254 + cons=ipmi + mgt=ipmi + 4. To check if user name or password is correct or not for bmc -bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD -c + +.. code-block:: perl + + bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD -c + Output is similar to: -Correct ADMINISTRATOR -bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD1 -c +.. code-block:: perl + + Correct ADMINISTRATOR + + bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD1 -c + Output is similar to: -Error: Wrong bmc password -bmcdiscover -i 10.4.23.254 -u USERID1 -p PASSW0RD1 -c +.. code-block:: perl + + Error: Wrong bmc password + + bmcdiscover -i 10.4.23.254 -u USERID1 -p PASSW0RD1 -c + Output is similar to: -Error: Wrong bmc user -bmcdiscover -i 10.4.23.2541234 -u USERID -p PASSW0RD -c +.. code-block:: perl + + Error: Wrong bmc user + + bmcdiscover -i 10.4.23.2541234 -u USERID -p PASSW0RD -c + Output is similar to: -Error: Not bmc + +.. code-block:: perl + + Error: Not bmc + 5. Get BMC IP Address source, DHCP Address or static Address -bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD --ipsource + +.. code-block:: perl + + bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD --ipsource + Output is similar to: -Static Address + +.. code-block:: perl + + Static Address + ******** diff --git a/xCAT-client/pods/man1/bmcdiscover.1.pod b/xCAT-client/pods/man1/bmcdiscover.1.pod index cc9b36907..342fd0675 100644 --- a/xCAT-client/pods/man1/bmcdiscover.1.pod +++ b/xCAT-client/pods/man1/bmcdiscover.1.pod @@ -1,6 +1,6 @@ =head1 NAME -B - Discover bmc using scan method, now scan_method can be nmap. +B - Discover Baseboard Management Controllers (BMCs) using a scan method =head1 SYNOPSIS @@ -14,13 +14,13 @@ B B<-i>|B<--bmcip> I [B<-u>|B<--bmcuser> I] B< =head1 DESCRIPTION -The B command will discover bmc using scan method. +The B command will discover Baseboard Management Controllers (BMCs) using a scan mathod. -This command will use nmap scan active nodes, ip range format should be the same format with that is used by nmap. +The command uses B to scan active nodes over a specified IP range. The IP range format should be a format that is acceptable by B. -Note: scan method can only be nmap now, default scan method is nmap. +The B command can also obtain some information about the BMC. (Check username/password, IP address source, DHCP/static configuration) -This command can check if bmc username or password is correct or not. It can get BMC IP Address source, DHCP Address or static Address. +Note: The scan method currently support is B. =head1 OPTIONS @@ -28,27 +28,27 @@ This command can check if bmc username or password is correct or not. It can get =item B<--range> -Specify one or more IP ranges. Ip ranges should be a string, can pass hostnames, IP addresses, networks, etc. Each can be an ip address (10.1.2.3) or an ip range (10.1.2.0/24). If the range is huge, for example, 192.168.1.1/8, the bmcdiscover may take a very long time to scan. So the range should be exactly specified. For nmap scan method, it accepts multiple formats. For example, 192.168.1.1/24, 40-41.1-2.3-4.1-100, scanme.nmap.org, microsoft.com/24. +Specify one or more IP ranges acceptable to nmap. IP rance 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 command may take a long time to return. =item B<-s> -Scan method, now it is nmap. +Scan method (The only supported scan method at this time is 'nmap') =item B<-z> -List the stanza formate data. +List the data returned in xCAT stanza format =item B<-w> -Write to the database. +Write to the xCAT database =item B<-t> -Genereate a BMC type node object. +Generate a BMC type node object =item B<-i|--bmcip> -BMC ip. +BMC IP =item B<-u|--bmcuser> @@ -60,19 +60,19 @@ BMC user password. =item B<-c|--check> -Check. +Check =item B<--ipsource> -BMC IP source. +BMC IP source =item B<-h|--help> -Display usage message. +Display usage message =item B<-v|--version> -Command version. +Display version information =back @@ -84,16 +84,16 @@ Command version. =head1 EXAMPLES -1. To get all bmc from ip range +1. To get all bmc from IP range -bmcdiscover -s nmap --range "10.4.23.100-254 50.3.15.1-2" + bmcdiscover -s nmap --range "10.4.23.100-254 50.3.15.1-2" Output is similar to: -10.4.23.254 -50.3.15.1 + 10.4.23.254 + 50.3.15.1 -Note: input for ip range can also be like scanme.nmap.org, microsoft.com/24, 192.168.0.1; 10.0.0-255.1-254. +Note: input for IP range can also be like scanme.nmap.org, microsoft.com/24, 192.168.0.1; 10.0.0-255.1-254. 2. After discover bmc, list the stanza format data @@ -101,14 +101,14 @@ bmcdiscover -s nmap --range "10.4.22-23.100-254" -z Output is similar to: -node10422254: + node10422254: objtype=node groups=all bmc=10.4.22.254 cons=ipmi mgt=ipmi -node10423254: + node10423254: objtype=node groups=all bmc=10.4.23.254 @@ -117,18 +117,18 @@ node10423254: 3. After discover bmc, write host node definition into the database, and the same time, give out stanza format data -bmcdiscover -s nmap --range "10.4.22-23.100-254" -w + bmcdiscover -s nmap --range "10.4.22-23.100-254" -w Output is similar to: -node10422254: + node10422254: objtype=node groups=all bmc=10.4.22.254 cons=ipmi mgt=ipmi -node10423254: + node10423254: objtype=node groups=all bmc=10.4.23.254 @@ -137,37 +137,37 @@ node10423254: 4. To check if user name or password is correct or not for bmc -bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD -c + bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD -c Output is similar to: -Correct ADMINISTRATOR + Correct ADMINISTRATOR -bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD1 -c + bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD1 -c Output is similar to: -Error: Wrong bmc password + Error: Wrong bmc password -bmcdiscover -i 10.4.23.254 -u USERID1 -p PASSW0RD1 -c + bmcdiscover -i 10.4.23.254 -u USERID1 -p PASSW0RD1 -c Output is similar to: -Error: Wrong bmc user + Error: Wrong bmc user -bmcdiscover -i 10.4.23.2541234 -u USERID -p PASSW0RD -c + bmcdiscover -i 10.4.23.2541234 -u USERID -p PASSW0RD -c Output is similar to: -Error: Not bmc + Error: Not bmc 5. Get BMC IP Address source, DHCP Address or static Address -bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD --ipsource + bmcdiscover -i 10.4.23.254 -u USERID -p PASSW0RD --ipsource Output is similar to: -Static Address + Static Address =head1 SEE ALSO