ZTE Server

BMC CLI Interface Description (BMC V4)

Version: R1.1

ZTE CORPORATION
ZTE Plaza, Keji Road South, Hi-Tech Industrial Park,
Nanshan District, Shenzhen, P.R.China
Postcode: 518057
Tel: +86-755-26771900
URL: https://support.zte.com.cn
E-mail: [email protected]
LEGAL INFORMATION
Copyright 2025 ZTE CORPORATION.
The contents of this document are protected by copyright laws and international treaties. Any reproduction or
distribution of this document or any portion of this document, in any form by any means, without the prior written

consent of ZTE CORPORATION is prohibited. Additionally, the contents of this document are protected by

contractual confidentiality obligations.

All company, brand and product names are trade or service marks, or registered trade or service marks, of ZTE

CORPORATION or of their respective owners.

This document is provided as is, and all express, implied, or statutory warranties, representations or conditions are

disclaimed, including without limitation any implied warranty of merchantability, fitness for a particular purpose,

title or non-infringement. ZTE CORPORATION and its licensors shall not be liable for damages resulting from the

use of or reliance on the information contained herein.

ZTE CORPORATION or its licensors may have current or pending intellectual property rights or applications

covering the subject matter of this document. Except as expressly provided in any written license between ZTE
CORPORATION and its licensee, the user of this document shall not acquire any license to the subject matter

herein.

ZTE CORPORATION reserves the right to upgrade or make technical change to this product without further notice.

Users may visit the ZTE technical support website https://support.zte.com.cn to inquire for related information.

The ultimate right to interpret this product resides in ZTE CORPORATION.

Statement on the Use of Third-Party Embedded Software:

If third-party embedded software such as Oracle, Sybase/SAP, Veritas, Microsoft, VMware, and Redhat is

delivered together with this product of ZTE, the embedded software must be used as only a component of this
product. If this product is discarded, the licenses for the embedded software must be void either and must not be

transferred. ZTE will provide technical support for the embedded software of this product.

Revision History

Revision No. Revision Date Revision Reason

R1.1 2025-07-21 Added the following sections:
 2.3.6 Querying Product Health Status
 2.3.7 Query Host Name
 2.3.8 Set Host Name
Revision No. Revision Date Revision Reason
R1.0 2025-03-11 First edition.

Serial Number: SJ-20230907115354-012

Publishing Date: 2025-07-21 (R1.1)
 Contents

1 Introduction to the CLI Tool................................................................................. 1

2 Command Descriptions......................................................................................... 2
2.1 IPMI Commands.................................................................................................................. 2
2.2 Managers-Related Commands............................................................................................3
2.2.1 Query DNS Configuration.......................................................................................3
2.2.2 Query NTP Configuration....................................................................................... 4
2.2.3 Query SEL Logs..................................................................................................... 5
2.2.4 Query SNMP Configuration.................................................................................... 7
2.2.5 Query BMC Service Information.............................................................................9
2.2.6 Query Syslog Configuration..................................................................................11
2.2.7 Set Syslog Information......................................................................................... 13
2.3 Systems-Related Commands............................................................................................ 15
2.3.1 Query Asset Tags.................................................................................................15
2.3.2 Set Asset Tag.......................................................................................................15
2.3.3 Query Product Information................................................................................... 16
2.3.4 Query CPU Information........................................................................................ 17
2.3.5 Query Memory Information...................................................................................20
2.3.6 Querying Product Health Status...........................................................................24
2.3.7 Query Host Name.................................................................................................24
2.3.8 Set Host Name..................................................................................................... 25
2.4 Chassis-Related Commands............................................................................................. 26
2.4.1 Query NIC Information..........................................................................................26
2.4.2 Query FC Card Information.................................................................................. 32
2.4.3 Query Hard Disk Information................................................................................38
2.4.4 Query Power Supply Information......................................................................... 41
2.4.5 Query Power Consumption Information............................................................... 44
2.4.6 Query Heat Dissipation Mode.............................................................................. 45
2.4.7 Set Heat Dissipation Mode...................................................................................46
2.4.8 Query Power Restoration Policy.......................................................................... 47
2.4.9 Set Power Restoration Policy...............................................................................48
2.4.10 Query Power Redundancy Mode....................................................................... 49
2.4.11 Query System Boot Mode.................................................................................. 49
2.4.12 Query Fan Sensor Information........................................................................... 51

I
 2.4.13 Query Temperature Sensor Information............................................................. 52
2.5 AccountService-Related Commands................................................................................. 54
2.5.1 Set BMC Redfish Account Service.......................................................................54
2.5.2 Query BMC Redfish Account Service Information................................................55
2.5.3 Query BMC User Information............................................................................... 56
2.5.4 Set BMC User Information................................................................................... 59
2.5.5 Create BMC User................................................................................................. 60
2.5.6 Delete BMC User................................................................................................. 62
2.5.7 Query AD Configuration....................................................................................... 63
2.5.8 Set Active Directory.............................................................................................. 65
2.5.9 Query LDAP Configuration................................................................................... 68
2.5.10 Set LDAP............................................................................................................ 71
2.6 UpdateService-Related Commands.................................................................................. 73
2.6.1 Query Upgradeable Firmware Information........................................................... 73
Glossary....................................................................................................................77

II
About This Manual
Purpose

This manual describes how to use the CLI tool and common commands of the BMC.

Intended Audience

This manual is intended for:

 Network planning engineers
 Equipment installation engineers
 On-site maintenance engineers

What Is in This Manual

This manual contains the following chapters.

Chapter Summary

Chapter 1, Introduction to the Describes the functions of the CLI tool.

CLI Tool

Chapter 2, Command Describes common commands of the CLI tool.

Descriptions

Conventions

This manual uses the following conventions.

Symbol Description

Note: provides additional information about a topic.

III
IV
 Chapter 1
Introduction to the CLI
Tool
Tool Overview

The CLI tool provides a Command Line Interface (CLI) operation mode without the UI. You can
use commands to manage servers, including querying and configuring the system resources
and management resources of servers, upgrading firmware, and collecting assets.

Usage Guidelines

The CLI tool can execute commands only after the tool is connected in SSH mode to the BMC
of the server to be managed.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 1

 Chapter 2
Command Descriptions
Table of Contents
IPMI Commands...........................................................................................................................2
Managers-Related Commands.....................................................................................................3
Systems-Related Commands..................................................................................................... 15
Chassis-Related Commands......................................................................................................26
AccountService-Related Commands..........................................................................................54
UpdateService-Related Commands........................................................................................... 73

2.1 IPMI Commands

Function

An IPMI command executes an ipmitool command and returns the execution result.

Syntax

ipmi IPMICOMMAND

Parameters

Parameter Description Setting

IPMICOMMAND Parameter of the ipmitool -

command that needs to be
executed, required.

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 The privilege requirement of an IPMI command is the same as that of the corresponding
ipmitool command.
 CLI logs are not recorded during the execution of operational commands, but IPMI logs are
still recorded.

Examples

Run the ipmi sensor list command.

2 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Returned result: The execution result is the same as that returned after the ipmitool sensor
list command is executed.

Output Descriptions

None.

2.2 Managers-Related Commands

2.2.1 Query DNS Configuration
Function

This command queries the DNS configuration.

Syntax

getdns

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getdns command.

Returned result:

----------------------------------------------------------------------
Command: getdns Result: Success
----------------------------------------------------------------------
Host Name : testname
DNS Enabled : True
DNS DhcpEnabled : False
DNS Server : [10.10.10.21,10.10.10.23,null]
Domain Name : 102.zte.com.cn
----------------------------------------------------------------------

Output Descriptions

Output Item Description

Host Name Host name.

DNS Enabled Whether the DNS service is enabled.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 3

ZTE Server BMC CLI Interface Description (BMC V4)

Output Item Description

DNS DhcpEnabled Whether to automatically retrieve DNS settings.

 True: automatically retrieves DNS settings.
 False: uses manually configured DNS settings.

DNS Server IP addresses of the DNS server.

Domain Name Domain name.

2.2.2 Query NTP Configuration

Function

This command queries the NTP configuration.

Syntax

getntp

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getntp command.

Returned result:

---------------------------------------------------------
Command: getntp Result: Success
---------------------------------------------------------
ServiceEnabled : False
NtpAddressOrigin : static
PrimaryNtpServer : 1.2.3.4
SecondaryNtpServer : 2.3.4.5
TertiarydaryNtpServer :
MinSyncPeriod(s) : 60
MaxSyncPeriod(s) : 65535
CurrentSyncPeriod(s) : 60
--------------------------------------------------------

4 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Output Descriptions

Output Item Description

ServiceEnabled Whether the NTP service is enabled. Values:

 True: enabled
 False: disabled

NtpAddressOrigin NTP address mode. Default: static.

PrimaryNtpServer IP address of the primary NTP server.

SecondaryNtpServer IP address of the secondary NTP server.

TertiarydaryNtpServer IP address of the tertiary NTP server.

MinSyncPeriod(s) Minimum synchronization period, unit: seconds.

MaxSyncPeriod(s) Maximum synchronization period, unit: seconds.

CurrentSyncPeriod(s) Current synchronization period, unit: seconds.

2.2.3 Query SEL Logs

Function

This command queries SEL logs.

Syntax

getsel

Parameters

None.

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 This command shows only the latest 50 records.

Examples

Run the getsel command.

Returned result:

---------------------------------------------------------
Command: getsel Result: Success
---------------------------------------------------------
[selcollect]
Id : 305
Name : #9

SJ-20230907115354-012 | 2025-07-21 (R1.1) 5

ZTE Server BMC CLI Interface Description (BMC V4)

Severity : Critical
EventTimestamp : 2024-04-02T13:13:53+08:00
EntryType : SEL
EntryCode : Asserted
SensorNumber : 9
SensorType : Power Supply
Message : Predictive Failure

Id : 306
Name : #9
Severity : Critical
EventTimestamp : 2024-04-02T13:13:53+08:00
EntryType : SEL
EntryCode : Asserted
SensorNumber : 9
SensorType : Power Supply
Message : Power Supply input lost (AC/DC)
--------------------------------------------------------

Output Descriptions

Output Item Description

selcollect SEL log collection.

Id ID of the specified SEL instance.

Name Name of the specified SEL instance.

Severity Log severity level of the SEL log instance.

 OK
 Warning
 Critical
 Non-recoverable

EventTimestamp Time stamp of the SEL log instance.

EntryType Type of the SEL log instance.

 SEL
 Oem

EntryCode Code of the SEL log instance.

 Asserted
 Deasserted

SensorNumber Sensor ID for generating SEL log instance information.

SensorType Sensor type for generating SEL log instance information.

Message Message content of the SEL log instance information.

6 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

2.2.4 Query SNMP Configuration

Function

This command queries the SNMP configuration.

Syntax

getsnmp

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getsnmp command.

Returned result:

---------------------------------------------------------
Command: getsnmp Result: Success
---------------------------------------------------------
Id : SnmpService
Name : SnmpService
ReadOnlyCommunity : null
ReadWriteCommunity : null
ComplexPwdEnable : True
SnmpServiceEnable : True
SnmpServicePort : 161
[SnmpTrapNotification]
[TrapServer]
MemberId : 1
TrapServerAddress : 1.2.3.4
TrapServerEnable : True
TrapServerPort : 162
SnmpTrapCommunity : zte_public
SnmpTrapEnable : True
AlarmSeverity : Normal
TrapHostIdentify : BoardSN
TrapV3User : null
TrapVersion : V2C
TrapServerCount : 0
SnmpV3AuthUserCount : 3

SJ-20230907115354-012 | 2025-07-21 (R1.1) 7

