Supermicro Update Manager

Der Supermicro Update Manager (SUM) ist ein Kommandozeilentool zur Verwaltung des BIOS und des BMC von Supermicro Systemen. Es ermöglicht die Aktualisierung des BIOS und der BMC (IPMI) Firmware, sowie die Konfiguration von BIOS und BMC Einstellungen. SUM kann sowohl lokal am Server (In-Band) als auch remote (Out-Of-Band) verwendet werden. Für die meisten Funktionen ist eine Lizenz (Supermicro Lizenzen SFT-OOB-LIC oder SFT-DCMS-Single) erforderlich.

SUM Download

Der Supermicro Update Manager (sum) ermöglicht via Kommandozeile beispielsweise BIOS-Updates zu automatisieren oder BIOS Einstellungen vorzunehmen.

Download Supermicro Update Manager:

Management Software Downloads - SUM (www.supermicro.com)
SUM User's Guide (www.supermicro.com, PDF)

SUM steht für folgende Betriebssysteme zur Verfügung:

Microsoft Windows
Linux
FreeBSD
UEFI (ausschließlich zur Verwaltung des lokalen Servers)

SUM Funktionen

Key Management


Kommando	Option	Beschreibung	Node Product Key Required
ActivateProductKey	--key <node product key value>	Aktiviert den angeführten Key am System.	No
QueryProductKey	(keine)	Zeigt aktivierte Keys des Systems.	No

System Checks


Kommando	Option	Beschreibung	Node Product Key Required
CheckOOBSupport	(keine)	Überprüft, ob BMC und BIOS Out-Of-Band Funktionen unterstützen.	No
CheckAssetInfo	(keine)	Zeigt Asset Informationen.	Yes
CheckSystemUtilization	(keine)	Zeigt Informationen zur Systemauslastung. Erfordert TAS Thin Agent.	Yes
CheckSensorData	(keine)	Zeigt Sensordaten.	No
ServiceCalls	--file <file name>	Überwacht den Status des Systemereignisprotokolls und der Sensordatenaufzeichnung des verwalteten Systems.	SFT-DCMS-SINGLE and SFT-DCMS-SVC-KEY

BIOS Management


Kommando	Option	Beschreibung	Node Product Key Required
GetBIOSInfo	--file <file name> (Optional)	Liest BIOS Informationen aus der angeführten Datei.	No
	--file_only (Optional)	Liest BIOS Informationen aus der angeführten Datei.
	--showall (Optional)	Zeigt BIOS Version und Revision und BIOS OEM FID Informationen.
UpdateBios	--file <file name>	Aktualisiert das BIOS, nutzt dazu das angeführte BIOS-Image.	Yes for [OOB] on platforms before H12/X12 and H12 non-RoT systems.
	--reboot (Optional)	Veranlasst einen Reboot bzw. startet den Server nachdem das BIOS aktualisiert wurde.
	--flash_smbios (Optional)	Überschreibt SMBIOS Daten. (*)
	--preserve_mer (Optional)	Erhält die ursprüngliche ME Firmware. (*)
	--preserve_nv (Optional)	Erhält den NVRAM. (*)
	--kcs (Optional)	Aktualisiert das BIOS über KCS (in-band).
	--preserve_setting (Optional)	Erhält die BIOS Konfiguration. (*)
	--erase_OA_key	Löscht OA Key (nur via in-band).
	--policy <policy XML file>	Option beim Einsatz von Policy Based Updates.
	--pre_check	Zusatzoption für --policy. Zeigt ausschließlich den Parsing Output und führt keine weiteren Schritte aus.
GetDefaultBiosCfg	--file <file name> (Optional)		Yes
GetDefaultBiosCfg	--overwrite (Optional)		Yes
GetCurrentBiosCfg	--file <file name> (Optional)		Yes
	--overwrite (Optional)
	--tui (Optional)
ChangeBiosCfg	--file <file name>		Yes, SFT-DCMS-SINGLE for some configuration items
	--reboot (Optional)
	--skip_unknown (Optional)
	--skip_bbs (Optional)
LoadDefaultBiosCfg	--reboot (Optional)		Yes
SetBiosAction	--BBS <yes/no>		Yes
SetBiosAction	--reboot (Optional)		Yes
SetBiosPassword	--new_password <new password> (Optional)	Setzt ein neues BIOS Administrator Passwort.	Yes
	--confirm_password <confirm password> (Optional)
	--pw_file <Password File> (Optional)	Liest ein neues BIOS Administrator Passwort aus der angeführten Datei und setzt dieses.
	--reboot (Optional)	Veranlasst einen Reboot bzw. startet den Server nachdem das Passwort gesetzt wurde.
