From 24cd358a62153b8ece2eab4bf9c629ef9e31057b Mon Sep 17 00:00:00 2001 From: XuWei Date: Wed, 28 Feb 2018 01:56:57 -0500 Subject: [PATCH 1/2] modify usage and manpage for openbmc --- .../references/man1/rbeacon.1.rst | 21 +++++++++- .../references/man1/rsetboot.1.rst | 2 +- .../references/man1/rspconfig.1.rst | 42 +++++++++++++++---- perl-xCAT/xCAT/Usage.pm | 33 +++++++++++++-- xCAT-client/pods/man1/rbeacon.1.pod | 12 +++++- xCAT-client/pods/man1/rsetboot.1.pod | 2 +- xCAT-client/pods/man1/rspconfig.1.pod | 38 +++++++++++++---- 7 files changed, 126 insertions(+), 24 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man1/rbeacon.1.rst b/docs/source/guides/admin-guides/references/man1/rbeacon.1.rst index 800f7e553..79790d901 100644 --- a/docs/source/guides/admin-guides/references/man1/rbeacon.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rbeacon.1.rst @@ -11,11 +11,28 @@ SYNOPSIS ******** +\ **rbeacon**\ [\ **-h | -**\ **-help | -v | -**\ **-version**\ ] + +BMC (using IPMI): +================= + + \ **rbeacon**\ \ *noderange*\ {\ **on | blink | off | stat**\ } -\ **rbeacon**\ [\ **-h | -**\ **-help**\ ] -\ **rbeacon**\ {\ **-v | -**\ **-version**\ } +OpenPOWER BMC (using IPMI): +=========================== + + +\ **rbeacon**\ \ *noderange*\ {\ **on | blink | off | stat**\ } + + +OpenPOWER OpenBMC: +================== + + +\ **rbeacon**\ \ *noderange*\ {\ **on | off**\ } + *********** diff --git a/docs/source/guides/admin-guides/references/man1/rsetboot.1.rst b/docs/source/guides/admin-guides/references/man1/rsetboot.1.rst index da5c3876e..6807ce6af 100644 --- a/docs/source/guides/admin-guides/references/man1/rsetboot.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rsetboot.1.rst @@ -62,7 +62,7 @@ OPTIONS \ **-u**\ - To specify the next boot mode to be "UEFI Mode". + To specify the next boot mode to be "UEFI Mode". (Not supported for OpenBMC) diff --git a/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst b/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst index ebd4923f4..ab6875b30 100644 --- a/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst @@ -47,7 +47,9 @@ OpenBMC specific: ================= -\ **rspconfig**\ \ *noderange*\ {\ **ipsrc | ip | netmask | gateway | hostname | vlan | sshcfg**\ } +\ **rspconfig**\ \ *noderange*\ {\ **ipsrc | ip | netmask | gateway | vlan**\ } + +\ **rspconfig**\ \ *noderange*\ \ **admin_passwd**\ ={\ *currentpasswd,newpasswd*\ } \ **rspconfig**\ \ *noderange*\ \ **autoreboot**\ @@ -59,6 +61,18 @@ OpenBMC specific: \ **rspconfig**\ \ *noderange*\ \ **dump**\ [\ **-l | -**\ **-list**\ ] [\ **-g | -**\ **-generate**\ ] [\ **-c | -**\ **-clear**\ {\ *id*\ | \ **all**\ }] [\ **-d | -**\ **-download**\ {\ *id*\ | \ **all**\ }] +\ **rspconfig**\ \ *noderange*\ \ **gard -c|-**\ **-clear**\ + +\ **rspconfig**\ \ *noderange*\ \ **ip=dhcp**\ + +\ **rspconfig**\ \ *noderange*\ \ **hostname**\ + +\ **rspconfig**\ \ *noderange*\ \ **hostname**\ ={\* | \ *name*\ } + +\ **rspconfig**\ \ *noderange*\ \ **ntpservers**\ + +\ **rspconfig**\ \ *noderange*\ \ **ntpservers**\ ={\ *ntpservers*\ } + \ **rspconfig**\ \ *noderange*\ \ **powerrestorepolicy**\ \ **rspconfig**\ \ *noderange*\ \ **powerrestorepolicy={always_on|restore|always_off}**\ @@ -67,6 +81,8 @@ OpenBMC specific: \ **rspconfig**\ \ *noderange*\ \ **powersupplyredundancy={disabled|enabled}**\ +\ **rspconfig**\ \ *noderange*\ \ **sshcfg**\ + \ **rspconfig**\ \ *noderange*\ \ **timesyncmethod**\ \ **rspconfig**\ \ *noderange*\ \ **timesyncmethod={manual|ntp}**\ @@ -135,9 +151,9 @@ FSP/CEC specific: \ **rspconfig**\ \ *noderange*\ \ **admin_passwd**\ ={\ *currentpasswd,newpasswd*\ } -\ **rspconfig**\ \ *noderange*\ \ **general_passwd**\ ={\ **currentpasswd,newpasswd**\ } +\ **rspconfig**\ \ *noderange*\ \ **general_passwd**\ ={\ *currentpasswd,newpasswd*\ } -\ **rspconfig**\ \ *noderange*\ \*\ **_passwd**\ ={\ **currentpasswd,newpasswd**\ } +\ **rspconfig**\ \ *noderange*\ \*\ **_passwd**\ ={\ *currentpasswd,newpasswd*\ } \ **rspconfig**\ \ *noderange*\ {\ *hostname*\ } @@ -198,9 +214,9 @@ FSP/CEC (using Direct FSP Management) Specific: \ **rspconfig**\ \ *noderange*\ \ **admin_passwd**\ ={\ *currentpasswd,newpasswd*\ } -\ **rspconfig**\ \ *noderange*\ \ **general_passwd**\ ={\ **currentpasswd,newpasswd**\ } +\ **rspconfig**\ \ *noderange*\ \ **general_passwd**\ ={\ *currentpasswd,newpasswd*\ } -\ **rspconfig**\ \ *noderange*\ \*\ **_passwd**\ ={\ **currentpasswd,newpasswd**\ } +\ **rspconfig**\ \ *noderange*\ \*\ **_passwd**\ ={\ *currentpasswd,newpasswd*\ } \ **rspconfig**\ \ *noderange*\ {\ **sysname**\ } @@ -237,9 +253,9 @@ BPA/Frame (using Direct FSP Management) Specific: \ **rspconfig**\ \ *noderange*\ \ **admin_passwd**\ ={\ *currentpasswd,newpasswd*\ } -\ **rspconfig**\ \ *noderange*\ \ **general_passwd**\ ={\ **currentpasswd,newpasswd**\ } +\ **rspconfig**\ \ *noderange*\ \ **general_passwd**\ ={\ *currentpasswd,newpasswd*\ } -\ **rspconfig**\ \ *noderange*\ \*\ **_passwd**\ ={\ **currentpasswd,newpasswd**\ } +\ **rspconfig**\ \ *noderange*\ \*\ **_passwd**\ ={\ *currentpasswd,newpasswd*\ } \ **rspconfig**\ \ *noderange*\ {\ **frame**\ } @@ -362,6 +378,12 @@ OPTIONS +\ **gard -c|-**\ **-clear**\ + + Clear gard file. [OpenBMC] + + + \ **garp**\ =\ *time*\ Get or set Gratuitous ARP generation interval. The unit is number of 1/2 second. @@ -552,6 +574,12 @@ OPTIONS +\ **ntpservers**\ + + Get or set NTP servers name. [OpenBMC] + + + \ **pd1**\ ={\ **nonred | redwoperf | redwperf**\ } Power Domain 1 - determines how an MPA responds to a loss of redundant power. diff --git a/perl-xCAT/xCAT/Usage.pm b/perl-xCAT/xCAT/Usage.pm index 140258560..a5394e099 100755 --- a/perl-xCAT/xCAT/Usage.pm +++ b/perl-xCAT/xCAT/Usage.pm @@ -72,9 +72,22 @@ my %usage = ( rpower noderange [off|on|stat|status|reset] rpower noderange [pduoff|pduon|pdustat|pdustatus|pdureset] ", - "rbeacon" => - "Usage: rbeacon [on|off|stat] [-V|--verbose] - rbeacon [-h|--help|-v|--version]", + "rbeacon" =>"", + "rbeacon.common" => + "Usage: + Common: + rbeacon [-h|--help|-v|--version] + ", + "rbeacon.begin" => + "BMC specific: + rbeacon [on|blink|off|stat] + OpenPOWER (IPMI) specific: + rbeacon [on|blink|off|stat] + ", + "rbeacon.openbmc" => + "OpenPOWER (OpenBMC) specific: + rbeacon [on|off] + ", "rvitals" => "", "rvitals.common" => "Usage: @@ -165,8 +178,13 @@ my %usage = ( ", "rspconfig.openbmc" => "OpenBMC specific: - rspconfig [ipsrc|ip|netmask|gateway|hostname|vlan] + rspconfig [ipsrc|ip|netmask|gateway|vlan] + rspconfig admin_passwd= rspconfig dump [-l|--list] [-g|--generate] [-c|--clear {|all}] [-d|--download {|all}] + rspconfig gard -c|--clear + rspconfig [hostname|ntpservers] + rspconfig [hostname=<*|hostname>|ntpservers=] + rspconfig sshcfg ", "rspconfig.begin" => "BMC/MPA Common: @@ -594,6 +612,13 @@ $usage{"rinv"} = $usage{"rinv.common"} . $usage{"rinv.openbmc"} = $usage{"rinv.common"} . $usage{"rinv.openbmc"}; +$usage{"rbeacon"} = $usage{"rbeacon.common"} . + $usage{"rbeacon.begin"} . + $usage{"rbeacon.openbmc"}; + +$usage{"rbeacon.openbmc"} = $usage{"rbeacon.common"} . + $usage{"rbeacon.openbmc"}; + $usage{"rvitals"} = $usage{"rvitals.common"} . $usage{"rvitals.begin"} . $usage{"rvitals.openbmc"} . diff --git a/xCAT-client/pods/man1/rbeacon.1.pod b/xCAT-client/pods/man1/rbeacon.1.pod index 7f2de147d..32725cd7b 100644 --- a/xCAT-client/pods/man1/rbeacon.1.pod +++ b/xCAT-client/pods/man1/rbeacon.1.pod @@ -5,11 +5,19 @@ B - Turns beacon on/off/blink or gives status of a node or noderange. =head1 SYNOPSIS +B [B<-h>|B<--help>|B<-v>|B<--version>] + +=head2 BMC (using IPMI): + B I {B|B|B|B} -B [B<-h>|B<--help>] +=head2 OpenPOWER BMC (using IPMI): -B {B<-v>|B<--version>} +B I {B|B|B|B} + +=head2 OpenPOWER OpenBMC: + +B I {B|B} =head1 DESCRIPTION diff --git a/xCAT-client/pods/man1/rsetboot.1.pod b/xCAT-client/pods/man1/rsetboot.1.pod index 75a2e9ef7..8a94b5f90 100644 --- a/xCAT-client/pods/man1/rsetboot.1.pod +++ b/xCAT-client/pods/man1/rsetboot.1.pod @@ -40,7 +40,7 @@ Display the current boot setting. =item B<-u> -To specify the next boot mode to be "UEFI Mode". +To specify the next boot mode to be "UEFI Mode". (Not supported for OpenBMC) =item B<-p> diff --git a/xCAT-client/pods/man1/rspconfig.1.pod b/xCAT-client/pods/man1/rspconfig.1.pod index ee0dc98f4..e9d21e60d 100644 --- a/xCAT-client/pods/man1/rspconfig.1.pod +++ b/xCAT-client/pods/man1/rspconfig.1.pod @@ -24,7 +24,9 @@ B I B=I