Supermicro/SUM
Jump to navigation
Jump to search
Set IPMI Password
./sum -c SetBmcPassword -h
./sum -i [IPMI_ADDRESS] -u ADMIN -p [OLD_PASSWORD] -c SetBmcPassword --pw_file [password.txt] ./sum -i [IPMI_ADDRESS] -u ADMIN -p [OLD_PASSWORD] -c SetBmcPassword --new_password [NEW_PASSWORD] --confirm_password [NEW_PASSWORD]
Still has to deal with password restrictions
Reset to ADMIN / ADMIN:
ipmitool -I lanplus -H [IP] -U ADMIN -P [OLD_PASSWORD] raw 0x30 0x48 0x1 ipmitool raw 0x30 0x48 0x1
Activate License
./sum -i [IPMI_ADDRESS] -u ADMIN -p [PASSWORD] -c ActivateProductKey --key XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
./sum -i [IPMI_ADDRESS] -u ADMIN -p [PASSWORD] -c ActivateProductKey --key_file keys.txt # keys.txt Supported key file format: MAC; Key # example: XX:XX:XX:XX:XX:XX ; XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
./sum -l [IP_LIST.TXT] -u ADMIN -p ADMIN -c ActivateProductKey --key_file keys.txt
./sum -l ips.txt -u ADMIN -p ADMIN -c ActivateProductKey --key_file keys.txt
Help
# ./sum
Supermicro Update Manager (for UEFI BIOS) 2.14.0 (2024/02/15) (x86_64)
Copyright(C) 2013-2024 Super Micro Computer, Inc. All rights reserved.
NAME
sum (Supermicro Update Manager)
SYNOPSIS
sum [OPTIONs] [COMMAND] [COMMAND ARGUMENTS]
OPTIONS
-h Shows help information.
-v Displays the verbose output.
-I <InterfaceName>
(case sensitive)
Supported Interfaces:
1. Redfish_HI (Execute In-Band commands through
Redfish Host Interface)
2. Remote_INB (Execute In-Band commands on a remote)
system)
3. Remote_RHI (Execute In-Band commands through
Redfish Host Interface on a remote system)
-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>
--batch_count show intermediate status of all managed systems
(For multiple systems management only)
--oi <OS IP address>
--ou <OS user ID>
--op <OS user password>
--os_key <OS private key>
--os_key_pw <OS private key password>
--port <BMC/CMM/Command port(s)>
The format is "RMCP:623,HTTPS:443"
Supported Ports:
1. RMCP (for BMC/CMM OOB usage)
2. HTTPS (for BMC/CMM Redfish usage)
(Will overwrite the ports in .sumrc file)
Each command may support more optional port(s).
Please read the help message of each command.
--version Shows version information.
--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 multiple systems management only)
--remote_sum Specifies the remote SUM path for Remote In-Band usage.
--remote_sum_rc Specifies the remote Sumrc path for Remote In-Band usage.
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
* Single System Remote In-Band Management [operates on remote OS]: Use -I
Remote_INB or -I Remote_RHI option
* Multiple Systems OOB Management [operates on multiple system BMCs/CMMs]:
Replace -i option with -l option
* Multiple Systems Remote In-Band Management [operates on multiple system
OSs]: Use -I Remote_INB or -I Remote_RHI option, together with -l option
COMMANDS
Function Group Command Names
Key Management ActivateProductKey, QueryProductKey
System Checks CheckOOBSupport, CheckAssetInfo,
CheckSystemUtilization, CheckSensorData,
ServiceCalls, SystemPFA, MemoryHealthCheck,
CpuOnDemand, GetFruInfo, RestoreFruInfo,
ChangeFruInfo, ChassisIntrusion
BIOS Management GetBiosInfo, UpdateBios, GetDefaultBiosCfg,
GetCurrentBiosCfg, ChangeBiosCfg, LoadDefaultBiosCfg,
SetBiosPassword, GetDmiInfo, ChangeDmiInfo,
EditDmiInfo, EraseOAKey, BiosRotManage, GetScpInfo,
UpdateScp, GetFixedBootCfg, ChangeFixedBootCfg,
SecureBootManage
BMC Management GetBmcInfo, UpdateBmc, GetBmcCfg, ChangeBmcCfg,
GetBmcLANCfg, ChangeBmcLANCfg, SetBmcPassword,
GetKcsPriv, SetKcsPriv, GetLockdownMode,
SetLockdownMode, LoadDefaultBmcCfg, BmcRotManage,
GetBmcUserList, SetBmcUserList, TimedBmcReset,
Attestation, BootStrappingAccount, RmcpManage
System Event Log GetHostDump, GetEventLog, ClearEventLog,
GetMaintenEventLog, ClearMaintenEventLog
CMM Management GetCmmInfo, UpdateCmm, GetCmmCfg, ChangeCmmCfg,
SetCmmPassword, LoadDefaultCmmCfg, GetBbpInfo,
UpdateBbp, GetBladePowerStatus, SetBladePowerAction,
ProfileManage, GetSwitchInfo, UpdateSwitch,
RebootSwitch
Storage Management GetRaidControllerInfo, UpdateRaidController,
GetRaidCfg, ChangeRaidCfg, GetSataInfo, GetNvmeInfo,
SecureEraseRaidHdd, GetVROCCfg, ChangeVROCCfg,
ControlNVMe, SecureEraseDisk, UpdatePMem, GetPMemInfo
PSU Management GetPsuInfo, UpdatePsu, GetPowerStatus, SetPowerAction
PCIe-Switch Management GetPCIeSwitchInfo, UpdatePCIeSwitch
Applications RawCommand, GetUsbAccessMode, SetUsbAccessMode,
LocateServerUid, SetHttpBoot, KmsManage, RedfishApi,
GetSystemCfg, ChangeSystemCfg, RemoteExec, ManageRHI
TPM Management TpmProvision, TpmManage, GetTpmInfo
GPU Management GetGpuInfo, UpdateGpu, DiagGpuStatus, GetGpuLog
CPLD Management GetCpldInfo, UpdateCpld, UpdateSwitchboardCpld,
CpldRotManage, GetFanboardCpldInfo,
UpdateFanboardCpld, GetSwitchboardCpldInfo,
GetMiscCpldInfo, UpdateMiscCpld, GetAomboardCpldInfo,
UpdateAomboardCpld
NIC Management UpdateAocNIC, GetAocNICInfo
AIP Management GetAipCpldInfo, UpdateAipCpld
TwinPro Management GetTpCfg, ChangeTpCfg
Backplane Management GetBackplaneCpldInfo, UpdateBackplaneCpld,
GetMultinodeEcInfo, UpdateMultinodeEc
Security Management GetCpuERotInfo, UpdateCpuERot, CpuERotManage,
GetGpuERotInfo, FpgaRotManage
VM Management MountIsoImage, UnmountIsoImage, MountFloppyImage,
UnmountFloppyImage, GetVmInfo, VmManage
CDU Management MonitorCDUStatus
FPGA Management GetMotherboardFpgaInfo, UpdateMotherboardFpga
MCU Management GetMotherboardMcuInfo, UpdateMotherboardMcu
COMMAND USAGE
See help message for each command
Syntax:" # ./sum -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
Single Systems
OOB
# ./sum -i 192.168.34.56 -u ADMIN -p ADMIN -c ChangeBmcCfg --file BmcCfg.txt
# ./sum -i 192.168.34.56 -u ADMIN -f password.txt -c ChangeBmcCfg --file
BmcCfg.txt
In-Band
# ./sum -c UpdateBios --file BIOS.rom
Remote In-Band
# ./sum -I Remote_INB --oi 192.168.34.56 --ou root --op 111111 -c UpdateBios
--file BIOS.rom --remote_sum /root/sum
# ./sum -I Remote_RHI --oi 192.168.34.56 --ou root --op 111111 -u ADMIN -p
ADMIN -c UpdateBios --file BIOS.rom --remote_sum /root/sum
Multiple Systems
OOB
# ./sum -l IP_ADDR_RANGE.txt -u ADMIN -p ADMIN -c GetBIOSInfo --file
BIOS.rom
# ./sum -l IP_ADDR_RANGE.txt -u ADMIN -f password.txt -c GetBIOSInfo --file
BIOS.rom
Remote In-Band
# ./sum -I Remote_INB -l IP_ADDR_RANGE.txt -c UpdateBios --file BIOS.rom
# ./sum -I Remote_RHI -l IP_ADDR_RANGE.txt -c UpdateBios --file BIOS.rom
Help Message
# ./sum -h -c UpdateBios