Man page - nvfwupd_manpage(1)

Packages contains this manual

Package: nvfwupd
apt-get install nvfwupd

Manuals in package:

nvfwupd_manpage(1)

Documentations in package:

nvfwupd

Manual

nvfwupd

NAME
SYNOPSIS
DESCRIPTION
GLOBAL OPTIONS
COMMAND
AUTHOR
COPYRIGHT

NAME

nvfwupd - Out-of-Band Tool to update NVIDIA DGX, HGX, MGX platforms.

SYNOPSIS

nvfwupd [global options] [command]

DESCRIPTION

nvfwupd This tool performs out-of-band firmware update of the entire DGX, HGX, MGX platforms, and NVSwitch Trays. It can also update an individual component of these platforms.

GLOBAL OPTIONS

-t/--target < sub-options >

Specify target Platform’s BMC IP address or NVSwitch Tray’s IP address and login credentials.
SUB-OPTIONS

<key=value> pairs of input parameters that describe the target machine.
ip

IP address/FQDN of target BMC or NVSwitch Tray.

user

Username to login to the target BMC or NVSwitch Tray.

password

Password to login to the target BMC or NVSwitch Tray.

port

TCP port with port-forwarding to use to connect with BMC service (optional)

servertype

Users can provide the servertype value from the [DGX | HGX | MGX | GH200 | NVOS | HGXB100 | HGXB300 | GB200 | GB300 | MGX-NVL | GB200Switch | GB300Switch] options based on the type of the target system type. This is optional and is recommended only if you experience unknown platform errors.

-c/--config < config YAML path >

A YAML config file can be used to define the behaviour of few commands. This option takes the path of such YAML config file (optional).

-v/--verbose < logfile path >

Increase verbosity. Provide chosen path for logfile (optional). Default path is current working directory.

COMMAND

show_version <command options>

Show AP components that can be updated out-of-band along with current running firmware versions. If -p option is specified, then show firmware version of these AP components from the firmware package, and if the given AP component is up-to-date or needs updating. Global option -t/--target required.

COMMAND OPTIONS

-p/--package

PLDM firmware package or firmware tar file. (optional)

-j/--json

Display package comparison in JSON format. (optional)

-s/--staged

Display staged firmware versions. (optional)

update_fw <command options>

Perform firmware update of the entire server out-of-band using either PLDM package or the tarball. If -s option is specified, firmware update only the AP component(s) mentioned in the JSON file. Global option -t/--target required.

COMMAND OPTIONS

-p/--package

PLDM firmware package or firmware tar file (mandatory).

-b/--background

Perform firmware update asynchronously in the background.

-s/--special

Special Update json file.

-t/--timeout

Redfish API request timeout value in seconds.

-y/--yes

Show update progress in table format.

-d/--details

Bypass firmware update confirmation prompt.

-j/--json

Show output in JSON. Must be paired with the -b background option, and always bypasses update confirmation prompt.

-u/--staged_update

Run a SPI staged update for components that support it. (optional)

-a/--staged_activate_update

Run a SPI staged and activate update for components that support it. (optional)

activate_fw <command options>

Perform firmware activation using IPMI commands . Global option -t/--target required.

COMMAND OPTIONS

-c/--cmd

Activation command to run. Supported values [’PWR_STATUS’, ’PWR_OFF’, ’PWR_ON’, ’PWR_CYCLE’, ’RESET_COLD’, ’RESET_WARM’, ’NVUE_PWR_CYCLE’, ’RF_AUX_PWR_CYCLE’, ’RF_PWR_ON’, ’RF_PWR_OFF’, ’RF_PWR_CYCLE’] (mandatory).

background_copy <command options>

Initiate background copy of the component identified in JSON file given with -s. Global option -t/--target required.

COMMAND OPTIONS

-s/--special

JSON file used to select the background copy target component. (mandatory)

force_update <option_value> <command options>

Command to check/enable/disable the force update flag on target system. Used for downgrades. Global option -t/--target required.

OPTION VALUE

enable

Enable force update on target.

disable

disable force update on target.

status

Show status of force update on target.

COMMAND OPTIONS

-j/--json

show output in JSON

show_update_progress <command options>

Show current status of an update task running on target. Global option -t/--target required.

COMMAND OPTIONS

-i/--id

Task ID of the update task to monitor.

-j/--json

show output in JSON

make_upd_targets <command options>

Create all update parameter JSON files for given target. Global option -t/--target required.

COMMAND OPTIONS

-o/--outdir

Path for output directory to store the JSON files (optional). Default loaction is current working directory. If given directory path does not exist, the tool will try to create it.

perform_factory_reset

Perform factory reset on target system. This is not supported on the NVSwitch trays. Global option -t/--target required.

install_license

Perform license installation on target system. This is only supported on the NVSwitch trays. Global option -t/--target required.

show_pkg_content <command options>

Show PLDM metadata for all firmware devices in a fwpkg file. -p/--package is mandatory. Global options not required.

COMMAND OPTIONS

-p/--package

PLDM firmware package file. Not supported with tar files.

unpack <command options>

Unpack all firmware images from a PLDM package and show associated metadata for all firmware devices. -p/--package is mandatory. Global options not required.

COMMAND OPTIONS

-p/--package

PLDM firmware package file. Not supported with tar files.

-o/--outdir

Path for output directory to store the unpacked firmware files (optional). Default loaction of unpacked files is current working directory. If given directory path does not exist, the tool will try to create it.

AUTHOR

NVIDIA Corporation