ZTE Server BMC CLI Interface Description (BMC V4)

[SnmpV3AuthUser]
snmpV3AuthProtocol : SHA
snmpV3PrivProtocol : AES
UserName : Administrator

snmpV3AuthProtocol : SHA
snmpV3PrivProtocol : AES
UserName : Administrator666

snmpV3AuthProtocol : SHA
snmpV3PrivProtocol : AES
UserName : test5
--------------------------------------------------------

Output Descriptions

Output Item Description

Id ID of the SNMP service.

Name Name of the SNMP service.

ReadOnlyCommunity SNMP read-only community (set to null by default for security purposes).

ReadWriteCommunity SNMP read-write community (set to null by default for security purposes).

ComplexPwdEnable Whether the complex-password function is enabled. This parameter is

unavailable for G4 series servers.

SnmpServiceEnable Whether the SNMP function is enabled. This parameter is unavailable for G4
series servers.

SnmpServicePort SNMP port. This parameter is unavailable for G4 series servers.

SnmpTrapNotification SNMP trap information.

TrapServer SNMP trap server information.

MemberId Member ID of the SNMP trap server.

TrapServerAddress Address of the SNMP trap server.

TrapServerEnable Whether the trap server is enabled. This parameter is unavailable for G4 series
servers.

TrapServerPort Port number of the SNMP trap server.

SnmpTrapCommunity SNMP trap community string.

SnmpTrapEnable Whether the SNMP trap function is enabled.

AlarmSeverity Alarm level of SNMP traps.

TrapHostIdentify Trap host ID. This parameter is unavailable for G4 series servers.

8 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Output Item Description

TrapV3User Name of the user with SNMPv3 user permissions.

TrapVersion SNMP trap version number.

TrapServerCount Number of SNMP trap servers.

SnmpV3AuthUserCount Number of users with SNMPv3 permissions.

SnmpV3AuthUser SNMPv3 user information.

snmpV3AuthProtocol SNMPv3 user authentication algorithm.

snmpV3PrivProtocol SNMPv3 user encryption algorithm.

UserName Name of the user with SNMPv3 permissions.

2.2.5 Query BMC Service Information

Function

This command displays the BMC service information.

Syntax

getservice

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getservice command.

Returned result:

---------------------------------------------------------
Command: getservice Result: Success
---------------------------------------------------------
[HTTPS]
Port : 443
ProtocolEnabled : True
Timeout : 30
[IPMI]
Port : 623
ProtocolEnabled : True
[KVMIP]

SJ-20230907115354-012 | 2025-07-21 (R1.1) 9

ZTE Server BMC CLI Interface Description (BMC V4)

Port : 7578
ProtocolEnabled : True
Timeout : 30
[SNMP]
Port : 161
ProtocolEnabled : True
[SSH]
Port : 22
ProtocolEnabled : True
[VMedia]
ProtocolEnabled : False
[VMedia-CD]
Instance : 1
Port : 5120
ProtocolEnabled : True
[VMedia-HD]
Instance : 1
Port : 5123
ProtocolEnabled : True
[VNC]
ProtocolEnabled : True
Port : 5900
SecurePort : 5901
[SSDP]
ProtocolEnabled : True
Port : 59001
NotifyMulticastIntervalSeconds : 10
NotifyIPv6Scope : Site
NotifyEnabled : True
--------------------------------------------------------

Output Descriptions

Output Item Description

HTTPS/KVMIP/SNMP/SSH/VMedia/IPMI/VMedia-HD/VMedi Services supported by the BMC.

a-CD/VNC/SSDP

Port Service port number.

ProtocolEnabled Whether the BMC service is enabled. Values:

 True
 False

Instance Number of instances.

Timeout Service timeout period.

10 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Output Item Description

SecurePort Secure VNC port.

NotifyEnabled Whether sending SSDP service messages in

multicast mode is enabled. Values:
 True
 False

NotifyIPv6Scope IPv6-based multicast scope of SSDP service

messages.

NotifyMulticastIntervalSeconds Interval for sending SSDP service messages

in multicast mode.

2.2.6 Query Syslog Configuration

Function

This command queries the syslog configuration.

Syntax

getsyslog

Parameters

None.

Usage Guidelines

BMC versions supported: V04.25.01.20 and later.

Examples

Run the getsyslog command.

Returned result:

---------------------------------------------------------
Command: getsyslog Result: Success
---------------------------------------------------------
Id : SyslogService
Name : SyslogService
ServiceEnabled : True
ServerIdentitySource : BoardSN
TransmissionProtocol : UDP
[SyslogServers]
Address : 192.168.0.147
Enabled : False
LogType : ['SecurityLog', 'OperationLog', 'EventLog']

SJ-20230907115354-012 | 2025-07-21 (R1.1) 11

ZTE Server BMC CLI Interface Description (BMC V4)

Port : 544
MemberId : 0

Address :
Enabled : False
LogType : []
Port : 514
MemberId : 1

Address :
Enabled : False
LogType : []
Port : 514
MemberId : 2

Address :
Enabled : False
LogType : []
Port : 514
MemberId : 3
--------------------------------------------------------

Output Descriptions

Output Item Description

Id ID of the syslog service.

Name Name of the syslog service.

ServiceEnabled Whether the syslog service is enabled. Values:

 True: enabled
 False: disabled

ServerIdentitySource Host ID.

 BoardSN: board SN.
 ProductAssetTag: product asset tag.
 HostName: host name.

TransmissionProtocol Transmission protocol for the syslog service. Values:

 TCP: TCP
 UDP: UDP
 TLS: TLS protocol

SyslogServers Information about the syslog server.

Address Address of the syslog server.

Enabled Whether the syslog server is enabled. Values:

12 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Output Item Description

 True: enabled
 False: disabled

LogType Type of logs recorded by the syslog server. Values:

 SecurityLog: audit logs
 OperationLog: operation logs
 EventLog: event log

Port Port number of the syslog server, range: 1–65535.

MemberId Channel number of the syslog server, range: 0–3.

2.2.7 Set Syslog Information

Function

This command sets syslog information.

Syntax

setsyslog [-SE SERVICEENABLED] [-SIS SERVERIDENTITYSOURCE]

[-TP TRANSMISSIONPROTOCOL] [-SSID SYSLOGSERVERID] [-SSE
SYSLOGSERVERENABLED] [-SSA SYSLOGSERVERADDRESS] [-SSP
SYSLOGSERVERPORT] [-SSLT SYSLOGSERVERLOGTYPE]

Parameters

Parameter Description Setting

SERVICEENABLED Whether to enable the syslog  True: enables the syslog

service, optional. service.
 False: disables the syslog
service.
To configure the syslog service, set
this parameter to True.

SERVERIDENTITYSOURCE Host ID, optional.  BoardSN: board SN.

 ProductAssetTag: asset tag.
 HostName: host name.

TRANSMISSIONPROTOCOL Transmission protocol for the  TCP

syslog service, optional. Options:  UDP

SYSLOGSERVERID Member ID of the syslog server, Range: 0–3.

optional.

SYSLOGSERVERENABLED Whether to enable the channel to  True: enables the channel.

the syslog server, optional.  False: disables the channel.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 13

ZTE Server BMC CLI Interface Description (BMC V4)

Parameter Description Setting

SYSLOGSERVERADDRESS IP address of the syslog server. Valid IPv4 and IPv6 addresses
This parameter is optional. (with the first section not being
zero) and valid domain names are
supported.

SYSLOGSERVERPORT Port number of the syslog server, Range: 1–65535.

optional.

SYSLOGSERVERLOGTYPE Type of logs recorded by the The supported log types are
syslog server. This parameter is OperationLog, SecurityLog, and
optional. EventLog. You can specify multiple
log types, which are separated
by a comma (,), for example,
OperationLog,EventLog.

Usage Guidelines

 BMC versions supported: V04.25.01.20 and later.

 The -SE, -SIS, and -TP options are public configuration items and can be configured
separately.
 The -SSID, -SSE, -SSA, -SSP, and -SSLT options are channel configuration items for
a server. They can be configured only if the -SE option is set to True. Otherwise, the
command will fail.
 The -SSID option specifies which channel's server to configure. If this option is not included
in this command, by default, this command sets the server with a channel ID of 0.
 When initially configuring a server with the specified channel, you must set the -SSA and -
SSLT options.
 If a server with the specified channel is not configured for the first time, the -SSE, -SSA, -
SSP, and -SSLT options can be set separately.
 It is not allowed to configure different channels with the same -SSA value and -SSE set to
True.
 If this command is executed without any options, it will succeed but make no changes to the
configuration.

Examples

Run the setsyslog -SE True -SIS HostName -TP UDP -SSID 0 -SSE True -SSA 10.10.10.10 -
SSP 514 -SSLT OperationLog,SecurityLog,EventLog command.
Returned result:

---------------------------------------------------------
Command: setsyslog Result: Success

14 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

---------------------------------------------------------
Set Syslog configuration successfully.
---------------------------------------------------------

Output Descriptions

None.

2.3 Systems-Related Commands

2.3.1 Query Asset Tags
Function

This command queries asset tags.

Syntax

getassettag

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getassettag command.

Returned result:

----------------------------------------------------------------------
Command: getassettag Result: Success
----------------------------------------------------------------------
AssetTag : Z012345678900123
----------------------------------------------------------------------

Output Descriptions

Output Item Description

AssetTag Asset tag name.

2.3.2 Set Asset Tag

Function

This command sets an asset tag.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 15

ZTE Server BMC CLI Interface Description (BMC V4)

Syntax

setassettag -AT ASSETTAG

Parameters

Parameter Description Setting

ASSETTAG Asset tag name, required. String of 2–63 characters. Allowed characters
include lowercase letters (a – z), uppercase
letters (A – Z), digits (0 – 9), hyphens (-),
underscores (_), spaces (), At signs (@), and
colons (:). Letters are case-sensitive. The name
cannot start with a hyphen (-), underscore (_),
space ( ), or colon (:).

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 The -AT option is required. If it is omitted, the command fails to execute.

Examples

Run the setassettag -AT A0123456789 command.

Returned result:

----------------------------------------------------------------------
Command: setassettag Result: Success
----------------------------------------------------------------------
Set assettag information successfully.
----------------------------------------------------------------------

Output Descriptions

None.

2.3.3 Query Product Information

Function

This command queries product information.

Syntax

getproduct

Parameters

None.

16 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getproduct command.

Returned result:

---------------------------------------------------------
Command: getproduct Result: Success
---------------------------------------------------------
ProductName : 12345678901234567890
Manufacturer : ZTE
SerialNumber : 88
UUID : 30e72400-0000-1000-0000-000000000000
PowerState : On
Health : OK
DeviceOwnerID : lx
DeviceSlotID : 0
TotalPowerWatts : 128
--------------------------------------------------------

Output Descriptions

Output Item Description

ProductName Product model.

Manufacturer Product manufacturer.

SerialNumber Product SN.

UUID Product UUID.

DeviceOwnerID Serial number of the mainboard of the product.

DeviceSlotID Slot number of the product (default: 0 for a universal

server).

PowerState Power status of the product.

TotalPowerWatts Overall power of the product.

Health Health status of the product.

2.3.4 Query CPU Information

Function

This command queries CPU information.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 17

ZTE Server BMC CLI Interface Description (BMC V4)

Syntax

getcpu [-S CPUSLOT]

Parameters

Parameter Description Setting

CPUSLOT CPU slot ID. Optional. Integer value. Its range is

