BMC CLI Interface Overview | Docs Center

Revision History

Version	Date	Description
1.0	2026/07/28	Initial release.

Overview

BMC CLI (Command Line Interface) provides a set of commands for system management and query operations after logging into the BMC via SSH or serial console. Command details are auto-generated from rackmount/interface_config/cli. The sections below list all commands grouped by function.

Active-Standby

Command Format	Command Function
`ipmcget -d redundancy`	Get redundancy states
`ipmcset -d failover`	Execute active_standby failover

Certificate

Command Format	Command Function
`ipmcget -t certificate -d info`	Get server certificate information
`ipmcset -t certificate -d import`	import certificate

Configuration

Command Format	Command Function
`ipmcget -t config -d export`	export configuration
`ipmcget -t config -d importresult`	get imported bundle validation result
`ipmcset -t config -d import`	import configuration

CRL

Command Format	Command Function
`ipmcset -d crl`	import CRL file

Manufacturing Test

Command Format	Command Function
`ipmcget -t maintenance -d boardlog`	Get board log
`ipmcset -t maintenance -d accycle`	accycle

Environment Variables

Command Format	Command Function
`ipmcget -t envvar -d hostgmac`	Get host GMAC address
`ipmcset -t envvar -d hostgmac`	Set host GMAC address

FRU

Command Format	Command Function
`ipmcget -d fruinfo`	Get fru information
`ipmcget -d health`	Get health status
`ipmcget -d healthevents`	Get fru0 health events
`ipmcget -d healthevents`	Get health events
`ipmcget -d powerstate`	Get fru0 power state
`ipmcget -d powerstate`	Get power state
`ipmcget -d shutdowntimeout`	Get graceful shutdown timeout state and value
`ipmcget -t fru0 -d health`	Get fru0 health status
`ipmcget -t fru0 -d shutdowntimeout`	Get graceful shutdown timeout state and value
`ipmcset -d frucontrol`	Control fru0
`ipmcset -d frucontrol`	Fru control
`ipmcset -d powerstate`	Set fru0 power state
`ipmcset -d powerstate`	Set power state
`ipmcset -d sel`	Clear SEL
`ipmcset -d sel`	Clear SEL
`ipmcset -d shutdowntimeout`	Set graceful shutdown timeout state and value
`ipmcset -t fru0 -d shutdowntimeout`	Set graceful shutdown timeout state and value

IPMI

Command Format	Command Function
`ipmcset -d ipmiraw`	Send ipmi command and get response
`ipmcset -t ipmb -d ipmiraw`	Send ipmi command and get response

LLDP

Command Format	Command Function
`ipmcset -t lldp -d status`	Set LLDP enable status

LAN Switch

Command Format	Command Function
`ipmcget -t lsw -d configinfo`	Get lsw net config state
`ipmcset -t lsw -d reset`	Reset LAN Switch

Maintenance & Diagnostics

Command Format	Command Function
`ipmcget -d blackbox`	Get black box data
`ipmcget -d diaginfo`	Get diagnostic info of management subsystem
`ipmcget -d operatelog`	Print operation log
`ipmcget -d sel`	Print System Event Log (SEL)
`ipmcget -t maintenance -d biosprint`	Show BIOS print switch information
`ipmcget -t maintenance -d catlog`	Show log of a specified type.
`ipmcget -t maintenance -d dumpdfxlog`	Dump DFX log
`ipmcget -t maintenance -d ipinfo`	Get the maintenance IP information of dedicated port
`ipmcget -t maintenance -d listcsr`	Get the list of csr.
`ipmcget -t maintenance -d loglist`	Get the list of logs that can be viewed.
`ipmcget -t maintenance -d poweronlock`	Get power on lock information
`ipmcget -t maintenance -d retiresystem`	Get retirement status
`ipmcset -t maintenance -d biosprint`	BIOS print set
`ipmcset -t maintenance -d callredfish`	callredfish
`ipmcset -t maintenance -d download`	Download files
`ipmcset -t maintenance -d ethlink`	Set ethernet port link status
`ipmcset -t maintenance -d importcsr`	Import CSR
`ipmcset -t maintenance -d ipaddr`	Set maintenance ip address
`ipmcset -t maintenance -d poweronlock`	Clear the power-on lock status.
`ipmcset -t maintenance -d psualarmlatch`	Set the power supply alarm latch status
`ipmcset -t maintenance -d resetiME`	Reset ARM iME
`ipmcset -t maintenance -d retiresystem`	Retire system
`ipmcset -t maintenance -d upgradebios`	Upgrade bios component

