Supermicro Update Manager (for UEFI BIOS) 1.1.0-p4 (2021/08/12) (UEFI)

Introduction
  The Supermicro Update Manager (SUM) UEFI can be used to manage the system BIOS,
  BMC and CPLD firmware image update for X12/H12 and later platforms except H12 non-RoT
  systems under EFI shell.

The package includes:
  - SUM.efi
  - README.txt
  
==============================================================================================================================

SYNOPSIS
  SUM.efi [OPTIONs] [COMMAND] [COMMAND ARGUMENTS]

Help Message
  SUM.efi (Shows help information)
  SUM.efi -h/H (Shows help information)
  SUM.efi -h/H -c <Command name> (Shows help information for each command)

OPTIONs
  -I        Redfish_HI
  -u        <BMC user ID>
  -p        <BMC user password>
  -c        <Command name>

COMMANDS
  UpdateBios, GetBiosInfo, BiosRotManage, UpdateBmc, GetBmcInfo, BmcRotManage, RawCommand, UpdateCpld, GetCpldInfo
            
COMMAND ARGUMENTS
  Required and optional arguments of each commands. 
  For detail information of each command, please refer to section below.

==============================================================================================================================
UpdateBios command:

Description
  Updates BIOS.

Example
  FS0:\> SUM.efi -I Redfish_HI -u ADMIN -p ADMIN -c UpdateBios --file BIOS.rom --reboot [Optional Arguments]

Required Arguments
  --file        BIOS image file

Optional Arguments
  --reboot               Forces the managed system to reboot or power up after operation
  --flash_smbios         Overwrites the SMBIOS data
  --preserve_nv          Preserves the NVRAM region
  --preserve_mer         Preserves the ME firmware region
  --backup               Backups current running BIOS image. (Only support for RoT systems)
  --forward              Confirms the Rollback ID forward

Node Product Key Required
  No

Note: flash_smbios and preserve_nv optional arguments cannot be used at the same time.

==============================================================================================================================

UpdateBmc command:

Description
  Updates BMC.

Example
  SUM.efi -I Redfish_HI -u ADMIN -p ADMIN -c UpdateBmc --file BMC.rom [Optional Arguments]

Required Arguments
  --file    BMC image file

Optional Arguments
  --overwrite_cfg        Overwrites the current BMC configuration using the factory default values in the given BMC image file
  --overwrite_sdr        Overwrites current BMC SDR data
  --overwrite_ssl        Overwrites current BMC SSL configuration.
  --backup               Backups current running BMC image. (Only support for RoT systems)
  --forward              Confirms the Rollback ID forward

Node Product Key Required
  No

==============================================================================================================================

GetBiosInfo command:

Description
  Gets system BIOS information of the managed system.

Example
  SUM.efi -I Redfish_HI -u ADMIN -p ADMIN -c GetBiosInfo
  SUM.efi -I Redfish_HI -u ADMIN -p ADMIN -c GetBiosInfo --file BIOS.rom
  SUM.efi -c GetBiosInfo --file BIOS.rom --file_only
Required Arguments
  N/A

Optional Arguments
  --file             Reads BIOS information from an input BIOS image file
  --file_only        Works with --file, and only reads BIOS information from the input image file

Node Product Key Required
  No

==============================================================================================================================

GetBmcInfo command:

Description
  Gets system BMC information of the managed system.

Example
  SUM.efi -I Redfish_HI -u ADMIN -p ADMIN -c GetBmcInfo 
  SUM.efi -I Redfish_HI -u ADMIN -p ADMIN -c GetBmcInfo --file BMC.rom
  SUM.efi -c GetBmcInfo --file BMC.rom --file_only

Required Arguments
  N/A

Optional Arguments
  --file             Reads BMC information from an input BMC image file
  --file_only        Works with --file, and only reads BMC information from the input image file

Node Product Key Required
  No

==============================================================================================================================

BiosRotManage command:

Description
  Execute Rot relate actions.

Example
  SUM.efi -I Redfish_HI -u ADMIN -p ADMIN -c BiosRotManage --action UpdateGolden

Required Arguments
  --action
      Sets action to:
	    1 = GetInfo
	    2 = UpdateGolden
	    3 = Recover

Optional Arguments
  --reboot
      Works with --action UpdateGolden and Recover. Forces the managed
      system to reboot or power up after operation.  

Node Product Key Required
  No
  SFT-DCMS-SINGLE for action recover
  
Note: UpdateGolden action will overwrite golden image with current BIOS firmware.

==============================================================================================================================

BmcRotManage command:

Description
  Execute Rot related actions.

Example
  SUM.efi -I Redfish_HI -u ADMIN -p ADMIN -c BmcRotManage --action UpdateGolden

Required Arguments
  --action
      Sets action to:
	    1 = GetInfo
	    2 = UpdateGolden
	    3 = Recover

Optional Arguments
  N/A

Node Product Key Required
  No
  SFT-DCMS-SINGLE for action recover
  
Note: UpdateGolden action will overwrite golden image with current BMC firmware.

==============================================================================================================================

RawCommand command:

Description
  Send IPMI raw command.

Example
  SUM.efi -c RawCommand --raw "06 01"

Required Arguments
  --raw    <raw command>
     Input hex-value commands.      

Optional Arguments
  N/A

Node Product Key Required
  No
    
Note: Raw command has to be quoted.

==============================================================================================================================

UpdateCpld command:

Description
  Updates CPLD.

Example
  SUM.efi -I Redfish_HI -u ADMIN -p ADMIN -c UpdateCpld --file CPLD.bin --reboot

Required Arguments
  --file             Updates the CPLD with the given CPLD image file.
  --reboot           Forces the managed system to reboot or power up after operation.

Optional Arguments
  N/A

Node Product Key Required
  No
  
Note: System needs to be powered off while updating CPLD FW.

==============================================================================================================================

GetCpldInfo command:

Description
  Gets the CPLD information of the managed system/input CPLD image file

Example
  SUM.efi -I Redfish_HI -u ADMIN -p ADMIN -c GetCpldInfo
  SUM.efi -I Redfish_HI -u ADMIN -p ADMIN -c GetCpldInfo --file CPLD.bin
  SUM.efi -c GetCpldInfo --file CPLD.bin --file_only

Required Arguments
  N/A

Optional Arguments
  --file             Reads the CPLD information from an input CPLD image file.
  --file_only        Works with --file, and only reads CPLD information from the input image file.

Node Product Key Required
  No
  
==============================================================================================================================