From 34f03cb217dca8be9ed6f1afec30ffa73470ff6f Mon Sep 17 00:00:00 2001 From: Jarrod Johnson Date: Wed, 14 Feb 2018 14:56:45 -0500 Subject: [PATCH] Update nodefirmware man page --- confluent_client/doc/man/nodefirmware.ronn | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/confluent_client/doc/man/nodefirmware.ronn b/confluent_client/doc/man/nodefirmware.ronn index 7f24ecfe..2e6f5df6 100644 --- a/confluent_client/doc/man/nodefirmware.ronn +++ b/confluent_client/doc/man/nodefirmware.ronn @@ -4,12 +4,19 @@ nodefirmware(8) -- Report firmware information on confluent nodes ## SYNOPSIS `nodefirmware ` -`nodefirmware update [--backup] ` +`nodefirmware |core` +`nodefirmware update [--backup] ` ## DESCRIPTION -`nodefirmware` reports and updates various firmware on nodes. In the update form, it accepts a single -file and attempts to update it using the out of band facilities. Firmware updates can end in one of three states: +`nodefirmware` reports and updates various firmware on nodes. By default it +will retrieve all firmware, but can be directed to fetch specific firmware by +calling out the name of the firmware (e.g. uefi or xcc) or request reading only +core firmware firmware by using the word 'core', which is generally a quicker +operation. + +In the update form, it accepts a single file and attempts to update it using +the out of band facilities. Firmware updates can end in one of three states: * `error`: The attempted update encountered an error that prevented successful install. Nodes experiencing this state will be reported at the end and more detail on the error will be given * `pending`: The firmware update process has completed, but the firmware will not be active until the relevant component next resets. Generally speaking, for UEFI update the system will need a reboot, and for BMC updates, the `nodebmcreset` command will begin the process to activate the firmware.