Network Configuration

Command Format	Command Function
`ipmcget -d ethport`	Get usable eth port
`ipmcget -d ipinfo`	Get ip information
`ipmcget -d lldpinfo`	Get LLDP information
`ipmcget -d macaddr`	Get mac address
`ipmcset -d activeport`	Set EthGroup active port
`ipmcset -d backupipaddr`	Set backup ip address
`ipmcset -d gateway`	Set gateway
`ipmcset -d gateway6`	Set ipv6 gateway
`ipmcset -d ipaddr`	Set ip address
`ipmcset -d ipaddr6`	Set ipv6 address
`ipmcset -d ipmode`	Set ip mode
`ipmcset -d ipmode6`	Set ipv6 mode
`ipmcset -d ipversion`	Set ip version
`ipmcset -d netmode`	Set net mode
`ipmcset -d vlan`	Set sideband vlan

NTP

Command Format	Command Function
`ipmcget -d ntpinfo`	Get NTP information
`ipmcset -t ntp -d alternativeserver`	Set alternative NTP server address
`ipmcset -t ntp -d authstatus`	Enable auth status
`ipmcset -t ntp -d extraserver`	Set extra NTP server address
`ipmcset -t ntp -d groupkey`	Import NTP group key
`ipmcset -t ntp -d mode`	Set NTP mode
`ipmcset -t ntp -d preferredserver`	Set preferred NTP server address
`ipmcset -t ntp -d status`	Set NTP enable status

Power Management

Command Format	Command Function
`ipmcget -d psuinfo`	Get PSU component information
`ipmcset -d psuswitch`	Set psu switch
`ipmcset -d psuworkmode`	Set PSU work mode

Precise Alarm

Command Format	Command Function
`ipmcset -t precisealarm -d mock`	Precise alarm mock

Command Format	Command Function
`ipmcget -t securitybanner -d info`	Get banner info
`ipmcset -t securitybanner -d content`	Set login security banner content
`ipmcset -t securitybanner -d state`	Set login security banner state

Security Enhancement

Command Format	Command Function
`ipmcget -t securityenhance -d inactivetimelimit`	Get inactive user timelimit(day)
`ipmcget -t securityenhance -d masterkeyupdateinterval`	Get masterkeyupdateinterval information
`ipmcset -t securityenhance -d inactivetimelimit`	Set inactive user timelimit(day)
`ipmcset -t securityenhance -d masterkeyupdateinterval`	Set master key automatic update interval(day)
`ipmcset -t securityenhance -d updatemasterkey`	Update master key

Sensor

Command Format	Command Function
`ipmcget -t sensor -d list`	List all sensor information
`ipmcset -t sensor -d state`	Sensor state
`ipmcset -t sensor -d test`	Sensor test

Service Management

Command Format	Command Function
`ipmcget -t service -d list`	List all service information
`ipmcset -t service -d port`	Set service port
`ipmcset -t service -d state`	Set service enable state

SMBIOS

Command Format	Command Function
`ipmcget -d serialnumber`	Get system serial number
`ipmcget -t smbios -d serialnumber`	Print serialnumber of smbios

SOL

Command Format	Command Function
`ipmcget -t sol -d info`	Get the information of SOL
`ipmcget -t sol -d session`	Get the information of SOL session
`ipmcset -t sol -d activate`	Set SOL activate
`ipmcset -t sol -d deactivate`	Close SOL session
`ipmcset -t sol -d timeout`	Set SOL timeout period(min)

Storage Management

