flash command
Use the flash command to deploy updates in sequence, from the list generated by the compare command to the command target. Results of the update flash operation are stored in an XML file. If errors occur during a CMM, SMM or I/O module or core firmware flash update, the flash command retrieves the FFDC logs from BMC, CMM, or SMM.
For In-Band (IB) mode, both firmware and device drivers are supported. An SFTP server is not required to be specified (--sftp parameter) in IB mode.
For Remote Update (including Platform, OOB, BMU) mode:
Scan results include only firmware.
An SFTP server can be specified (--sftp parameter) when in OOB mode. Users can upload the package payload to the SFTP server manually, then specify the package location as part of the --sftp parameter. OneCLI checks the SFTP folder and the local folder, as specified in the compare command results XML file. If both locations contain an update payload, OneCLI checks if they are the same, using the SFTP payload file if they are the same and generating an error and exiting the command if they are not the same. If only the SFTP location has a payload, this payload is used. If only the local location has a payload, it is uploaded to the SFTP server and flashed (the --uselocalimg parameter must be specified).
flash command syntax
Onecli.exe update flash [--esxi <userid:password@host[:port]>] [--comparexml <filename>]
[--nocompare--includeid <ids>] [--includeid <includeids>] [--dir <folder>] [--backup]
[--noreboot] [--output <folder>] [--bmc <userid:password@host[:port]>]
[--remoteos userid:passord@host[:port]>] [--cmm <userid:password@host[:port]>]
[--iobay <bay_number>] [--sftp <userid:password@host [:port]>] [--uselocalimg]
[--ffdc <userid:password@host [:port]>/ffdc/] [<options>] [--psu <arg>][--ftp <arg>] [--tftp <arg>]
| Parameter | Required/Optional | Notes |
|---|---|---|
| --applytime | Optional | Specify the firmware apply time for bundle update. Valid values include:
|
| --backup | Optional | By default, if the --backup parameter is specified, OneCLI flashes the IMM and UEFI backup firmware by running the flash command. The --backup parameter is only used with the --nocompare parameter (in no compare mode). |
| --bmu | Optional | The --bmu parameter is the BMU OOB update parameter, which can only be used when the --bmc and --sftp parameters are specified. |
| --bundle | Optional | Update the firmware with bundled packages. |
| --checkdevice | Optional | Check the driver and firmware information for device, and only keep the packages which has an applicable device. |
| --cleanup | Optional | Clear the staged task if any. |
| --cmm | Optional | Specify the CMM information for scan functions. If the --scanxml parameter or the --noscan parameter is specified, this parameter is not required. |
| --comparexml | Optional | filename specifies an XML file (typically named compare.xml) containing comparison results to control the flash command. All suggested packages listed in the comparison file are flashed. |
| --dir | Optional | Specify the firmware package folder. By default, OneCLI runs the --dir parameter in the default folder. Do not use the --dir parameter if the --comparexml parameter is used. |
| --esxi | Required | Specify the esxi OS information, including OS user name, password, IP address, and port. |
| --ffdc | Optional | userid:password@host[:port] specifies access information for the SFTP server. Both read and write access are required. If the --ffdc parameter is specified and there are update failures, the flash command will try to output the FFDC log file from the BMC or CMM (for I/O module updates only) to the location specified by the current --output parameter. The --ffdc parameter specifies the SFTP server to be used to be a temporary storage location for the FFDC log file. After the log file is downloaded, it is deleted from the SFTP server. If the --ffdc parameter is not used, OneCLI will use the same SFTP location that the --sftp parameter uses to specify the file payload location. |
| --fileserver | Optional | Format: <scheme>://[userid:password@]host[:port][/path].
Note If the options |
| --forceid, -F | Optional | Similar with --includeid. But it can add force tag for these updateids to enforce the downgrade. Besides the specified id, it also supports “all”, which means it can add force tag for all the suggested flash packages. The force tag works on the following cases:
|
| --graceful | Optional | Gracefully power off OS in the platform update process. |
| --includeid, -I | Optional | This parameter should be used with the --nocompare parameter. |
| --iobay | Optional | bay_number specifies the I/O module bay number. Valid values are 1, 2, 3, or 4. The --iobay parameter specifies an I/O module scan operation. When scanning an I/O module target, the --cmm parameter must also be specified. |
| --nocompare | Optional | If this parameter is specified, the flash command will update the firmware and device drivers without performing a comparison. This parameter should be used with the --includeid parameter to specify the flash packages. |
| --noreboot | Optional | By default, BMC will automatically restart and take effect after the update. However, if the --noreboot parameter is specified, the flashed BMC will not restart automatically after the update. To activate the new firmware, users should manually restart the BMC. The --noreboot parameter is only used for flashing the primary IMM. By default, the --noreboot parameter will restart IMM automatically. |
| --noscan | Optional | If the --noscan parameter is specified, OneCLI obtains the query results for comparison by running the compare command without using the scan results. |
| --nostage | Optional | Update the firmware without staging the packages. |
| --platform | Optional | The --platform parameter is used to update the OOB and BMU update packages of the remote server in the platform. It can only be used when the --bmc parameter is specified. |
| --queryxml | Optional | Specify the file containing the query results to control the compare command. |
| --remoteos | Optional | Specify the remote OS login credential for OneCLI to manage system in the local host OS. Support Windows-to-Windows, Linux-to-Linux, and Windows-to-Linux. |
| --scanxml | Optional | Specify the file containing the scan results to control the compare command. |
| --sftp | Optional | Only used for the remote update of the firmware temporary payload file in the server. If the --uselocalimg parameter is specified, OneCLI will copy the firmware temporary payload file from the local folder to the SFTP server. If the SFTP server contains a firmware temporary payload file, this payload file will be overwritten with the local copy. By default, if the --uselocalimg parameter is not specified, OneCLI will check if the firmware temporary payload file is in the SFTP server. If yes, OneCLI will use the file on the SFTP server; if no, OneCLI will detect and upload the local file to the SFTP server. |
| --smm | Required | Specify the access information of the target SMM. The format is: userid:password@host[:port]. Note
|
| --type, -T | Optional | Specify the type of package or component to be downloaded, scanned, compared, or flashed. |
| --uselocalimg | Optional | If the --uselocalimg parameter is specified, OneCLI will copy the firmware temporary payload file from the local folder to the SFTP server. If the SFTP server contains a firmware temporary payload file, this payload file will be overwritten by the local copy. The --uselocalimg parameter is only used when OneCLI runs in the remote update mode. In this case, an SFTP server might be used as a temporary file server for payload files. By default, if the --uselocalimg parameter is not specified, OneCLI will check if the firmware temporary payload file is in the SFTP server. If yes, OneCLI will use the file on the SFTP server; if no, OneCLI will detect and upload the local file to the SFTP server. |
| --psu | Optional | The number of Power Supply Unit (PSU). |
| --tftp | Optional | TFTP server for SMM interface. Format: IP[:port][/path]. |
| Optional | Refer to Table 2. |
Example of the flash command
In this example, we are performing a flash update (update flash command) based on compare results stored in the “.\#VID:#PID\output\Onecli-update-compare.xml” file (--comparexml .\output\Onecli-update-compare.xml argument) for an I/O module in bay 2 (--iobay 2 argument) that is accessed via a CMM with a user ID of “userid”, a password of “password”, an IP address of “host”, and a port number of “5989” (--cmm userid:password@host[:5989] argument), where the update package file is on a temporary SFTP server accessed with a user ID of “user”, a password/authentication string of “password;38:a8:21:16:cb:5d:0c:13:56:7c:2a:b9:f3:62:ed:17”, and an IP address of “host” (--sftp user:password;38:a8:21:16:cb:5d:0c:13:56:7c:2a:b9:f3:62:ed:17@9.125.90.x argument), and storing the log file in the “.\872102cn03e\output\” directory (--output .\872102cn03e\output\ argument).
Onecli.exe update flash --comparexml .\output\Onecli-update-compare.xml
--output .\872102cn03e\output\ --cmm userid:password@host[:5989]
--iobay 2
--sftp user:password;38:a8:21:16:cb:5d:0c:13:56:7c:2a:b9:f3:62:ed:17@9.125.90.x