determined by the maximum
number of CPUs supported by the
server. The value of this parameter
cannot exceed the maximum
number of CPUs supported by the
server.

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 If no option is specified with the getcpu command, this command shows information about
the CPUs in all slots. If a CPU slot is specified with the getcpu command, this command
shows information about the CPU installed in the specified slot.
 The -S option specifies the ID of the slot where a CPU is installed. If the specified slot does
not contain a configured CPU, the input is considered invalid, and this command fails to
execute.

Examples

Example 1

Run the getcpu command to query all CPU information.

Returned result:

----------------------------------------------------------------------
Command: getcpu Result: Success
----------------------------------------------------------------------
Name : Processors Collection
CPUCount : 1
[CPUs]
Id : 0
Name : Intel Processor 0
Slot : 0
SerialNumber : 57F26AC68929C290
Model : Intel(R) Xeon(R) Silver 4214 CPU @2.20GHz
InstructionSet : x86-64
ProcessorArchitecture : x86

18 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Manufacturer : Intel(R) Corporation

TotalCores : 12
TotalThreads : 24
MaxFrequency(MHz) : 3200
Frequency(MHz) : 2200
L1Cache(KB) : 768
L2Cache(KB) : 12288
L3Cache(KB) : 16896
[Status]
Health : OK
State : Enabled
----------------------------------------------------------------------

Example 2

Run the getcpu -S 0 command to query the information about the CPU in the specified slot.
Returned result:

----------------------------------------------------------------------
Command: getcpu Result: Success
----------------------------------------------------------------------
Id : 0
Name : Intel Processor 0
Slot : 0
SerialNumber : 57F26AC68929C290
Model : Intel(R) Xeon(R) Silver 4214 CPU @2.20GHz
InstructionSet : x86-64
ProcessorArchitecture : x86
Manufacturer : Intel(R) Corporation
TotalCores : 12
TotalThreads : 24
MaxFrequency(MHz) : 3200
Frequency(MHz) : 2200
L1Cache(KB) : 768
L2Cache(KB) : 12288
L3Cache(KB) : 16896
[Status]
Health : OK
State : Enabled
----------------------------------------------------------------------

Output Descriptions

Output Item Description

Name Name of the CPU collection.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 19

ZTE Server BMC CLI Interface Description (BMC V4)

Output Item Description

CPUCount Number of current CPUs.

CPUs CPU collection.

Id CPU ID.

Name Name of the CPU.

Slot CPU slot.

SerialNumber CPU SN.

Model CPU model.

InstructionSet CPU instruction set.

ProcessorArchitecture CPU architecture.

Manufacturer CPU manufacturer.

TotalCores Total number of CPU cores.

TotalThreads Total number of CPU threads.

MaxFrequency(MHz) Maximum boost frequency of the CPU.

Frequency(MHz) Base clock frequency of the CPU.

L1Cache(KB) L1 cache of the CPU.

L2Cache(KB) L2 cache of the CPU.

L3Cache(KB) L3 cache of the CPU.

Status CPU status collection.

Health CPU health status.

State Whether the CPU is isolated.

2.3.5 Query Memory Information

Function

This command queries memory information.

Syntax

getmemory [-D DEVICELOCATOR]

20 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Parameters

Parameter Description Setting

DEVICELOCATOR Silk-screen number of the memory, -

optional.

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 For the getmemory command, if no option is provided, this command shows information
about all memory modules. If a memory silkscreen number is provided, this command
shows information about the memory module corresponding to the specified silkscreen
number.
 The silkscreen number of a memory module must be provided after -D. If the silkscreen
number does not correspond to any memory module, the command will fail.

Examples

Example 1

To query all memory information, run the getmemory command.

Returned result:

----------------------------------------------------------------------
Command: getmemory Result: Success
----------------------------------------------------------------------
Name : Memory Collection
MemoryCount : 2
[Memorys]
Id : CPU0_B0
Name : CPU0_B0
DeviceLocator : CPU0_B0
[MemoryLocation]
Slot : 0
Channel : 0
Controller : 3
Socket : 0
SerialNumber : 802C0622473CC5868C
MemoryDeviceType : DDR5
BaseModuleType : RDIMM
Manufacturer : Micron
Capacity(MB) : 32768
ECCType : Multi-bit ECC
OperatingSpeed(Mhz) : 4800
PartNumber : MTC20F2085S1RC48BA1

SJ-20230907115354-012 | 2025-07-21 (R1.1) 21

ZTE Server BMC CLI Interface Description (BMC V4)

[Status]
Health : OK
State : Enabled

Id : CPU0_D0
Name : CPU0_D0
DeviceLocator : CPU0_D0
[MemoryLocation]
Slot : 1
Channel : 0
Controller : 7
Socket : 0
SerialNumber : 802C0622483CE6814E
MemoryDeviceType : DDR5
BaseModuleType : RDIMM
Manufacturer : Micron
Capacity(MB) : 32768
ECCType : Multi-bit ECC
OperatingSpeed(Mhz) : 4800
PartNumber : MTC20F2085S1RC48BA1
[Status]
Health : OK
State : Enabled
----------------------------------------------------------------------

Example 2

To query information about the memory module in the specified slot, run the getmemory-D
CPU0_B0 command.
Returned result:

----------------------------------------------------------------------
Command: getmemory Result: Success
----------------------------------------------------------------------
Id : CPU0_B0
Name : CPU0_B0
DeviceLocator : CPU0_B0
[MemoryLocation]
Slot : 0
Channel : 0
Controller : 3
Socket : 0
SerialNumber : 802C0622473CC5868C
MemoryDeviceType : DDR5
BaseModuleType : RDIMM

22 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Manufacturer : Micron
Capacity(MB) : 32768
ECCType : Multi-bit ECC
OperatingSpeed(Mhz) : 4800
PartNumber : MTC20F2085S1RC48BA1
[Status]
Health : OK
State : Enabled
----------------------------------------------------------------------

Output Descriptions

Output Item Description

Name Name of the memory module collection.

MemoryCount Number of memory modules.

Memorys Memory module collection.

Id ID of the memory module.

Name Name of the memory module.

DeviceLocator Silkscreen number of the memory module.

MemoryLocation Location of the memory module.

Slot Slot ID of the memory module.

Channel Channel number of the memory module.

Controller Controller ID of the memory module.

Socket Slot number of the CPU that the memory module belongs to.

SerialNumber Serial number of the memory module.

MemoryDeviceType Memory type.

BaseModuleType Memory module type.

Manufacturer Memory manufacturer.

Capacity(MB) Capacity of the memory module.

ECCType ECC type of the memory module.

OperatingSpeed(Mhz) Operating speed of the memory module.

PartNumber Part number of the memory module.

Status Status information about the memory module.

Health Health status of the memory module.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 23

ZTE Server BMC CLI Interface Description (BMC V4)

Output Item Description

State Whether the memory module is enabled.

2.3.6 Querying Product Health Status

Function

This command queries product health status.

Syntax

gethealth

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the gethealth command.

Returned result:

----------------------------------------------------------------------
Command: gethealth Result: Success
----------------------------------------------------------------------
System : Critical
----------------------------------------------------------------------

Output Descriptions

Output Item Description

System Product health status.

2.3.7 Query Host Name

Function

This command queries host name.

Syntax

gethostname

24 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the gethostname command.

Returned result:

----------------------------------------------------------------------
Command: gethostname Result: Success
----------------------------------------------------------------------
HostName : iSAC-20221022
----------------------------------------------------------------------

Output Descriptions

Output Item Description

HostName Host name.

2.3.8 Set Host Name

Function

This command sets a host name for the product.

Syntax

sethostname -HN HOSTNAME

Parameters

Parameter Description Setting

HOSTNAME Host name, required. String of 1–255 characters.

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

Examples

Run the sethostname -HN isac-test command.

Returned result:

----------------------------------------------------------------------

SJ-20230907115354-012 | 2025-07-21 (R1.1) 25

ZTE Server BMC CLI Interface Description (BMC V4)

Command: sethostname Result: Success

----------------------------------------------------------------------
Set host name successfully.
----------------------------------------------------------------------

Output Descriptions

None.

2.4 Chassis-Related Commands

2.4.1 Query NIC Information
Function

This command queries NIC information.

Syntax

getnic [--slot NICSLOT] [--id NICPORTID]

Parameters

Parameter Description Setting

NICSLOT NIC slot ID. This parameter is -

optional.

NICPORTID NIC port number. This parameter is -

optional.

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 If no option is specified with the getnic command, this command shows information about
all NICs.
 If --slot is used with the getnic command to specify the slot ID of a NIC, this command
shows information about the NIC in the specified slot.
 If --id is used with the getnic command to specify the port number of a NIC, this command
shows information about the specified port on the NIC in the specified slot.
 If --id is used to query NIC information, --slot is required. Otherwise, this command
shows all NIC information.
 If the specified slot ID (--slot) or port number (--id) does not exist, and a NIC is present,
this command fails and an error is returned.
 If no NIC is configured for the device, this command will return an empty dataset, regardless
of the input parameters.

26 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Examples

Example 1

Run the getnic command to query information about all NICs.

Returned result:

---------------------------------------------------------
Command: getnic Result: Success
---------------------------------------------------------
Name : Network Adapters Collection
NetworkAdaptersCount : 1
[NetworkAdapters]
Id : mainboardPCIeCard9
CardName : mainboardPCIeCard9
SerialNumber : 750087700021
[Status]
Health : OK
State : Enabled
CardManufacturer : ZTE
CardModel : 2*25GE
CardType : fiber
ChipManufacturer : Mellanox
ChipModel : ConnectX-4 Lx
FirmwarePackageVersion : 14.32.1010
DriverVersion : null
DeviceLocator : mainboardPCIeCard9
SlotNumber : 9
CurrentTmp : 45
FpgaStatus : N/A
HistoryMaxTemperature : N/A
NetworkTechnology : ['Ethernet']
RootBDF : 0007:00:00.0
NicMemory : N/A
[NetworkPorts]
Id : 1
Name : 1
LinkStatus : Down
MAC Address : ['30:b9:30:0c:64:f6']
PhysicalPortNumber : 1
BDF : 0007:01:00.0
PortType : OpticalPort
CurrentSpeed : null
PortMaxSpeed : 25000Mb/s
SupportSpeed : ['1000Mb/s', '10000Mb/s', '25000Mb/s']

SJ-20230907115354-012 | 2025-07-21 (R1.1) 27

ZTE Server BMC CLI Interface Description (BMC V4)

[LldpService]
ServiceEnabled : True
LldpEnabled : True
WorkMode : TxRx
FirmwarePackageVersion : 14.32.1010
DriverVersion : null

Id : 2
Name : 2
LinkStatus : Down
MAC Address : ['30:b9:30:0c:64:f7']
PhysicalPortNumber : 2
BDF : 0007:01:00.1
PortType : OpticalPort
CurrentSpeed : null
PortMaxSpeed : 25000Mb/s
SupportSpeed : ['1000Mb/s', '10000Mb/s', '25000Mb/s']
[LldpService]
ServiceEnabled : True
LldpEnabled : True
WorkMode : TxRx
FirmwarePackageVersion : 14.32.1010
DriverVersion : null
--------------------------------------------------------

Example 2

Run the getnic --slot 9 command to query information about the NIC in the specified slot.
Returned result:

---------------------------------------------------------
Command: getnic Result: Success
---------------------------------------------------------
Id : mainboardPCIeCard9
CardName : mainboardPCIeCard9
SerialNumber : 750087700021
[Status]
Health : OK
State : Enabled
CardManufacturer : ZTE
CardModel : 2*25GE
CardType : fiber
ChipManufacturer : Mellanox
ChipModel : ConnectX-4 Lx
FirmwarePackageVersion : 14.32.1010

28 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

