| Current File : //usr/man/man1m/fwupdate.1m |
'\" te
.\" Copyright (c) 2009, 2016, Oracle and/or its affiliates. All rights reserved.
.TH fwupdate 1M "June 23, 2016" "" "System Administration Commands"
.sp
.SH NAME
fwupdate \- A firmware update utility for Oracle devices\&.
.sp
.SH SYNOPSIS
.LP
.nf
\fBfwupdate <subcommand> <target> [options]\fR
.fi
.sp
.SH DESCRIPTION
.sp
A command line utility to update the firmware of devices in Oracle x86 or SPARC servers\&. You can also use \fBfwupdate\fR to check to ensure that system firmware, including Oracle ILOM, are at the minimum required version specified by Oracle\&. When updating component firmware, refer to the user manual for the component for special instructions or handling requirements\&.
.sp
When doing a firmware update the preferred mode is with the use of firmware metadata\&. This metadata is an XML file that is downloaded with the firmware patch from My Oracle Support (MOS)\&. This metadata automates the firmware update process and it should be used unmodified as it contains no customer configurable elements\&. The Oracle Hardware Management Pack documentation refers to this mode as automatic mode\&.
.sp
Accessing the service processor remotely over the network requires that you provide credentials manually\&.
.sp
This utility interacts directly with physical hardware and can not run in a virtual environment\&.
.sp
A complete list of currently supported Oracle servers is available at:
.sp
http://www.oracle.com/goto/ohmp
.sp
.SH SUB-COMMANDS
.sp
The following subcommands are supported by \fBfwupdate\fR\&.
.sp
For help on a specific subcommand, type: fwupdate <subcommand> --help
.sp
.in +2
.nf
Available subcommands:
list Show components available for upgrade\&.
check Check system firmware to see if it is at the
minimum required version\&.
update Update individual component firmware\&.
reset Reset individual component (not all components
are supported)\&.
General Options:
-?, --help Command line help\&.
-H, --remote-hostname=sp_ip Provide IP address or hostname of
remote SP (must be paired with
option -U)\&.
-U, --remote-username=username Provide user name to log into remote
SP (must be paired with option -H)\&.
-V, --version Show the version of the command\&.
-q, --quiet Suppress informational message
output and only return error codes\&.
.fi
.in -2
.sp
Details on each subcommand, including supported targets and options, are listed below\&.
.sp
.ne 2
.mk
.na
\fBlist\fR
.ad
.br
.sp .6
.RS 4n
Show devices available for update\&.
.sp
.in +2
.nf
fwupdate list <target> [options]
<target>
supported-targets List supported target devices\&.
supported-images List supported images\&.
error-codes List possible fwupdate error codes\&.
all All updatable devices\&.
expander Updatable SAS expanders\&.
disk Updatable HDDs and SDDs\&.
bridge Updatable SAS-to-SATA bridge devices\&.
controller Updatable storage and network controllers\&.
sp_bios System firmware including ILOM
(deprecated, replaced by sysfw)\&.
sysfw System firmware including ILOM\&.
.fi
.in -2
.sp
The \fBsupported-targets\fR and \fBsupported-images\fR targets, shown above, are only used to list devices that can be updated using \fBfwupdate\fR\&. The \fBerror-codes\fR target is used to list all the possible \fBfwupdate\fR error codes\&.
.sp
.in +2
.nf
[options]
-v, --verbose Show detailed display, default
is a brief display\&.
-x, --xml=\fIfilename\fR Using the provided XML file,
determine which devices are
supported\&.
-n, --device_name=\fIname\fR Allows a mandatory parameter
to designate a single device
to list\&. The device name is
the common-mapped device
name label\&.
-o, --output_xml=\fIfilename\fR Print configuration
information in XML format
to the given file\&.
.fi
.in -2
.RE
.sp
.ne 2
.mk
.na
\fBcheck\fR
.ad
.br
.sp .6
.RS 4n
Check that system firmware, including Oracle ILOM, meets the minimum requirements\&. Firmware checking not supported for use with systems that have a version of Oracle ILOM older than 3\&.0\&.2\&.
.sp
.in +2
.nf
fwupdate check <target>
<target>
sp_bios System firmware including ILOM
(deprecated, replaced by sysfw)\&.
sysfw System firmware including ILOM\&.
.fi
.in -2
.sp
This command will check the current firmware version against installed metadata\&. If the firmware needs to be updated, an error will display to stdout\&. If not, nothing will be displayed\&.
.RE
.sp
.ne 2
.mk
.na
\fBupdate\fR
.ad
.br
.sp .6
.RS 4n
Update device firmware\&.
.sp
Update the firmware of all devices of the same type\&.
.sp
.in +2
.nf
fwupdate update <target> <tokens> [options]
<target>
.fi
.in -2
.sp
.in +2
.nf
When using an XML metadata file, the following
targets can be specified to update all devices of
the same type:
<target>
all All updatable devices\&.
expander Updatable SAS expanders\&.
disk Updatable HDDs and SDDs\&.
bridge Updatable SAS-to-SATA bridge devices\&.
controller Updatable storage and network controllers\&.
sp_bios System firmware including ILOM
(deprecated, replaced by sysfw)
sysfw System firmware including ILOM\&.
.fi
.in -2
.sp
.in +2
.nf
<tokens>
-x, --xml=\fIfilename\fR Take an XML file as input\&.
-o, --output=\fIfilename\fR Log all actions in an output
file\&.
-n, --device_name Enter the name of the
device that is to be updated\&.
.fi
.in -2
.sp
Note -
.sp
.RS 2
The device name is optional when updating using an XML metadata file\&.
.RE
.sp
.in +2
.nf
[Options]
-d --dry-run Process and check firmware against
selected device, but do not upload\&.
-q, --quiet Suppress all output except for error
codes and do not ask for user input\&.
-p, --priority=\fIvalue\fR Start processing at given
priority level, skipping all
lower levels\&.
--silent-reboot User is not prompted if a reboot is
required to update the firmware, the
reboot will take place automatically\&.
--silent-no-reboot User is not prompted if a reboot
is required to complete the update
and no reboot will take place
(x86 systems only)\&.
.fi
.in -2
.RE
.sp
.ne 2
.mk
.na
\fBreset\fR
.ad
.br
.sp .6
.RS 4n
Reset a device\&. Typically done after an update (not all devices are supported)\&.
.sp
.in +2
.nf
fwupdate reset <target> <tokens> [options]
<target>
expander SAS expanders\&.
controller Storage and network controllers\&.
sp_bios System firmware including ILOM
(deprecated, replaced by sysfw)
sysfw System firmware including ILOM\&.
.fi
.in -2
.sp
Note -
.sp
.RS 2
SPARC systems typically reboot automatically after a system firmware/ILOM update\&.
.RE
.sp
.in +2
.nf
<tokens>
-n, --device_name Enter the name of the device
that is to be reset\&.
.fi
.in -2
.RE
.sp
.SH OPTIONS
.sp
The following are general short and long options are supported with \fBfwupdate\fR:
.sp
.ne 2
.mk
.na
\fB-?, --help\fR
.ad
.br
.sp .6
.RS 4n
Display a brief usage message and then exit\&.
.RE
.sp
.ne 2
.mk
.na
\fB-H, --remote-hostname=\fIsp_ip\fR\fR
.ad
.br
.sp .6
.RS 4n
Provide host name or IP address of remote SP (must be paired with option -U)\&.
.RE
.sp
.ne 2
.mk
.na
\fB-U, --remote-username=\fIusername\fR\fR
.ad
.br
.sp .6
.RS 4n
Provide user name with root privileges to login to remote SP (must be paired with option -H)\&.
.RE
.sp
.ne 2
.mk
.na
\fB-q, --quiet\fR
.ad
.br
.sp .6
.RS 4n
Suppress informational message output and only return error codes\&.
.RE
.sp
.ne 2
.mk
.na
\fB-V, --version\fR
.ad
.br
.sp .6
.RS 4n
Print version information for \fBfwupdate\fR and then exit\&.
.RE
.sp
The following subcommand short and long options are supported\&. Refer to the subcommands section to see which options are supported for each subcommand\&.
.sp
Note -
.sp
.RS 2
The options below reference fwupdate device names\&. These device names look similar to Solaris device paths but they are not the same\&.
.RE
.sp
.ne 2
.mk
.na
\fB-d, --dry-run\fR
.ad
.br
.sp .6
.RS 4n
Used with the \fBupdate\fR subcommand to process and check firmware against selected device, but does not actually update anything\&. Very useful for determining which device would be updated by a given XML metadata file without changing any system firmware\&.
.RE
.sp
.ne 2
.mk
.na
\fB-n, --device_name=\fIname\fR\fR
.ad
.br
.sp .6
.RS 4n
Allows a mandatory parameter to designate a single device\&. The device name is the common-mapped device name label\&. The device name can be found by using the \fBlist\fR subcommand\&. Used with \fBlist\fR, \fBupdate\fR and \fBreset\fR subcommands\&.
.RE
.sp
.ne 2
.mk
.na
\fB-o, --output_xml=\fIfilename\fR\fR
.ad
.br
.sp .6
.RS 4n
When used with the \fBlist\fR subcommand, prints configuration information in XML format to the specified file\&. When used with the \fBupdate\fR subcommand, logs all actions to the specified file\&.
.RE
.sp
.ne 2
.mk
.na
\fB-p, --priority=\fIvalue\fR\fR
.ad
.br
.sp .6
.RS 4n
Used with the \fBupdate\fR subcommand in automatic mode\&. Start processing at given priority level defined in the metadata XML file, skipping all lower levels\&.
.RE
.sp
.ne 2
.mk
.na
\fB-q, --quiet\fR
.ad
.br
.sp .6
.RS 4n
Used with the \fBupdate\fR subcommand to suppress all output, except for error codes, and not to ask for user input\&. Use the \fB-o\fR option to log output to a file to capture all update actions\&.
.RE
.sp
.ne 2
.mk
.na
\fB-v, --verbose\fR
.ad
.br
.sp .6
.RS 4n
Used with the \fBlist\fR subcommand to show a detailed display\&. The default is a brief display\&.
.RE
.sp
.ne 2
.mk
.na
\fB-x, --xml=\fIfilename\fR\fR
.ad
.br
.sp .6
.RS 4n
Used to specify an XML metadata file containing information on platform firmware\&. This file is typically supplied with the firmware when obtained from Oracle\&. Used with \fBlist\fR and \fBupdate\fR subcommands\&.
.RE
.sp
.ne 2
.mk
.na
\fB--silent-reboot\fR
.ad
.br
.sp .6
.RS 4n
Used with the \fBupdate\fR subcommand, the user is not prompted if a reboot is required to complete the firmware update and the reboot will take place automatically\&.
.RE
.sp
.ne 2
.mk
.na
\fB--silent-no-reboot\fR
.ad
.br
.sp .6
.RS 4n
Used with the \fBupdate\fR subcommand, the user is not prompted if a reboot is required to complete the firmware update and no reboot will take place (x86 systems only)\&.
.RE
.sp
.SH EXAMPLES
.LP
\fBExample 1\fR List All Updatable Devices
.sp
Use \fBfwupdate\fR to list all available devices for update\&.
.sp
.in +2
.nf
# \fBfwupdate list all\fR
.fi
.in -2
.sp
If fwupdate cannot list information about a device, it cannot update it\&.
.LP
\fBExample 2\fR List Information For a Disk
.sp
Use \fBfwupdate\fR to list information about the disk labeled c0d1\&.
.sp
.in +2
.nf
# \fBfwupdate list disk -n c0d1\fR
.fi
.in -2
.sp
.LP
\fBExample 3\fR List Information About a Device to an XML File
.sp
Use \fBfwupdate\fR to list all expanders, log configuration to "output", and show which expanders are supported by firmware\&.xml\&.
.sp
.in +2
.nf
# \fBfwupdate list expanders -v -x firmware\&.xml -o output\fR
.fi
.in -2
.sp
By using -x and providing a metadata XML file, the output list will show what devices will be updated for the given patch metadata\&.
.LP
\fBExample 4\fR Check That System Firmware Meets Minimum Requirements
.sp
Use \fBfwupdate\fR to check that system firmware, including Oracle ILOM, meets the minimum requirements\&.
.sp
.in +2
.nf
# \fBfwupdate check sysfw\fR
or
# \fBfwupdate check sp_bios\fR
.fi
.in -2
.sp
If the check fails, you will see output similar to the following:
.sp
.in +2
.nf
# fwupdate check sysfw
ERROR: The installed System Firmware or ILOM version
is not the latest available\&. You must update it to
obtain the latest security and other fixes\&.
.fi
.in -2
.sp
Download and install the latest firmware\&.
.LP
\fBExample 5\fR Perform a Firmware Update
.sp
Using automatic mode, perform a dry run to update all components specified in firmware\&.xml and output all actions to a file named "output"\&.
.sp
.in +2
.nf
# \fBfwupdate update all -x firmware\&.xml -o output --dry-run\fR
.fi
.in -2
.sp
Using automatic mode, perform an update of all disks specified in firmware\&.xml and output all actions to a file named "output"\&.
.sp
.in +2
.nf
# \fBfwupdate update disk -x firmware\&.xml -o output\fR
.fi
.in -2
.sp
.LP
\fBExample 6\fR Reset a Device After a Firmware Update
.sp
Use \fBfwupdate\fR to reset the expander c0x1\&.
.sp
.in +2
.nf
# \fBfwupdate reset expander -n c0x1\fR
.fi
.in -2
.sp
To find the device name to use with \fB-n\fR, run the list subcommand\&.
.sp
.SH ERRORS
.sp
The following are \fBfwupdate\fR error codes:
.sp
.in +2
.nf
Error Code Error Description
---------- ------------------------------------------
0 OK\&. No errors\&.
1 Invalid option\&.
2 Invalid subcommand\&.
3 Subcommand not supported\&.
4 Invalid device format\&.
5 Cannot create XML file\&.
6 Cannot read XML file\&.
7 Cannot retrieve application data\&.
8 Internal error\&.
9 Insufficient memory\&.
10 Invalid boolean argument\&.
11 Option not supported\&.
12 Storage initialization failed\&.
13 Name too long\&.
14 Invalid string after subcommand\&.
15 XML file name required\&.
16 Invalid argument\&.
17 Error writing XML file\&.
18 Device busy\&.
19 CTRL-C pressed\&.
20 Insufficient privileges\&.
21 Missing argument\&.
22 XML not supported\&.
23 Failed to parse XML metadata due to errors\&.
24 XML file not found\&.
25 XML metadata has no records\&.
26 Directory not writable\&.
27 Invalid type\&.
28 XML priority error\&.
29 XML pre req cyclical error\&.
30 IPMI connection timeout\&.
31 Installation error\&.
32 Platform not supported\&.
33 Oracle ILOM not supported\&.
34 Command cannot be run in virtual environment\&.
35 Ulink file failure\&.
40 XML metadata read access error\&.
41 XML metadata version error\&.
42 Firmware is older than minimum required version\&.
43 XML metadata is not complete\&.
44 Firmware-Check component not available\&.
45 Firmware checking is not supported on systems
with ILOM versions older than 3\&.0\&.2\&.
92 Interface already exists\&.
200 Invalid device type\&.
201 Invalid device target type\&.
202 Invalid device ID, run: fwupdate list all
to verify id\&.
203 Reset of component failed\&.
204 Firmware check failed for component\&.
205 Firmware download failed for component\&.
206 Specified component and specified image
type do not match\&.
207 Must specify an image file name when doing
an update\&.
208 Could not read specified image file\&.
209 Reset of this component type is not supported\&.
210 Specified component type does not match
devices type\&.
211 Must specify device to update\&.
212 Update canceled by user\&.
213 Firmware version information not available\&.
Reset necessary to activate new firmware\&.
214 Version verification failed\&.
215 Final version is being reported the same
as the starting version\&. Update may have
succeeded, check update documentation\&.
216 Missing or corrupt firmware file referenced
by firmware metadata file\&.
217 Metadata file invalid or corrupt\&.
218 Metadata error\&. Prerequisite and priority
settings conflict\&.
219 Power control option is not supported for
pre-application\&.
220 Power control option is not supported for
post-application\&.
221 Power Control option is not supported\&.
222 Requested component not available\&.
223 Cannot verify version information, no XML
provided\&.
224 Metadata does not include support for this
host\&.
225 Could not identify host type\&.
226 A valid subcommand required\&.
227 Invalid option entered\&.
228 Must specify device to reset\&.
229 Cannot open file to write XML output\&.
230 Metadata XML file is required\&.
231 Invalid priority level entered\&.
232 Cannot read firmware metadata XML file\&.
233 Missing required argument\&.
.fi
.in -2
.sp
.SH FILES
.sp
.ne 2
.mk
.na
\fB\fB/var/log/ssm/fwupdate\&.log\fR \fR
.ad
.br
.sp .6
.RS 4n
\fBfwupdate\fR specific log file\&.
.RE
.sp
.ne 2
.mk
.na
\fB/usr/lib/ssm/doc/fwupdate\&.xsd\fR
.ad
.br
.sp .6
.RS 4n
\fBfwupdate\fR XML schema definition\&.
.RE
.sp
.SH ATTRIBUTES
.sp
See attributes(5) for descriptions of the following attributes:
.sp
.TS
tab(
) box;
cw(2.75i) |cw(2.75i)
lw(2.75i) |lw(2.75i)
.
ATTRIBUTE TYPE
ATTRIBUTE VALUE
_
Availability
system/management/fwupdate
_
Interface Stability
Committed
.TE
.sp
.SH SEE ALSO
.sp
firmware-check(1m)
.sp
http://www.oracle.com/goto/ohmp/solarisdocs
.sp
Copyright (c) 2009, 2016, Oracle and/or its affiliates\&. All rights reserved\&.