Command Format	Command Function
`ipmcget -t storage -d arrayinfo`	Get the information of disk array
`ipmcget -t storage -d ctrlinfo`	Get the information of RAID controller
`ipmcget -t storage -d ldinfo`	Get the information of logical drive
`ipmcget -t storage -d pdinfo`	Get the information of physical drive
`ipmcset -t storage -d addld`	Add a logical drive on already existing disk array
`ipmcset -t storage -d createld`	Create a logical drive
`ipmcset -t storage -d ctrlconfig`	Set RAID controller configurations
`ipmcset -t storage -d deleteld`	Delete a logical drive
`ipmcset -t storage -d ldconfig`	Set logical drive configurations
`ipmcset -t storage -d pdconfig`	Set physical drive configurations

Syslog

Command Format	Command Function
`ipmcget -t syslog -d auth`	Get syslog auth type
`ipmcget -t syslog -d clientcertificate`	Get syslog client certificate information
`ipmcget -t syslog -d identity`	Get syslog identity
`ipmcget -t syslog -d iteminfo`	Get syslog dest item information
`ipmcget -t syslog -d protocol`	Get syslog protocol
`ipmcget -t syslog -d rootcertificate`	Get syslog root certificate information
`ipmcget -t syslog -d severity`	Get syslog send severity
`ipmcget -t syslog -d state`	Get syslog enable status
`ipmcset -t syslog -d address`	Set syslog dest address
`ipmcset -t syslog -d auth`	Set syslog auth type
`ipmcset -t syslog -d identity`	Set syslog identity
`ipmcset -t syslog -d logtype`	Set syslog dest log type
`ipmcset -t syslog -d port`	Set syslog dest port
`ipmcset -t syslog -d protocol`	Set syslog protocol
`ipmcset -t syslog -d rootcertificate`	import syslog rootcertificate
`ipmcset -t syslog -d severity`	Set syslog severity
`ipmcset -t syslog -d state`	Set syslog enable state
`ipmcset -t syslog -d test`	Test syslog dest send

System Management

Command Format	Command Function
`ipmcget -d bootdevice`	Get boot device
`ipmcget -d ledinfo`	Get led information
`ipmcget -d rollbackstatus`	Get rollback status
`ipmcget -d serialdir`	Get currently connected serial direction
`ipmcget -d systemcom`	Get system com data
`ipmcget -d time`	Get system time
`ipmcget -d version`	Get openUBMC version
`ipmcset -d bootdevice`	Set boot device
`ipmcset -d clearcmos`	Clear CMOS
`ipmcset -d printscreen`	Print current screen to openUBMC
`ipmcset -d reset`	Reboot openUBMC system
`ipmcset -d restore`	Restore factory setting
`ipmcset -d rollback`	Perform a manual rollback
`ipmcset -d serialdir`	Set serial direction
`ipmcset -d timezone`	Set time zone
`ipmcset -d upgrade`	Upgrade component

Thermal Management

Command Format	Command Function
`ipmcget -d coolingdeviceinfo`	Get fan or pump mode and the percentage of the fan or pump speed
`ipmcget -d faninfo`	Get fan mode and the percentage of the fan speed
`ipmcset -d coolinglevel`	Set cooling device level
`ipmcset -d coolingmode`	Set cooling device mode, you can choose manual, auto or mixed
`ipmcset -d fanlevel`	Set fanlevel
`ipmcset -d fanmode`	Set fan mode,you can choose manual / auto or mixed

SNMP Trap

Command Format	Command Function
`ipmcget -t trap -d mode`	Get SNMP trap mode
`ipmcget -t trap -d severity`	Get trap send severity
`ipmcget -t trap -d state`	Get trap enable status
`ipmcget -t trap -d trapiteminfo`	Get trapitem information
`ipmcget -t trap -d user`	Get SNMP trap user
`ipmcget -t trap -d version`	Get SNMP trap version
`ipmcset -t trap -d address`	Set trap address
`ipmcset -t trap -d community`	Set SNMP trap community
`ipmcset -t trap -d mode`	Set SNMP trap mode
`ipmcset -t trap -d port`	Set trap port
`ipmcset -t trap -d severity`	Set trap send severity
`ipmcset -t trap -d state`	Set trap enable state
`ipmcset -t trap -d user`	Set SNMP trap user
`ipmcset -t trap -d version`	Set SNMP trap version