DriverVersion : null
DeviceLocator : mainboardPCIeCard9
SlotNumber : 9
CurrentTmp : 45
FpgaStatus : N/A
HistoryMaxTemperature : N/A
NetworkTechnology : ['Ethernet']
RootBDF : 0007:00:00.0
NicMemory : N/A
[NetworkPorts]
Id : 1
Name : 1
LinkStatus : Down
MAC Address : ['30:b9:30:0c:64:f6']
PhysicalPortNumber : 1
BDF : 0007:01:00.0
PortType : OpticalPort
CurrentSpeed : null
PortMaxSpeed : 25000Mb/s
SupportSpeed : ['1000Mb/s', '10000Mb/s', '25000Mb/s']
[LldpService]
ServiceEnabled : True
LldpEnabled : True
WorkMode : TxRx
FirmwarePackageVersion : 14.32.1010
DriverVersion : null

Id : 2
Name : 2
LinkStatus : Down
MAC Address : ['30:b9:30:0c:64:f7']
PhysicalPortNumber : 2
BDF : 0007:01:00.1
PortType : OpticalPort
CurrentSpeed : null
PortMaxSpeed : 25000Mb/s
SupportSpeed : ['1000Mb/s', '10000Mb/s', '25000Mb/s']
[LldpService]
ServiceEnabled : True
LldpEnabled : True
WorkMode : TxRx
FirmwarePackageVersion : 14.32.1010
DriverVersion : null
--------------------------------------------------------

SJ-20230907115354-012 | 2025-07-21 (R1.1) 29

ZTE Server BMC CLI Interface Description (BMC V4)

Example 3

Run the getnic --slot 9 --id 1 command to query the information about the port of the specified
NIC.
Returned result:

---------------------------------------------------------
Command: getnic Result: Success
---------------------------------------------------------
Id : 1
Name : 1
LinkStatus : Down
MAC Address : ['30:b9:30:0c:64:f6']
PhysicalPortNumber : 1
BDF : 0007:01:00.0
PortType : OpticalPort
CurrentSpeed : null
PortMaxSpeed : 25000Mb/s
SupportSpeed : ['1000Mb/s', '10000Mb/s', '25000Mb/s']
[LldpService]
ServiceEnabled : True
LldpEnabled : True
WorkMode : TxRx
FirmwarePackageVersion : 14.32.1010
DriverVersion : null
--------------------------------------------------------

Output Descriptions

Output Item Description

Name Name of the NIC collection.

NetworkAdaptersCount Current number of NICs.

NetworkAdapters NIC collection.

Id NIC ID.

CardName NIC name.

SerialNumber Serial number of the NIC.

Status NIC status.

Health NIC health status.

State Whether the NIC is enabled.

CardManufacturer NIC manufacturer.

30 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Output Item Description

CardModel NIC interface mode.

CardType NIC type.

ChipManufacturer NIC chip manufacturer.

ChipModel NIC chip model.

FirmwarePackageVersion Firmware version number of the NIC.

DriverVersion Driver version of the NIC.

DeviceLocator Silkscreen number of the NIC.

SlotNumber Slot number of the NIC.

ConfigFpgaTemperature Alarm temperature of the NIC.

CurrentFpgaTemperature Main chip temperature of the NIC.

FpgaStatus FPGA status of the NIC. Values:

 0: normal
 1: abnormal

HistoryMaxTemperature Maximum historical temperature of the NIC.

NetworkTechnology Network protocol for the NIC: Ethernet.

RootBDF Root port BDF of the NIC.

NicMemory Memory information set of the NIC (N/A displayed for non-FPGA
cards).

CapacityGb Memory capacity of the NIC (displayed only for FPGA cards).

Model Memory model of the NIC (displayed only for FPGA cards).

Status Memory status of the NIC (displayed only for FPGA cards).
Values:
 0: normal
 1: abnormal

NetworkPorts Information about NIC ports

Id Port ID.

Name Port name.

LinkStatus Port status, including Up and Down.

MAC Address MAC address of the port.

PhysicalPortNumber Physical silkscreen number of the port.

BDF Port BDF.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 31

ZTE Server BMC CLI Interface Description (BMC V4)

Output Item Description

PortType Port type. Values:

 OpticalPort: optical port.
 ElectricalPort: electrical port.
 N/A: unknown.

CurrentSpeed Current speed of the port, unit: Mb/s.

PortMaxSpeed Maximum speed of the port, unit: Mb/s.

SupportSpeed Supported speed of the port, unit: Mb/s.

LldpService LLDP service configuration.

ServiceEnabled Whether the specified network port supports LLDP information

query. Values:
 True: LLDP query is supported.
 False: LLDP query is not supported.
If this option is set to False, only the default values of
LldpEnabled and WorkMode are displayed, providing no
meaningful information.

LldpEnabled Whether LLDP is enabled on the port. Values:

 True: enabled
 False: disabled

WorkMode LLDP operating mode.

FirmwarePackageVersion Firmware version of the port.

DriverVersion Driver version of the port.

2.4.2 Query FC Card Information

Function

This command queries FC card information.

Syntax

getfc [--slot FCSLOT] [--id NETWORKPORTID]

Parameters

Parameter Description Setting

FCSLOT FC card slot ID. This parameter is -

optional.

NETWORKPORTID FC card port number. This -

parameter is optional.

32 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 If no parameter is specified after getfc, the information about all FC cards is displayed.
 If --slot is used to specify an FC card slot ID after getfc, the information about the
specified FC card is displayed.
 If --id is used to specify a FC card port number after getfc, the information about the
specified port on the specified FC card is displayed.
 If --id is used to query FC card information, --slot is required. Otherwise, this command
shows information about all FC cards.
 If the specified slot ID (--slot) or port number (--id) does not exist, this command fails
and an error is returned.
 If no FC is configured for the device, this command will return an empty dataset, regardless
of the input parameters.

Examples

Example 1

To query the information about all FC cards, run the getfc command.
Returned result:

---------------------------------------------------------
Command: getfc Result: Success
---------------------------------------------------------
Name : FC Cards Collection
FCCardsCount : 1
[FCCards]
Id : mainboardFCCard5
CardName : mainboardFCCard5
SerialNumber : null
[Status]
Health : OK
State : Enabled
CardManufacturer : Emulex
CardModel : 2*32GE
CardType : fiber
ChipManufacturer : Emulex
ChipModel : Lancer G6
FirmwarePackageVersion : null
DriverVersion : null
DeviceLocator : mainboardFCCard5
SlotNumber : 5

SJ-20230907115354-012 | 2025-07-21 (R1.1) 33

ZTE Server BMC CLI Interface Description (BMC V4)

CurrentTmp : null
FpgaStatus : N/A
HistoryMaxTemperature : None
NetworkTechnology : ['FC']
RootBDF : 0007:80:00.0
NicMemory : N/A
[NetworkPorts]
Id : 1
Name : 1
LinkStatus : null
MAC Address : [null, null]
PhysicalPortNumber : 1
BDF : 0007:81:00.0
PortType : OpticalPort
CurrentSpeed : null
PortMaxSpeed : 32000Mb/s
SupportSpeed : ['8000Mb/s', '16000Mb/s', '32000Mb/s']
[LldpService]
ServiceEnabled : False
LldpEnabled : False
WorkMode : null
FirmwarePackageVersion : null
DriverVersion : null

Id : 2
Name : 2
LinkStatus : null
MAC Address : [null, null]
PhysicalPortNumber : 2
BDF : 0007:81:00.0
PortType : OpticalPort
CurrentSpeed : null
PortMaxSpeed : 32000Mb/s
SupportSpeed : ['8000Mb/s', '16000Mb/s', '32000Mb/s']
[LldpService]
ServiceEnabled : False
LldpEnabled : False
WorkMode : null
FirmwarePackageVersion : null
DriverVersion : null
--------------------------------------------------------

Example 2

34 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

To query the information about the FC card in the specified slot, run the getfc--slot 5
command.
Returned result:

---------------------------------------------------------
Command: getfc Result: Success
---------------------------------------------------------
Id : mainboardFCCard5
CardName : mainboardFCCard5
SerialNumber : null
[Status]
Health : OK
State : Enabled
CardManufacturer : Emulex
CardModel : 2*32GE
CardType : fiber
ChipManufacturer : Emulex
ChipModel : Lancer G6
FirmwarePackageVersion : null
DriverVersion : null
DeviceLocator : mainboardPCIeCard5
SlotNumber : 5
CurrentTmp : null
FpgaStatus : N/A
HistoryMaxTemperature : N/A
NetworkTechnology : ['FC']
RootBDF : 0007:80:00.0
NicMemory : N/A
[NetworkPorts]
Id : 1
Name : 1
LinkStatus : null
MAC Address : [null, null]
PhysicalPortNumber : 1
BDF : 0007:81:00.0
PortType : OpticalPort
CurrentSpeed : null
PortMaxSpeed : 32000Mb/s
SupportSpeed : ['8000Mb/s', '16000Mb/s', '32000Mb/s']
[LldpService]
ServiceEnabled : False
LldpEnabled : False
WorkMode : null
FirmwarePackageVersion : null

SJ-20230907115354-012 | 2025-07-21 (R1.1) 35

ZTE Server BMC CLI Interface Description (BMC V4)

DriverVersion : null

Id : 2
Name : 2
LinkStatus : null
MAC Address : [null, null]
PhysicalPortNumber : 2
BDF : 0007:81:00.0
PortType : OpticalPort
CurrentSpeed : null
PortMaxSpeed : 32000Mb/s
SupportSpeed : ['8000Mb/s', '16000Mb/s', '32000Mb/s']
[LldpService]
ServiceEnabled : False
LldpEnabled : False
WorkMode : null
FirmwarePackageVersion : null
DriverVersion : null
--------------------------------------------------------

Output Descriptions

Output Item Description

Name Name of the FC card collection.

FCCardsCount Number of current FC cards.

FCCards FC cards.

Id ID of the FC card.

CardName Name of the FC card.

SerialNumber Serial number of the FC card.

Status Status of the FC card.

Health Health status of the FC card.

State Whether the FC card is enabled.

CardManufacturer FC card manufacturer.

CardModel Interface mode of the FC card.

CardType FC card type.

ChipManufacturer Chip manufacturer of the FC card.

ChipModel FC card chip model

FirmwarePackageVersion Firmware version of the FC card.

36 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Output Item Description

DriverVersion Driver version of the FC card.

DeviceLocator Silkscreen number of the FC card.

SlotNumber Slot number of the FC card.

CurrentTmp Alarm temperature of the FC card.

FpgaStatus FPGA status of the FC card. Values:

 0: normal
 1: abnormal

HistoryMaxTemperature Maximum historical temperature of the FC card.

NetworkTechnology Network protocol for the FC card: Ethernet.

RootBDF Root port BDF of the FC card.

NicMemory Memory information set of the FC card (N/A displayed for non-FPGA
cards).

CapacityGb Memory capacity of the FC card (displayed only for FPGA cards).

Model Memory model of the FC card (displayed only for FPGA cards).

Status Memory status of the FC card (displayed only for FPGA cards). Values:
 0: normal
 1: abnormal

NetworkPorts Port information about the FC card.

Id Port ID.

Name Port name.

LinkStatus Port status. Values:

 Up
 Down

MAC Address MAC address of the port.

PhysicalPortNumber Physical silkscreen number of the port.

BDF Port BDF.

PortType Port type. Values:

 OpticalPort: optical port.
 ElectricalPort: electrical port.
 N/A: unknown.

CurrentSpeed Current speed of the port, unit: Mb/s.

PortMaxSpeed Maximum speed of the port, unit: Mb/s.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 37