GetDmiInfo	--file <file name> (Optional)	Optionen zum Abfragen bzw. Setzen von DMI Werten.	Yes
GetDmiInfo	--overwrite (Optional)		Yes
ChangeDmiInfo	--file <file name>		Yes
ChangeDmiInfo	--reboot (Optional)		Yes
EditDmiInfo	--file <file name>		Yes
	--item_type <item type>
	--item_name <item name>
	--shn <short name>
	--value <assignment value>
	--default
EraseOAKey (In-band only)	--reboot (Optional)	Erzwingt einen Neustart oder ein Hochfahren des Servers nach dem Ausführen des Kommandos.
BiosRotManage			No, SFT-DCMS-SINGLE for action recover

(*) Diese Optionen werden ausschließlich für spezifische Zwecke verwendet. Verwenden Sie diese Optionen nur dann, wenn Sie mit SMBIOS, ME, NVRAM bzw. BIOS Konfigurationen vertraut sind.

BMC Management


Kommando	Option	Beschreibung	Node Product Key Required
GetBmcInfo	--file <file name> (Optional)	Liest BMC Informationen von der angeführten Image Datei.	No
GetBmcInfo	--file_only (Optional)		No
UpdateBmc	--file <file name>	Aktualisiert die BMC Firmware, verwendet dazu das angeführte Image.	No
	--overwrite_cfg (Optional)	Überschreibt die aktuelle BMC-Konfiguration unter Verwendung der werkseitigen Standardwerte in der angegebenen BMC-Imagedatei.
	--overwrite_sdr (Optional)	Überschreibt die aktuellen SDR (Sensor Data Record) Daten.
GetBmcCfg	--file <file name> (Optional)	Speichert die aktuelle BMC Konfiguration in die angeführte Datei.	Yes
GetBmcCfg	--overwrite (Optional)	Überschreibt die Ausgabedatei, sofern diese bereits vorhanden ist.	Yes
ChangeBmcCfg	--file <file name>	Aktualisiert den BMC mit der angegebenen Konfigurationsdatei.	Yes
SetBmcPassword	--user_id <BMC/CMM user ID>	User ID des Benutzers, dessen Passwort geändert werden soll.	No
	--new_password <new password>	Setzt das neue Passwort.
	--confirm_password <confirms password>	Bestätigt das neue Passwort.
	--pw_file <password file>	Liest das Passwort aus der angeführten Datei.
GetKcsPriv	(keine)		Yes
SetKcsPriv (OOB only)	--priv_level <KCS privilege level>	Setzt den KCS Privilege Level: 1 = Call Back 2 = User 3 = Operator 4 = Administrator	Yes
GetLockdownMode			SFT-DCMS-SINGLE
SetLockdownMode			SFT-DCMS-SINGLE
LoadDefaultBmcCfg			No
BmcRotManage			No, SFT-DCMS-SINGLE for action recover
TimedBmcReset			No

System Event Log


Kommando	Option	Beschreibung	Node Product Key Required
GetEventLog	--file <file name> (Optional)		Yes
GetEventLog	--overwrite	Überschreibt die Ausgabedatei.	Yes
ClearEventLog	--reboot (Optional)	Erzwingt einen Neustart oder ein Hochfahren des Servers nach dem Ausführen des Kommandos.	Yes
GetMaintenEventLog			No
ClearMaintenEventLog			No
GetHostDump			SFT-DCMS-SINGLE

CMM Management

SUM bietet zur Verwaltung der Chassis Management Module von Blade Systemen die folgenden Funktionen:


Kommando	Option	Node Product Key Required
GetCmmInfo (OOB only)	Informationen zu den Optionen und weitere Details finden Sie im SUM Handbuch (PDF).	No
UpdateCmm (OOB only)		No
GetCmmCfg (OOB only)		No
ChangeCmmCfg (OOB only)		No
SetCmmPassword (OOB only)		No
LoadDefaultCmmCfg		No
GetBbpInfo		No
UpdateBbp		No
GetBladePowerStatus		No
SetBladePowerAction		No

Storage Management


Kommando	Option	Node Product Key Required
GetRaidControllerInfo	--file <file name> (Optional)	SFT-DCMS-SINGLE
	--file_only (Optional)
	--dev_id <DEVICE_ID> (Optional)