USB Management

Command Format	Command Function
`ipmcget -t usbmgmt -d info`	Get USB management service information
`ipmcset -t usbmgmt -d state`	Set USB management service state

User Management

Command Format	Command Function
`ipmcget -d minimumpasswordage`	Get minimum password age
`ipmcget -d notimeoutstate`	Get CLI session notimeout state
`ipmcget -d passwordcomplexity`	Get password complexity check enable status
`ipmcget -d sshpasswordauthentication`	Get SSH password authentication status
`ipmcget -d userlist`	List all user information
`ipmcget -t user -d list`	List all user information
`ipmcget -t user -d osadminprivilege`	Get the host side administrator privilege enable status
`ipmcget -t user -d passwordcomplexity`	Get password complexity check enable status
`ipmcget -t user -d passwordpattern`	Get the regular expression for checking password complexity
`ipmcget -t user -d passwordrulepolicy`	Get the password complexity check mode
`ipmcget -t user -d usermgmtbyhost`	Get user management status on the host side
`ipmcset -d adduser`	Add user
`ipmcset -d deluser`	Delete user
`ipmcset -d emergencyuser`	Set emergencyuser
`ipmcset -d minimumpasswordage`	Set minimum password age configuration
`ipmcset -d password`	Modify user password
`ipmcset -d passwordcomplexity`	Set password complexity check enable state
`ipmcset -d privilege`	Set user privilege
`ipmcset -d sshpasswordauthentication`	Set SSH password authentication state
`ipmcset -t user -d addpublickey`	Add SSH public key
`ipmcset -t user -d delpublickey`	Delete SSH public key
`ipmcset -t user -d firstloginpolicy`	Set user first login password reset policy
`ipmcset -t user -d interface`	Set user login interface
`ipmcset -t user -d lock`	Set user lock state
`ipmcset -t user -d osadminprivilege`	Set the host side administrator privilege enable status
`ipmcset -t user -d passwordcomplexity`	Set password complexity check enable state
`ipmcset -t user -d passwordpattern`	Set the regular expression for checking password complexity
`ipmcset -t user -d passwordrulepolicy`	Set the password complexity check mode
`ipmcset -t user -d privilege`	Set user privilege
`ipmcset -t user -d snmpprivacypassword`	Set snmp privacy password
`ipmcset -t user -d state`	Enable/Disable user
`ipmcset -t user -d unlock`	Set user unlock state
`ipmcset -t user -d usermgmtbyhost`	Set user management function on the host side
`ipmcset -t user -d weakpwddic`	Manage weak password dictionary
`ipmcset -t vnc -d password`	Set VNC password

Virtual Media

Command Format	Command Function
`ipmcget -t vmm -d info`	Get virtual media information
`ipmcset -t vmm -d connect`	connect virtual media
`ipmcset -t vmm -d disconnect`	disconnect virtual media

VNC

Command Format	Command Function
`ipmcget -t vnc -d info`	Get VNC information
`ipmcset -t vnc -d keyboardlayout`	Set VNC keyboard layout
`ipmcset -t vnc -d ssl`	Set VNC ssl encryption
`ipmcset -t vnc -d timeout`	Set VNC timeout period(min)

Revision History ​

Overview ​

Active-Standby ​

Certificate ​

Configuration ​

CRL ​

Manufacturing Test ​

Environment Variables ​

FRU ​

IPMI ​

LLDP ​

LAN Switch ​

Maintenance & Diagnostics ​

Network Configuration ​

NTP ​

Power Management ​

Precise Alarm ​

Security Banner ​

Security Enhancement ​

Sensor ​

Service Management ​

SMBIOS ​

SOL ​

Storage Management ​

Syslog ​

System Management ​

Thermal Management ​

SNMP Trap ​

USB Management ​

User Management ​

Virtual Media ​

VNC ​