ZTE Server BMC CLI Interface Description (BMC V4)

Output Item Description

SupportSpeed Supported speed of the port, unit: Mb/s.

LldpService LLDP service configuration.

ServiceEnabled Whether the specified network port supports LLDP information query.
Values:
 True: LLDP query is supported.
 False: LLDP query is not supported.
If this option is set to False, only the default values of LldpEnabled and
WorkMode are displayed, providing no meaningful information.

LldpEnabled Whether LLDP is enabled on the port. Values:

 True: enabled
 False: disabled

WorkMode LLDP operating mode.

FirmwarePackageVersion Firmware version of the port.

DriverVersion Driver version of the port.

2.4.3 Query Hard Disk Information

Function

This command queries hard disk information.

Syntax

getpdisk [-S SLOT]

Parameters

Parameter Description Setting

SLOT Slot ID of the hard disk, optional. -

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 If no option is specified with the getpdisk command, this command shows information about
all hard disks.
 If a hard disk slot ID is specified with the getpdisk command, this command shows
information about the hard disk in the specified slot.
 The -S option specifies the ID of the slot where a hard disk is installed. If the specified slot
does not contain a configured hard disk, the input is considered invalid, and this command
fails to execute.

38 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Examples

Example 1

Run the getpdisk command to query all hard disks.

Returned result:

---------------------------------------------------------
Command: getpdisk Result: Success
---------------------------------------------------------
Name : Drivers Collection
DrivesCount : 2
[Drives]
Id : HDDPlaneDisk0
Name : Disk0
SlotNumber : 0
[DriveLocation]
Info : Disk0
InfoFormat : DeviceName
Capacity(Bytes) : 2147483647
CapableSpeed(Gbs) : 6
SerialNumber : S6KKNC0TB16293
Model : SAMSUNG MZ7L31T9HBLT-00B7C
MediaType : SSD
Manufacturer : SAMSUNG
Protocol : SATA
Revision : JXTC304Q
FailurePredicted : False
HotspareType : null
PartNumber : null
PredictedMediaLifeLeftPercent : 99
[Status]
Health : OK
State : Enabled

Id : HDDPlaneDisk1
Name : Disk1
SlotNumber : 1
[DriveLocation]
Info : Disk1
InfoFormat : DeviceName
Capacity(Bytes) : 2147483647
CapableSpeed(Gbs) : 6
SerialNumber : S6KKNC0TB22589
Model : SAMSUNG MZ7L31T9HBLT-00B7C

SJ-20230907115354-012 | 2025-07-21 (R1.1) 39

ZTE Server BMC CLI Interface Description (BMC V4)

MediaType : SSD
Manufacturer : SAMSUNG
Protocol : SATA
Revision : JXTC304Q
FailurePredicted : False
HotspareType : null
PartNumber : null
PredictedMediaLifeLeftPercent : 99
[Status]
Health : OK
State : Enabled
--------------------------------------------------------

Example 2

Run the getpdisk-S 0 command to query information about the hard disk in the specified slot.
Returned result:

---------------------------------------------------------
Command: getpdisk Result: Success
---------------------------------------------------------
Id : HDDPlaneDisk0
Name : Disk0
SlotNumber : 0
[DriveLocation]
Info : Disk0
InfoFormat : DeviceName
Capacity(Bytes) : 2147483647
CapableSpeed(Gbs) : 6
SerialNumber : S6KKNC0TB16293
Model : SAMSUNG MZ7L31T9HBLT-00B7C
MediaType : SSD
Manufacturer : SAMSUNG
Protocol : SATA
Revision : JXTC304Q
FailurePredicted : False
HotspareType : null
PartNumber : null
PredictedMediaLifeLeftPercent : 99
[Status]
Health : OK
State : Enabled
--------------------------------------------------------

40 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Output Descriptions

Output Item Description

Name Name of the hard disk collection.

DrivesCount Current number of hard disks.

Drives Hard disk collection.

Id ID of the hard disk.

Name Name of the hard disk.

SlotNumber Slot number of the hard disk.

DriveLocation Information about hard disk silkscreens.

Info Information about the hard disk silkscreen.

InfoFormat Hard disk silkscreen format.

Capacity(Bytes) Capacity of the hard disk.

CapableSpeed(Gbs) Maximum hard disk speed.

SerialNumber Serial number of the hard disk.

Model Hard disk model.

MediaType Media type of the hard disk.

Manufacturer Hard disk manufacturer.

Protocol Protocol that the hard disk complies with.

Revision Version information about the hard disk.

FailurePredicted Whether the hard disk has a predictive failure.

HotspareType Hot-spare status of the hard disk.

PartNumber Part number of the hard disk.

PredictedMediaLifeLeftPercent Remaining use life (in percentage) of the hard disk.

Status Status collection of the hard disk.

Health Health status of the hard disk.

State Whether the hard disk is enabled.

2.4.4 Query Power Supply Information

Function

This command queries power supply information.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 41

ZTE Server BMC CLI Interface Description (BMC V4)

Syntax

getpsu

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getpsu command.

Returned result:

---------------------------------------------------------
Command: getpsu Result: Success
---------------------------------------------------------
Name : Power
[PowerControl]
MemberId : 1
Name : Chassis Power Control
PowerConsumedWatts : 0
[PowerLimit]
LimitInWatts : null
PowerLimitEnable : False
LimitException : NoAction
PowerSuppliesCount : 2
[PowerSupplies]
MemberId : 1
Name : PSU1
SlotNumber : 1
SerialNumber : 22N094014197
Manufacturer : Great Wall
Model : CRPS1200D
PowerCapacityWatts : 1200
PowerSupplyType : null
LineInputVoltage : 0
FirmwareVersion : DC:1.03 PFC:1.01
[Status]
Health : Warning
State : Enabled

MemberId : 2

42 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Name : PSU2
SlotNumber : 2
SerialNumber : 22L080006492
Manufacturer : Great Wall
Model : CRPS1200D
PowerCapacityWatts : 1200
PowerSupplyType : AC
LineInputVoltage : 229
FirmwareVersion : DC:1.01 PFC:1.00
[Status]
Health : OK
State : Enabled
--------------------------------------------------------

Output Descriptions

Output Item Description

Name Name of the power supply collection.

PowerControl Information about power control.

MemberId ID of the power control unit.

Name Name of the power control unit.

PowerConsumedWatts Current power of the device.

PowerLimit Information about power capping.

LimitInWatts Server power limit.

PowerLimitEnable Whether power capping is enabled.

 True: enabled
 False: disabled

LimitException Action to take when the power limit is exceeded.

PowerSuppliesCount Current number of power supplies.

PowerSupplies Information about power supplies.

MemberId PSU ID.

Name PSU name.

SlotNumber Slot number of the PSU.

SerialNumber Serial number of the PSU.

Manufacturer PSU manufacturer.

Model PSU model.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 43

ZTE Server BMC CLI Interface Description (BMC V4)

Output Item Description

PowerCapacityWatts Rated power of the PSU.

PowerSupplyType Power supply type of the PSU.

LineInputVoltage Input voltage of the PSU.

FirmwareVersion Firmware version of the PSU.

Status Status information about the PSU.

Health Health status of the PSU.

State Whether the PSU is enabled.

2.4.5 Query Power Consumption Information

Function

This command queries power consumption information.

Syntax

getpower

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getpower command.

Returned result:

---------------------------------------------------------
Command: getpower Result: Success
---------------------------------------------------------
PowerConsumedWatts : 227
CurrentCPUPowerWatts : 42
CurrentFanPowerWatts : 24
CurrentMemoryPowerWatts : 6
CurrentHDDPowerWatts : 28
--------------------------------------------------------

44 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Output Descriptions

Output Item Description

PowerConsumedWatts Current power of the device.

CurrentCPUPowerWatts Current power consumption of the CPUs.

CurrentFanPowerWatts Current power consumption of the fans.

CurrentMemoryPowerWatts Current power consumption of the memory.

CurrentHDDPowerWatts Current power consumption of the hard disks.

2.4.6 Query Heat Dissipation Mode

Function

This command queries the heat dissipation mode configuration.

Syntax

getfanmode

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getfanmode command.

Returned result:

----------------------------------------------------
Command: getfanmode Result: Success
----------------------------------------------------
FanSpeedAdjustmentMode : Manual
FanSmartCoolingMode : N/A
FanSpeedRatio : 40
----------------------------------------------------

Output Descriptions

Output Item Description

FanSpeedAdjustmentMode Fan speed regulation mode. Values:

 Automatic

SJ-20230907115354-012 | 2025-07-21 (R1.1) 45

ZTE Server BMC CLI Interface Description (BMC V4)

Output Item Description

 Manual

FanSmartCoolingMode Smart fan speed regulation mode. Values:

 NormalMode: balance mode.
 LowNoiseMode: low noise mode.
 HighPerformanceMode: high-performance mode.
Note: If the value of the FanSpeedAdjustmentMode
parameter is Manual, the value of this parameter is N/A by
default.

FanSpeedRatio Fan rotation speed percentage

Note: If the value of the FanSpeedAdjustmentMode
parameter is Automatic, the value of this parameter is N/A by
default.

2.4.7 Set Heat Dissipation Mode

Function

This command sets the heat dissipation mode.

Syntax

setfanmode -FAM FANSPEEDADJUSTMENTMODE [-FSM FANSMARTCOOLINGMODE] [-

FSR FANSPEEDRATIO]

Parameters

Parameter Description Setting

FANSPEEDADJUSTMENTMODE Fan speed regulation mode,  Automatic

required.  Manual

FANSMARTCOOLINGMODE Smart fan speed regulation mode,  NormalMode: balance mode

optional.  LowNoiseMode: low noise
mode
 HighPerformanceMode: high-
performance mode

FANSPEEDRATIO Fan rotation speed percentage, Range: 10–100.

optional.

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 When configuring the heat dissipation mode, you must set -FAM. Otherwise, the input is
considered invalid, and the command will fail.

46 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

 If -FAM is set to Automatic, -FSM is required. Otherwise, the input is considered invalid,
and -FSR becomes invalid.
 If -FAM is set to Manual, -FSR is required. Otherwise, the input is considered invalid, and -
FSM becomes invalid.

Examples

Run the setfanmode -FAM Automatic -FSM NormalMode command.

Returned result:

----------------------------------------------------------------------
Command: setfanmode Result: Success
----------------------------------------------------------------------
Set fan mode successfully.
----------------------------------------------------------------------

Output Descriptions

None.

2.4.8 Query Power Restoration Policy

Function

This command queries the power restoration policy.

Syntax

getpowerrestorepolicy

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getpowerrestorepolicy command.

Returned result:

---------------------------------------------------------
Command: getpowerrestorepolicy Result: Success
---------------------------------------------------------
PowerRestorePolicy : RestorePreviousState

SJ-20230907115354-012 | 2025-07-21 (R1.1) 47

ZTE Server BMC CLI Interface Description (BMC V4)

---------------------------------------------------------

Output Descriptions

Output Item Description

PowerRestorePolicy Power restoration policy. Values:

 TurnOn: powers on.
 StayOff: stays off.
 RestorePreviousState: restores the state before
power-off.

2.4.9 Set Power Restoration Policy

Function

This command configures a power restoration policy.

Syntax

setpowerrestorepolicy -RP POWERONSTRATEGY

Parameters

Parameter Description Setting

POWERONSTRATEGY Power restoration policy, required.  TurnOn: powers on.

 StayOff: stays off.
 RestorePreviousState: restores
the state before power-off.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the setpowerrestorepolicy -RP TurnOn command.

Returned result:

