man page for bmcdiscover

xCAT-client/pods/man1/bmcdiscover.1.pod

@@ -0,0 +1,62 @@
+=head1 NAME
+
+B<bmcdiscover> - Discover bmc using scan method, now scan_method can be nmap.
+
+=head1 SYNOPSIS
+
+B<bmcdiscover> [B<-h>|B<--help>] [B<-v>|B<--version>]
+
+B<bmcdiscover> [B<-m>|B<--method>] I<scan_method> [B<-r>|B<--range>] I<ip_range> 
+
+=head1 DESCRIPTION
+
+The B<bmcdiscover> command will discover bmc using scan method.
+
+This command will use nmap scan active nodes, ip range format should be the same format with that is used by nmap.
+
+Note: scan method can only be nmap now.
+
+=head1 OPTIONS
+
+=over 10
+
+=item B<-h|--help>
+
+Display usage message.
+
+=item B<-v|--version>
+
+Command version.
+
+=item B<-m> I<scan_method>
+
+Scan method, now it is nmap.
+
+=item B<-r> I<ip_range>
+
+Ip range should be a string, can pass hostnames, IP addresses, networks, etc.
+
+=back
+
+=head1 RETURN VALUE
+
+0  The command completed successfully.
+
+1  An error has occurred.
+
+=head1 EXAMPLES
+
+1. To get all bmc from ip range
+
+bmcdiscover -m nmap -r "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.
+
+=head1 SEE ALSO
+
+L<lsslp(1)|lsslp.1>