xcat-core/perl-xCAT/xCAT/Usage.pm
jbjohnso 8035013447 -Add usage for KVM rpower extention
-Implement storage instance initialization for KVM guests


git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@2918 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
2009-03-17 00:49:55 +00:00

219 lines
7.6 KiB
Perl

#!/usr/bin/perl
# IBM(c) 2007 EPL license http://www.eclipse.org/legal/epl-v10.html
package xCAT::Usage;
use Getopt::Long;
use xCAT::Utils;
#-------------------------------------------------------------------------------
=head1 xCAT::Usage
=head2 Package Description
xCAT usage module. Some commands such as rpower have different implementations
for different hardware. This module holds the usage string for these kind
of commands so that the usage can be referenced from different modules.
=cut
#-------------------------------------------------------------------------------
my %usage = (
"rnetboot" =>
"Usage: rnetboot <noderange> [-f][-V|--verbose]
rnetboot [-h|--help|-v|--version]",
"rpower" =>
"Usage: rpower <noderange> [--nodeps] [on|onstandby|off|reset|stat|state|boot|cycle|softoff] [-V|--verbose]
rpower [-h|--help|-v|--version]
KVM Virtualization specific:
rpower <noderange> [boot] [ -c <path to iso> ]
PPC (with IVM or HMC) specific:
rpower <noderange> [--nodeps] [of] [-V|--verbose]
PPC (HMC) specific:
rpower <noderange> [onstandby] [-V|--verbose]
",
"rbeacon" =>
"Usage: rbeacon <noderange> [on|off|stat] [-V|--verbose]
rbeacon [-h|--help|-v|--version]",
"rvitals" =>
"Usage: rvitals <noderange> [all|temp|wattage|voltage|fanspeed|power|leds|lcds|state] [-V|--verbose]
rvitals [-h|--help|-v|--version]",
"reventlog" =>
"Usage: reventlog <noderange> [all|clear|<number of entries to retrieve>] [-V|--verbose]
reventlog [-h|--help|-v|--version]",
"rinv" =>
"Usage:
Common:
rinv <noderange> [all|model|serial] [-V|--verbose]
rinv [-h|--help|-v|--version]
BMC specific:
rinv <noderange> [vpd|mprom|deviceid|uuid|guid]
MPA specific:
rinv <noderange> [firm|bios|diag|mprom|sprom|mparom|mac|mtm]
PPC specific:
rinv <noderange> [bus|config|serial|model|firm|all]",
"rsetboot" =>
"Usage: rsetboot <noderange> [net|hd|cd|floppy|def|stat] [-V|--verbose]
rsetboot [-h|--help|-v|--version]",
"rbootseq" =>
"Usage: rbootseq <noderange> [hd0|hd1|hd2|hd3|net|iscsi|usbflash|floppy|none],...
rbootseq [-h|--help|-v|--version]",
"rscan" =>
"Usage: rscan <noderange> [-w][-x|-z] [-V|--verbose]
rscan [-h|--help|-v|--version]",
"rspconfig" =>
"Usage:
Common:
rspconfig [-h|--help|-v|--version]
BMC/MPA Common:
rspconfig <noderange> [snmpdest|alert|community] [-V|--verbose]
rspconfig <noderange> [snmpdest=<dest ip address>|alert=<on|off|en|dis|enable|disable>|community=<string>]
BMC specific:
rspconfig <noderange> [ip|netmask|gateway|backupgateway|garp]
rspconfig <noderange> [garp=<number of 1/2 second>]
iDataplex specific:
rspconfig <noderange> [thermprofile]
rspconfig <noderange> [thermprofile=<two digit number from chassis>]
MPA specific:
rspconfig <noderange> [sshcfg|snmpcfg|pd1|pd2|network|swnet|ntp|textid]
rspconfig <singlenode> [textid=name]
rspconfig <noderange> [sshcfg=<enable|disable>|
snmpcfg=<enable|disable>|
pd1=<nonred|redwoperf|redwperf>|
pd2=<nonred|redwoperf|redwperf>|
network=<*|[ip],[host],[gateway],[netmask]>|
swnet=<[ip],[gateway],[netmask]>|
textid=<*>|
ntp=<[ntp],[ip],[frequency],[v3]>
FSP specific:
rspconfig <noderange> [autopower|iocap|decfg|memdecfg|procdecfg|time|date|spdump|sysdump]
rspconfig <noderange> autopower=<enable|disable>|
iocap=<enable|disable>|
decfg=<enable|disable>:<policy name>,...|
memdecfg=<configure|deconfigure>:<processing unit>:<bank|unit>:<bank/unit number>:id,...|
procdecfg=<configure|deconfigure>:<processing unit>:id,...|
date=<mm-dd-yyyy>|
time=<hh:mm:ss>
HMC specific:
rspconfig <noderange> [sshcfg]
rspconfig <noderange> [sshcfg=<enable|disable>]",
"getmacs" =>
"Usage:
Common:
getmacs <noderange> [-V|--verbose]
getmacs [-h|--help|-v|--version]
PPC specific:
getmacs <noderange> [-f][-d][-S server -G gateway -C client]",
"mkvm" =>
"Usage: mkvm singlenode -i id -n noderange [-V|--verbose]
mkvm srccec -c destcec [-V|--verbose]
mkvm [-h|--help|-v|--version]",
"lsvm" =>
"Usage:
Common:
lsvm <noderange> [-V|--verbose]
lsvm [-h|--help|-v|--version]
PPC specific:
lsvm <noderange> [-a|--all]",
"chvm" =>
"Usage: chvm <noderange> [-p profile][-V|--verbose]
chvm [-h|--help|-v|--version]",
"rmvm" =>
"Usage: rmvm <noderange> [-V|--verbose]
rmvm [-h|--help|-v|--version]",
"lsslp" =>
"Usage: lsslp [-h|--help|-v|--version]
lsslp [-V|--verbose][-i ip[,ip..]][-w][-u] [-r|-x|-z][-s BPA|MM|IVM|RSA|FSP|HMC]
[-t tries][-m][-e cmd][-c [timeout[timeout,..]]]",
"rflash" =>
"Usage: rflash [ -h|--help|-v|--version]
rflash <noderange> -p directory [--activate concurrent | disruptive][-V|--verbose]
rflash <noderange> [--commit | --recover] [-V|--verbose]"
);
my $vers = xCAT::Utils->Version();
my %version = (
"rnetboot" => "$vers",
"rpower" => "$vers",
"rbeacon" => "$vers",
"rvitals" => "$vers",
"reventlog" => "$vers",
"rinv" => "$vers",
"rsetboot" => "$vers",
"rbootseq" => "$vers",
"rscan" => "$vers",
"rspconfig" => "$vers",
"getmacs" => "$vers",
"mkvm" => "$vers",
"lsvm" => "$vers",
"chvm" => "$vers",
"rmvm" => "$vers",
"lsslp" => "$vers",
"rflash" => "$vers"
);
#--------------------------------------------------------------------------------
=head3 getUsage
It returns the usage string for the given command.
Arguments:
command
Returns:
the usage string for the command.
=cut
#-------------------------------------------------------------------------------
sub getUsage {
my ($class, $command)=@_;
if (exists($usage{$command})) { return $usage{$command};}
else { return "Usage for command $command cannot be found\n"; }
}
#--------------------------------------------------------------------------------
=head3 getVersion
It returns the version string for the given command.
Arguments:
command
Returns:
the version string for the command.
=cut
#-------------------------------------------------------------------------------
sub getVersion {
my ($class, $command)=@_;
if (exists($version{$command})) { return $version{$command};}
else { return "Version string for command $command cannot be found\n"; }
}
#--------------------------------------------------------------------------------
=head3 parseCommand
This function parses the given command to see if the usage or version string
need to be returned.
Arguments:
command
arguments
Returns:
the usage or the version string for the command. The caller need to display the
string and then exit.
none, if no usage or version strings are needed. The caller can keep going.
=cut
#-------------------------------------------------------------------------------
sub parseCommand {
my $command=shift;
if ($command =~ /xCAT::Usage/) { $command=shift; }
my @exargs=@_;
@ARGV=@exargs;
#print "command=$command, args=@exargs, ARGV=@ARGV\n";
Getopt::Long::Configure('pass_through','no_ignore_case');
# parse the options
if(!GetOptions(
'h|help' => \$::HELP,
'v|version' => \$::VERSION)) {
return "";
}
if ($::HELP) { return xCAT::Usage->getUsage($command); }
if ($::VERSION) { return xCAT::Usage->getVersion($command); }
return "";
}