UpdateRaidController	--file <file name>	SFT-DCMS-SINGLE
	--dev_id <DEVICE_ID>
	--reboot (Optional)
GetRaidCfg	--file <file name> (Optional)	SFT-DCMS-SINGLE
GetRaidCfg	--overwrite (Optional)	SFT-DCMS-SINGLE
ChangeRaidCfg	--file <file name>	SFT-DCMS-SINGLE
GetSataInfo (OOB only)	(keine)	Yes
GetNvmeInfo (OOB only)	--dev_id <DEVICE_ID> (Optional)	Yes
SecureEraseRaidHdd		SFT-DCMS-SINGLE
SecureEraseDisk		SFT-DCMS-SINGLE
UpdatePMem		SFT-DCMS-SINGLE
GetPMemInfo		SFT-DCMS-SINGLE

PSU Management


Kommando	Option	Node Product Key Required
GetPsuInfo	(keine)	Yes
UpdatePsu	--file <file name>	SFT-DCMS-SINGLE
UpdatePsu	--address	SFT-DCMS-SINGLE
GetPowerStatus		No
SetPowerAction		No

Applications


Kommando	Option	Beschreibung	Node Product Key Required
MountIsoImage			Yes
UnmountIsoImage			Yes
MountFloppyImage			Yes
UnmountFloppyImage			Yes
RawCommand			No
GetUsbAccessMode (Inband only)	(keine)		SFT-DCMS-SINGLE
SetUsbAccessMode (Inband only)	--panel <front/rear>	Definiert das gewünschte Panel.	SFT-DCMS-SINGLE
	--enable	Aktiviert dynamisch die USB-Ports im zugewiesenen Panel.
	--disable	Deaktiviert dynamisch die USB-Ports im zugewiesenen Panel.
LocateServerUid	--action <action>	Mögliche Werte für <action>: 1 = GetStatus 2 = On 3 = Off	No
SetHttpBoot	--boot_name <boot description>	Beschreibung für HTTP-Boot	Yes
	--boot_lan <boot lan port>	Geben Sie den LAN-Port für HTTP-Boot ein. LAN-Port 1 wird nur von der X11 Serie unterstützt.
	--reboot	Erzwingt den Neustart oder das Hochfahren des verwalteten Systems nach dem Betrieb.
	--boot_clean	Löscht alle HTTP-Boot-Optionen.
	--disable_hostname_check	Deaktiviert für HTTPS Boot die Überprüfung, ob der Hostname von TLS-Zertifikaten mit dem vom Remote-Server angegebenen Hostnamen übereintimmt.
	--image_url <URL>	Die URL für den Zugriff auf die freigegebene Image-Datei.
	--post_complete (Optional)	Wartet auf den Abschluss des POST des verwalteten Systems nach dem Neustart.

TPM management


Kommando	Option	Node Product Key Required
TpmProvision (OOB only)	--reboot	Yes
	--image_url <URL>
	--lock <yes>
	--id <ID> (Optional)
	--pw <Password> (Optional)
	--pw_file <Password File> (Optional)
	--cleartpm (Optional)
TpmManage	--reboot	Yes
	--clear_and_enable_dtpm_txt
	--clear_dtpm
	--enable_txt_and_dtpm
	--clear_and_enable_dtpm
	--disable_dtpm
	--disable_txt
	--provision
	--table_default
	--table <table name>
GetTpmInfo	--showall (Optional)	Yes

GPU Management


Kommando	Option	Beschreibung	Node Product Key Required
GetGpuInfo			SFT-DCMS-SINGLE

CPLD Management


Kommando	Option	Beschreibung	Node Product Key Required
GetCpldInfo			No
UpdateCpld			No

Ausgaben

Supermicro Update Manager (for UEFI BIOS) 2.7.0 (2021/09/03) (x86_64)
Copyright(C) 2013-2021 Super Micro Computer, Inc. All rights reserved.
NAME

  sum.exe (Supermicro Update Manager)
SYNOPSIS

  sum.exe [OPTIONs] [COMMAND] [COMMAND ARGUMENTS]
OPTIONS

  -h                       Shows help information.
  -v                       Displays the verbose output.
  -i                       <BMC/CMM IP address or host name>
                           (case sensitive)
  -l                       <BMC/CMM system list file name. Refer to the user's
                           guide for formatting.>
  -u                       <BMC/CMM user ID>
  -p                       <BMC/CMM user password>
  -f                       <BMC/CMM user password file>
  -c                       <command name>
  --journal_level          <set SUM journal level>
                           (0: silent, 1: fatal, 2: error, 3: warning, 4:
                           information, 5: debug, 6: verbose)
  --journal_path           <set SUM journal path>
  --rc_path                <set .sumrc file path>
  --show_multi_full        show intermediate status of all managed systems
                           (For concurrent systems OOB management only)