----------------------------------------------------------------------
Command: setpowerrestorepolicy Result: Success
----------------------------------------------------------------------
Set power restore policy successfully.
----------------------------------------------------------------------

Output Descriptions

None.

48 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

2.4.10 Query Power Redundancy Mode

Function

This command queries the power redundancy mode.

Syntax

getpowerredun

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getpowerredun command.

Returned result:

--------------------------------------------------------
Command: getpowerredun Result: Success
--------------------------------------------------------
RedundancyMode : Sharing
ActivePSUs : ['1','2']
--------------------------------------------------------

Output Descriptions

Output Item Description

RedundancyMode Power redundancy mode. Values:

 Sharing
 Failover

ActivePSUs ID list of current active PSUs.

2.4.11 Query System Boot Mode

Function

This command queries the system boot mode.

Syntax

getsysboot

SJ-20230907115354-012 | 2025-07-21 (R1.1) 49

ZTE Server BMC CLI Interface Description (BMC V4)

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getsysboot command.

Returned result:

----------------------------------------------------------------------
Command: getsysboot Result: Success
----------------------------------------------------------------------
SystemBootMode : Hdd
SystemBootModeOptions : ['None', 'Pxe', 'Cd', 'Floppy', 'Hdd', 'BiosSetup',
'RemotelyHdd']
SystemBootEffectiveMode : Continuous
BootEffectiveModeOptions : ['Once', 'Continuous']
----------------------------------------------------------------------

Output Descriptions

Output Item Description

SystemBootMode Current system boot mode.

SystemBootModeOptions Supported system boot modes. Values:

 None
 Pxe
 Cd
 Floppy
 Hdd
 BiosSetup
 RemotelyHdd

SystemBootEffectiveMode Current method for applying the system boot mode.

BootEffectiveModeOptions Supported methods for applying the system boot mode.

Values:
 Once: effective only once
 Continuous: effective permanently

50 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

2.4.12 Query Fan Sensor Information

Function

This command displays fan sensor information.

Syntax

getfan

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getfan command.

Returned result:

----------------------------------------------------------------------
Command: getfan Result: Success
----------------------------------------------------------------------
Name : Fans Collection
FansCount : 1
[Fans]
Id : 1
Name : FAN_SPEED_01
SlotNumber : 1
SpeedRatio : 40
SerialNumber : 20150305
Reading : 6000
MinReadingRange : 1000
MaxReadingRange : 16500
ReadingUnits : RPM
LowerThresholdNonCritical : null
LowerThresholdCritical : 1000
LowerThresholdFatal : null
UpperThresholdNonCritical : null
UpperThresholdCritical : 16500
UpperThresholdFatal : null
[Status]
Health : OK
State : Enabled

SJ-20230907115354-012 | 2025-07-21 (R1.1) 51

ZTE Server BMC CLI Interface Description (BMC V4)

----------------------------------------------------------------------

Output Descriptions

Output Item Description

Name Name of the fan sensor collection.

FansCount Number of fans.

Fans Information about fan sensors.

Id Fan sensor ID.

Name Fan sensor name.

SlotNumber Slot ID of the fan sensor.

SpeedRatio Rotation speed percentage of the fan sensor.

SerialNumber Serial number of the fan sensor.

Reading Current reading of the fan sensor.

MinReadingRange Minimum readable rotation speed for the fan sensor.

MaxReadingRange Maximum readable rotation speed for the fan sensor.

ReadingUnits Unit of the fan rotation speed reading for the fan sensor.

LowerThresholdNonCritical Minor-alarm threshold for low-speed rotation of the fan sensor.

LowerThresholdCritical Major-alarm threshold for low-speed rotation of the fan sensor.

LowerThresholdFatal Critical-alarm threshold for low-speed rotation of the fan sensor.

UpperThresholdNonCritical Minor-alarm threshold for high-speed rotation of the fan sensor.

UpperThresholdCritical Major-alarm threshold for high-speed rotation of the fan sensor.

UpperThresholdFatal Critical-alarm threshold for high-speed rotation of the fan sensor.

Status Status information about the fan sensor.

Health Health status of the fan sensor.

State Whether the fan sensor is enabled.

2.4.13 Query Temperature Sensor Information

Function

This command displays temperature sensor information.

Syntax

gettemp

52 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the gettemp command.

Returned result:

----------------------------------------------------------------------
Command: gettemp Result: Success
----------------------------------------------------------------------
Name : Temperature Sensors Collection
TemperatureSensorsCount : 1
[TemperatureSensors]
Name : INPUT_TEMP
SensorNumber : 15
MinReadingTemperature : -128
MaxReadingTemperature : 127
ReadingCelsius : 29
PhysicalContext : Intake
LowerThresholdNonCritical : null
LowerThresholdCritical : null
LowerThresholdFatal : null
UpperThresholdNonCritical : 40
UpperThresholdCritical : 45
UpperThresholdFatal : 52
[Status]
Health : OK
State : Enabled
----------------------------------------------------------------------

Output Descriptions

Output Item Description

Name Name of the temperature sensor collection.

TemperatureSensorsCount Number of temperature sensors.

TemperatureSensors Information about temperature sensors.

Name Temperature sensor name.

SensorNumber Serial number of the temperature sensor.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 53

ZTE Server BMC CLI Interface Description (BMC V4)

Output Item Description

MinReadingTemperature Minimum readable temperature for the temperature

sensor.

MaxReadingTemperature Maximum readable temperature for the temperature

sensor.

ReadingCelsius Current reading of the temperature sensor.

PhysicalContext Area or device to which the temperature

measurement applies.

LowerThresholdNonCritical Minor-alarm threshold for low temperature of the

temperature sensor.

LowerThresholdCritical Major-alarm threshold for low temperature of the

temperature sensor.

LowerThresholdFatal Critical-alarm threshold for low temperature of the

temperature sensor.

UpperThresholdNonCritical Minor-alarm threshold for high temperature of the

temperature sensor.

UpperThresholdCritical Major-alarm threshold for high temperature of the

temperature sensor.

UpperThresholdFatal Critical-alarm threshold for high temperature of the

temperature sensor.

Status Status information about the temperature sensor.

Health Health status of the temperature sensor.

State Whether the temperature sensor is enabled.

2.5 AccountService-Related Commands

2.5.1 Set BMC Redfish Account Service

Function

This command sets the BMC Redfish account service.

Syntax

setaccountservice [-AFT AUTHENTICATIONFAILURETIMES] [-ALT

ACCOUNTLOCKOUTTIME] [-OE OSUSERMANAGEMENTENABLED]

54 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Parameters

Parameter Description Setting

AUTHENTICATIONFAILUR Maximum number of incorrect password Range: 0–10.

ETIMES attempts allowed (number of authorization
failures), optional.

ACCOUNTLOCKOUTTIME Time to wait before a user is locked due Range: 60–1800 seconds. The
to a login failure is automatically unlocked. value must be a multiple of 60.
Optional.

OSUSERMANAGEMENTEN Whether to enable user management on the  True: enables user

ABLED OS side. Optional. management on the OS
side.
 False: disables user
management on the OS
side.

Usage Guidelines

 BMC versions supported: V04.24.03.00 and later.

 When configuring the BMC user service, you must set at least one of -AFT, -ALT, and -OE.
Otherwise, the input is considered invalid, and the command will fail to execute.
 Both -AFT and -ALT must be configured together. Configuring only one will cause the
command to fail.

Examples

Run the setaccountservice -AFT 5 -ALT 180 -OE False command.

Returned result:

----------------------------------------------------------------------
Command: setaccountservice Result: Success
----------------------------------------------------------------------
Set account service successfully.
----------------------------------------------------------------------

Output Descriptions

None.

2.5.2 Query BMC Redfish Account Service Information

Function

This command queries information about the BMC Redfish account service.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 55

ZTE Server BMC CLI Interface Description (BMC V4)

Syntax

getaccountservice

Parameters

None.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Run the getaccountservice command.

Returned result:

---------------------------------------------------------
Command: getaccountservice Result: Success
---------------------------------------------------------
AccountAuthenticationFailureTimes : 3
AccountLockoutTime(s) : 600
MaxPasswordLength(bytes) : 20
MinPasswordLength(bytes) : 8
OSUserManagementEnabled : True
---------------------------------------------------------

Output Descriptions

Output Item Description

AccountAuthenticationFailureTimes Number of incorrect password attempts allowed. If the

number is exceeded, the account is locked.

AccountLockoutTime(s) Lockout duration after a login failure, unit: seconds.

MaxPasswordLength(bytes) Maximum password length.

MinPasswordLength(bytes) Minimum password length.

OSUserManagementEnabled Whether user management is enabled on the OS side.

2.5.3 Query BMC User Information

Function

This command queries BMC user information.

Syntax

getuser [-I USERID] [-UN USERNAME]

56 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Parameters

Parameter Description Setting

USERID ID of the BMC user, optional. Range: 1–16.

USERNAME Name of the BMC user, optional. -

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 For the getuser command, if no option is provided, this command shows information about
all BMC users.
 The -I option specifies a BMC user ID to output information about the specified BMC user.
The BMC user ID provided after -I must already exist. Otherwise, the input is considered
invalid, and this command will fail.
 The -UN option specifies a BMC username to output information about the specified BMC
user. The BMC username provided after -I must already exist. Otherwise, the input is
considered invalid, and this command will fail.
 Options -I and -UN are mutually exclusive. Only one can be specified at a time.

Examples

Example 1

To query information about all BMC users, run the getuser command.
Returned result:

---------------------------------------------------------
Command: getuser Result: Success
---------------------------------------------------------
AccountsCount : 3
[Accounts]
Id : 1
UserName : anonymous
Enabled : False
Role : Administrator
Locked : False

Id : 2
UserName : Administrator
Enabled : True
Role : Administrator
Locked : False

SJ-20230907115354-012 | 2025-07-21 (R1.1) 57

ZTE Server BMC CLI Interface Description (BMC V4)

Id : 3
UserName : test1
Enabled : True
Role : Administrator
Locked : False
--------------------------------------------------------

Example 2

To query information about a BMC user by specifying an ID, run the getuser -I 2 command.
Returned result:

---------------------------------------------------------
Command: getuser Result: Success
---------------------------------------------------------
Id : 2
UserName : Administrator
Enabled : True
Role : Administrator
Locked : False
--------------------------------------------------------

Example 3

To query information about a BMC user by specifying a username, run the getuser -UN
Administrator command.
Returned result:

---------------------------------------------------------
Command: getuser Result: Success
---------------------------------------------------------
Id : 2
UserName : Administrator
Enabled : True
Role : Administrator
Locked : False
--------------------------------------------------------

Output Descriptions

Output Item Description

AccountsCount Number of BMC users.

Accounts BMC users.

Id BMC user ID.

58 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Output Item Description

UserName BMC user name.

Enabled Whether the BMC user is enabled.

 True: enabled
 False: disabled

Role Role configured for the BMC user.

Locked Lock status of the BMC user. Values:

 True: locked
 False: unlocked

2.5.4 Set BMC User Information

Function

This command modifies a BMC user with the specified ID.

Syntax

setuser -I USERID [-UN USERNAME] [-UP USERPASSWORD] [-UR USERROLE] [-UE

USERENABLED] [-SA SNMPAUTHENTICATION] [-SP SNMPPRIVACY]

Parameters

Parameter Description Setting

USERID ID of the BMC user, required. Range: 2–16.

USERNAME New username of the user, String of 1–16 characters. Allowed

optional. characters include lowercase
letters (a – z), uppercase letters (
A – Z), digits (0 – 9), hyphens (-),
underscores (_), and At signs (@).
Letters are case-sensitive.

