From 0d870b9225bb7bf3888a567878e463fd86c3cb9b Mon Sep 17 00:00:00 2001 From: bybai Date: Wed, 13 Dec 2017 01:59:23 -0500 Subject: [PATCH 1/2] add -d usage and manpage --- perl-xCAT/xCAT/Usage.pm | 3 ++- xCAT-client/pods/man1/rflash.1.pod | 12 ++++++++++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/perl-xCAT/xCAT/Usage.pm b/perl-xCAT/xCAT/Usage.pm index 67d1bee90..48db09d73 100755 --- a/perl-xCAT/xCAT/Usage.pm +++ b/perl-xCAT/xCAT/Usage.pm @@ -353,7 +353,8 @@ my %usage = ( OpenPOWER OpenBMC specific: rflash {[-c|--check] | [-l|--list]} rflash {[-c|--check] | [-a|--activate] | [-u|--upload]} - rflash {[-a|--activate] | [-d|--delete]}", + rflash [-d] [--no-host-reboot] + rflash {[-a|--activate] | [--delete]}", "mkhwconn" => "Usage: mkhwconn [-h|--help] diff --git a/xCAT-client/pods/man1/rflash.1.pod b/xCAT-client/pods/man1/rflash.1.pod index 62db1eecd..694f25ee9 100644 --- a/xCAT-client/pods/man1/rflash.1.pod +++ b/xCAT-client/pods/man1/rflash.1.pod @@ -34,7 +34,9 @@ B I {[B<-c>|B<--check>] | [B<-l>|B<--list>]} B I I {[B<-c>|B<--check>] | [B<-a>|B<--activate>] | [B<-u>|B<--upload>]} -B I I {[B<-a>|B<--activate>] | [B<-d>|B<--delete>]} +B I I [B<-d>] [B<--no-host-reboot>] + +B I I {[B<-a>|B<--activate>] | [B<--delete>]} =head1 B @@ -119,6 +121,12 @@ To apply the firmware level, a reboot is required to BMC and HOST. B When using B in hierarchical environment, the .tar file must be accessible from Service Nodes. +B<-d>: + + This option steamline the update, activate, reboot BMC and reboot HOST procedure. It expects a directory contains both BMC and PNOR .tar files. When BMC and PNOR tar files are provided, it will upload, activate firmware. When BMC is activate, it will reboot BMC. If BMC state is Ready, it will reboot the HOST. If BMC state is NotReady, the command exit. + +B When using B<--no-host-reboot>, it will not reboot the host after BMC is reboot. + =head1 B =over 7 @@ -179,7 +187,7 @@ List currently uploaded update images. "(*)" indicates currently active image. Upload update image. Specified file must be in .tar format. -=item B<-d|--delete> +=item B<--delete> Delete update image from BMC From edfb89ecb0a1b46f978b2dbcb38dc3231d839be4 Mon Sep 17 00:00:00 2001 From: bybai Date: Wed, 13 Dec 2017 21:54:43 -0500 Subject: [PATCH 2/2] add rflash -d doc --- .../admin-guides/references/man1/rflash.1.rst | 23 ++++++++++++++++--- xCAT-client/pods/man1/rflash.1.pod | 10 +++++--- 2 files changed, 27 insertions(+), 6 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man1/rflash.1.rst b/docs/source/guides/admin-guides/references/man1/rflash.1.rst index 7a6493de9..097c35655 100644 --- a/docs/source/guides/admin-guides/references/man1/rflash.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rflash.1.rst @@ -63,7 +63,9 @@ OpenPOWER OpenBMC specific : \ **rflash**\ \ *noderange*\ \ *tar_file_path*\ {[\ **-c | -**\ **-check**\ ] | [\ **-a | -**\ **-activate**\ ] | [\ **-u | -**\ **-upload**\ ]} -\ **rflash**\ \ *noderange*\ \ *image_id*\ {[\ **-a | -**\ **-activate**\ ] | [\ **-d | -**\ **-delete**\ ]} +\ **rflash**\ \ *noderange*\ \ *tar_file_directory*\ [\ **-d**\] [\ **--no-host-reboot**\] + +\ **rflash**\ \ *noderange*\ \ *image_id*\ {[\ **-a | -**\ **-activate**\ ] | [\ **-**\ **-delete**\ ]} @@ -179,6 +181,21 @@ To apply the firmware level, a reboot is required to BMC and HOST. \ **Note:**\ When using \ **rflash**\ in hierarchical environment, the .tar file must be accessible from Service Nodes. +\ **-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. + *************** \ **Options**\ @@ -264,7 +281,7 @@ To apply the firmware level, a reboot is required to BMC and HOST. -\ **-d|-**\ **-delete**\ +\ **-**\ **-delete**\ Delete update image from BMC @@ -357,7 +374,7 @@ To apply the firmware level, a reboot is required to BMC and HOST. -6. To update the firmware on IBM Power S822LC for Big Data machine specify the node name and the file path of the data directory containing pUpdate utility and BMC and/or PNOR update files: +6. To update the firmware on IBM Power S822LC for Big Data machine specify the node name and the file path of the data directory containing pUpdate utility, both BMC and PNOR update files: .. code-block:: perl diff --git a/xCAT-client/pods/man1/rflash.1.pod b/xCAT-client/pods/man1/rflash.1.pod index 694f25ee9..447bdc332 100644 --- a/xCAT-client/pods/man1/rflash.1.pod +++ b/xCAT-client/pods/man1/rflash.1.pod @@ -123,10 +123,14 @@ B When using B in hierarchical environment, the .tar file must be B<-d>: - This option steamline the update, activate, reboot BMC and reboot HOST procedure. It expects a directory contains both BMC and PNOR .tar files. When BMC and PNOR tar files are provided, it will upload, activate firmware. When BMC is activate, it will reboot BMC. If BMC state is Ready, it will reboot the HOST. If BMC state is NotReady, the command 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 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. + =head1 B =over 7 @@ -241,14 +245,14 @@ Print verbose message to rflash log file (/var/log/xcat/rflash/fs3.log) when upd rflash fs3 /firmware/8335_810.1543.20151021b_update.hpm -V =item 6. -To update the firmware on IBM Power S822LC for Big Data machine specify the node name and the file path of the data directory containing pUpdate utility and BMC and/or PNOR update files: +To update the firmware on IBM Power S822LC for Big Data machine specify the node name and the file path of the data directory containing pUpdate utility, both BMC and PNOR update files: rflash briggs01 -d /root/supermicro/OP825 =item 7. To update the firmware on the OpenBMC machine, specify the firmare update file to upload and activate: - rflash p9euh02 -a /tmp/witherspoon.pnor.squashfs.tar + rflash p9euh02 -a /tmp/witherspoon.pnor.squashfs.tar =back