fwupdate Command-Line Interface - CLI Tools User's Guide for SPARC Servers

`fwupdate` Command-Line Interface

Command-line mode is designed to update a single component with a user-specified firmware file.

The following restrictions apply when using the fwupdate command:

You must be in root permission level to run fwupdate commands on Unix-based platforms, or administrator permission level for Windows platforms.
Only one device type can be upgraded per command-line execution.
Only one file type and file may be specified by the command line.
Components with multiple and different firmware files require a separate command-line execution to be upgraded.

Note - For Solaris, after hot-plugging any device, run the devfsadm -C command to reenumerate all of the system device nodes before running the fwupdate command.

When a command fails, it returns one of several failure codes listed in fwupdate Error Codes.

Note - Default (noarg) behavior of the tool lists the help options. Incomplete command-line arguments result in an error, and context-sensitive help is displayed.

The following table shows the options that apply to all CLI tools commands including fwupdate.

Short Option	Long Option	Description
`-?`	`--help`	Displays help information.
`-v`	`--version`	Displays the tool version.
`-q`	`--quiet`	Suppresses informational message output and returns only error codes.

The tool uses the following syntax:

fwupdate subcommand device_type option

where subcommand is one of the options shown in the following table.

Subcommand	Description
`list`	Listing mode displays system data and helps select components for upgrade.
`update`	Update mode allows updating a single component based on command-line directives.
`reset`	Reset mode allows resetting of individual components.

The preceding subcommands have the options shown in the following table.

Subcommand	Description
`--?`	The help option provides context sensitive help for that subcommand. After every command or subcommand, can you type `--?` or `--help` to discover the additional available subcommands or options.
`--q`	The quiet option outputs the mode with no prompting or `stdout` reporting. All output goes to a log file.
`--v`	The version option prints version information of the tool.