USERPASSWORD New password of the user, Set the password in accordance

optional. with the password policy set on the
BMC.

USERROLE New role of the user, optional.  Administrator: administrator

 Operator: operator
 User: common user
 OEM1: self-defined role 1
 OEM2: self-defined role 2
 OEM3: self-defined role 3
 OEM4: self-defined role 4

SJ-20230907115354-012 | 2025-07-21 (R1.1) 59

ZTE Server BMC CLI Interface Description (BMC V4)

Parameter Description Setting

USERENABLED Whether to enable the user,  True: enables the user.

optional.  False: disables the user.

SNMPAUTHENTICATION SNMPv3 authentication algorithm,  SHA

optional.  MD5
 SHA256
 SHA384
 SHA512

SNMPPRIVACY SNMPv3 encryption algorithm,  DES

optional.  AES

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 The -I option is required. You must enter an existing ID. If the ID does not exist, this
command fails.
 If the corresponding parameter does not meet the rule, an error is reported.

Examples

Run the setuser -I 8 -UN test8 -UP Abc12345! -UR User -UE True -SA SHA -SP DES
command.
Returned result:

----------------------------------------------------------------------
Command: setuser Result: Success
----------------------------------------------------------------------
Set bmc user account successfully.
----------------------------------------------------------------------

Output Descriptions

None.

2.5.5 Create BMC User

Function

This command creates a BMC user.

Syntax

adduser -UN USERNAME -UP USERPASSWORD -UR USERROLE [-UE USERENABLE] [-I
USERID]

60 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Parameters

Parameter Description Setting

USERNAME Name of the new user, required. The name is a string of 1–16
characters. Allowed characters
include lowercase letters (a – z),
uppercase letters (A – Z), digits (0
– 9), hyphens (-), underscores (_),
and At signs (@). Letters are case-
sensitive.

USERPASSWORD Password of the new user, If the strong-password policy is

required. configured, the specified password
must meet the policy. If no strong-
password policy is configured,
the specified password is a string
of 5–20 characters, excluding
spaces and tabs. Letters are case-
sensitive.

USERROLE Role of the new user, required.  Administrator: administrator

 Operator: operator
 User: common user
 OEM1: self-defined role 1
 OEM2: self-defined role 2
 OEM3: self-defined role 3
 OEM4: self-defined role 4

USERENABLE Whether to enable the new user.  True: enables the user.
This parameter is optional. (  False: disables the user.
Default: False.)

USERID ID of the new user. This parameter Range: 2–16.

is optional.

Usage Guidelines

 BMC versions supported: V04.24.03.00 and later.

 It is not allowed to set -UN to an existing username. Otherwise, the user will fail to be
created.
 A maximum of 15 BMC users (IDs 2 through 16) can be created. If the limit is reached, the
attempt to create a new BMC user will fail.
 The -I option is optional and allows you to specify a unique ID for the new BMC user. The
ID provided with -I must not conflict with any existing user IDs.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 61

ZTE Server BMC CLI Interface Description (BMC V4)

Examples

Run the adduser -UN zteroot60 -UP ztePublic1! -UR Administrator -UE True command.
Returned result:

----------------------------------------------------------------------
Command: adduser Result: Success
----------------------------------------------------------------------
Add bmc user account successfully.
----------------------------------------------------------------------

Output Descriptions

None.

2.5.6 Delete BMC User

Function

This command deletes a BMC user.

Syntax

deluser [-I USERID] [-UN USERNAME]

Parameters

Parameter Description Setting

USERID ID of the BMC user, optional. Range: 2–16.

USERNAME Username of the BMC user, -

optional.

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 The -I option is required. You must enter an existing ID. If the ID does not exist, this
command fails.
 You must enter an existing username with the -UN option. If the specified username does
not exist, the input is considered invalid, and this command fails.
 Options -I and -UN are mutually exclusive. Only one can be specified at a time.

Examples

Example 1

Run the deluser -I 10 command to delete a BMC user by specifying the ID.
Returned result:

62 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

----------------------------------------------------------------------
Command: deluser Result: Success
----------------------------------------------------------------------
Delete bmc user account successfully.
----------------------------------------------------------------------

Example 2

Run the deluser-UN A9-oper command to delete a BMC user by specifying the username.
Returned result:

----------------------------------------------------------------------
Command: deluser Result: Success
----------------------------------------------------------------------
Delete bmc user account successfully.
----------------------------------------------------------------------

Output Descriptions

None.

2.5.7 Query AD Configuration

Function

This command queries the Active Directory (AD) configuration.

Syntax

getad [-RI ROLEGROUPID]

Parameters

Parameter Description Setting

ROLEGROUPID AD role group ID. Range: 0–4.

Usage Guidelines

BMC versions supported: V04.24.02.00 and later.

Examples

Example 1

To query all AD configurations, run the getad command.

Returned result:

--------------------------------------------------------------
Command: getad Result: Success

SJ-20230907115354-012 | 2025-07-21 (R1.1) 63

ZTE Server BMC CLI Interface Description (BMC V4)

--------------------------------------------------------------
Name : Activedirectory
ADAuthenticationEnable : True
UserName : test
Password : null
UserDomain : mydomain.com
ADSSLEnable : True
DomainControllerServerAddress1 : 10.10.10.21
DomainControllerServerAddress2 : 10.10.10.22
DomainControllerServerAddress3 : 10.10.10.23
[ADRoleGroups]
GroupDomain : role1.com
GroupLoginInterface : ['KVM', 'VMedia']
GroupName : group1
GroupRole : Administrator
MemberId : 0

GroupDomain : role2.com
GroupLoginInterface : ['KVM', 'VMedia']
GroupName : group2
GroupRole : Operator
MemberId : 1

GroupDomain : role3.com
GroupLoginInterface : []
GroupName : group3
GroupRole : User
MemberId : 2

GroupDomain : role4.com
GroupLoginInterface : ['KVM', 'VMedia']
GroupName : group4
GroupRole : Administrator
MemberId : 3

GroupDomain : role5.com
GroupLoginInterface : ['KVM', 'VMedia']
GroupName : group5
GroupRole : Operator
MemberId : 4
--------------------------------------------------------------

Example 2

To query the AD configuration by specifying a role group ID, run the getad-RI 0 command.

64 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Returned result:

--------------------------------------------------------------
Command: getad Result: Success
--------------------------------------------------------------
GroupDomain : role1.com
GroupLoginInterface : ['KVM', 'VMedia']
GroupName : group1
GroupRole : Administrator
MemberId : 0
--------------------------------------------------------------

Output Descriptions

Output Item Description

Name Name of the AD configuration collection.

ADAuthenticationEnable Whether AD authentication is enabled.

UserName Username configured for AD authentication.

Password Password of the AD user.

UserDomain Domain name of the AD user.

ADSSLEnable Whether AD SSL encryption is enabled.

 True: enabled
 False: disabled

DomainControllerServerAddress1 Domain controller server address 1.

DomainControllerServerAddress2 Domain controller server address 2.

DomainControllerServerAddress3 Domain controller server address 3.

ADRoleGroups Role groups associated with the AD.

GroupDomain Domain name of the AD role group.

GroupLoginInterface Access permission of the AD role group.

GroupName Name of the AD role group.

GroupRole Role of the AD role group.

MemberId AD role group ID.

2.5.8 Set Active Directory

Function

This command sets the Active Directory (AD).

SJ-20230907115354-012 | 2025-07-21 (R1.1) 65

ZTE Server BMC CLI Interface Description (BMC V4)

Syntax

setad [-AE ADAUTHENTICATIONENABLE] [-UN USERNAME] [-UP USERPASSWORD]

[-UD USERDOMAINNAME] [-DCS1 DOMAINCONTROLLERSERVER1] [-DCS2
DOMAINCONTROLLERSERVER2] [-DCS3 DOMAINCONTROLLERSERVER3] [-SE
SSLENABLE] [-RI ROLEGROUPID] [-GN GROUPNAME] [-GD GROUPDOMAIN] [-GP
GROUPROLE] [-DR DELETEFLAG]

Parameters

Parameter Description Setting

ADAUTHENTICATIONENABLE Whether to enable AD  True: enables AD

authentication, optional. authentication.
 False: disables AD
authentication.

USERNAME AD username, optional. Enter a string of 1–64 characters.

Allowed characters include
lowercase letters (a–z), uppercase
letters (A–Z), digits (0–9), spaces
( ), hyphens (-), and underscores
(_). The string must begin with a
letter and is case-sensitive.

USERPASSWORD Password of the AD user, optional. Enter a string of 6–127 characters.

No space is allowed in the string.

USERDOMAINNAME Domain name to which the AD Enter a string of 3–255 characters,

user belongs, optional. which must comply with the
domain name specifications (
allowed special characters include
hyphens (-), underscores (_), and
dots (.). It must contain at least
one dot (.), and the last segment
consists of only letters.) Letters are
case-sensitive.

DOMAINCONTROLLERSERVER1 IP address of domain controller Both IPv4 and IPv6 address

server 1, optional. formats are supported. The first
segment of the IP address must
not be 0.

DOMAINCONTROLLERSERVER2 IP address of domain controller Both IPv4 and IPv6 address

server 2, optional. formats are supported. The first
segment of the IP address must
not be 0.

66 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Parameter Description Setting

DOMAINCONTROLLERSERVER3 IP address of domain controller Both IPv4 and IPv6 address

server 3, optional. formats are supported. The first
segment of the IP address must
not be 0.

SSLENABLE Whether to enable AD SSL  True: enables AD SSL

encryption, optional. encryption.
 False: disables AD SSL
encryption.

ROLEGROUPID ID of the AD role group, optional. Range: 0–4.

GROUPNAME Name of the AD role group, Enter a string of 1–64 characters.

optional. Allowed characters include digits,
letters, spaces, hyphens (-), and
underscores (_). It cannot begin
with a space. Letters are case-
sensitive.

GROUPDOMAIN Domain name of the AD role A string of 3–255 characters, which

group, optional. must comply with the domain name
specifications.

GROUPROLE Permissions of the AD role group,  Administrator: administrator

optional.  Operator: operator
 User: common user

DELETEFLAG Deletes the role group, optional. Flag parameter.

Usage Guidelines

 BMC versions supported: V04.24.04.00 and later.

 If you do not specify any option when you set the active directory, a success response will
be returned, but no configuration will be made, and no log will be recorded.
 The prerequisite for setting the general information or role group information is that the
ADAUTHENTICATIONENABLE parameter is set to True. If this parameter is set to False,
the configuration fails. (If the setting information contains the enabling field, this prerequisite
is not applicable.)
 The -RI, -GN, -GD, and -GP options are required for configuring an AD role group. If any of
them is not set, the configuration of the AD role group fails.
 The -DR option is a flag parameter, which indicates to delete a role group. It must be used
together with -RI.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 67

ZTE Server BMC CLI Interface Description (BMC V4)

 The role group name specified in -GN and the domain name specified in -GD must not
already exist. Using an existing role group or domain name may prevent the AD role group
from being configured correctly.
 The -UN and -UP options must be configured together if required.

Examples

Run the setad -AE True -UN ztead1 -UP ztePublic1! -UD ad1.zte.com -DCS1 10.10.20.21 -
DCS2 10.10.20.22 -DCS3 10.10.20.23 -RI 3 -GN role3 -GD role3.zte.com -GP Administrator
command.
Returned result:

----------------------------------------------------------------------
Command: setad Result: Success
----------------------------------------------------------------------
Set Active directory configuration successfully.
----------------------------------------------------------------------

Output Descriptions

None.

2.5.9 Query LDAP Configuration

Function

This command queries the LDAP configuration.

Syntax

