xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-22 03:32:04 +00:00
Code Issues Releases Wiki Activity

Merge pull request #4598 from whowutwut/rvitals_man

Browse Source 
Add man page and usage help for 'leds' option for OpenBMC
This commit is contained in:
Mark Gurevich 2018-01-04 15:34:34 -05:00 committed by GitHub
commit 2526e0f15f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 17 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/source/guides/admin-guides/references/man1/rflash.1.rst
View File

@ -150,31 +150,19 @@ The command will update firmware for OpenPOWER BMC when given an OpenPOWER node
\ **-l|-**\ **-list**\ :
The list option will list out available firmware on the BMC. It provides an interface to display the ID of the various firmware levels.
.. code-block:: perl
The list option will list out available firmware on the BMC. It provides an interface to display the ID of the various firmware levels.
The (*) symbol indicates the active running firmware on the server.
The (+) symbol indicates the firmware that is pending and a reboot is required to set it to be the active running firmware level.
The (\*) symbol indicates the active running firmware on the server.
The (+) symbol indicates the firmware that is pending and a reboot is required to set it to be the active running firmware level.
\ **-u|-**\ **-upload**\ :
.. code-block:: perl
The upload option expects a .tar file as the input and will upload the file to the BMC. Use the list option to view the result.
The upload option expects a .tar file as the input and will upload the file to the BMC. Use the list option to view the result.
\ **-a|-**\ **-activate**\ :
.. code-block:: perl
The activate option expects either a .tar file or an ID as the input. If a .tar file is provided, it will upload and activate the firmware in a single step
The activate option expects either a .tar file or an ID as the input. If a .tar file is provided, it will upload and activate the firmware in a single step
To apply the firmware level, a reboot is required to BMC and HOST.
@ -182,37 +170,14 @@ To apply the firmware level, a reboot is required to BMC and HOST.
\ **-d**\ :
.. code-block:: perl
This option steamlines the update, activate, reboot BMC and reboot HOST procedure. It expects a directory containing both BMC and PNOR .tar files. When BMC and PNOR tar files are provided, the command will upload and activate firmware. After BMC becomes activate, it will reboot BMC. If BMC state is Ready, the command will reboot the HOST. If BMC state is NotReady, the command will exit.
This option steamlines the update, activate, reboot BMC and reboot HOST procedure. It expects a directory containing both BMC and PNOR .tar files. When BMC and PNOR tar files are provided, the command will upload and activate firmware. After BMC becomes activate, it will reboot BMC. If BMC state is Ready, the command will reboot the HOST. If BMC state is NotReady, the command will exit.
\ **Note:**\ When using \ **-**\ **-no-host-reboot**\ , it will not reboot the host after BMC is reboot.
\ **-**\ **-delete**\ :
This delete option will delete update image from BMC. It expects an ID as the input.
.. code-block:: perl
This delete option will delete update image from BMC. It expects an ID as the input.
\ **-d**\ :
.. code-block:: perl
This option steamlines the update, activate, reboot BMC and reboot HOST procedure. It expects a directory containing both BMC and PNOR .tar files. When BMC and PNOR tar files are provided, the command will upload and activate firmware. After BMC becomes activate, it will reboot BMC. If BMC state is Ready, the command will reboot the HOST. If BMC state is NotReady, the command will exit.
\ **Note:**\ When using \ **--no-host-reboot**\, it will not reboot the host after BMC is reboot.
\ **-**\ **-delete**\ :
.. code-block:: perl
The delete option will delete update image from BMC. It expects an ID as the input.
***************

2
docs/source/guides/admin-guides/references/man1/rvitals.1.rst
View File

@ -67,7 +67,7 @@ OpenPOWER (OpenBMC) specific:
=============================
\ **rvitals**\ \ *noderange*\ [\ **temp | voltage | wattage | fanspeed | power | altitude | all**\ ]
\ **rvitals**\ \ *noderange*\ [\ **temp | voltage | wattage | fanspeed | power | leds | altitude | all**\ ]

2
perl-xCAT/xCAT/Usage.pm
View File

@ -83,7 +83,7 @@ my %usage = (
OpenPOWER (IPMI) specific:
rvitals noderange [temp|voltage|wattage|fanspeed|power|leds|chassis|all]
OpenPOWER (OpenBMC) specific:
rvitals noderange [temp|voltage|wattage|fanspeed|power|altitude|all]
rvitals noderange [temp|voltage|wattage|fanspeed|power|leds|altitude|all]
MIC specific:
rvitals noderange {thermal|all}
pdu specific:

14
xCAT-client/pods/man1/rflash.1.pod
View File

@ -103,19 +103,19 @@ The command will update firmware for OpenPOWER BMC when given an OpenPOWER node
B<-l|--list>:
The list option will list out available firmware on the BMC. It provides an interface to display the ID of the various firmware levels.
The list option will list out available firmware on the BMC. It provides an interface to display the ID of the various firmware levels.
The (*) symbol indicates the active running firmware on the server.
The (*) symbol indicates the active running firmware on the server.
The (+) symbol indicates the firmware that is pending and a reboot is required to set it to be the active running firmware level.
The (+) symbol indicates the firmware that is pending and a reboot is required to set it to be the active running firmware level.
B<-u|--upload>:
The upload option expects a .tar file as the input and will upload the file to the BMC. Use the list option to view the result.
The upload option expects a .tar file as the input and will upload the file to the BMC. Use the list option to view the result.
B<-a|--activate>:
The activate option expects either a .tar file or an ID as the input. If a .tar file is provided, it will upload and activate the firmware in a single step
The activate option expects either a .tar file or an ID as the input. If a .tar file is provided, it will upload and activate the firmware in a single step
To apply the firmware level, a reboot is required to BMC and HOST.
@ -123,13 +123,13 @@ B<Note:> When using B<rflash> in hierarchical environment, the .tar file must be
B<-d>:
This option steamlines the update, activate, reboot BMC and reboot HOST procedure. It expects a directory containing both BMC and PNOR .tar files. When BMC and PNOR tar files are provided, the command will upload and activate firmware. After BMC becomes activate, it will reboot BMC. If BMC state is Ready, the command will reboot the HOST. If BMC state is NotReady, the command will exit.
This option steamlines the update, activate, reboot BMC and reboot HOST procedure. It expects a directory containing both BMC and PNOR .tar files. When BMC and PNOR tar files are provided, the command will upload and activate firmware. After BMC becomes activate, it will reboot BMC. If BMC state is Ready, the command will reboot the HOST. If BMC state is NotReady, the command will exit.
B<Note:> When using B<--no-host-reboot>, it will not reboot the host after BMC is reboot.
B<--delete>:
This delete option will delete update image from BMC. It expects an ID as the input.
This delete option will delete update image from BMC. It expects an ID as the input.
=head1 B<Options>

2
xCAT-client/pods/man1/rvitals.1.pod
View File

@ -32,7 +32,7 @@ B<rvitals> I<noderange> [B<temp>|B<voltage>|B<wattage>|B<fanspeed>|B<power>|B<le
=head2 OpenPOWER (OpenBMC) specific:
B<rvitals> I<noderange> [B<temp>|B<voltage>|B<wattage>|B<fanspeed>|B<power>|B<altitude>|B<all>]
B<rvitals> I<noderange> [B<temp>|B<voltage>|B<wattage>|B<fanspeed>|B<power>|B<leds>|B<altitude>|B<all>]
=head1 B<Description>