USAGE MODES

 *  Single System Out-Of-Band (OOB) Management [operates on single BMC/CMM]:
    Must use -i, -u, -p options
 *  Single System In-Band Management [operates on local OS]: Do not use -i
    option
 *  Concurrent Systems OOB Management [operates on multiple system BMCs/CMMs]:
    Replace -i option with -l option

COMMANDS
Function Group             Command Names

Key Management             ActivateProductKey, QueryProductKey
System Checks              CheckOOBSupport, CheckAssetInfo,
                           CheckSystemUtilization, CheckSensorData, ServiceCalls
BIOS Management            GetBiosInfo, UpdateBios, GetDefaultBiosCfg,
                           GetCurrentBiosCfg, ChangeBiosCfg, LoadDefaultBiosCfg,
                           SetBiosAction, SetBiosPassword, GetDmiInfo,
                           ChangeDmiInfo, EditDmiInfo, EraseOAKey, BiosRotManage
BMC Management             GetBmcInfo, UpdateBmc, GetBmcCfg, ChangeBmcCfg,
                           SetBmcPassword, GetKcsPriv, SetKcsPriv,
                           GetLockdownMode, SetLockdownMode, LoadDefaultBmcCfg,
                           BmcRotManage, TimedBmcReset
System Event Log           GetHostDump, GetEventLog, ClearEventLog,
                           GetMaintenEventLog, ClearMaintenEventLog
CMM Management             GetCmmInfo, UpdateCmm, GetCmmCfg, ChangeCmmCfg,
                           SetCmmPassword, LoadDefaultCmmCfg, GetBbpInfo,
                           UpdateBbp, GetBladePowerStatus, SetBladePowerAction
Storage Management         GetRaidControllerInfo, UpdateRaidController,
                           GetRaidCfg, ChangeRaidCfg, GetSataInfo, GetNvmeInfo,
                           SecureEraseRaidHdd, SecureEraseDisk, UpdatePMem,
                           GetPMemInfo
PSU Management             GetPsuInfo, UpdatePsu, GetPowerStatus, SetPowerAction
Applications               MountIsoImage, UnmountIsoImage, MountFloppyImage,
                           UnmountFloppyImage, RawCommand, GetUsbAccessMode,
                           SetUsbAccessMode, LocateServerUid, SetHttpBoot
TPM Management             TpmProvision, TpmManage, GetTpmInfo
GPU Management             GetGpuInfo
CPLD Management            GetCpldInfo, UpdateCpld

COMMAND USAGE
  See help message for each command
  Syntax:" # sum.exe -h -c <command name>"
  Notes: 1) Commands are platform dependent. Please refer to Appendix C in the
         user's guide for platform dependency hints.
         2) If a BMC/CMM user ID or password includes special character(s), it
         has to be quoted.
         3) Use -p option or -f option for assigning a password, do not use them
         together.

EXAMPLES
OOB
  # sum.exe -i 192.168.34.56 -u ADMIN -p ADMIN -c ChangeBmcCfg --file BmcCfg.txt
  # sum.exe -i 192.168.34.56 -u ADMIN -f password.txt -c ChangeBmcCfg --file
  BmcCfg.txt
Multiple systems OOB
  # sum.exe -l IP_ADDR_RANGE.txt -u ADMIN -p ADMIN -c GetBIOSInfo --file
  BIOS.rom
  # sum.exe -l IP_ADDR_RANGE.txt -u ADMIN -f password.txt -c GetBIOSInfo --file
  BIOS.rom
In-Band
  # sum.exe -c UpdateBios --file BIOS.rom
Help Message
  # sum.exe -h -c UpdateBios

Weitere Informationen

SUM_UserGuide.pdf

Autor: Werner Fischer

Werner Fischer arbeitet im Product Management Team von Thomas-Krenn. Er evaluiert dabei neueste Technologien und teilt sein Wissen in Fachartikeln, bei Konferenzen und im Thomas-Krenn Wiki. Bereits 2005 - ein Jahr nach seinem Abschluss des Studiums zu Computer- und Mediensicherheit an der FH Hagenberg - heuerte er beim bayerischen Server-Hersteller an. Als Öffi-Fan nutzt er gerne Bus & Bahn und genießt seinen morgendlichen Spaziergang ins Büro.