getldap [-RI ROLEGROUPID]

Parameters

Parameter Description Setting

ROLEGROUPID LDAP role group ID. Range: 0–4.

Usage Guidelines

 BMC versions supported: V04.24.03.00 and later.

 If no option is provided with the getldap command, this command shows the general LDAP
configuration and information about all role groups.
 The -RI option specifies a role group ID. If a role group ID is provided, this command shows
information about the specified role group. The role group ID provided after -RI must already
exist. Otherwise, the input is considered invalid, and this command will fail.

68 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Examples

Example 1

To query all LDAP information, run the getldap command.

Returned result:

---------------------------------------------------------
Command: getldap Result: Success
---------------------------------------------------------
Name : LDAP
LDAPAuthenticationEnable : True
BindDN : cn=manager
Password : null
CommonNameType : FQDN
EncryptionType : NoEncryption
Port : 389
SearchBase : ou=login
ServerAddress : www.testldap.com
UserLoginAttribute : cn
[LDAPRoleGroups]
GroupDomain : cn=login
GroupLoginInterface : ['KVM', 'VMedia']
GroupName : ldap1
GroupRole : Administrator
MemberId : 0

GroupDomain : cn=domain
GroupLoginInterface : ['KVM', 'VMedia']
GroupName : ldap2
GroupRole : Operator
MemberId : 1

GroupDomain : cn=com
GroupLoginInterface : []
GroupName : ldap3
GroupRole : User
MemberId : 2

GroupDomain :
GroupLoginInterface : []
GroupName :
GroupRole : null
MemberId : 3

SJ-20230907115354-012 | 2025-07-21 (R1.1) 69

ZTE Server BMC CLI Interface Description (BMC V4)

GroupDomain :
GroupLoginInterface : []
GroupName :
GroupRole : null
MemberId : 4
----------------------------------------------------------------------

Example 2

To query information about the specified role group, run the getldap -RI 0 command.
Returned result:

---------------------------------------------------------
Command: getldap Result: Success
---------------------------------------------------------
GroupDomain : cn=login
GroupLoginInterface : ['KVM', 'VMedia']
GroupName : ldap1
GroupRole : Administrator
MemberId : 0
----------------------------------------------------------------------

Output Descriptions

Output Item Description

Name Name of the LDAP configuration collection.

ADAuthenticationEnable Whether LDAP authentication is enabled.

BindDN Bind distinguished name used to authenticate with the

LDAP server.

Password Password of the LDAP user (displayed as null by

default for data security).

CommonNameType Common name type in LDAP.

EncryptionType LDAP encryption type. Values:

 NoEncryption: no encryption
 SSL: SSL encryption
 StartTLS: StartTLS encryption

Port Port number.

SearchBase LDAP search base.

ServerAddress Address of the LDAP server.

UserLoginAttribute Attribute to use for user login.

70 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Output Item Description

LDAPRoleGroups Information about LDAP role groups.

GroupDomain Domain of the LDAP role group.

GroupLoginInterface Access permission of the LDAP role group (for

common users, the array is empty).

GroupName Name of the LDAP role group.

GroupRole Role assigned to the group. Values:

 Administrator: administrator
 Operator: operator
 User: common user

MemberId Role group ID, range: 0–4.

2.5.10 Set LDAP

Function

This command sets LDAP.

Syntax

setldap [-LE LDAPAUTHENTICATIONENABLE] [-PW PASSWORD] [-SA SERVERADDRESS]

[-PN PORTNUMBER] [-ET ENCRYPTIONTYPE] [-BD BINDDN] [-SB SEARCHBASE] [-UL
USERLOGINATTRIBUTE] [-RI ROLEGROUPID] [-GN GROUPNAME] [-GD GROUPDOMAIN]
[-GR GROUPROLE] [-DR DELETEFLAG]

Parameters

Parameter Description Setting

LDAPAUTHENTICATIONENABLE Whether to enable LDAP  True: enables LDAP

authentication, optional. authentication.
 False: disables LDAP
authentication.

PASSWORD LDAP password, optional. Enter a string of 1–47 characters,

excluding spaces.

SERVERADDRESS Address of the LDAP server, Enter an IPv4 address, IPv6

optional. address, or domain name.

PORTNUMBER Port number, optional. Range: 1–65535. Default: 389.

ENCRYPTIONTYPE LDAP encryption type, optional.  StartTLS: StartTLS encryption

 SSL: SSL encryption
 NoEncryption: no encryption

SJ-20230907115354-012 | 2025-07-21 (R1.1) 71

ZTE Server BMC CLI Interface Description (BMC V4)

Parameter Description Setting

BINDDN Bind distinguished name used to The bind distinguished name is

authenticate with the LDAP server, a string of 4–64 alphanumeric
optional. characters, starting with a letter
and is case-sensitive. Allowed
special characters include dots
(.), commas (,), hyphens (-),
underscores (_), and equal signs
(=), for example, cn=manager,
ou=login,dc=domain,dc=com.

SEARCHBASE LDAP search base, optional. Enter a string of 4–253

alphanumeric characters, starting
with a letter and is case-sensitive.
Allowed special characters include
dots (.), commas (,), hyphens (-),
underscores (_), and equal signs
(=), for example, ou=login,dc=
domain,dc=com.

USERLOGINATTRIBUTE Login attribute of the LDAP user,  uid

optional.  cn

ROLEGROUPID ID of the LDAP role group, Range: 0–4.

optional.

GROUPNAME Name of the LDAP role group, Enter a string of 1–64

optional. alphanumeric characters. Allowed
special characters include hyphens
(-), underscores (_), and spaces
( ). This string must not start with a
space. Letters are case-sensitive.

GROUPDOMAIN Domain name of the LDAP role Enter a string of 1–64

group, optional. alphanumeric characters, starting
with a letter and is case-sensitive.
Allowed special characters include
dots (.), commas (,), hyphens (-),
underscores (_), and equal signs
(=), for example, cn=manager,
ou=login, dc=domain,dc=
com.

GROUPROLE Permissions of the LDAP role  Administrator: administrator

group, optional. Options:  Operator: operator
 User: common user

72 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Parameter Description Setting

DELETEFLAG Deletes the role group, optional. Flag parameter.

Usage Guidelines

 BMC versions supported: V04.24.03.00 and later.

 If no LDAP is set in the current environment, all basic LDAP information needs to be
provided. In subsequent configurations, only the modified LDAP attributes need to be
provided.
 If no option is specified with the command, the command can still be executed successfully,
but no change will be made, and no log will be recorded.
 The -RI, -GN, -GD, and -GR options are required for configuring an LDAP role group. If any
of them is not set, the configuration of the LDAP role group fails.
 The -DR option is a flag parameter, indicating the deletion of a role group. Its value must be
NULL, and it needs to be used in conjunction with -RI.
 The -GD and -GN options have a relationship similar to that of a folder and a file. The
combination of -GD and -GN for different role groups must be unique. Otherwise, the LDAP
configuration for the specified role group may fail.

Examples

Run the setldap -LE True -PW test123 -SA 10.10.10.11 -PN 12001 -ET SSL -BD cn=
manager,ou=login,dc=domain,dc=com -SB ou=login,dc=domain,dc=com -UL cn
command.
Returned result:

----------------------------------------------------------------------
Command: setldap Result: Success
----------------------------------------------------------------------
Set LDAP configuration successfully.
----------------------------------------------------------------------

Output Descriptions

None.

2.6 UpdateService-Related Commands

2.6.1 Query Upgradeable Firmware Information
Function

This command queries information about upgradeable firmware.

SJ-20230907115354-012 | 2025-07-21 (R1.1) 73

ZTE Server BMC CLI Interface Description (BMC V4)

Syntax

getfw [-FW FIRMWARENAME]

Parameters

Parameter Description Setting

FIRMWARENAME Name of the upgradeable firmware, -

optional.

Usage Guidelines

 BMC versions supported: V04.24.02.00 and later.

 If no option is specified with the getfw command, this command shows information about all
upgradeable firmware.
 The -FW option specifies the name of a specific upgradeable firmware. If the name is
provided, this command shows information about the specified upgradeable firmware.

Examples

Example 1

To query information about all upgradeable firmware, run the getfw command.
Returned result:

---------------------------------------------------------
Command: getfw Result: Success
---------------------------------------------------------
[Firmwares]
Name : ActiveBMC
SoftwareId : ActiveBMC
Version : 04.25.01.20
Updateable : True
Health : OK
State : Enabled

Name : BackupBMC
SoftwareId : BackupBMC
Version : 04.23.02.00
Updateable : True
Health : OK
State : Enabled

Name : ActiveBIOS
SoftwareId : ActiveBIOS
Version : 31.24.03.00

74 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 2 Command Descriptions

Updateable : True
Health : OK
State : Enabled

Name : BackupBIOS
SoftwareId : BackupBIOS
Version : 31.24.04.00
Updateable : True
Health : OK
State : Enabled

Name : ActiveBOOT
SoftwareId : ActiveBOOT
Version : 04.22.02.07
Updateable : True
Health : OK
State : Enabled

Name : EPLD
SoftwareId : EPLD
Version : 00.00.00.0106
Updateable : True
Health : OK
State : Enabled

Name : MainBoardFRU
SoftwareId : MainBoardFRU
Version : 01.03.0002
Updateable : True
Health : OK
State : Enabled

Name : SubCardFRU9
SoftwareId : SubCardFRU9
Version : 01.03.0001
Updateable : True
Health : OK
State : Enabled

Name : ChassisPsu1
SoftwareId : ChassisPsu1
Version : DC:1.03 PFC:1.01
Updateable : False
Health : OK

SJ-20230907115354-012 | 2025-07-21 (R1.1) 75

ZTE Server BMC CLI Interface Description (BMC V4)

State : Enabled

Name : ChassisPsu2
SoftwareId : ChassisPsu2
Version : DC:1.03 PFC:1.01
Updateable : False
Health : OK
State : Enabled
--------------------------------------------------------

Example 2

To query information about a specific upgradeable firmware, run the getfw -FW ActiveBMC
command.
Returned result:

---------------------------------------------------------
Command: getfw Result: Success
---------------------------------------------------------
Name : ActiveBMC
SoftwareId : ActiveBMC
Version : 04.24.05.10
Updateable : True
Health : OK
State : Enabled
---------------------------------------------------------

Output Descriptions

Output Item Description

Firmwares Information about the upgradeable firmware collection.

Name Name of the upgradeable firmware.

SoftwareId Firmware ID.

Version Firmware version.

Updateable Whether the firmware is upgradeable. Values:

 True: enabled.
 False: disabled.

Health Health status of service resources involved in the upgrade.

State Whether the firmware is enabled.

76 SJ-20230907115354-012 | 2025-07-21 (R1.1)

 Glossary

BDF

- Bus/Device/Function

BMC

- Baseboard Management Controller

CLI

- Command Line Interface

CPU

- Central Processing Unit

DNS

- Domain Name Server

FC

- Fiber Channel

FPGA

- Field Programmable Gate Array

ID

- Identification

IP

- Internet Protocol

IPv6

- Internet Protocol Version 6

LDAP

- Lightweight Directory Access Protocol

LLDP

- Link Layer Discovery Protocol

SJ-20230907115354-012 | 2025-07-21 (R1.1) 77

 MAC

- Media Access Control

NTP

- Network Time Protocol

SNMP

- Simple Network Management Protocol

SSDP

- Simple Service Discovery Protocol

TCP

- Transmission Control Protocol

UDP

- User Datagram Protocol

UI

- User Interface

VNC

- Virtual Network Computing

78 SJ-20230907115354-012 | 2025-07-21 (R1.1)