mirror of
https://github.com/xcat2/xcat-core.git
synced 2025-05-29 17:23:08 +00:00
116 lines
3.3 KiB
Plaintext
116 lines
3.3 KiB
Plaintext
=head1 NAME
|
|
|
|
B<bmcdiscover> - Discover Baseboard Management Controllers (BMCs) using a scan method
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<bmcdiscover> [B<-?>|B<-h>|B<--help>]
|
|
|
|
B<bmcdiscover> [B<-v>|B<--version>]
|
|
|
|
B<bmcdiscover> B<--range> I<ip_ranges> [B<--sn> I<SN_nodename>] [B<-s> I<scan_method>] [B<-u> I<bmc_user>] [B<-p> I<bmc_passwd>] [B<-n> I<new_bmc_passwd>] [B<-z>] [B<-w>]
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<bmcdiscover> command will discover Baseboard Management Controllers (BMCs) using a scan method.
|
|
|
|
The command uses B<nmap> to scan active nodes over a specified IP range. The IP range format should be a format that is acceptable by B<nmap>.
|
|
|
|
B<Note:> The scan method currently supported is B<nmap>.
|
|
|
|
|
|
B<Note:> Starting on January 1, 2020, some newly shipped systems will require the default BMC password to be changed before they can be managed by xCAT. Use B<bmcdiscover> with B<-n> option to specify new BMC password.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 10
|
|
|
|
=item B<--range>
|
|
|
|
Specify one or more IP ranges acceptable to B<nmap>. IP range can be hostnames, IP addresses, networks, etc. A single IP address (10.1.2.3), several IPs with commas (10.1.2.3,10.1.2.10), IP range with "-" (10.1.2.0-100) 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 nodes on which B<bmcdiscover> will run. In hierarchical cluster, the MN may not be able to access the BMC of CN directly, but SN can. In that case, B<bmcdiscover> will be dispatched to the specified SNs. Then, the nodename of the service node that B<bmcdiscover> is running on will be set to the 'servicenode' attribute of the discovered BMC node.
|
|
|
|
=item B<-s>
|
|
|
|
Scan method (The only supported scan method at this time is B<nmap>)
|
|
|
|
=item B<-z>
|
|
|
|
List the data returned in xCAT stanza format
|
|
|
|
=item B<-w>
|
|
|
|
Write to the xCAT database.
|
|
|
|
=item B<-u|--bmcuser>
|
|
|
|
BMC user name.
|
|
|
|
=item B<-p|--bmcpasswd>
|
|
|
|
BMC user password.
|
|
|
|
=item B<-n|--newbmcpw>
|
|
|
|
New BMC user password.
|
|
|
|
=item B<-h|--help>
|
|
|
|
Display usage message
|
|
|
|
=item B<-v|--version>
|
|
|
|
Display version information
|
|
|
|
=back
|
|
|
|
=head1 RETURN VALUE
|
|
|
|
0 The command completed successfully.
|
|
|
|
1 An error has occurred.
|
|
|
|
=head1 EXAMPLES
|
|
|
|
|
|
1. To get all responding BMCs from IP range "10.4.23.100-254" and "50.3.15.1-2":
|
|
|
|
bmcdiscover -s nmap --range "10.4.23.100-254 50.3.15.1-2"
|
|
|
|
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 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. To discover 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 format to the console:
|
|
|
|
bmcdiscover -s nmap --range "10.4.22-23.100-254" -w -z
|
|
|
|
5. Discover the BMC with the specified IP address, change its default BMC password and display in xCAT stanza format:
|
|
|
|
bmcdiscover --range "10.4.22-23.100" -u root -p 0penBmc -n 0penBmc123 -z
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<lsslp(1)|lsslp.1>
|