Copyright © 2024新华三技术有限公司及其许可者 版权所有,保留一切权利。
未经本公司书面许可,任何单位和个人不得擅自摘抄、复制本书内容的部分或全部,并不得以任何形式传播。
除新华三技术有限公司的商标外,本手册中出现的其它公司的商标、产品标识及商品名称,由各自权利人拥有。
由于产品版本升级或其他原因,本手册内容有可能变更。H3C保留在没有任何通知或者提示的情况下对本手册的内容进行修改的权利。本手册仅作为使用指导,H3C尽全力在本手册中提供准确的信息,但是H3C并不确保手册内容完全没有错误,本手册中的所有陈述、信息和建议也不构成任何明示或暗示的担保。
hREST命令行工具使用Python语言开发,主要基于HTTPs协议和Redfish、RESTful和IPMI接口协议,是一款便于用户管理服务器的客户端工具。用户可通过本工具的查询、设置等命令对服务器进行管理。
本工具将Python运行基础包、Redfish源码以及程序运行所依赖外部包,放于同一个工程目录下,软件执行时可直接调用,可以做到免安装且无需环境配置。当前hREST工具支持Windows和Linux操作系统,且仅支持64位操作系统。
执行步骤如下:
(1) 工程文件hREST_Linux_Vx.xx.tar.gz(Windows版本对应hREST_Windows_Vx.xx.zip)包拷贝至系统目录下;
(2) 解压并进入工程目录hREST_Linux_Vx.xx或hREST_Windows_Vx.xx;
(3) 进入bin 文件夹;
(4) 输入命令 :./hREST –H ****** -U ****** -P ****** subcommand (Windows环境对应命令:hREST –H ****** -U ****** -P ****** subcommand);
(5) 回车执行命令。
带内驱动安装:
(1) 将与系统相匹配的带内驱动包(hdmdrv.ko)拷贝至系统下;
(2) 使用insmod hdmdrv.ko安装驱动;
(3) 驱动安装完成后,可通过lsmod | grep hdmdrv查看驱动是否安装成功;
(4) 也可通过rmmod hdmdrv.ko卸载驱动。
(5) 驱动文件可联系技术支持提供。
推荐HDM-1.30.15及其以上版本。部分功能对HDM版本有特殊要求,可查看使用指南中的命令说明。hREST无特殊说明仅支持通用版本HDM,如有特殊需求,请联系技术支持。
支持的Windows系统包括:
· Windows Server 2012 R2
· Windows 7
· Windows 10
支持的Linux系统包括:
· CentOS 6.2
· CentOS 7.3
· RedHat 9.0
其他操作系统或版本不保证工具可用,以实际为准。
hREST命令的通用格式为:
hREST -H host -p port -U username -P password <command>。
hREST命令参数区分大小写。
在执行hREST命令时,需要指定以下参数,此处统一说明。
· -H host:指定被管理设备的HDM IP地址。
· -p port:指定Redfish接口端口号,默认为“443”,为可选参数。
· -q ipmi_port:指定IPMI接口端口号,默认为“623”,为可选参数。
· -U username -P password:指定被管理设备的HDM用户名及其密码。如无特别说明,建议用户全部为Administrator权限,避免因权限不足导致的操作失败。
· <command>:关于<command>参数的说明,下文将详细介绍。
· 注意在命令行中应避免使用与操作系统相关的特殊字符组合,如无法避免建议命令使用“”(双引号)或者‘’(单引号)包含。
带内模式
hREST -p port <command>。
hREST命令参数区分大小写。带内模式需要功能支持(详见功能介绍),并且在使用带内模式前安装hdmdrv驱动,及通过带内命令开启USB通道。
· -p port:指定Redfish接口端口号,默认为“443”,为可选参数。
· -q ipmi_port:指定IPMI接口端口号,默认为“623”,为可选参数。
· 安装驱动:执行insmod hdmdrv.ko, 安装对应版本的hdmdrv驱动,驱动将随HDM版本一起发布。
· 开启USB通道:ipmitool raw 0x36 0x09 0xa2 0x63 0x00 0x1a 0x11 0x00,如无其他需要使用USB通道的情况,建议使用后关闭通道ipmitool raw 0x36 0x09 0xa2 0x63 0x00 0x1a 0x11 0x01,否则系统下会出现hdmdrv相关设备。
· 带内模式不支持并发调用。
· 安装带内驱动及使用带内模式建议系统下使用root用户,避免因权限不足导致的操作失败。
本手册适用于以下产品:
· AE100
· H3C UniServer B5700 G6
· H3C UniServer R4700 G6
· H3C UniServer R4700LE G6
· H3C UniServer R4900 G6
· H3C UniServer R4900 G6 Ultra
· H3C UniServer R4900LE G6
· H3C UniServer R4950 G6
· H3C UniServer R5300 G6
· H3C UniServer R5350 G6
· H3C UniServer R5500 G6
· H3C UniServer R6700 G6
· H3C UniServer R6900 G6
· H3C UniServer B5700 G5
· H3C UniServer R4300 G5
· H3C UniServer R4330 G5
· H3C UniServer R4330 G5 H3
· H3C UniServer R4700 G5
· H3C UniServer R4700LC G5
· H3C UniServer R4900 G5
· H3C UniServer R4900LC G5
· H3C UniServer R4930 G5
· H3C UniServer R4930 G5 H3
· H3C UniServer R4930LC G5 H3
· H3C UniServer R4950 G5
· H3C UniServer R5300 G5
· H3C UniServer R5500 G5
· H3C UniServer R5500LC G5
· H3C UniServer R6900 G5
· H3C UniServer B5700 G3
· H3C UniServer B5800 G3
· H3C UniServer B7800 G3
· H3C UniServer E3200 G3
· H3C UniServer R2700 G3
· H3C UniServer R2900 G3
· H3C UniServer R4100 G3
· H3C UniServer R4300 G3
· H3C UniServer R4500 G3
· H3C UniServer R4700 G3
· H3C UniServer R4900 G3
· H3C UniServer R4950 G3
· H3C UniServer R5300 G3
· H3C UniServer R6700 G3
· H3C UniServer R6900 G3
· H3C UniServer R8900 G3
· H3C UniStor X10000 G3
本命令用于获取工具帮助信息。
【命令】
hREST -h/--help
【参数】
表2-1 参数说明
参数 |
描述 |
-h/--help |
获取帮助信息 |
【举例】
# 获取工具帮助信息
-> hREST –h
usage: hREST [-h] [-V] [-H HOST] [-p PORT] [-q IPMI_PORT] [-U USERNAME]
[-P PASSWORD]
sub command ...
optional arguments:
-h, --help show this help message and exit
-V, --version show program's version number and exit
-H HOST domain name, IPv4 address,or [IPv6 address]
-p PORT port
-q IPMI_PORT ipmi_port
-U USERNAME local or LDAP username
-P PASSWORD password
sub commands:
sub command sub-command help
addaduser add ad user.
addldapuser add ldap user.
addldisk create logical disk.
adduser add user.
delelog delete event log.
closeinner close inner user setting.
getsdslog get sds log.
deladuser delete ad user.
delldapuser delete ldap user.
delldisk delete logical disk.
deluser delete user by username.
downloadconfig download configuration.
fwupdate fwupdate command.
getbios get BIOS information.
getbiossetting set pending bios setting.
getcpu get CPUs information.
getgpu get GPUs information.
getelog get event log.
getfan get fan information.
getfirewall get firewall status.
setfirewall set firewall status.
getfwv get firmware version.
gethdmlog get hdm log.
getsyshealth get system health state.
getip get ip information.
getvlan get vlan information.
getvncsession get vnc session info.
getldisk get logical drive information.
getloginruleip get ip login rule.
getmemory get memory information.
getnetmode get net mode.
getnic get nic information.
getntp get ntp information.
getnvmessd get nvme ssd information.
getpcie get pcie information.
getpdisk get physical disk information.
getpowerlimit get power limit.
getproductinfo get product information.
getpsu get power information.
getraid get raid information.
getrole get role information.
setrole set role rivileges.
getscreencapture
get virtual media information.
getsensor get sensors information.
geteventsub get event subscription information.
getservice get service information.
getsnmp get snmp information.
getsmtp get smtp information.
setsmtp set smtp information.
getstorage get storage information.
getsysboot get system boot information.
setsysboot set system boot.
gettemp get temperature information.
getthreshold get predictive failure threshold.
setthreshold set predictive failure threshold.
gettime get system time.
getuser get user information.
getvmm get virtual media information.
mountvmm mount or unmount virtual media.
setbiosdefault set bios default.
setbmcdefault set bmc default.
syspowerctrl system power control options.
setad set ad(Active Directory).
setbios set bios parameter.
setfan set fan speed.
setshareport set the BMC shareport.
setipv4 set IPv4 information of the BMC network port.
setipv6 set IPv6 information of the BMC network port.
locatedisk locate the physical disk by LED lights.
setvlan set VLAN information.
setldap set ldap.
setloginruleip add ip login rule.
setnetmode set net mode.
getncsi get ncsi status.
setncsi set ncsi status.
setntp set ntp information.
setpdisk set physical disk information.
setpowerlimit set power limit.
setpmb set power main/backup.
setassettag set product information.
sethostname set hostname information.
getserialport get serial port information.
setserialport set serial port.
setservice set service configuration.
setsnmp set snmp information.
settimezone time zone. for example, UTC+9 and UTC-3.
setuser set user.
uploadconfig download configuration.
importsshkey import SSH key.
delsshkey delete SSH key.
getldap get ldap configuration information.
getad get ad configuration information.
get2factorauth get two-factor authentication configuration information.
set2factorauth configure two-factor authentication attributes.
getdns get dns configuration information.
setdns DNS configuration.
getlldp get lldp information.
setlldp set LLDP service properties.
getsysperf get system performance information.
setsysperf set the host monitoring alarm threshold.
getvideocfg get video recording function configuration.
setvideocfg set video recording function.
setldisk set logical disk properties.
setpsu power configuration.
memoryinspect memory inspect.
setvnc set vnc.
exportlog export operator log.
gethardware get hardware information.
sendipmirawcmd send ipmi raw command.
本命令用于获取服务器CPU信息。
【命令】
hREST -H host -p port -U username -P password getcpu -CI cupId
【参数】
表2-2 参数说明
参数 |
描述 |
取值 |
cupId |
CPU编号,为可选参数 |
当不携带此参数时,将展示所有CPU信息 |
【举例】
# 获取CPU详细信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getcpu –CI 2
--------------------------------------------------
Id : 2
Name : CPU2
FrequencyMHz : 3200
L1CacheKiB : 768
L2CacheKiB : 12288
L3CacheKiB : 12288
Temperature : 62
ProcessorType : CPU
ProcessorArchitecture : x86
InstructionSet : x86-64
Manufacturer : Intel(R) Corporation
Model : Intel(R) Xeon(R) Gold 6146 CPU @ 3.20GHz
MaxSpeedMHz : 255
TotalCores : 12
TotalThreads : 24
Socket : 2
[Status]
Health : OK
State : Enabled
[ProcessorId]
IdentificationRegisters : BF-EB-FB-FF-00-05-06-54
--------------------------------------------------
【输出说明】
表2-3 输出说明
参数 |
描述 |
Id |
CPU编号 |
Name |
CPU名称 |
FrequencyMHz |
CPU主频 |
L1CacheKiB |
CPU一级缓存大小 |
L2CacheKiB |
CPU二级缓存大小 |
L3CacheKiB |
CPU三级缓存大小 |
ProcessorType |
CPU类型 |
ProcessorArchitecture |
CPU架构 |
InstructionSet |
CPU指令集 |
Manufacturer |
CPU制造商 |
Model |
CPU型号 |
MaxSpeedMHz |
CPU最大主频 |
TotalCores |
CPU核心数 |
TotalThreads |
CPU总线程数 |
Socket |
CPU槽位号 |
State |
CPU使能状态 |
Health |
CPU健康状态 |
IdentificationRegisters |
CPU ProcessID |
本命令用于获取服务器内存信息。
【命令】
hREST -H host -p port -U username -P password getmemory -MI memoryId
【参数】
表2-4 参数说明
参数 |
描述 |
取值 |
memoryId |
内存槽位,为可选参数 |
当不携带此参数时,将展示所有内存信息 |
【举例】
# 获取CPU1channel 3槽位D0的的内存详细信息
-> hREST –H 192.168.10.6 –U ****** -P ****** getmemory –MI CPU1CH3D0
--------------------------------------------------
CommonName : CPU1CH3D0
CapacityMiB : 32768
Manufacturer : Micron
Model : 18ASF4G72PDZ-2G9E1
SerialNumber : S802C0F20212847D95C
OperatingSpeedMhz : 2933
MemoryDeviceType : DDR4
DataWidthBits : 64
RankCount : 2
PartNumber : 18ASF4G72PDZ-2G9E1
[MemoryLocation]
Position : CPU1
Channel : 3
Slot : D0
[Status]
State : Enabled
Health : OK
--------------------------------------------------
【输出说明】
表2-5 输出说明
参数 |
描述 |
CommonName |
内存丝印号 |
CapacityMiB |
内存容量 |
Manufacturer |
内存制造商 |
Model |
内存型号 |
SerialNumber |
内存序列号 |
OperatingSpeedMhz |
内存速率 |
MemoryDeviceType |
内存类型 |
DataWidthBits |
内存数据位宽 |
RankCount |
内存Rank数量 |
PartNumber |
内存部件号 |
MemoryLocation |
内存位置 |
Position |
内存所处CPU id |
Channel |
内存通道 |
Slot |
内存槽位号 |
State |
内存使能状态 |
Health |
内存健康状态 |
本命令用于获取服务器物理盘信息。
【命令】
hREST -H host -p port -U username -P password getpdisk -PI physicalId
【参数】
表2-6 参数说明
参数 |
描述 |
取值 |
physicalId |
物理盘id,为可选参数,此ID为物理盘的BIOS下物理盘编号 |
当不携带此参数时,将展示所有物理信息 |
【举例】
# 获取物理盘详细信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getpdisk –PI 0
--------------------------------------------------
Panel : Front
Slot_phys_no : 11
Slot : Front 11
Connection id : 0
Drive number in BIOS : 3
Drive number in OS : 3
Status : Ready
Model : ATA INTEL SSDSC2BB12
Firmware version : 0140
Serial number : PHWA606300D5120CGN
Property : 6 Gbps SATA SSD
Capacity : 0.11TiB
PredictedMediaLifeLeftPercent : 99
ControllerID : 0
[Status]
Health : OK
State : Enabled
--------------------------------------------------
【输出说明】
表2-7 输出说明
参数 |
描述 |
Slot |
物理盘槽位号 |
Connection id |
物理盘链接ID,组建逻辑盘时使用 |
Drive number in BIOS |
BIOS下物理盘编号 |
Drive number in OS |
OS下物理盘编号 |
Status |
物理盘状态 |
Model |
物理盘型号 |
Firmware version |
物理盘驱动版本 |
Serial number |
物理盘序列号 |
Property |
物理盘型号 |
Capacity |
物理盘存储容量 |
PredictedMediaLifeLeftPercent |
物理盘剩余寿命百分比,物理盘支持该字段时显示具体值,不支持时显示None |
ControllerID |
物理盘所连接的存储控制卡ID |
State |
物理盘使能状态 |
Health |
物理盘健康状态 |
Slot |
物理盘槽位号 |
Connection id |
物理盘链接ID,组建逻辑盘时使用 |
本命令用于设置物理盘状态。
【命令】
hREST -H host -p port -U username -P password setpdisk -CI controllerId –LI logicalId –PI physicalId -S status -B biosId -I slotId
【参数】
表2-8 参数说明
参数 |
描述 |
取值 |
controllerId |
控制卡ID,为可选参数 |
控制卡ID |
logicalId |
逻辑盘 ID,为可选参数 |
由逻辑盘集合中查询 |
physicalId |
物理盘ID,为可选参数 |
G3、G5服务器为硬盘的connected ID;G6服务器为物理盘ID。 |
status |
物理盘状态,为可选参数 |
物理盘使用状态包括: · Enable:启用 · Disable:不启用 · JBOD:JBOD模式 · Global:全局热备 · Dedicated:局部热备 · None:解除热备 |
biosId |
BIOS下物理盘ID,为可选参数 |
不指定时,不影响功能,日志会记录该物理盘的BIOS下Id为0 |
slotId |
Slot ID,为可选参数 |
不指定时,不影响功能,日志会记录该物理盘的Slot Id为0 |
【使用指南】
本命令仅可设置未组建逻辑盘且连接正常的物理盘。
【举例】
# 设置控制卡ID为0,connection ID为22的物理盘,状态为Disable
-> hREST –H 192.168.10.6 –U ****** -P ****** setpdisk -CI 0 -PI 22 -S Disable
Success: set physical drive successfully
本命令用于获取服务器逻辑盘信息。
【命令】
hREST -H host -p port -U username -P password getldisk -CI controllerId –LI logicalId
【参数】
表2-9 参数说明
参数 |
描述 |
取值 |
controllerId |
控制卡ID,为可选参数 |
从0递增的整数,不携带此参数且不携带逻辑盘ID参数时,将展示所有控制卡信息 |
logicalId |
逻辑盘ID,为可选参数 |
从0递增的整数,当控制卡ID参数存在时,才可携带此参数,否则提示参数错误 |
【举例】
# 获取控制卡ID为0,逻辑盘id为3的逻辑盘信息
-> hREST –H 192.168.10.6 –U ****** -P ****** getldisk –CI 0 –LI 3
--------------------------------------------------
RaidControllerID : 0
Logical Drive Id : 3
LogicDiskName :
CapacityGiB : 400
RaidLevel : RAID 0
OptimumIOSizeBytes : 65536
DriveCache : Unchanged
CurrentReadPolicy : No Read Ahead
CurrentWritePolicy : Write Through
CurrentIOPolicy : Direct
CurrentCachePolicy : Direct
BootEnable : True
Drives : 1, 2
Health : OK
--------------------------------------------------
【输出说明】
表2-10 输出说明
参数 |
描述 |
RaidControllerID |
控制卡编号,从0开始 |
Logical Drive Id |
逻辑盘编号 |
LogicDiskName |
逻辑盘名称 |
CapacityGiB |
逻辑盘容量 |
RaidLevel |
逻辑盘RAID级别 |
OptimumIOSizeBytes |
· 逻辑盘条带大小,包括: · 16384,即16KB · 32768,即32KB · 65536,即64KB · 131072,即128KB · 262144,即256KB · 524288,即512KB · 1048576,即1MB |
DriveCache |
逻辑盘缓存策略 |
CurrentReadPolicy |
逻辑盘读策略 |
CurrentWritePolicy |
逻辑盘写策略 |
CurrentIOPolicy |
逻辑盘IO策略 |
CurrentCachePolicy |
逻辑盘Cache策略 |
BootEnable |
是否为启动盘 |
Drives |
组成逻辑盘的物理盘ID,此ID为物理盘在系统下的编号 |
Health |
逻辑盘健康状态 |
本命令用于创建逻辑盘。
【命令】
hREST -H host -p port -U username -P password addldisk -CI controlerId -N volumeName –OV optsizeBytes –M initMode –VL volumeRaidLevel –CNI drivesId –SN spanNumber –RP readPolicy –WP writePolicy –IP ioPolicy –DCP cachePolicy –AP accessPolicy –V capacity –SU sizeUnit –AM accelerationMethod
【用户权限】
admin
【参数】
表2-11 参数说明
参数 |
描述 |
取值 |
controlerId |
控制卡ID,为必配参数 |
- |
volumeName |
逻辑盘名称,为可选参数 |
- |
optsizeBytes |
条带大小,为可选参数 |
条带大小,包括: · 64 · 128 · 256 · 512 · 1024 |
initMode |
初始化类型,为可选参数 |
初始化类型,包括: · No · Fast · Full |
volumeRaidLevel |
Raid级别,为可选参数 |
Raid级别,包括: · RAID0 · RAID1 · RAID5 · RAID6 · RAID00 · RAID10 · RAID50 · RAID60 |
drivesId |
组成逻辑盘的物理成员盘信息,为必配参数 说明: HDM-1.11.27版本增加panel、bios_phys_id和slot_phys_no参数 |
示例:[65:0] · 65:物理盘连接序号(connection id) · 0:组号,物理盘在逻辑盘中的分组 |
spanNumber |
物理盘组个数,为可选参数 |
- |
readPolicy |
读策略,为可选参数 |
读策略,包括: · NoReadAhead · ReadAhead |
writePolicy |
写策略,为可选参数 |
写策略,包括: · WriteThrough · WriteBack · AlwaysWriteBack |
ioPolicy |
IO策略,为可选参数 |
IO策略,包括: · Direct · Cached |
cachePolicy |
缓存策略,为可选参数 |
缓存策略,包括: · Unchanged · Enabled · Disabled |
accessPolicy |
访问策略,为可选参数 |
访问策略,包括: · ReadWrite · ReadOnly · Blocked |
capacity |
逻辑盘容量大小,为可选参数 |
- |
sizeUnit |
容量单位,为可选参数 |
容量单位,包括: · MB · GB · TB |
accelerationMethod |
加速策略,仅PMC涉及 |
加速策略,仅PMC卡涉及 · 1:表示None · 2:表示Controller Cache · 3:表示IO Bypass(仅涉及SSD硬盘) |
【使用指南】
对于不支持HDM带外配置功能的RAID卡,此功能无法使用。
【举例】
# 添加逻辑盘。控制卡iD为0,逻辑盘名称为dragon,条带大小为64,初始化类型为No,RAID级别为1,两块物理盘,connection id分别为26,23,逻辑组id为0,每个SPAN的成员盘数为2,写策略为WriteThrough,IO策略为Cached,物理盘缓存策略为Enable,访问策略为只读,大小为600,单位为GB,加速策略为None
-> hREST –H 192.168.10.6 –U ****** -P ****** addldisk -CI 0 -N dragon -OV 64 -M No -VL RAID1 -CNI [26:0_23:0] -SN 1 -RP NoReadAhead -WP WriteThrough -IP Cached -DCP Enabled -AP ReadOnly -V 600 -SU GB -AM 1
Success: add logical drive successfully
本命令用于删除逻辑盘。
【命令】
hREST -H host -p port -U username -P password delldisk –CI controllerId –LI logicalId
【参数】
表2-12 参数说明
参数 |
描述 |
取值 |
controllerId |
控制卡ID,为必配参数 |
- |
logicalId |
逻辑盘ID,为必配参数 |
- |
【使用指南】
无
【举例】
# 删除控制卡ID为0,逻辑盘ID为3的逻辑盘
-> hREST –H 192.168.10.6 –U ****** -P ****** delldisk -CI 0 -LI 3
Success: delete logical driver successfully
本命令用于设置逻辑盘。
【命令】
hREST -H host -p port -U username -P password setldisk -CI raidId –LI logicalId –WP writePolicy –RP readPolicy -AP accessPolicy -CP driveCache
【参数】
表2-13 参数说明
参数 |
描述 |
取值 |
raidId |
Raid卡ID,为必配参数 |
- |
logicalId |
逻辑盘ID,为必配参数 |
- |
writePolicy |
写策略,为可选参数 |
选项: · WriteBack · WriteThrough · AlwaysWriteBack |
readPolicy |
读策略,为可选参数 |
选项: · NoReadAhead · ReadAhead |
accessPolicy |
访问策略,为可选参数,PMC卡不支持该字段 |
选项: · Read/Write · ReadOnly · Blocked |
driveCache |
物理盘缓存策略,为可选参数,PMC卡不支持该字段 |
选项: · Unchanged · Enabled · Disabled |
【使用指南】
HDM-2.33及其以上版本支持,但不支持设置PMC厂商控制卡。
G3、G5服务器在HDM-6.05新增支持访问策略和缓存策略配置。G6服务器读策略和写策略实际为默认读策略和默认写策略
【举例】
# 设置id为0的控制卡上id为0的逻辑盘,写策略WriteThrough,读策略NoReadAhead
-> hREST -H 192.168.10.32 -p 443 -U admin -P Password@_ setldisk -CI 0 -LI 0 -WP WriteThrough -RP NoReadAhead
Success: set logical disk properties successfully
本命令用于获取RAID卡信息。
【命令】
hREST -H host -p port -U username -P password getraid
【参数】
无
【举例】
# 获取RAID卡信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getraid
--------------------------------------------------
CommonName : RAIDStorage0
SerialNumber : SP73513465
State : Enabled
Health : OK
Controller
Id : 0
Manufacturer : LSI
Model : HBA-LSI-9440-8i
SupportedDeviceProtocols : ['SAS']
SASAddress : null
FirmwareVersion : 5.010.01-0671
PackageVersion : None
JBODState : Disabled
MemorySizeMiB : null
SupportedRAIDLevels : RAID0, RAID1, RAID5, RAID10, RAID50
[CapacitanceStatus]
State : Absent
Health : None
----------------------------------------------
--------------------------------------------------
【输出说明】
表2-14 输出说明
参数 |
描述 |
CommonName |
控制卡名称 |
SerialNumber |
控制卡序列号 |
State |
控制卡使能状态 |
Health |
控制卡缓存容量 |
Id |
控制卡ID |
Manufacturer |
厂商 |
Model |
控制卡型号 |
SupportedDeviceProtocols |
控制卡支持协议 |
SASAddress |
存储控制器地址 |
FirmwareVersion |
存储控制器固件版本 |
PackageVersion |
LSI控制卡的PackageVersion |
JBODState |
JBOD状态 |
MemorySizeMiB |
缓存大小 |
SupportedRAIDLevels |
所支持RAID级别 |
CapacitanceStatus.State |
存储控制卡电容使能状态 |
CapacitanceStatus.Health |
存储控制卡电容健康状态 |
本命令用于获取存储信息。
【命令】
hREST -H host -p port -U username -P password getstorage –CI controlerId
【参数】
表2-15 参数说明
参数 |
描述 |
取值 |
controlerId |
控制卡ID,为可选参数 |
参数为空时展示所有控制卡的存储信息 |
【举例】
# 获取存储信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getstorage –CI 0
--------------------------------------------------
Ctrl_id : 0
Raid card model : HBA-LSI-9440-8i
Firmware version : 5.010.01-0671
Serial number : SP73513465
DDR size :
Flash :
Supercapacitor :
Charging status :
Support RAID Level : 0/1/5/10/50
Volumes
Id : 3
Status : Optimal
Level : RAID 0
Capacity : 400GiB
Element : 2
Drives : 1,2
----------------------------------------------
Id : 1
Status : Optimal
Level : RAID 0
Capacity : 223.060GiB
Element : 1
Drives : 0
----------------------------------------------
Id : 2
Status : Optimal
Level : RAID 0
Capacity : 500GiB
Element : 1
Drives : 4
----------------------------------------------
Id : 0
Status : Optimal
Level : RAID 1
Capacity : 600GiB
Element : 2
Drives : 5,7
----------------------------------------------
Drives : 0, 1, 2, 3, 4, 5, 6, 7
--------------------------------------------------
【输出说明】
表2-16 输出说明
参数 |
描述 |
Ctrl_id |
控制卡ID |
Raid card model |
控制卡型号 |
Firmware version |
控制卡固件版本号 |
Serial number |
控制卡序列号 |
DDR size |
控制卡缓存容量 |
Flash |
Flash卡状态 |
Supercapacitor |
电容状态 |
Charging status |
电容充电状态 |
Support RAID Level |
支持组建RAID等级 |
Id |
逻辑盘ID |
Status |
逻辑盘状态 |
Level |
RAID级别 |
Capacity |
逻辑盘容量 |
Element |
组成逻辑盘物理盘个数 |
Volumes.Drives |
组成逻辑盘的物理盘序号 |
Drives |
控制卡下所有物理盘序号 |
本命令用于获取事件日志信息。
【命令】
hREST -H host -p port -U username -P password getelog -C count -T time -F filePath
【参数】
表2-17 参数说明
参数 |
描述 |
取值 |
count |
获取的事件日志条数,为可选参数 |
当不携带此参数时,将展示所有事件信息,依赖于展示窗口限制 |
time |
指定获取日志的时间范围,为可选参数 |
格式为”yyyy-MM-ddTHH:mm:ss+HH:mm”,例如”2019-03-13T03:24:45+08:00” |
filePath |
指定日志文件的路径,为可选参数 |
|
【举例】
# 获取事件日志信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getelog –C 1
--------------------------------------------------
Id : 1
Record type : system_event_record
Time : 2020-07-04 02:37:27
System software type : system_management_software
Generator type : ipmb_slave_address
Channel number : 0
Ipmb lun : 0
Event format ipmi version : 4
Sensor type : Microcontroller / Coprocessor
Type number : 22
Sensor number : 255
Sensor name : Microcontroller
Event direction : asserted
Event reading class : discrete
Sensor reading value : 0
Triggered value : 0
Sensor reading value type : unspecified
Triggered type : unspecified
Event description : BMC reset
Level : 1
--------------------------------------------------
【输出说明】
表2-18 输出说明
参数 |
描述 |
Id |
日志信息编号,注意该编号为HDM后台的编号,与Web页面显示有所不同 |
Record type |
事件记录类型,包括: · system_event_record:系统事件类型 · oem_record:OEM事件 G6服务器不支持。 |
Time |
日志记录的时间 |
System software type |
事件产生源,包括: · bios · smi_handler · system_management_software · system_software_oem · remote_console_software · oem · terminal_mode_remote_console_software G6服务器不支持。 |
Generator type |
产生源类型,包括: · system_software_id · ipmb_slave_address G6服务器不支持。 |
Channel number |
事件产生的通道编号,G6服务器不支持。 |
Ipmb lun |
事件的LUN编号,G6服务器不支持。 |
Event format ipmi version |
IPMI协议版本号,G6服务器不支持。 |
Sensor type |
产生该日志的传感器的类型。 |
Type number |
日志类型编号,G6服务器不支持。 |
Sensor number |
产生该日志的传感器的编号,G6服务器不支持。 |
Sensor name |
产生该日志的传感器的名称,G6服务器不支持。 |
Event direction |
事件是触发还是解除,包括: · asserted · deasserted |
Event reading class |
事件产生的类别,用于筛选,包括: · threshold · discrete · oem G6服务器不支持。 |
Sensor reading value |
产生传感器事件的传感器的读数,G6服务器不支持。 |
Triggered value |
产生传感器事件的传感器的阈值读数,G6服务器不支持。 |
Sensor reading value type |
事件产生的类别,包括: · trigger_based · oem_based · sensor_specific · unspecified G6服务器不支持。 |
Triggered type |
产生传感器事件的传感器类型,G6服务器不支持。 |
Event description |
事件日志描述 |
Level |
事件级别,G3、G5包括: · 0:保留 · 1:正常 · 2:轻微 · 3:严重 · 4:致命 G6包括: · Info :正常 · Minor:轻微 · Major:严重 · Critical:致命 |
本命令用于删除事件日志信息。
【命令】
hREST -H host -p port -U username -P password delelog
【举例】
# 删除事件日志信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** delelog
Success: clear system event log successfully
本命令用于查询网口信息。
【命令】
hREST -H host -p port -U username -P password getip -NI ethernetId
【用户权限】
admin
【参数】
表2-19 参数说明
参数 |
描述 |
取值 |
ethernetId |
网口名称,为可选参数,缺省状态下默认获取当前HOST地址对应的网口信息。 |
依据实际情形填写,例如eth0、eth1或者eth1.401 |
【说明】
当-NI参数为空时,会返回命令中使用的HDM IP对应网口的信息。
需要注意的是,本工具无法获取使用串口等方式设置的临时IP信息,将返回Failure: failed to get ip information。
【举例】
# 获取网口信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getip –NI eth0
--------------------------------------------------
Id : eth0
Name : eth0
Description : Ethernet Interface eth0
AutoNeg : True
FQDN : HDM210200A00QH17C000002.
FullDuplex : True
HostName : HDM210200A00QH17C000002
MACAddress : 30:7B:AC:DE:64:B2
IPv6DefaultGateway : ::
InterfaceEnabled : True
MTUSize : 1500
MaxIPv6StaticAddresses : 16
NameServers : ::
PermanentMACAddress : 30:7B:AC:DE:64:B2
SpeedMbps : 1000
[Status]
Health : OK
Status : Enabled
IPv4Status : True
IPv6Status : True
VLANEnable : False
[IPv4Addresses]
--------------------------------------------------
SubnetMask : 255.255.0.0
AddressOrigin : DHCP
Address : 192.168.0.13
[IPv6Addresses]
--------------------------------------------------
Address : fe80::327b:acff:fede:64b2
AddressOrigin : LinkLocal
PrefixLength : 64
--------------------------------------------------
【输出说明】
表2-20 输出说明
参数 |
描述 |
Id |
网口ID |
Name |
网口名称 |
Description |
网口描述信息 |
FQDN |
全限定域名 |
FullDuplex |
全双工是否开启 |
HostName |
主机名 |
MACAddress |
MAC地址 |
IPv6DefaultGateway |
IPv6默认网关 |
InterfaceEnabled |
网口是否使能 |
MTUSize |
MTU最大值 |
MaxIPv6StaticAddresses |
IPv6静态地址最大长度 |
NameServers |
DNS服务器信息 |
PermanentMACAddress |
固定MAC地址 |
SpeedMbps |
传输速率,单位Mbps |
Health |
健康状态 |
Status |
健康状态使能 |
IPv4Status |
IPv4使能状态 |
IPv6Status |
IPv6使能状态 |
VLANEnable |
VLAN是否使能 |
IPv4Addresses.Address |
IPv4地址 |
IPv6Addresses.Address |
IPv6地址 |
IPv6Addresses.AddressOrigin |
IPv6协议类型 |
IPv6Addresses.PrefixLength |
IPv6前缀长度 |
本命令用于设置网口IPv4地址。
【命令】
hREST -H host -p port -U username -P password setipv4 –N ethernetId –S ipv4Enable –IP address –T dhcpEnable –G gateway –M subnetMask
【参数】
表2-21 参数说明
参数 |
描述 |
取值 |
ethernetId |
网口名称,为必配参数。 |
依据实际情形填写,例如eth0、eth1或者eth1.401 |
ipv4Enable |
启用IPv4,为可选参数 |
启用IPv4,包括: · Enabled:启用 · Disabled:不启用 |
address |
IP地址,为可选参数 |
- |
dhcpEnable |
使能DHCP,为可选参数 |
IPv4地址生成方式,包括: · DHCP:启用DHCP · Static:使用静态IP |
gateway |
网关,为可选参数 |
- |
subnetMask |
子网掩码,为可选参数 |
- |
【使用指南】
设置网口IPv4时,若共享口已关闭,会开启共享口。禁用IPv4时需保证IPv6处于开启状态,否则可能会导致功能异常。
【举例】
# 设置eth0的IPv4地址。
-> hREST –H 192.168.10.6 –U ****** -P ****** setipv4 -N eth0 -IP 172.16.10.162 -T Static -G 0.0.0.0 -M 255.255.255.0
Success: set network successfully
本命令用于设置网口IPv6地址。
【命令】
hREST -H host -p port -U username -P password setipv6 -N ethernetId -S ipv6Enable -IP address -T dhcpEnable -G gateway -L prefixLength
【参数】
表2-22 参数说明
参数 |
描述 |
取值 |
ethernetId |
网口ID,为必配参数 |
- |
ipv6Enable |
启用IPv6,为可选参数 |
启用IPv6,包括: · Enabled:启用 · Disabled:不启用 |
address |
IP地址,为可选参数 |
- |
dhcpEnable |
使能DHCP,为可选参数 |
IPv6地址生成方式,包括: · DHCP:启用DHCP · Static:使用静态IP |
gateway |
网关,为可选参数 |
- |
prefixLength |
子网前缀长度,为可选参数 |
- |
【使用指南】
设置网口IPv6地址时,若共享口已关闭,会开启共享口。禁用IPv6时需保证IPv4处于开启状态,否则可能会导致功能异常。
【举例】
# 设置eth0网口的IPv6地址。
-> hREST –H 192.168.10.6 –U ****** -P ****** setipv6 -N eth0 -IP 2022::10 –T Static –G 2022::1 –L 64
Success: set network successfully
本命令用于获取网口VLAN信息。
【命令】
hREST -H host -p port -U username -P password getvlan –N ethernetId
【参数】
表2-23 参数说明
参数 |
描述 |
取值 |
ethernetId |
网口名称,为必配参数。 |
依据实际情形填写,例如eth0、eth1或者eth1.401 |
【举例】
# 获取eth0网口的VLAN信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getvlan –N eth0
--------------------------------------------------
VLANEnable : False
VLANId : 0
VLANPriority : 0
--------------------------------------------------
【输出说明】
表2-24 输出说明
参数 |
描述 |
VLANEnable |
是否启用VLAN,包括: · True:启用VLAN · False:未启用VLAN |
VLANId |
VLAN ID |
VLANPriority |
VLAN的优先级,此处为0,表示未指定优先级 |
本命令用于配置网口的VLAN。
【命令】
hREST -H host -p port -U username -P password setvlan –N ethernetId -S vlanEnable -I vlanId –P priority
【参数】
表2-25 参数说明
参数 |
描述 |
取值 |
ethernetId |
网口名称,为必配参数。 |
依据实际情形填写,例如eth0、eth1或者eth1.401 |
vlanEnable |
启用VLAN,为可选参数 |
启用VLAN,包括: · Enabled:启用 · Disabled:不启用 |
vlanId |
IP地址,为可选参数 |
取值范围是2到4094之间的整数 |
priority |
VALN优先级,为可选参数 |
取0~7之间的整数,7为最高优先级 |
【使用指南】
设置网口VLAN时,若共享口已关闭,会开启共享口。
【举例】
# 设置网口VLAN。
-> hREST –H 192.168.10.6 –U ****** -P ****** setvlan -N eth0 -S Enabled -I 5 -P 0
Success: set network successfully
本命令用于查询网口模式。
【命令】
hREST -H host -p port -U username -P password getnetmode
【举例】
# 查询网口模式。
-> hREST –H 192.168.10.6 –U ****** -P ****** getnetmode
--------------------------------------------------
PortModes : Normal mode
--------------------------------------------------
【输出说明】
表2-26 输出说明
参数 |
描述 |
PortModes |
网口模式,包括: · Normal:正常模式 · Bonding:Bond模式 · Active/standby:网口自适应模式 |
本命令用于设置HDM网口模式。
【命令】
hREST -H host -p port -U username -P password setnetmode –M status
【参数】
表2-27 参数说明
参数 |
描述 |
取值 |
status |
网口模式,为必配参数。 |
网口模式,包括: · Normal:正常模式 · Bond:Bond模式 · Adaptive:网口自适应模式 |
【举例】
# 设置HDM网口模式为Bond。
-> hREST –H 192.168.10.6 –U ****** -P ****** setnetmode –M Bond
Success: set network port mode succeed
本命令用于获取网卡信息。
【命令】
hREST -H host -p port -U username -P password getnic
【举例】
# 获取网卡信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getnic
--------------------------------------------------
CommonName : mLOM
Location : mLOM
CardManufacturer : H3C
SlotNumber : 9
CardModel : 2*10GE
SerialNumber : 02A3GLH175000029
State : Enabled
Health : OK
Controller
Id : None
Manufacturer : Intel
Model : NIC-10GE-2P-560T-L2
FirmwareVersion : 1.2585.0
PortCount : 2
----------------------------------------------
Port
Id : 1
MACAddress : ['30:7B:AC:C1:24:54']
LinkStatus : Up
MediaType : ElectricalPort
------------------------------------------
Id : 2
MACAddress : ['30:7B:AC:C1:24:55']
LinkStatus : Down
MediaType : ElectricalPort
------------------------------------------
--------------------------------------------------
【输出说明】
表2-28 输出说明
参数 |
描述 |
CommonName |
网络适配器资源名称 |
Location |
网络适配器的丝印信息 |
CardManufacturer |
网络适配器的厂商 |
SlotNumber |
网络适配器的槽位号 |
Model |
网络适配器的接口类型 |
SerialNumber |
网络适配器的序列号 |
Controller.Id |
网络适配器资源Id |
Controller.Manufacturer |
网络适配器的芯片制造商 |
Controller.Model |
网络适配器的型号 |
Controller.FirmwareVersion |
网络适配器的固件版本 |
Controller.PortCount |
网络适配器的相关网络端口数 |
Controller.Port.Id |
网络适配器的相关网络端口ID |
Controller.Port.MACAddress |
网络适配器的相关网络端口Mac地址 |
Controller.Port.LinkStatus |
网络适配器的相关网络端口状态 |
Controller.Port.MediaType |
网络适配器的相关网络端口类型 |
本命令用于获取IP登录规则信息。
【命令】
hREST -H host -p port -U username -P password getloginruleip
【举例】
# 获取IP登录规则信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getloginruleip
--------------------------------------------------
MemberId : 1
IpFrom : 192.168.253.1
IpTo : 192.168.253.2
MacAddress : aa:bb:cc:dd:ee:ff
Rule : Blacklist
TimeRange : Enabled
TimeFrom : 2023-11-17T00:00:00+08:00
TimeTo : 2023-11-18T00:00:00+08:00
Protocol : ['TCP', 'UDP']
PortFrom : 10096
PortTo : 10100
--------------------------------------------------
【输出说明】
表2-29 输出说明
参数 |
描述 |
MemberId |
规则ID |
IpFrom |
登录规则起始IP |
IpTo |
登录规则终止IP |
MacAddress |
· 允许或禁止访问的Mac地址 |
Rule |
防火墙类型,包括: · Whitelist:白名单 · Blacklist:黑名单 |
TimeRange |
是否启用规则有效期,包括: · Enabled:启用 · Disabled:不启用 |
TimeFrom |
登录规则起始时间 |
TimeTo |
登录规则终止时间 |
Protocol |
支持的协议 |
PortFrom |
登录规则起始端口号 |
PortTo |
登录规则终止端口号 |
本命令用于设置登录规则,包含添加和删除登录规则。
【命令】
hREST -H host -p port -U username -P password setloginruleip –O operator –E rule –M macAddress –P startTime –Q endTime -IS ipStart –IE ipEnd -PS portStart -PE portEnd -I memberId -T protocolType
【参数】
表2-30 参数说明
参数 |
描述 |
取值 |
operator |
操作类型,为可选参数 |
防火墙操作类型,包括: · Add:添加规则 · Del:删除规则 |
rule |
规则类型,为可选参数 |
防火墙规则,包括: · Allow:允许登录,对应白名单 · Block:阻止登录,对应黑名单 |
macAddress |
Mac地址,为可选参数,和规则起始ip不能同时为空 |
- |
startTime |
规则起始时间,为可选参数 |
强格式要求,如2020-06-03T13:10 |
endTime |
规则终止时间,为可选参数 |
强格式要求,如2020-06-06T13:15 |
ipStart |
规则起始IP,为可选参数,和Mac地址不能同时为空 |
- |
ipEnd |
规则终止IP,为可选参数 |
- |
portStart |
规则起始端口号,为可选参数 |
端口号范围是1~65535 |
portEnd |
规则起始端口号,为可选参数 |
端口号范围是1~65535 |
memberId |
规则ID |
- |
protocolType |
设置协议类型 |
可选值为UDP、TCP和TCP+UDP |
【举例】
# 添加登录规则。规则为阻止,拦截期限为2020-05-20T12:22-2020-06-03T13:10,ip拦截范围为172.16.10.11-172.16.10.13
-> hREST –H 192.168.10.6 –U ****** -P ****** setloginruleip -O Add -E Block -IS 172.16.10.11 -IE 172.16.10.13 -M aa:aa:aa:aa:aa:aa -P 2020-05-20T12:22 -Q 2020-06-03T13:10
Success: set ip login rule succeed
# 删除登录规则。删除登录规则需要参数一一对应
-> hREST –H 192.168.10.6 –U ****** -P ****** setloginruleip -O Del -E Block -IS 172.16.10.11 -IE 172.16.10.13 -M aa:aa:aa:aa:aa:aa -P 2020-05-20T12:22 -Q 2020-06-03T13:10
Success: set ip login rule succeed
本命令用于获取NVMe SSD信息。
【命令】
hREST -H host -p port -U username -P password getnvmessd
【举例】
# 获取NVMe SSD信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getnvmessd
--------------------------------------------------
SlotID : N1 Slot 164
VendorName : INTEL
ProductName : P3520
PDStatus : Normal
PercentLife : 0
SerialNumber : CVPF733500CL450RGN
ModelNumber : SSDPE2MX450G7
Capacity : 450.0GB
FirmwareVersion : MDV10271
PortType : PCIe
--------------------------------------------------
【输出说明】
表2-31 输出说明
参数 |
描述 |
SlotID |
PCIe槽位 |
VendorName |
SSD制造商 |
ProductName |
SSD产品名称 |
PDStatus |
NVMe SSD状态 |
PercentLife |
SSD已使用寿命 |
SerialNumber |
SSD序列号 |
ModelNumber |
SSD硬盘编码 |
Capacity |
SSD容量 |
FirmwareVersion |
SSD固件版本 |
PortType |
SSD接口类型 |
本命令用于获取功率封顶信息。
【命令】
hREST -H host -p port -U username -P password getpowerlimit
【使用指南】
刀箱服务器无该参数。
【举例】
# 获取电源功率封顶信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getpowerlimit
--------------------------------------------------
PowerLimitEnable : False
LimitInWatts : 500
LimitException : HardPowerOff
--------------------------------------------------
【输出说明】
表2-32 输出说明
参数 |
描述 |
PowerLimitEnable |
是否开启功率封顶,包括: · True:是 · False:否 |
LimitInWatts |
功率封顶值 |
LimitException |
达到封顶功率后的动作设置,包括: · HardPowerOff:关机 · NoAction:无操作 |
本命令用于设置功率封顶。
【命令】
hREST -H host -p port -U username -P password setpowerlimit -S status -V limitValue –E exception
【参数】
表2-33 参数说明
参数 |
描述 |
取值 |
status |
是否启用功率封顶,为必配参数 |
是否启用功率封顶,包括: · Enable:启用 · Disable:不启用 |
limitValue |
功率封顶值,为可选参数 |
可选范围[150, 10000] |
exception |
超出封顶值后操作,为可选参数 |
超出功率登顶后是否关机,包括: · Shutdown:关机 · NoAction:无操作 |
【使用指南】
刀箱服务器不支持功率封顶设置。
【举例】
# 设置功率封顶。开启功率封顶,封顶值为600,超出封顶值后无动作。
-> hREST –H 192.168.10.6 –U ****** -P ****** setpowerlimit -S Enable -V 600 -E NoAction
Success: set power limit successfully
本命令用于获取电源信息。
【命令】
hREST -H host -p port -U username -P password getpsu
【举例】
# 获取电源信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getpsu
--------------------------------------------------
Name : PSU1
Model : PSR550-12A
SerialNumber : 210231A8LOH177000002
PowerSupplyType : No-input
PowerCapacityWatts : 550
PowerOutputWatts : 108
LineInputVoltageType : ACMidLine
LineInputCurrent : 0.667
FirmwareVersion : 1M.0009.0021.001
PowerID : 1
SlotNumber : 0
ActiveStandby : Active
[Status]
Health : Critical
State : Enabled
--------------------------------------------------
【输出说明】
表2-34 输出说明
参数 |
描述 |
Name |
电源名称 |
Model |
电源型号 |
SerialNumber |
电源序列号 |
PowerSupplyType |
电源的供电类型 |
PowerCapacityWatts |
电源的总功率 |
PowerOutputWatts |
电源的输出功率 |
LineInputVoltageType |
电源输入电压类型 |
LineInputCurrent |
电源的输入电流 |
FirmwareVersion |
电源的固件版本 |
PowerID |
电源ID |
SlotNumber |
电源槽位号 |
ActiveStandby |
电源主备状态 |
State |
电源是否使能 |
Health |
电源健康状态 |
本命令用于切换主备电源。
【命令】
hREST -H host -p port -U username -P password setpmb -I powerid -S status
【参数】
表2-35 参数说明
参数 |
描述 |
取值 |
powerid |
电源ID,为必配参数。 |
- |
status |
电源状态,为必配参数。 |
电源状态包括: · Active:主用 · Standby:备用 |
【举例】
# 设置电源id为2的电源为备用电源。
-> hREST –H 192.168.10.6 –U ****** -P ****** setpmb –I 2 –S Standby
Success: set power redundancy successfully
本命令用于控制系统上下电。
【命令】
hREST -H host -p port -U username -P password syspowerctrl -T type
【参数】
表2-36 参数说明
参数 |
描述 |
取值 |
type |
系统上下电控制选项,为必配参数 |
是否启用功率封顶,包括: · On:正常开机 · GracefulShutdown:正常关机 · ForceOff:强制关机 · ForceReset:立即重启 · ForcePowerCycle:关机并重新开机 |
【举例】
# 控制系统强制关机。
-> hREST –H 192.168.10.6 –U ****** -P ****** syspowerctrl -T ForceOff
Success: power control request successfully: ForceOff
本命令用于获取设备信息。
【命令】
hREST -H host -p port -U username -P password getproductinfo
【举例】
# 获取设备信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getproductinfo
--------------------------------------------------
Id : 1
Name : Computer System
AssetTag : N/A2
Manufacturer : Unis Huashan Technologies Co., Ltd.
Model : UniServer R4900 G3
HostName : 20112102010000000001
IndicatorLED : Off
SerialNumber : 12345678901234567890
PartNumber : 0200A00Q
ChassisPartNumber : 0235AQ7
PowerState : On
SystemType : Physical
BiosVersion : 2.00.41 V100R001B02D041
[Status]
Health : OK
HealthRollup : None
State : Enabled
[Healthstate]
OverallHealth : OK
board : OK
current : OK
disk : OK
fans : OK
memory : OK
pcie : OK
power : OK
processor : OK
storage : OK
raid : OK
temperature : OK
volatge : OK
--------------------------------------------------
【输出说明】
表2-37 输出说明
参数 |
描述 |
Id |
设备ID |
Name |
设备名称 |
AssetTag |
设备资产标签 |
Manufacturer |
设备制造商 |
Model |
设备型号 |
HostName |
主机名 |
IndicatorLED |
设备指示灯状态,包括: · On:常亮 · Off:常灭 · Blink:闪烁 |
SerialNumber |
设备序列号 |
PartNumber |
设备部件号 |
ChassisPartNumber |
机箱部件号 |
PowerState |
当前上电状态 |
SystemType |
系统类型 |
BiosVersion |
BIOS版本 |
Status |
设备状态,包括: · Health:系统资源健康状态 · HealthRollup:- · State:系统资源使能状态 |
OverallHealth |
整体健康状态 |
board |
系统板卡健康状态 |
current |
电流健康状态 |
disk |
硬盘健康状态 |
fans |
风扇健康状态 |
memory |
内存健康状态 |
pcie |
PCIe卡健康状态 |
power |
电源健康状态 |
processor |
处理器健康状态 |
storage |
存储健康状态 |
raid |
RAID卡下逻辑盘健康状态 |
temperature |
温度传感器健康状态 |
volatge |
电压传感器健康状态 |
本命令用于设置设备资产标签。
【命令】
hREST -H host -p port -U username -P password setassettag -T assetTag
【参数】
表2-38 参数说明
参数 |
描述 |
取值 |
assetTag |
设备资产标签,为可选参数 |
- |
【举例】
# 设置资产标签。
-> hREST –H 192.168.10.6 –U ****** -P ****** setassettag –T test_123
Success: set asset tag succeed
本命令用来设置主机名称。
【命令】
hREST -H Host -p Port -U UserName -P PassWord sethostname -M nameMathod -N newName
【用户权限】
admin
【参数】
表2-39 参数说明
字段 |
描述 |
取值 |
nameMathod |
名称获取方式,为可选参数。 |
名称获取方式,包括: · Manual:手动 · Auto:自动 |
newName |
主机名称,为可选参数 |
1-48位:HDM-2.97以前版本 1-63位:HDM-2.97及其以后版本 |
【使用指南】
名称获取方式为手动时必须指定新的设备名称,为自动时,不可指定设备名。允许使用特殊字符连接符(-),但不能以连接符(-)开头或结束。
【举例】
# 设置设备名称为手动,名称为。
-> ./hREST –H 192.168.10.6 –U ****** -P ****** sethostname -M Manual -N HDM210235A2CSH17C000001
Success: host name configuration is successful
本命令用于获取角色信息。
【命令】
hREST -H host -p port -U username -P password getrole –R role
【参数】
表2-40 参数说明
参数 |
描述 |
取值 |
role |
角色名称,为可选参数,不指定时展示所有角色信息 |
- |
【举例】
# 获取角色信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getrole –R Administrator
--------------------------------------------------
Role : Administrator
IsPredefined : True
AssignedPrivileges : Login, ConfigureManager, ConfigureUsers, ConfigureSelf, ConfigureComponents
OemPrivileges : OemKvm, OemVemdia, OemWeb, OemIPMI
--------------------------------------------------
【输出说明】
表2-41 输出说明
参数 |
描述 |
Role |
角色组ID名。 |
IsPredefined |
是否预设启用。 |
AssignedPrivileges |
指定权限 " ConfigureManager ":管理员配置 "ConfigureUsers":用户配置 "ConfigureComponents":常规配置 "Login":查询权限 "ConfigureSelf":配置自身 |
OemPrivileges |
服务器自定义的权限 " OemWeb":Web访问 " OemIPMI":IPMI访问 "OemKvm":远程控制 "OemVmm":远程媒体 "OemSecurityMgmt":安全配置 "OemPowerControl":电源控制 "OemDiagnosis":维护诊断 “OemSystemAudit”:系统审计 |
本命令用于设置角色组权限。
【命令】
hREST -H host -p port -U username -P password setrole –R role –P privileges
【参数】
表2-42 参数说明
参数 |
描述 |
取值 |
role |
角色组id,为必配参数。 |
- |
privileges |
角色组权限组合,为可选参数,未指定时角色权限将设置为空。 |
角色组权限取值范围: · Kvm · Vmm · SecurityMgmt · ConfigureComponents · PowerControl · Diagnosis · ConfigureSelf · SystemAudit |
【使用指南】
无
【举例】
# 开启CustomRole1组权限为Kvm,Vmm。
-> hREST –H 192.168.10.6 –U ****** -P ****** setrole -R CustomRole1 -P Kvm,Vmm
Success: set user role information successfully
【修改记录】
(1) HDM-2.08:权限模块由安全配置修改成用户配置,hREST V1.08引入该功能。
本命令用于获取系统启动信息。
【命令】
hREST -H host -p port -U username -P password getsysboot
【使用指南】
获取到的启动项均为下一次启动设置
【举例】
# 获取启动信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getsysboot
--------------------------------------------------
BootSourceOverrideTarget : Pxe
BootSourceOverrideEnabled : Continuous
BootSourceOverrideMode : Legacy
--------------------------------------------------
【输出说明】
表2-43 输出说明
参数 |
描述 |
BootSourceOverrideTarget |
服务器的下一次启动设备,包括: · None · Hdd · Pxe · BiosSetup · Cd |
BootSourceOverrideEnabled |
启动设置有效期,包括: · Once:仅生效一次, 即下次重启时生效 · Continuous:永久生效 |
BootSourceOverrideMode |
服务器的启动模式,包括: · None · Legacy · UEFI |
本命令用来设置系统启动项。
【命令】
hREST -H Host -p Port -U UserName -P PassWord setsysboot -D bootDevice –E effective -M bootMode
【用户权限】
admin
【参数】
表2-44 参数说明
字段 |
描述 |
取值 |
bootDevice |
启动设备,为可选参数。 |
启动设备,包括: · CD · HDD · PXE · BIOSSETUP · none |
effective |
启动有效期,为可选参数。 |
启动设置有效期,包括: · Once:一次性启动 · Continuous:永久性启动 |
bootMode |
启动模式,为可选参数。 |
启动模式,包括: · Legacy · UEFI |
【使用指南】
HDM B01版本仅支持一次性启动。
【举例】
# 设置系统启动设备为PXE,启动模式为UEFI,有效期为永久性启动。
-> ./hREST –H 192.168.10.6 –U ****** -P ****** setsysboot -D PXE -E Continuous -M UEFI
Success: set system startup item successfully
本命令用于获取服务器健康状态信息。
【命令】
hREST -H host -p port -U username -P password getsyshealth
【举例】
# 获取健康状态信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getsyshealth
--------------------------------------------------
System health : OK
Temperature : OK
Voltage : OK
Current : OK
Memory : OK
Fans : OK
Processor : OK
Disk : OK
Power : OK
--------------------------------------------------
【输出说明】
表2-45 输出说明
参数 |
描述 |
System health |
整体系统健康状态,包括: · OK:正常 · Caution:一般 · Warning:严重 · Critical:致命 健康状态等级会根据HDM版本有所不同,以实际为准。 |
Temperature |
系统温度健康状态 |
Voltage |
系统电压健康状态 |
Current |
系统电流健康状态 |
Memory |
系统内存健康状态 |
Fans |
系统风扇健康状态 |
Processor |
系统处理器健康状态 |
Disk |
系统硬盘健康状态 |
Power |
系统电源健康状态 |
本命令用于获取操作日志。
【命令】
hREST -H host -p port -U username -P password gethdmlog -C count
【参数】
表2-46 参数说明
参数 |
描述 |
取值 |
count |
HDM日志条数,为可选参数 |
此参数为空时,展示所有HDM日志信息 |
【举例】
# 获取操作日志信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** gethdmlog -C 2
--------------------------------------------------
Id : 999
UserName : N/A
Interface : KCS
LogIpAdd : HOST
LogType : 3
LogContent : Failed to set virtual keyboard mouse status.
Timestamp : 2020-07-03 23:41:07.178
HostName : HDM210200A00QH175000046
LogLevel : WARN
--------------------------------------------------
Id : 1000
UserName : admin
Interface : LAN
LogIpAdd : 192.168.0.177
LogType : 1
LogContent : HTTPS login from IP:192.168.0.177 user:admin
Timestamp : 2020-07-03 23:42:05.133
HostName : HDM210200A00QH175000046
LogLevel : INFO
--------------------------------------------------
【输出说明】
表2-47 输出说明
参数 |
描述 |
ID |
HDM日志ID |
Username |
管理员名称 |
Interface |
接口类型 |
LogIpAdd |
IP地址 |
LogType |
日志类型,包括: · 1:审计日志 · 2:固件更新日志 · 3:操作日志 · 4:事件日志 · 5:硬件更新日志 |
LogContent |
日志内容 |
Timestamp |
时间戳 |
HostName |
主机名 |
LogLevel |
日志级别,包括: · INFO:信息 · WARN:警告 G6服务器不支持。 |
本命令用于获取系统时间。
【命令】
hREST -H host -p port -U username -P password gettime
【使用指南】
部分HDM-1.10.xx版本HDM,工具返回时区格式未GMT标准,而Web显示为UTC,以实际接口为准,工具不做适配。
【举例】
# 获取系统时间。
-> hREST –H 192.168.10.6 –U ****** -P ****** gettime
--------------------------------------------------
Time : 2023-11-15 13:28:25
Timezone : UTC+08:00
--------------------------------------------------
【输出说明】
表2-48 输出说明
参数 |
描述 |
Time |
当前系统时间 |
Timezone |
系统时区 |
本命令用于设置系统时区。
【命令】
hREST -H host -p port -U username -P password settimezone –Z timezone
【参数】
表2-49 参数说明
参数 |
描述 |
取值 |
timezone |
时区信息,为必配参数 |
|
【举例】
# 设置系统时区。
-> hREST –H 192.168.10.6 –U ****** -P ****** settimezone -Z UTC-9
Success: set system timezone successfully: UTC-9
本命令用于获取系统温度。
【命令】
hREST -H host -p port -U username -P password gettemp
【举例】
# 获取系统温度信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** gettemp
--------------------------------------------------
Name : N1 FrontBP R
SensorNumber : 185
ReadingCelsius : 27
PhysicalContext : Room
LowerThresholdCritical : 0
UpperThresholdCritical : 100
LowerThresholdFatal : 0
UpperThresholdFatal : 0
LowerThresholdNonCritical : 0
UpperThresholdNonCritical : 95
[Status]
Health : OK
State : Enabled
--------------------------------------------------
Name : N2 FrontBP L
SensorNumber : 186
ReadingCelsius : 0
PhysicalContext : Room
LowerThresholdCritical : 0
UpperThresholdCritical : 100
LowerThresholdFatal : 0
UpperThresholdFatal : 0
LowerThresholdNonCritical : 0
UpperThresholdNonCritical : 95
[Status]
Health : Critical
State : Disabled
--------------------------------------------------
Name : N2 FrontBP R
SensorNumber : 187
ReadingCelsius : 29
PhysicalContext : Room
LowerThresholdCritical : 0
UpperThresholdCritical : 100
LowerThresholdFatal : 0
UpperThresholdFatal : 0
LowerThresholdNonCritical : 0
UpperThresholdNonCritical : 95
[Status]
Health : OK
State : Enabled
--------------------------------------------------
【输出说明】
表2-50 输出说明
参数 |
描述 |
Name |
温度传感器的名称 |
SensorNumber |
温度传感器编号,为其在温度传感器列表中的唯一标识 |
ReadingCelsius |
温度传感器的当前读数 |
PhysicalContext |
物理环境 |
LowerThresholdCritical |
温度传感器的低温严重告警阈 |
UpperThresholdCritical |
温度传感器的高温严重告警阈值 |
LowerThresholdFatal |
温度传感器的低温紧急告警阈值 |
UpperThresholdFatal |
温度传感器的高温紧急告警阈值 |
LowerThresholdNonCritical |
温度传感器的低温轻微告警阈值 |
UpperThresholdNonCritical |
温度传感器的高温轻微告警阈值 |
Status |
温度传感器的状态,包括: · Health:温度传感器健康状态 · State:温度传感器的启用状态,“Enabled”表示已启用,“Disabled”表示未启用 |
本命令用于获取用户信息。
【命令】
hREST -H host -p port -U username -P password getuser –N name
【参数】
表2-51 参数说明
参数 |
描述 |
取值 |
name |
指定用户名,为可选参数。 |
参数为空时展示所有用户信息。 |
【举例】
# 获取用户信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getuser –N test
--------------------------------------------------
Id : 3
UserName : test
RoleId : Operator
Enabled : Enabled
Privilege : ['IPMI', 'WEB']
IPMIEnable : True
KvmEnable : True
SnmpV3AccessPermission : read_only
SnmpV3AuthProtocol : sha
SnmpV3Enable : True
SnmpV3PrivProtocol : des
VmediaEnable : True
WebEnable : True
--------------------------------------------------
【输出说明】
表2-52 输出说明
参数 |
描述 |
Id |
用户ID |
UserName |
用户名 |
RoleId |
用户角色 |
Enabled |
是否启用用户访问权限,包括: · Enabled:启用 · Disabled:不启用 |
Privilege |
用户具有的权限列表 |
IPMIEnable |
IPMI扩展权限使能 |
KvmEnable |
KVM扩展权限使能 |
VmediaEnable |
VM扩展权限使能 |
WebEnable |
Web扩展权限使能 |
SnmpV3Enable |
SNMP V3扩展权限使能 |
SnmpV3AccessPermission |
SNMP V3读写权限: · read_only · read_write |
SnmpV3AuthProtocol |
SNMP V3鉴权算法: · sha · md5 · sha256 · sha384 · sha512 |
SnmpV3PrivProtocol |
SNMP V3加密算法: · des · aes · aes192 · aes256 |
本命令用于添加用户。
【命令】
hREST -H host -p port -U username -P password adduser -N name –P userPWD –R role -EN enabled –KVM kvmEnable –VME vmeEnable -IPMI ipmiEnable -WEB KvmEnable -V3 snmpV3Enable -V3APE snmpV3AccessPermission -V3APR snmpV3AuthProtocol -V3PP snmpV3PrivProtocol -I userId -V3PWD snmpV3Password
【参数】
表2-53 参数说明
参数 |
描述 |
取值 |
name |
用户名,为必配参数 |
- |
userPWD |
用户密码,为必配参数 |
- |
role |
用户角色,为必配参数 |
- |
enabled |
用户访问权限,为可选参数 |
是否启用用户访问权限,包括: · Enable:启用 · Disable:不启用 |
kvmenable |
用户KVM权限,为可选参数 |
是否启用用户KVM权限,包括: · Enable:启用 · Disable:不启用 |
vmeenable |
用户Vmedia权限,为可选参数 |
是否启用用户Vmedia权限,包括: · Enable:启用 · Disable:不启用 |
IPMIEnable |
布尔型,为可选参数 |
IPMI扩展权限使能 |
WebEnable |
布尔型,为可选参数 |
Web扩展权限使能 |
SnmpV3Enable |
布尔型,为可选参数 |
SnmpV3扩展权限使能 |
SnmpV3AccessPermission |
字符串,为可选参数 |
SNMP V3读写权限: · read_only · read_write |
SnmpV3AuthProtocol |
字符串,为可选参数 |
SNMP V3鉴权算法: · sha · md5 · sha256 · sha384 · sha512 G6新增sha256、sha384、sha512 |
SnmpV3PrivProtocol |
字符串,为可选参数 |
SNMP V3加密算法: · des · aes · aes192 · aes256 G6新增aes192、aes256 注:加密算法aes192和aes256只能与鉴权算法sha256、sha384或sha512搭配使用 |
userId |
整型,为可选参数 |
- |
SnmpV3Password |
字符串,为可选参数 |
SnmpV3独立密码 注:独立密码最长为40位 |
【使用指南】
HDM-2.0.04以前版本角色组权限可选Administrator、Operator、User、None选项,CustomRole1~5不可用,在HDM-2.0.04至HDM-2.06版本CustomRole1~5实际生效角色组权限为Custom 1~5,HDM-2.06版本以后新增可选范围CustomRole1~5,HDM-2.33新增角色组自定义,需根据自定义情况设置角色组。
【举例】
# 添加用户。
-> hREST –H 192.168.10.6 –U ****** -P ****** adduser -N test -P test@test123 -R Operator -EN Enable -KVM Enable -VME Enable -IPMI Enable -WEB Enable -V3 Enable -V3APE read_only -V3APR sha -V3PP des
Success: add user successfully
【修改记录】
(1) hREST V1.08新增角色组可选范围CustomRole1~5
本命令用于修改用户信息,比如用户密码及用户角色。
【命令】
hREST -H host -p port -U username -P password setuser –N name –P newpwd –R newrole -EN enabled –KVM kvmenable –VME vmeenable -IPMI Enable -WEB Enable -V3 SnmpV3Enable -V3APE SnmpV3AccessPermission -V3APR SnmpV3AuthProtocol -V3PP SnmpV3PrivProtocol -U newName -V3PWD SnmpV3Password
【参数】
表2-54 参数说明
参数 |
描述 |
取值 |
name |
所要修改信息的用户名,为可选参数 |
参数为空时,默认修改当前用户 |
newpwd |
用户新密码,为可选参数 |
- |
newrole |
用户新角色,为可选参数 |
- |
enabled |
用户访问权限,为可选参数 |
是否启用用户访问权限,包括: · Enable:启用 · Disable:不启用 |
kvmenable |
用户KVM权限,为可选参数 |
是否启用用户KVM权限,包括: · Enable:启用 · Disable:不启用 |
vmeenable |
用户Vmedia权限,为可选参数 |
是否启用用户Vmedia权限,包括: · Enable:启用 · Disable:不启用 |
IPMIEnable |
用户IPMI权限,为可选参数 |
IPMI扩展权限使能,包括: · Enable:启用 · Disable:不启用 |
WebEnable |
用户Web权限,为可选参数 |
Web扩展权限使能,包括: · Enable:启用 · Disable:不启用 |
SnmpV3Enable |
用户SNMP V3权限,为可选参数 |
SnmpV3扩展权限使能,包括: · Enable:启用 · Disable:不启用 |
SnmpV3AccessPermission |
SnmpV3读写权限,为可选参数 |
SNMP V3读写权限: · read_only · read_write |
SnmpV3AuthProtocol |
SnmpV3鉴权算法,为可选参数 |
SNMP V3鉴权算法: · sha · md5 · sha256 · sha384 · sha512 G6新增sha256、sha384、sha512 |
SnmpV3PrivProtocol |
SnmpV3加密算法,为可选参数 |
SNMP V3加密算法: · des · aes · aes192 · aes256 G6新增aes192、aes256 · 注:加密算法aes192和aes256只能与鉴权算法sha256、sha384或sha512搭配使用 |
newName |
用户新名称,为可选参数 |
- |
SnmpV3Password |
SnmpV3密码,为可选参数 |
SnmpV3独立密码 注:独立密码最长为40位 |
【使用指南】
HDM-2.0.04以前版本角色组权限可选Administrator、Operator、User、None选项,CustomRole1~5不可用,在HDM-2.0.04至HDM-2.06版本CustomRole1~5实际生效角色组权限为Custom 1~5,HDM-2.06版本以后新增可选范围CustomRole1~5,HDM-2.33新增角色组自定义,需根据自定义情况设置角色组。
【举例】
# 修改用户角色。
-> hREST –H 192.168.10.6 –U ****** -P ****** setuser -N test -P test@test123 -R Operator -EN Enable -KVM Enable -VME Enable -IPMI Enable -WEB Enable -V3 Enable -V3APE read_only -V3APR sha -V3PP aes
Success: set user successfully
本命令用于删除用户。
【命令】
hREST -H host -p port -U username -P password deluser –N name
【参数】
表2-55 参数说明
参数 |
描述 |
取值 |
name |
所要删除的用户名,为必配参数。 |
- |
【举例】
# 删除用户名为user的用户。
-> hREST –H 192.168.10.6 –U ****** -P ****** deluser –N user
Success: delete user successfully
本命令用于获取BIOS信息。
【命令】
hREST -H host -p port -U username -P password getbios –A value
【参数】
表2-56 参数说明
参数 |
描述 |
取值 |
value |
指定BIOS属性,当HDM或BIOS的固件版本为B01时,为必配参数;当HDM或BIOS的固件版本为B02及其以上版本时,为可选参数。 |
- |
【使用指南】
当服务器的BIOS版本为BIOS-1.00.XX或HDM版本为HDM-1.10.XX时,命令行工具通过HDM的IPMI接口来进行BIOS的查询,且仅支持单个BIOS配置项查询,加-a value,value为指定BIOS属性。
【举例】
# 获取BIOS CPUC6Report选项的信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getbios -A CPUC6Report
--------------------------------------------------
CPUC6Report : Auto
--------------------------------------------------
本命令用于设置BIOS选项的值。
hREST命令行工具通过HDM的IPMI或Redfish接口来实现设置BIOS选项的功能。
· 当服务器的HDM版本为HDM-1.10.XX时,hREST命令行工具通过HDM的IPMI接口来进行BIOS选项设置,具体支持设置的BIOS选项及取值请参见《H3C HDM IPMI基础命令参考手册》的“设置BIOS单个配置信息”章节。
· 当服务器的HDM版本为HDM-1.11.00及以上时,hREST命令行工具通过HDM的Redfish接口来进行BIOS选项设置,具体支持修改的BIOS选项及取值请参见《H3C HDM Redfish参考手册》的“BIOS选项参数及说明”章节。
· 具体可设置项也可参见getbios命令获取到的配置项。
【命令】
hREST -H host -p port -U username -P password setbios –A attribute –V value
【参数】
表2-57 参数说明
参数 |
描述 |
取值 |
attribute |
BIOS选项名称,为必配参数。 |
- |
value |
该BIOS选项可设置的参数值,为必配参数。 |
- |
【使用指南】
重启BIOS生效。
【举例】
# 设置BIOS选项CPUC6Report的值为Disable。
-> hREST –H 192.168.10.6 –U ****** -P ****** setbios -A CPUC6Report -V Disable
Success: BIOS setup is successfully
# 设置启动顺序BootOption#1为Network
-> hREST –H 192.168.10.6 –U ****** -P ****** setbios -a BootOption#1 -v Network
Success: BIOS setup is successfully
本命令用于获取BIOS待生效配置信息。
【命令】
hREST -H host -p port -U username -P password getbiossetting
【使用指南】
当服务器的BIOS版本为BIOS-1.00.XX或HDM版本为HDM-1.10.XX时,不支持获取BIOS待生效配置。
【举例】
# 获取BIOS待生效配置信息信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getbiossetting
--------------------------------------------------
CPUC6Report : Auto
--------------------------------------------------
本命令用于恢复BIOS配置。
【命令】
hREST -H host -p port -U username -P password setbiosdefault –T type
【参数】
表2-58 参数说明
字段 |
描述 |
取值 |
type |
BIOS恢复类型,为可选参数,缺省状态为default。 |
BIOS恢复类型,包括: · default:默认配置 · factory:出厂配置 |
【使用指南】
重启BIOS生效。HDM B01版本不支持,对于B03,HDM-1.30.15SP12合入需求,并同步至B05 DHM-2.19。当不满足恢复出厂配置条件则执行恢复默认配置操作。
【举例】
# 恢复BIOS出厂设置。
-> hREST –H 192.168.10.6 –U ****** -P ****** setbiosdefault –T factory
Success: restore BIOS factory settings successfully
本命令用于恢复BMC配置。
【命令】
hREST -H host -p port -U username -P password setbmcdefault –T type
【参数】
表2-59 参数说明
字段 |
描述 |
取值 |
type |
BMC恢复类型,为可选参数,缺省状态为default。 |
BMC恢复类型,包括: · default:默认配置 · factory:出厂配置 |
【使用指南】
HDM B01版本不支持,对于B03,HDM-1.30.15SP12合入需求,并同步至B05 DHM-2.19。
【举例】
# 恢复BMC出厂设置。
-> hREST –H 192.168.10.6 –U ****** -P ****** setbmcdefault –T factory
Success: restore BMC factory settings successfully
本命令用于获取风扇信息。
【命令】
hREST -H host -p port -U username -P password getfan
【举例】
# 获取风扇信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getfan
--------------------------------------------------
FanCount : 6
FanSpeedAdjustmentMode : Automatic
--------------------------------------------------
Id : 0
FanName : N/A
Slot : 1
Location : chassis
Model : 3203A01V
RatedSpeedRPM : 19
SpeedRPM : 3500
LowerThresholdRPM : N/A
[Status]
State : Enabled
Health : N/A
--------------------------------------------------
Id : 1
FanName : N/A
Location : chassis
Slot : 2
Model : 3203A01V
RatedSpeedRPM : 42
SpeedRPM : 7200
LowerThresholdRPM : N/A
[Status]
State : Enabled
Health : N/A
--------------------------------------------------
Id : 2
FanName : N/A
Location : chassis
Slot : 3
Model : 3203A01V
RatedSpeedRPM : 19
SpeedRPM : 3300
LowerThresholdRPM : N/A
[Status]
State : Enabled
Health : N/A
--------------------------------------------------
Id : 3
FanName : N/A
Location : chassis
Slot : 4
Model : 3203A01V
RatedSpeedRPM : 25
SpeedRPM : 4300
LowerThresholdRPM : N/A
[Status]
State : Enabled
Health : N/A
--------------------------------------------------
Id : 4
FanName : N/A
Location : chassis
Slot : 5
Model : 3203A01V
RatedSpeedRPM : 42
SpeedRPM : 7300
LowerThresholdRPM : N/A
[Status]
State : Enabled
Health : N/A
--------------------------------------------------
Id : 5
FanName : N/A
Location : chassis
Slot : 6
Model : 3203A01V
RatedSpeedRPM : 42
SpeedRPM : 7300
LowerThresholdRPM : N/A
[Status]
State : Enabled
Health : N/A
--------------------------------------------------
【输出说明】
表2-60 输出说明
参数 |
描述 |
FanCount |
最大风扇传感器的数量 |
FanSpeedAdjustmentMode |
调速模式 |
Id |
风扇ID |
FanName |
风扇名称 |
Slot |
槽位号 |
Location |
风扇位置 |
Model |
风扇型号 |
RatedSpeedRPM |
风扇转速比 |
SpeedRPM |
风扇转速 |
LowerThresholdRPM |
低速告警阈值 |
State |
风扇使能状态 |
Health |
风扇健康状态 |
本命令用于设置风扇转速。
【命令】
hREST -H host -p port -U username -P password setfan –M mode –S fanSpeed
【参数】
表2-61 参数说明
参数 |
描述 |
取值 |
mode |
风扇模式,为必配参数 |
风扇速率模式,包括: · Optimal:最佳散热模式 · Increased:增强散热模式 · Maximum:最大散热模式 · Custom:自定义散热模式 |
fanspeed |
风扇档位,自定义模式下为必配参数,其他模式不可用 |
1-20代表风扇调速的档位值 |
【举例】
# 设置风扇转速。
-> hREST –H 192.168.10.6 –U ****** -P ****** setfan -M Custom -S 10
Success: fan speed control successfully
本命令设置关闭带内设置用户。
【命令】
hREST -H host -p port -U username -P password closeinner –S status
【参数】
表2-62 参数说明
参数 |
描述 |
取值 |
status |
关闭带内设置用户是否使能 |
是否使能关闭带内用户设置,包括: · Enable:是 · Disable:否 |
【举例】
# 设置关闭带内设置用户
-> hREST –H 192.168.10.6 –U ****** -P ****** closeinner –S Enable
Success: set close inner set user status successfully
本命令用于导出配置。
【命令】
hREST -H host -p port -U username -P password downloadconfig -T type –F filePath
【参数】
表2-63 参数说明
参数 |
描述 |
取值 |
type |
导出配置类型,为必配参数 |
配置类型,包括: · RAID · BMC · BIOS |
filePath |
保存配置文件的路径及文件名,为必配参数 |
参数为空时,将自动保存到本工具目录下的config文件夹中 |
【举例】
# 导出BIOS配置。
-> hREST –H 192.168.10.6 –U ****** -P ****** downloadconfig -T BIOS -F ../update/bios.json
Success: export BIOS configuration is successful
本命令用于导入配置。
【命令】
hREST -H host -p port -U username -P password uploadconfig -T type –F filePath
【参数】
表2-64 参数说明
参数 |
描述 |
取值 |
type |
导出配置类型,为必配参数 |
配置类型,包括: · RAID · BMC · BIOS |
filePath |
保存配置文件的路径,必选参数 |
- |
【举例】
# 导入BIOS配置。
-> hREST –H 192.168.10.6 –U ****** -P ****** uploadconfig -T BIOS -F ../update/bios.json
Success: import BIOS configuration successfully
本命令用于获取固件版本。
【命令】
hREST -H host -p port -U username -P password getfwv
【举例】
# 获取固件版本信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getfwv
--------------------------------------------------
Name : HDM
Version : 1.30.15 HDM V100R001B03D015
--------------------------------------------------
Name : CPLD
Version : V007
--------------------------------------------------
Name : BIOS
Version : 2.00.37P06 V100R001B02D037SP06
--------------------------------------------------
Name : ME
Version : 4.1.4.339
--------------------------------------------------
Name : NIC-GE-4P-360T-L3
Version : 1.1767.0
--------------------------------------------------
Name : HBA-LSI-9440-8i
Version : 5.010.01-0671
--------------------------------------------------
【输出说明】
表2-65 输出说明
参数 |
描述 |
Name |
固件名称 |
Version |
固件版本 |
本命令用于获取NTP信息。
【命令】
hREST -H host -p port -U username -P password getntp
【举例】
# 获取ntp信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getntp
--------------------------------------------------
ServiceEnabled : False
RefreshInterval : 3600
TimeZone : UTC-9
PreferredNtpServer : 1.cn.pool.ntp.org
AlternateNtpServer : 2.cn.pool.ntp.org
TertiaryNtpServer :
NtpAddressOrigin : Static
--------------------------------------------------
【输出说明】
表2-66 输出说明
参数 |
描述 |
ServiceEnabled |
是否开启NTP自动同步 |
RefreshInterval |
刷新间隔 |
TimeZone |
时区 |
PreferredNtpServer |
主NTP服务器 |
AlternateNtpServer |
二级NTP服务器 |
TertiaryNtpServer |
三级NTP服务器 |
NtpAddressOrigin |
NTP模式,当前只支持Static |
本命令用于设置NTP信息。
【命令】
hREST -H host -p port -U username -P password setntp -S status -PRE prentpserver -ALT altntpserver -TN TertiaryNtpServer
hREST -H host -p port -U username -P password setntp -Z timezone
hREST -H host -p port -U username -P password setntp -F timeinterval
【参数】
表2-67 参数说明
参数 |
描述 |
取值 |
status |
是否开启NTP功能,为可选参数 |
是否启用,包括: · Enable:启用 · Disable:不启用 |
prentpserver |
首选NTP服务器,为可选参数 |
- |
altntpserver |
备用NTP服务器,为可选参数 |
- |
TertiaryNtpServer |
三级NTP服务器,为可选参数 |
- |
timezone |
NTP时区,为可选参数 |
- |
timeinterval |
NTP时间同步间隔,为可选参数 |
[600,2592000]之间100的整数倍,该参数和其他参数不能同时设置。 |
【使用指南】
当设置参数和原有参数相同,可能会返回失败。在HDM-2.xx版本HDM,首选NTP服务器和备用NTP服务器需要同时配置,否则可能会出现NTP服务器配置异常,HDM-3.10及其以后版本问题解决。
【举例】
# 开启NTP服务。
-> hREST –H 192.168.10.6 –U ****** -P ****** setntp -S Enable -PRE 192.168.170.66 -ALT 192.168.170.67 -TN 192.168.170.68
Success: set ntp server information successful
# 设置NTP时区,设置NTP时区需要NTP时钟同步在关闭状态下
-> hREST –H 192.168.10.6 –U ****** -P ****** setntp –Z UTC+9
Success: set ntp server information successful
# 设置NTP时间同步间隔。
-> hREST –H 192.168.10.6 –U ****** -P ****** setntp –F 800
Success: set ntp time synchronization interval successful
本命令用于获取SNMP信息。
【命令】
hREST -H host -p port -U username -P password getsnmp
【举例】
# 获取snmp信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getsnmp
--------------------------------------------------
Description : SnmpService Gettings
Id : SnmpService
LongPasswordEnabled : False
Name : SNMP
ReadOnlyCommunity : rocommstr
ReadWriteCommunity :
SnmpTrapNotification
AlarmSeverity : Minor+Major+Critical
CommunityName : public
ServiceEnabled : True
TrapMode : NodeMode
TrapServer
Enabled : True
MemberId : 1
TrapServerAddress :
TrapServerPort : 162
------------------------------------------
Enabled : True
MemberId : 2
TrapServerAddress :
TrapServerPort : 162
------------------------------------------
Enabled : True
MemberId : 3
TrapServerAddress :
TrapServerPort : 162
------------------------------------------
Enabled : True
MemberId : 4
TrapServerAddress :
TrapServerPort : 162
------------------------------------------
TrapServerIdentity : HDM210200A00QH17C000002
TrapV3User :
TrapVersion : v1
SnmpV1Enabled : False
SnmpV2CEnabled : True
SnmpV3AuthProtocol :
SnmpV3Enabled : True
SnmpV3PrivProtocol :
--------------------------------------------------
【输出说明】
表2-68 输出说明
参数 |
描述 |
Description |
SNMP资源描述 |
Id |
功能ID |
LongPasswordEnabled |
超长口令使能状态 |
Name |
功能名称 |
ReadOnlyCommunity |
只读团体名 |
ReadWriteCommunity |
读写团体名 |
AlarmSeverity |
告警等级,包括: · Critical · Minor+Major+Critical · All |
CommunityName |
Trap团体名 |
ServiceEnabled |
是否启用SNMP trap服务 |
TrapMode |
Trap模式,包括: · NodeMode:模块OID模式 · EventMode:事件OID模式 · EventCodeMode:事件码OID模式 |
TrapServer |
告警Trap报文设置 |
Enabled |
Trap服务使能 |
MemberId |
Trap成员ID |
TrapServerAddress |
Trap服务地址 |
TrapServerPort |
Trap服务端口 |
TrapServerIdentity |
主机标识 |
TrapV3User |
V3用户 |
TrapVersion |
SNMP Trap版本 |
SnmpV1Enabled |
V1启用 |
SnmpV2CEnabled |
V2C启用 |
SnmpV3AuthProtocol |
SNMP V3鉴权算法: · sha · md5 |
SnmpV3Enabled |
V3启用 |
SnmpV3PrivProtocol |
SNMP V3加密算法: · des · aes |
本命令用于设置SNMP信息。
【命令】
hREST -H host -p port -U username -P password setsnmp -V1E snmpV1Enabled -V2CE snmpV2CEnabled -LPE longPasswordEnabled -ROC readOnlyCommunity -RWC readWriteCommunity -CN communityName -SE serviceEnabled -TV trapVersion -T3U trapV3User -AS alarmSeverity -TM trapMode -TS trapServer -V3E snmpV3Enabled
【参数】
表2-69 参数说明
参数 |
参数说明 |
取值 |
snmpV1Enabled |
SNMP协议版本1使能状态,为可选参数 |
SNMP协议版本1是否使能,包括: · Enable:是 · Disable:否 |
snmpV2CEnabled |
SNMP协议版本2使能状态,为可选参数 |
SNMP协议版本2是否使能,包括: · Enable:是 · Disable:否 |
snmpV3Enabled |
SNMP协议版本3使能状态,为可选参数 |
SNMP协议版本3是否使能,包括: Enable:是 Disable:否 |
longPasswordEnabled |
超长口令使能状态,为可选参数 |
超长口令是否使能,包括: · Enable:是 · Disable:否 |
readOnlyCommunity |
只读团体名,为可选参数 |
- |
readWriteCommunity |
读写团体名,为可选参数 |
- |
communityName |
Trap团体名,为可选参数 |
若输入参数为“”(空字符串),相当于删除团体名 |
serviceEnabled |
Trap服务使能状态,为可选参数 |
Trap服务是否使能,包括: · Enable:是 · Disable:否 |
trapVersion |
Trap版本,为可选参数 |
Trap版本,包括:v1、v2c、v3 |
trapV3User |
Trap V3用户,为可选参数 |
- |
alarmSeverity |
告警等级,为可选参数 |
HDM-1.122.05之前版本可修改的告警等级,包括: · Critical · WarningAndCritical · All (1) HDM-1.30.11P01:字段AlarmSeverity值取值为:"Critical","MinorAndMajorAndCritical","All" (2) HDM-2.10.00:字段AlarmSeverity的可选值由" Critical"修改成"MajorAndCritical"
(3) 其他情况以实际为准 |
trapMode |
Trap模式,为可选参数 |
Trap模式: · NodeMode:模块OID模式 · EventMode:事件OID模式 · EventCodeMode:事件码OID模式 |
trapServer |
Trap服务器参数数组集合,为可选参数 |
示例: [1-1-163-192.168.11.32_ 2-1-163-192.168.11.44_ 3-1-163-192.168.11.55_ 4-1-163-192.168.11.55] 表示设置四个Trap服务器,每个Trap服务器信息由四个参数组成,用冒号分隔,以2:1:163:192.168.11.44为例说明 · 2表示编号 · 1表示启用 · 163为端口号 · 192.168.11.44表示Trap服务器地址 |
trapServer.Enabled |
Trap服务使能状态,为可选参数 |
- |
trapServer.TrapServerPort |
Trap服务端口,为可选参数 |
- |
trapServer.TrapServerAddress |
Trap服务地址,支持IP地址和域名,为可选参数 |
- |
【使用指南】
无
【举例】
# 设置SNMP服务。
-> hREST -H 192.168.10.32 -p 443 -U admin -P Password@_ setsnmp -V1E Disable -V2CE Enable -LPE Disable -ROC rocommstr_r -RWC rocommstr_w -CN public -SE Enable -TV v1 -T3U admin -AS Critical -TM NodeMode -TS [1-1-163-192.168.10.121_2-1-163-192.168.10.122]
Success: set snmp successfully
本命令用于获取服务配置信息。
【命令】
hREST -H host -p port -U username -P password getservice –T serviceType
【参数】
表2-70 参数说明
参数 |
描述 |
取值 |
serviceType |
服务信息类型,为可选参数,参数为空时展示所有服务信息 |
服务信息类型,包括: · Web · KVM · CD-Media · FD-Media · HD-Media · SSH · Telnet · IPMI · SNMP · VNC · Remote_XDP |
【举例】
# 获取Web服务配置信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getservice –T Web
--------------------------------------------------
Name : Web
Status : Enable
Insecure service port : 80
Secure service port : 443
Idle timeout : 1800
Maximum sessions : 20
--------------------------------------------------
【输出说明】
表2-71 输出说明
参数 |
描述 |
Name |
服务名称 |
Status |
服务状态,包括: · Enable:活动 · Disable:禁用 |
Insecure service port |
服务的非安全端口 |
Secure service port |
服务的安全端口 |
Idle timeout |
超时时长 |
Maximum sessions |
服务的最大会话数 |
本命令用于设置服务配置信息。
【命令】
hREST -H host -p port -U username -P password setservice -T type -S status –M timeout –SP securePort –NSP nonSecurePort
【使用指南】
Web和IPMI服务不支持设置状态。
【参数】
表2-72 参数说明
参数 |
描述 |
取值 |
type |
服务类型,为必配参数 |
服务信息类型,包括: · Web · KVM · CD-Media · FD-Media · HD-Media · SSH · Telnet · IPMI · SNMP · VNC · Remote_XDP |
status |
是否开启服务,为可选参数 |
是否启用,包括: · Enabled:启用 · Disabled:不启用 |
timeout |
服务会话的超时时间,为可选参数 说明: type参数取值为CD-Media、FD-Media、HD-Media、Remote_XDP、SNMP、IPMI时,不支持设置 |
超时时间长度,单位为分钟 |
securePort |
安全端口号 |
- |
nonSecurePort |
非安全端口号 |
- |
【举例】
# 设置VNC服务。
-> hREST –H 192.168.10.6 –U ****** -P ****** setservice -T VNC -S Enabled -NSP 4901
Success: set BMC network protocol services successfully
本命令用于下载SDS日志。
【命令】
hREST -H host -p port -U username -P password getsdslog –F filePath -P startDate –Q endDate
【参数】
表2-73 参数说明
参数 |
描述 |
取值 |
filePath |
存储SDS日志的文件路径,为必配参数 |
避免出现中文字符,以免出现字符编码格式问题 |
startDate |
SDS日志起始时间,为可选参数 |
年-月-日 |
endDate |
SDS日志终止时间,为可选参数 |
年-月-日 |
【使用指南】
· 当不指定起始和终止日期时,默认下载全部日志。
· 下载的SDS文件名默认为SN号_日期,形如HDM12345678912345678907_20191223_20191230.sds。
· 不支持带内模式
【举例】
# 下载从2019-01-21到2019-01-28的SDS日志到F:\sdslog。
-> hREST –H 192.168.10.6 –U ****** -P ****** getsdslog –F F:\sdslog -P 2019-01-21 -Q 2019-01-28
Success: one-click collection of log requests succeeded
本命令用于获取虚拟媒体信息。
【命令】
hREST -H host -p port -U username -P password getvmm –T mediaType
【参数】
表2-74 参数说明
参数 |
描述 |
取值 |
mediaType |
虚拟媒体类型,为必选参数。 |
服务信息类型,包括: · HD · CD |
【举例】
# 获取CD虚拟媒体信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getvmm –T CD
--------------------------------------------------
[Connected]
----------------------------------------------
MediaIndex : 0
ImageName : bnx2x-1.714.18-dd-xs6.5-3.10.0+2-x86_64.iso
MediaTypes : CD/DVD
----------------------------------------------
MediaIndex : 1
ImageName : netxtreme2-7.14.46-dd-sles11sp3-3.0.76_0.11-x86_64.iso
MediaTypes : CD/DVD
----------------------------------------------
[NotConnected]
----------------------------------------------
ID : 1
ImageName : netxtreme2-7.14.46-dd-sles12sp2-4.4.21_69-x86_64.iso
MediaTypes : CD/DVD
----------------------------------------------
ID : 2
ImageName : ONEStor-Ubuntu_14.04.3.18.iso
MediaTypes : CD/DVD
----------------------------------------------
ID : 3
ImageName : REPO-1.11.02.iso
MediaTypes : CD/DVD
----------------------------------------------
--------------------------------------------------
# 获取HD虚拟媒体信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getvmm –T HD
--------------------------------------------------
[Connected]
----------------------------------------------
MediaIndex : 0
ImageName : BOOT95.IMG
MediaTypes : Hard disk
----------------------------------------------
[NotConnected]
----------------------------------------------
ID : 4
ImageName : BOOT98.IMG
MediaTypes : Hard disk
----------------------------------------------
ID : 5
ImageName : BOOTDOS.IMG
MediaTypes : Hard disk
----------------------------------------------
--------------------------------------------------
【输出说明】
表2-75 输出说明
参数 |
描述 |
MediaIndex |
已挂载虚拟媒体ID |
ID |
未挂载虚拟媒体ID |
ImageName |
虚拟媒体名称 |
MediaTypes |
虚拟媒体类型 |
本命令用来控制虚拟媒体的挂载与卸载
【命令】
hREST -H host -p port -U username -P password mountvmm -O type -I image
【用户权限】
admin
【参数】
表2-76 参数说明
字段 |
描述 |
取值 |
type |
控制虚拟媒体操作类型,为必配参数。 |
操作类型,包括: l Mount:挂载 l Unmount:卸载 |
image |
虚拟媒体镜像,挂载操作时为必配参数。 |
- |
【使用指南】
无
【举例】
# 挂载镜像。
-> ./hREST –H 192.168.10.6 –U ****** -P ****** mountvmm -O Mount -I nfs://192.168.190.51/Share/image.so
Success: successfully mount virtual media
本命令用于升级固件,包括BIOS、BMC和CPLD。
【命令】
hREST -H host -p port -U username -P password fwupdate –E mode –O override -T type -U firmware –F isForce
【参数】
表2-77 参数说明
参数 |
描述 |
取值 |
mode |
升级模式,为必配参数 |
升级模式,包括: · Manual:升级后手动重启 · Auto:升级后自动重启 |
override |
是否覆盖配置,为可选参数,缺省状态下为不覆盖。 |
是否覆盖配置,包括: · 0:不覆盖 · 1:覆盖 |
type |
固件升级类型,为必配参数 |
- |
firmware |
固件文件路径与文件名,为必配参数 |
- |
isForce |
是否强制升级,仅针对REPO,缺省状态下为非强制。 |
是否强制升级,包括: · 0:仅高版本升级 · 1:强制升级 |
【使用指南】
需要注意的是配置覆盖在升级HDM时对应恢复出厂配置,恢复BIOS时对应配置覆盖。带内模式仅支持BMC和BIOS升级。
【举例】
# 升级bmc。
-> hREST –H 192.168.10.6 –U ****** -P ****** fwupdate -E Auto -T BMC -U ../config/HDM-1.30.18_signed.bin
2020-07-03 17:21:54 Get product serial number : 210200A00QH17C000002
2020-07-03 17:21:54 Check environment is ok
2020-07-03 17:21:54 Set fw type success
2020-07-03 17:21:55 Upload file start
2020-07-03 17:22:02 Upload file inprogress...
2020-07-03 17:22:41 Upload file successfully
2020-07-03 17:22:45 File verify successfully
2020-07-03 17:22:45 Apply(Flash) start
2020-07-03 17:23:56 Apply(Flash) ingrogress, process: 100% done
2020-07-03 17:24:01 Apply(Flash) successfully
2020-07-03 17:24:01 Auto model BMC restart, please waiting...
2020-07-03 17:29:13 BMC reboot complete
2020-07-03 17:29:13 Version verify ok
HDM upgrade successfully, Version: image change from 1.30.15 to 1.30.18
本命令用于获取PCIe设备列表。
【命令】
hREST -H host -p port -U username -P password getpcie
【举例】
# 获取PCIE设备列表。
-> hREST –H 192.168.10.6 –U ****** -P ****** getpcie
--------------------------------------------------
Location : PCIe slot 3
ProductName : HBA-LSI-9440-8i
VendorID : 0x1000
VendorName : None
SerialNumber : SP73513465
ProductID : 0x0017
NegotiatedSpeed : 8.0GT/s
NegotiatedProtocol : Gen 3
NegotiatedLinkWidth : x8
MaxSpeed : None
MaxProtocol : Gen 3
PartNumber : N/A
MaxLinkWidth : x8
[Status]
Status : Enabled
Health : OK
--------------------------------------------------
【输出说明】
表2-78 输出说明
参数 |
描述 |
Location |
PCIe卡位置 |
ProductName |
产品名称 |
VendorID |
厂商ID |
VendorName |
厂商名称 |
SerialNumber |
序列号 |
ProductID |
设备ID |
NegotiatedSpeed |
协商速率 |
NegotiatedProtocol |
协商协议 |
NegotiatedLinkWidth |
协商带宽 |
MaxSpeed |
最大速率 |
MaxProtocol |
最高协议 |
PartNumber |
部件号 |
Status |
使能状态 |
Health |
健康状态 |
本命令用于获取KVM截图,HDM-1.30.08之后合入。
【命令】
hREST -H host -p port -U username -P password getscreencapture -F path
【使用指南】
G6机型不支持该功能
【参数】
表2-79 参数说明
参数 |
描述 |
取值 |
path |
截图存放路径,必备参数。 |
- |
【举例】
-> hREST -H 192.168.10.11 -U admin -P Password@_ getscreencapture -F ../update
Success: get screen capture successfully
截图文件示例:
本命令用于LDAP的高级设置。
【命令】
hREST -H host -p port -U username -P password setldap -BD bindDn -CNT commonNameType -E enable -ET encryptionType -PW ldapPassword –P port -SB searchBase -SA serverAddress -ULA userLoginAttribute
【参数】
表2-80 参数说明
参数 |
描述 |
取值 |
bindDn |
LDAP管理员用户DN,为可选参数 |
最大长度255 |
commonNameType |
LDAP服务器地址类型,为可选参数 |
· ip · fqdn |
enable |
LDAP认证是否开启,为必配参数 |
LDAP认证是否开启,包括: · 0:停用 · 1:启用 |
encryptionType |
加密类型,为可选参数 |
加密类型,包括: · 0:无加密 · 1:SSL认证类型 |
ldapPassword |
LDAP密码,为可选参数 |
- |
port |
LDAP端口号,为可选参数 |
- |
searchBase |
LDAP搜索库DN,为可选参数 |
- |
serverAddress |
LDAP Server字符串,为可选参数 |
LDAP服务器地址类型为ip时,支持IPV4、IPV6 LDAP服务器地址类型为fqdn时,支持域名地址 |
userLoginAttribute |
用户登录属性,为可选参数 |
用户登录属性,包括: · uid:代表uid · cn:代表cn |
【举例】
-> hREST -H 192.168.10.32 -p 443 -U admin -P Password@_ setldap -E 1 -PW 123456 -BD cn=admin,dc=example,dc=com -ULA uid -ET 1 -P 100 -CNT ip -SB dc=example,dc=com -SA 192.168.1.2
Success: set ldap successfully
本命令用于获取LDAP信息。
【命令】
hREST -H host -p port -U username -P password getldap
【参数】
无
【使用指南】
无
【举例】
# 获取LDAP信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getldap
--------------------------------------------------
CertificateVerificationState : Enable
EncryptionType : SSL
CommonNameType : IP
ServerAddress : 192.168.1.2
PortNumber : 100
BindDN : cn=admin,dc=example,dc=com
Password :
SearchBase : dc=example,dc=com
UserIdentification : uid
[LdapGroups]
----------------------------------------------
MemberId : 1
GroupName : test
GroupDomain : dc=example,dc=com
GroupRole : Administrator
----------------------------------------------
MemberId : 2
GroupName : test1
GroupDomain : dc=example,dc=com
GroupRole : User
----------------------------------------------
MemberId : 3
GroupName : test2
GroupDomain : dc=example,dc=com
GroupRole : Operator
--------------------------------------------------
【输出说明】
表2-81 参数说明
参数 |
描述 |
CertificateVerificationState |
LDAP认证是否开启,包括: · Enable:启用 · Disable:禁用 |
EncryptionType |
加密类型,包括: · No encryption:无加密 · SSL:SSL认证类型 |
CommonNameType |
通用名称类型,包括: · IP · FQDN |
ServerAddress |
服务器地址 |
PortNumber |
端口号 |
BindDN |
Bind DN |
Password |
密码,不显示 |
SearchBase |
用户搜索库 |
UserIdentification |
用户登录属性 |
MemberId |
角色组ID |
GroupName |
角色组名称 |
GroupDomain |
角色组搜索库 |
GroupRole |
角色组权限 |
本命令用于新增或修改LDAP用户。
【命令】
hREST -H host -p port -U username -P password addldapuser -RI roleId -RGN roleGroupName -RGD roleGroupDomain -RGP roleGroupPrivilege -RGKP roleGroupKvmPrivilege -RGVP roleGroupVmediaPrivilege -RGNP roleGroupNetworkPrivilege -RGUP roleGroupUserPrivilege -RGBP roleGroupBasicPrivilege -RGPP roleGroupPowerPrivilege -RGFP roleGroupFirmwarePrivilege -RGHP roleGroupHealthPrivilege -RGRP roleGroupRemotectrlPrivilege
【参数】
表2-82 参数说明
参数 |
描述 |
取值 |
roleId |
角色组ID,为必配参数 |
1、2、3、4、5 |
roleGroupName |
角色组名称,为必配参数 |
- |
roleGroupDomain |
角色组搜索库,为必配参数 |
- |
roleGroupPrivilege |
角色组权限,为必配参数 |
- |
roleGroupKvmPrivilege |
KVM权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
roleGroupVmediaPrivilege |
镜像挂载权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
roleGroupNetworkPrivilege |
网络配置权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
roleGroupUserPrivilege |
用户配置权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
roleGroupBasicPrivilege |
基本配置权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
roleGroupPowerPrivilege |
电源管理权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
roleGroupFirmwarePrivilege |
固件更新权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
roleGroupHealthPrivilege |
健康诊断权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
roleGroupRemotectrlPrivilege |
远程控制权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
【使用指南】
HDM-2.0.04以前版本角色组权限可选Administrator、Operator、User选项,CustomRole1~5不可用,在HDM-2.0.04至HDM-2.06版本CustomRole1~5实际生效角色组权限为Custom 1~5,HDM-2.06版本以后新增可选范围CustomRole1~5,HDM-2.33新增角色组自定义,需根据自定义情况设置角色组。
【举例】
-> hREST -H 192.168.10.11 -U admin -P Password@_ addldapuser -RI 1 -RGN test -RGD dc=example,dc=com -RGP Operator -RGKP 1 -RGVP 1 -RGNP 1 -RGUP 1 -RGBP 1 -RGPP 1 -RGFP 1 -RGHP 1 -RGRP 1
Success: add ldap user successfully
【修改记录】
(1) hREST V1.08新增角色组可选范围CustomRole1~5
本命令用于删除LDAP用户。
【命令】
hREST -H host -p port -U username -P password delldapuser -RI roleId
【使用指南】
LDAP用户不存在时,删除依然提示成功,restful接口问题
【参数】
表2-83 参数说明
字段 |
描述 |
取值 |
roleId |
角色组编号 |
1、2、3、4、5 |
【举例】
-> hREST -H 192.168.10.11 -U admin -P Password@_ delldapuser -RI 1
Success: delete ldap user successfully
本命令用于Active Directory的高级设置。
【命令】
hREST -H host -p port -U username -P password setad -E adEnable -UDN adUserDomainName -SU adSecretUsername -SP adSecretPassword -DC1 adDomainController1 -DC2 adDomainController2 -DC3 adDomainController3
【参数】
表2-84 参数说明
字段 |
描述 |
取值 |
adEnable |
AD使能,为必配参数 |
AD使能,包括: · Disable:禁用 · Enable:使能 |
adUserDomainName |
AD用户域名,为可选参数 |
- |
adSecretUsername |
AD机密用户名,为可选参数 |
- |
adSecretPassword |
AD机密用户名密码,为可选参数 |
密码长度需大于6 |
adDomainController1 |
AD域控制器服务器地址1,为可选参数 |
- |
adDomainController2 |
AD域控制器服务器地址2,为可选参数 |
- |
adDomainController3 |
AD域控制器服务器地址3,为可选参数 |
- |
【举例】
-> hREST -H 192.168.10.32 -p 443 -U admin -P Password@_ setad -E 1 -UDN sit.com -SU group1 -SP 123456 -DC1 192.168.1.78 -DC2 192.168.1.79 -DC3 192.168.1.80
Success: set ad successfully
本命令用于获取AD信息。
【命令】
hREST -H host -p port -U username -P password getad
【参数】
无
【使用指南】
HDM-1.30.12及其以上版本支持。
【举例】
# 获取AD信息
-> hREST –H 192.168.10.6 –U ****** -P ****** getad
--------------------------------------------------
CertificateVerificationState : Enable
SecretUsername : group
SecretPassword :
UserDomainName : sit.com
DomainControllerAddress1 : 192.168.1.78
DomainControllerAddress2 : 192.168.1.79
DomainControllerAddress3 : 192.168.1.80
[ADUsers]
----------------------------------------------
MemberId : 1
GroupName : test
GroupDomain : sit.com
GroupRole : Administrator
----------------------------------------------
MemberId : 2
GroupName : test1
GroupDomain : sit.com
GroupRole : CustomRole1
--------------------------------------------------
【输出说明】
表2-85 参数说明
参数 |
描述 |
CertificateVerificationState |
活动目录认证是否开启,包括: · Enable:启用 · Disable:禁用 |
SecretUsername |
机密用户名 |
SecretPassword |
机密用户名密码,不显示 |
UserDomainName |
用户域名 |
DomainControllerAddress1 |
域控制器服务器地址1 |
DomainControllerAddress2 |
域控制器服务器地址2 |
DomainControllerAddress3 |
域控制器服务器地址3 |
MemberId |
角色组ID |
GroupName |
角色组名称 |
GroupDomain |
角色组搜索库 |
GroupRole |
角色组权限 |
本命令用于新增或修改AD(Active Directory)用户。
【命令】
hREST -H host -p port -U username -P password addaduser -RI role_id -RGN role_group_name -RGD role_group_domain -RGP role_group_privilege -RGKP role_group_kvm_privilege -RGVP role_group_vmedia_privilege -RGNP role_group_network_privilege -RGUP role_group_user_privilege -RGBP role_group_basic_privilege -RGPP role_group_power_privilege -RGFP role_group_firmware_privilege -RGHP role_group_health_privilege -RGRP role_group_remotectrl_privilege
【参数】
表2-86 参数说明
字段 |
描述 |
取值 |
role_id |
角色组编号,为必配参数 |
1、2、3、4、5 |
role_group_name |
角色组名称,为必配参数 |
- |
role_group_domain |
角色组域名,为必配参数 |
- |
role_group_privilege |
角色组权限,为必配参数 |
· |
role_group_kvm_privilege |
KVM权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
role_group_vmedia_privilege |
镜像挂载权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
role_group_network_privilege |
网络配置权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
role_group_user_privilege |
用户配置权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
role_group_basic_privilege |
基本配置权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
role_group_power_privilege |
电源管理权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
role_group_firmware_privilege |
固件更新权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
role_group_health_privilege |
健康诊断权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
role_group_remotectrl_privilege |
远程控制权限,为可选参数 |
· 1代表有权限 · 0代表无权限 |
【使用指南】
HDM-2.0.04以前版本角色组权限可选Administrator、Operator、User选项,在HDM-2.0.04至HDM-2.06版本CustomRole1~5实际生效角色组权限为Custom 1~5,HDM-2.06版本以后新增可选范围CustomRole1~5,HDM-2.33新增角色组自定义,需根据自定义情况设置角色组。
【举例】
-> hREST -H 192.168.10.11 -U admin -P Password@_ addaduser -RI 1 -RGN test -RGD sit.com -RGP administrator -RGKP 1 -RGVP 1 -RGNP 1 -RGUP 1 -RGBP 1 -RGPP 1 -RGFP 1 -RGHP 1 -RGRP 1
Success: add ad user successfully
【修改记录】
(1) hREST V1.08新增角色组可选范围CustomRole1~5
本命令用于删除AD用户。
【命令】
hREST -H host -p port -U username -P password deladuser -RI role_id
【参数】
表2-87 参数说明
字段 |
描述 |
取值 |
role_id |
角色组编号 |
1、2、3、4、5 |
【举例】
-> hREST -H 192.168.10.11 -U admin -P Password@_ deladuser -RI 1
Success: delete ad user successfully
本命令用于获取服务器GPU信息。
【命令】
hREST -H host -p port -U username -P password getgpu
【举例】
# 获取GPU详细信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getgpu
--------------------------------------------------
ID : 0x1
Name : Tesla K80
SlotNum : 2
Manufacturer : NVIDIA
Model : Tesla K80
SerialNumber : 0324816063163
PartNumber : 102D-885-A1
FirmwareVersion : 80.21.1F.00.01
PowerConsumedWatts : 0
TemperatureCelsius : 67
[Status]
Health : OK
State : Enable
--------------------------------------------------
【输出说明】
表2-88 输出说明
参数 |
描述 |
ID |
GPU编号 |
Name |
GPU名称 |
SlotNum |
GPU槽位号 |
Manufacturer |
厂商名称 |
Model |
产品型号 |
SerialNumber |
GPU序列号 |
PartNumber |
GPU部件号 |
FirmwareVersion |
固件版本 |
PowerConsumedWatts |
功率;当功率为0时需要在OS下安装驱动 |
TemperatureCelsius |
温度,单位摄氏度 |
Health |
健康状态 |
State |
在位状态 |
本命令用于获取服务器VNC会话信息。
【命令】
hREST -H host -p port -U username -P password getvncsession
【举例】
# 获取vnc会话信息
-> hREST –H 192.168.10.6 –U ****** -P ****** getvncsession
--------------------------------------------------
Id : 28
SessionID : 28
SessionType : VNC
ClientIP : 192.168.184.44
UserID : N/A
UserName : N/A
UserPrivilege : Administrator
--------------------------------------------------
【输出说明】
表2-89 输出说明
参数 |
描述 |
Id |
ID |
SessionID |
会话ID |
SessionType |
会话类型 |
ClientIP |
IP地址 |
UserID |
用户编号 |
UserName |
用户名 |
UserPrivilege |
用户权限 |
本命令用于获取防火墙状态信息。
【命令】
hREST -H host -p port -U username -P password getfirewall
【举例】
# 获取防火墙状态信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getfirewall
--------------------------------------------------
Status : Stop
--------------------------------------------------
【输出说明】
表2-90 输出说明
参数 |
描述 |
Status |
防火墙状态,包括: · Stop:禁用 · WhiteList:白名单模式 · BlackList:黑名单模式 |
本命令用于设置防火墙状态。
【命令】
hREST -H host -p port -U username -P password setfirewall –S status
【参数】
表2-91 参数说明
参数 |
描述 |
取值 |
status |
防火墙状态,为必配参数。 |
防火墙状态,包括: · Stop:禁用 · WhiteList:白名单模式 · BlackList:黑名单模式 |
【使用指南】
无
【举例】
# 设置防火墙状态为白名单模式。
-> hREST –H 192.168.10.6 –U ****** -P ****** setfirewall -S WhiteList
Success: set the firewall status successfully
本命令用于获取串口使用部件。
【命令】
hREST -H host -p port -U username -P password getserialport
【举例】
# 获取串口使用部件。
-> hREST –H 192.168.10.6 –U ****** -P ****** getserialport
--------------------------------------------------
PanelComSources : Host
SOLSource : Host
--------------------------------------------------
【输出说明】
表2-92 输出说明
参数 |
描述 |
PanelComSources |
当前使用面板串口的部件,包括: · BMC · Host · PCIeNIC · MEZZNIC · MEZZRAID |
SOLSource |
当前使用面板串口的部件,包括: · BMC · Host · PCIeNIC · MEZZNIC · MEZZRAID |
本命令用于设置串口使用部件。
【命令】
hREST -H host -p port -U username -P password setserialport –D type –S source
【参数】
表2-93 参数说明
参数 |
描述 |
取值 |
type |
串口类型,为必配参数。 |
串口类型,包括: · panel · sol |
source |
串口使用部件,为必配参数。 |
串口使用部件,包括: · host · bmc · mezzraid · mezznic · PCIeNIC |
【使用指南】
无
【举例】
# 设置面板串口使用部件为host。
-> hREST –H 192.168.10.6 –U ****** -P ****** setserialport -D panel -S host
Success: the serial port is set successfully
本命令用来通过设置UID灯状态来定位物理盘。
【命令】
hREST -H Host -p Port -U UserName -P PassWord locatedisk -I DiskId –L DiskType –S Status
【用户权限】
admin
【参数】
表2-94 参数说明
字段 |
描述 |
取值 |
DiskId |
物理盘id,为必配参数。 |
- |
DiskType |
为可选参数,详见使用指南。 |
- |
State |
UID灯状态,为必配参数。 |
UID灯状态,包括: l on:常亮 l off:常灭 |
【使用指南】
在HDM-2.12之前版本,物理盘id为对应的传感器id,DiskType字段为预留字段,不起作用;在HDM-2.12及其以后版本,物理盘id为物理盘Slot号,可以通过getpdisk功能的Slot_phys_no字段的数字位确定,DiskType:0代表HDD或SSD等普通硬盘,1代表NVMe硬盘,缺省值为0。
【举例】
# 控制传感器id为160的物理盘,led灯为常亮
-> ./hREST –H 192.168.10.6 –U ****** -P ****** locatedisk -I 160 -S on
Success: set the physical disk led light successfully
本命令用于获取存储介质告警准线。
【命令】
hREST -H host -p port -U username -P password getthreshold
【举例】
# 获取存储介质告警准线。
-> hREST –H 192.168.10.6 –U ****** -P ****** getthreshold
--------------------------------------------------
ReservedBlock : 10
ReservedBlockStatus : Disabled
RemainLifePercents : 90
RemainLifePercentsStatus : Disabled
PrefailCount : 0
PrefailCountStatus : Enabled
MediaError : 60000
MediaErrorStatus : Disabled
--------------------------------------------------
【输出说明】
表2-95 输出说明
参数 |
描述 |
ReservedBlock |
硬盘预留块。 |
ReservedBlockStatus |
硬盘预留块的状态 |
RemainLifePercents |
硬盘擦写寿命百分比。 |
RemainLifePercentsStatus |
硬盘擦写寿命百分比的状态 |
PrefailCount |
Pred fail,该字段仅对HDD、SSD盘有效。 |
PrefailCountStatus |
Pred fail的状态 |
【修改记录】
(1) HDM-1.30.09接口新增
本命令用于设置存储介质告警准线。
【命令】
hREST -H host -p port -U username -P password setthreshold –F Type –T Threshold –S Status
【参数】
表2-96 参数说明
参数 |
描述 |
取值 |
Type |
准线类型,为必配参数。 |
准线类型,包括: · reservedblock · remainlife, · prefailcount · mediaerror |
Threshold |
告警准线,为必配参数。 |
准线取值范围: · reservedblock:[0: 100] · remainlife:[0, 100] · prefailcount:[0: 255] · mediaerror:[0: 65535] |
Status |
是否开起准线阀值,为可选参数,缺省状态下为开启。 |
是否开启,包括: · Enable:是 · Disable:否 |
【使用指南】
无
【举例】
# 设置硬盘擦写寿命百分比为90,开启准线。
-> hREST –H 192.168.10.6 –U ****** -P ****** setthreshold -F remainlife -T 90 -S Enable
Success: successfully set the predictive failure threshold
【修改记录】
(1) HDM-1.30.09接口新增
本命令用于获取事件订阅信息。
【命令】
hREST -H host -p port -U username -P password geteventsub
【举例】
# 获取事件订阅信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** geteventsub
--------------------------------------------------
Id : 1
Destination : https://172.16.11.96
EventTypes : ResourceUpdated, StatusChange, ResourceRemoved, ResourceAdded, Alert
HttpHeaders : null
Protocol : Redfish
Context : event subscription context string
MessageIds : []
OriginResources : []
--------------------------------------------------
【输出说明】
表2-97 输出说明
参数 |
描述 |
Id |
EventService资源的ID。 |
Destination |
目的地事件服务的URI。 |
EventTypes |
包含将要发送到指定的事件的类型: "ResourceRemoved" "ResourceAdded", "StatusChange", "ResourceUpdated", "Alert" |
HttpHeaders |
事件订阅HTTP头,查询时对外固定显示为"null"。 |
Protocol |
事件连接的协议类型, 当前取值只能为Redfish。 |
Context |
客户端提供的与事件目标订阅一起存储的字符串。 |
MessageIds |
事件消息Id匹配列表。 |
OriginResources |
事件源匹配列表。 |
本命令用于导入SSH密钥。
【命令】
hREST -H host -p port -U username -P password importsshkey –N name –F sshfFile –O uploadFile
【使用指南】
带内模式不支持
【参数】
表2-98 参数说明
参数 |
描述 |
取值 |
name |
所要修改信息的用户名,为可选参数 |
参数为空时,默认配置当前用户 |
sshfFile |
SSH密钥文件,为必配参数 |
- |
uploadFile |
是否只绑定用户而不上传文件,为可选参数 |
Enable:启用 Disable:禁用 |
【举例】
# 针对test用户导入SSH密钥。
-> hREST –H 192.168.10.6 –U ****** -P ****** importsshkey -N test -F ../config/key.pub
Success: import SSH key successfully
本命令用于删除SSH密钥。
【命令】
hREST -H host -p port -U username -P password delsshkey –N name -F SSH_key_name
【参数】
表2-99 参数说明
参数 |
描述 |
取值 |
name |
所要删除SSH密钥的用户名,为可选参数 |
参数为空时,默认配置当前用户 |
SSH_key_name |
所要删除SSH密钥文件的名称,为可选参数 |
|
【举例】
# 针对test用户删除SSH密钥。
-> hREST –H 192.168.10.6 –U ****** -P ****** delsshkey -N test
Success: successfully delete the ssh public key
本命令用于获取双因素认证配置信息。
【命令】
hREST -H host -p port -U username -P password get2factorauth
【参数】
无
【使用指南】
带内模式不支持
【举例】
# 获取双因素认证配置信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** get2factorauth
--------------------------------------------------
TwoFactorAuthenticationState : False
OTPServerAddress : sit.com
OTPServerPort : 1812
OTPServerSharedKey : 123
--------------------------------------------------
【输出说明】
表2-100 输出说明
参数 |
描述 |
TwoFactorAuthenticationState |
双因素认证是否开启,包括: · True:启用 · False:禁用 |
OTPServerAddress |
OTP服务器地址 |
OTPServerPort |
服务端口 |
OTPServerSharedKey |
共享秘钥 |
本命令用于设置双因素认证。
【命令】
hREST -H host -p port -U username -P password set2factorauth –E authEnable –D serverAddr –P portNum –K shareKey
【参数】
表2-101 参数说明
参数 |
描述 |
取值 |
authEnable |
是否启用双因素认证,为可选参数 |
双因素认证是否开启,包括: · Enable:启用 · Disable:禁用 |
serverAddr |
OTP服务器地址,为可选参数 |
- |
portNum |
服务端口,为可选参数 |
- |
shareKey |
共享密钥,为可选参数 |
长度为1-64 |
【举例】
-> hREST -H 192.168.10.32 -p 443 -U admin -P Password@_ set2factorauth -E Disable -P 999 -D sit.com –K 1234
Success: two-factor authentication configuration is successful
本命令用于获取LLDP信息。
【命令】
hREST -H host -p port -U username -P password getlldp
【参数】
无
【使用指南】
HDM-1.30.10及其以上版本支持。
【举例】
# 获取LLDP信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getlldp
--------------------------------------------------
Name : LldpService
LldpEnabled : Disable
WorkMode : Tx
[LLDP]
----------------------------------------------
ChassisMac : 58:6a:b1:0b:31:af
ChassisName : 21
EthIndex : eth0
PortDesc : GigabitEthernet1/0/4 Interface
PortIfName : GigabitEthernet1/0/4
VlanId : 1
----------------------------------------------
ChassisMac : 58:6a:b1:0b:31:af
ChassisName : 21
EthIndex : eth1
PortDesc : GigabitEthernet1/0/25 Interface
PortIfName : GigabitEthernet1/0/25
VlanId : 1
--------------------------------------------------
【输出说明】
表2-102 输出说明
参数 |
描述 |
Name |
· 服务名称 |
CertificateVerificationState |
发送LLDP信息是否开启,包括: · Enable:启用 · Disable:禁用 |
WorkMode |
LLDP工作模式 · Tx:发送模式 |
ChassisMac |
交换机MAC地址 |
ChassisName |
交换机系统名 |
EthIndex |
网络接口 |
PortDesc |
端口信息 |
PortIfName |
连接端口号 |
VlanId |
VLAN ID |
本命令用于配置LLDP。
【命令】
hREST -H host -p port -U username -P password setlldp –S serviceEnable
【参数】
表2-103 参数说明
参数 |
描述 |
取值 |
serviceEnable |
是否开启服务,为必配参数 |
是否开启发送LLDP信息服务,包括: · Enable:启用 · Disable:禁用 |
【使用指南】
HDM-1.30.10及其以上版本支持。
【举例】
# 开启LLDP发送信息
-> hREST -H 192.168.10.32 -p 443 -U admin -P Password@_ setlldp –S Enable
Success: successfully set LLDP service attributes
本命令用于获取DNS信息。
【命令】
hREST -H host -p port -U username -P password getdns -N networkPortId -IP internetProtocol
【参数】
表2-104 参数说明
参数 |
描述 |
取值 |
networkPortId |
网络端口id,为可选参数 |
- |
internetProtocol |
互联网协议,为可选参数 |
可选择:IPv4、IPv6 |
【使用指南】
无。
【举例】
# 获取DNS信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getdns
--------------------------------------------------
Status : Enable
ServerSetup : Manual
SuperiorDomain :
PreferredServer : 192.168.0.66
AlternateServer : 192.168.0.67
TertiaryServer : 192.168.0.68
--------------------------------------------------
【输出说明】
表2-105 输出说明
参数 |
描述 |
Status |
域名服务配置是否开启,包括: · Enable:启用 · Disable:禁用 |
ServerSetup |
DNS服务器设置,包括: · Manual:手动 · IPv4Auto:IPv4自动 · IPv6Auto:IPv6自动 |
SuperiorDomain |
当前域的上级域名 |
PreferredServer |
DNS服务器1 |
AlternateServer |
DNS服务器2 |
TertiaryServer |
DNS服务器3 |
本命令用于配置DNS。
【命令】
hREST -H host -p port -U username -P password setdns –E serviceEnable –M configMethod –D dynamicSelects -P RegPort –DS domainSuffix -PS preferredServer –AS alternateServer –TS tertiaryServer -N networkPortId -IP internetProtocol
【参数】
表2-106 参数说明
参数 |
描述 |
取值 |
serviceEnable |
是否开启服务,为必配参数 |
是否开启服务,包括: · Enable:启用 · Disable:禁用 |
configMethod |
服务器配置方式,为可选参数 |
服务器配置方式,括: · Manual:手动 · IPv4Auto:IPv4自动 · Pv6Auto:IPv6自动 |
dynamicSelects |
动态注册选项,为可选参数 |
动态注册选项,包括: · HostName:主机名 · Auto:自动 |
RegPort |
DNS注册信息获取网口,为可选参数,缺省为共享网口 |
动态注册选项,包括: · Shared:共享网口 · Dedicated:专用网口 |
domainSuffix |
上级域名,为可选参数 |
域名 |
preferredServer |
DNS服务器1,为可选参数 |
IPv4 或 IPv6地址 |
alternateServer |
DNS服务器2,为可选参数 |
IPv4 或 IPv6地址 |
tertiaryServer |
DNS服务器3,为可选参数 |
IPv4 或 IPv6地址 |
networkPortId |
网络端口id,为可选参数 |
- |
internetProtocol |
互联网协议,为可选参数 |
可选择:IPv4、IPv6 |
【使用指南】
无。
【举例】
# 设置服务开启,手动配置,上级域名sit.com,一级服务器192.168.0.66,二级服务器192.168.0.67, 三级服务器192.168.0.68
-> hREST -H 192.168.10.32 -p 443 -U admin -P Password@_ setdns -E Disable -M Manual -DS sit.com -PS 192.168.0.66 -AS 192.168.0.67 -TS 192.168.0.68
Success: DNS configuration is successful
本命令用于获取系统性能信息。
【命令】
hREST -H host -p port -U username -P password getsysperf
【参数】
无
【使用指南】
无。
【举例】
# 获取系统性能信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getsysperf
--------------------------------------------------
CPUUsagePercent : 0
CPUThresholdPercent : 40
CPUUsageAlert : OK
MemoryUsagePercent : 3
MemoryThresholdPercent : 50
MemoryUsageAlert : OK
[IOUsage]
----------------------------------------------
Name : C
UsedSize : 29.16GB
TotalSize : 1.82TB
IOUsagePercent : 2
IOUsageAlert : Alert
--------------------------------------------------
IOThresholdPercent : 1
--------------------------------------------------
【输出说明】
表2-107 输出说明
参数 |
描述 |
CPUUsagePercent |
CPU占用率 |
CPUThresholdPercent |
CPU占用率告警水线 |
CPUUsageAlert |
CPU占用率告警状态,包括: · OK:正常 · Alert:告警 |
MemoryUsagePercent |
Memory 占用率 |
MemoryThresholdPercent |
Memory占用率告警水线 |
MemoryUsageAlert |
内存占用率告警状态,包括: · OK:正常 · Alert:告警 |
IOUsage |
IO 占用率信息 |
Name |
磁盘名称 |
UsedSize |
磁盘已使用容量 |
TotalSize |
磁盘总容量 |
IOUsagePercent |
磁盘占用率 |
IOUsageAlert |
磁盘告警状态 |
IOThresholdPercent |
IO占用率告警水线 |
本命令用于设置系统告警阀值。
【命令】
hREST -H host -p port -U username -P password setsysperf -C CPU –M MEM -I IO
【参数】
表2-108 参数说明
参数 |
描述 |
取值 |
CPU |
CPU使用率告警门限,为可选 参数 |
- |
MEM |
内存使用率告警门限,为可选 参数 |
- |
IO |
IO使用率告警门限,为可选 参数 |
- |
【使用指南】
无。
【举例】
# 设置CPU告警阀值70, 内存80,硬盘90
-> hREST -H 192.168.10.32 -p 443 -U admin -P Password@_ setsysperf -C 70 -M 80 -I 90
Success: successfully set the host monitoring alarm threshold
本命令用于获取视频录制功能配置。
【命令】
hREST -H host -p port -U username -P password getvideocfg
【参数】
无
【使用指南】
无
【举例】
# 获取视频录制功能配置。
-> hREST –H 192.168.10.6 –U ****** -P ****** getvideocfg
--------------------------------------------------
RecordService : Enable
RecordTime : 20
[RecordEvent]
Crash : Enable
Restart : Enable
Shutdown : Disable
--------------------------------------------------
【输出说明】
表2-109 输出说明
参数 |
描述 |
RecordService |
是否开启,包括: · Enable:启用 · Disable:禁用 |
RecordTime |
录制时间S |
Crash |
视频类型:崩溃前 |
Restart |
视频类型:重启前 |
Shutdown |
视频类型:关机前 |
本命令用于设置视频录制功能。
【命令】
hREST -H host -p port -U username -P password setvideocfg -E recordEnable –T recordTime –C crashEnable –R restartEnable –S shutdownEnable
【参数】
表2-110 参数说明
参数 |
描述 |
取值 |
recordEnable |
是否开启视频录制,为可选参数 |
选项: · Enable: 代表开启 · Disable:代表开启 |
recordTime |
屏幕录制时间,为可选参数 |
15-255之间 |
crashEnable |
崩溃前录制,为可选参数 |
选项: · Enable: 代表开启 · Disable:代表开启 |
restartEnable |
重启前录制,为可选参数 |
选项: · Enable: 代表开启 · Disable:代表开启 |
shutdownEnable |
关机前录制,为可选参数 |
选项: · Enable: 代表开启 · Disable:代表开启 |
【使用指南】
无。
【举例】
# 开始视频录制功能,录制时间为15S,视频类型为崩溃前、重启前
-> hREST -H 192.168.10.32 -p 443 -U admin -P Password@_ setvideocfg -E Enable -T 15 -C Enable -R Enable -S Disable
Success: the video recording function is set successfully
本命令用于设置电源模式。
【命令】
hREST -H host -p port -U username -P password setpsu -M powerMode –I powerID –P perfMode
【参数】
表2-111 参数说明
参数 |
描述 |
取值 |
powerMode |
电源模式,为可选参数 |
选项: · LoadBalancing:负载均衡 · ActiveStandby:主备模式 |
powerID |
主备模式主电源ID,当为主备模式时为必选参数 |
- |
perfMode |
电源节能配置,为可选参数 |
选项: · Performance:性能优先 · Balanced:均衡 · Power:节能优先 |
【使用指南】
主备模式下,至少预留一个备用电源。当仅有一块电源在位时,不支持设置电源模式。
【举例】
# 设置为工作模式为主备模式,主电源ID为1,性能模式为节能优先
-> hREST -H 192.168.10.32 -p 443 -U admin -P Password@_ setpsu -M ActiveStandby -I 1 -P Power
Success: power setting is successful
本命令用于预测内存故障。
【命令】
hREST -H host -p port -U username -P password memoryinspect –M Mode –C ThreadCount –P LogPath -L alarmLimit
【使用指南】
带内模式不支持。内存CE Limit告警默认处于屏蔽状态,功能使用前需要手动开启告警。
HDM-3.37引入了PFA告警策略,单条CE limit告警不会触发事件日志,一段时间内CE limit告警告警数量达到阈值,则触发一条PFA告警,自定义告警门限值不再生效,始终为1。
适用于HDM-1.30.18P56及其以上版本,BIOS-2.00.39及其以上版本;当选择批量扫描模式时应确保…/config/server_info.txt文件存在且服务器信息格式正确;扫描过程日志将会记录在…/logs/execute.log文件中,文件大小为10M,当文件达到限定值时将自动备份为execute.log.1;需要注意的是当进行批量扫描时,实际上-H、-U、-P、-p参数不起作用,但为了和其他功能保持一致进行了保留,随便输入合法值即可;请保持服务器时区的一致性,否则可能会导致扫描结果与实际不一致。不支持HDM-1.10.xx版本(对应版本未记录硬件更换日志)。
server_info.txt文件中每一行对应一台服务器,包括服务器HOST地址、用户名、密码、端口号(可选),中间以空格隔开,形如:192.168.0.14 admin ****** 443,注意文件尾部不要包含多余空行。
-> server_info.txt
192.168.0.18 admin ******
192.168.0.19 root ******
192.168.0.20 admin ****** 443
192.168.0.21 admin ******
--------------------------------以上为样例参考,使用前请删除
【参数】
表2-112 参数说明
参数 |
描述 |
取值 |
Mode |
检测模式,为可选参数,缺省状态下为单台。 |
检测模式,包括: · Single:单台扫描 · Multiple:批量扫描 |
ThreadCount |
线程数量,为可选参数,缺省状态下为100。 |
- |
LogPath |
结果文件路径,为可选参数,缺省状态下为 工程目录/logs/result.log。 |
- |
alarmLimit |
报警限制,为可选参数 |
HDM-3.37及其以后版本自定义告警门限值不再生效,原因详见使用指南。 |
【举例】
# 内存巡检单台模式,缺省状态
-> hREST –H 192.168.0.14 –U ****** -P ****** memoryinspect
IP Serial Number Slot Description
192.168.0.14 210235A2CSH17C000001 CPU1_DIMM_A5 occur 32 ce limit(s) in the past day
# 内存巡检批量扫描模式,线程数为50,结果日志记录在D:/result/inspect_res.log
-> hREST –H 192.168.0.14 –U ****** -P ****** memoryinspect –M Multiple –C 50 –P D:/result/inspect_res.log
IP Serial Number Slot Description
192.168.0.33 None None Cannot access HDM
192.168.0.32 None None Ping https failed
192.168.170.53 210235A2CSH17D000001 None No memory failure detected
192.168.0.197 210235A2CSH17C000001 CPU1_DIMM_A1 occur 33 ce limit(s) in the past day
本命令用于关闭HDM共享口
【命令】
hREST -H host -p port -U username -P password setshareport –N ethernetid –S disable
【参数】
表2-113 参数说明
参数 |
描述 |
取值 |
ethernetid |
网口名称,为必配参数。 |
依据实际情形填写,例如eth0或者eth0.401 |
disable |
不启用,为必配参数。 |
关闭共享口包括: · Disabled:不启用 |
【使用指南】
HDM-2.97及其以上版本支持。
【举例】
# 关闭共享口eth0。
-> hREST –H 192.168.10.6 –U ****** -P ****** setshareport -N eth0 –S Disabled
Success: set shareport successfully
本命令用于获取共享口NCSI状态信息。
【命令】
hREST -H host -p port -U username -P password getncsi
【使用指南】
无
【举例】
# 获取共享口ncsi状态信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getncsi
--------------------------------------------------
NCSIStatus : Enable
--------------------------------------------------
【输出说明】
表2-114 输出说明
参数 |
描述 |
NCSIStatus |
共享口NCSI状态信息,包括: · Enable:开启 · Disable:关闭 |
本命令用来设置共享口NCSI状态。
【命令】
hREST -H Host -p Port -U UserName -P PassWord setncsi -S NcsiStatus
【用户权限】
admin
【参数】
表2-115 参数说明
字段 |
描述 |
取值 |
NcsiStatus |
共享口NCSI状态,为必配参数。 |
共享口NCSI状态信息,包括: · Enable:开启 · Disable:关闭 |
【使用指南】
不可通过共享口ip设置共享口NCSI状态为关闭。
【举例】
# 设置共享口ncsi状态为关闭。
-> ./hREST –H 192.168.10.6 –U ****** -P ****** setncsi -S Disable
Success: set the shared port NCSI successfully
本命令用来设置VNC密码。
【命令】
hREST -H Host -p Port -U UserName -P PassWord setvnc -P VNCpwd
【用户权限】
admin
【参数】
表2-116 参数说明
字段 |
描述 |
取值 |
VNCpwd |
VNC密码,为必配参数。 |
- |
【使用指南】
涉及到密码时,密码复杂度和长度由后端进行限制,本工具不做校验,谨慎使用操作系统会自动转义的字符,避免设置密码与实际有效密码不符。
HDM B01版本不支持。
【举例】
#设置VNC超时时间为20分钟,密码为root。
-> ./hREST –H 192.168.10.6 –U ****** -P ****** setvnc -P root
"Success: VNC password is set successfully"
本命令用于获取SMTP信息。
【命令】
hREST -H host -p port -U username -P password getsmtp
【举例】
# 获取smtp信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** getsmtp
--------------------------------------------------
Id : Smtp
Name : Smtp
ServiceEnabled : True
ServerAddress : 2022::20
ServerPort : 10086
AnonymousLoginEnabled : False
SenderAddress : test@h3c.com
SenderUserName : test
SenderPassword : null
AlarmSeverity : All
TLSEnabled : False
RecipientAddresses
MemberId : 1
EmailAddress :
Enabled : True
----------------------------------------------
--------------------------------------------------
【输出说明】
表2-117 输出说明
参数 |
描述 |
Id |
SMTP资源id |
Name |
资源名称 |
ServiceEnabled |
服务使能 |
ServerAddress |
服务地址 |
ServerPort |
服务端口 |
AnonymousLoginEnabled |
匿名登录使能 |
SenderAddress |
发送者邮件地址 |
SenderUserName |
发送者用户名 |
SenderPassword |
发送者密码 |
AlarmSeverity |
可修改的告警等级,包括: · “Critical" · “All” · "Minor+Major+Critical" |
TLSEnabled |
告警Trap报文设置 |
RecipientAddresses.MemberId |
接收告警邮件地址的ID |
RecipientAddresses. EmailAddress |
接收者邮件地址 |
RecipientAddresses. Enabled |
接收者邮件使能 |
本命令用于设置SMTP信息。
【命令】
hREST -H host -p port -U username -P password setsmtp -S SmtpEnabled - A SeverAddress -P ServerPort -AN AnonymousEnabled -SN SenderName -SP SenderPwd -SA SenderAddr -AS AlarmSeverity -TLS TlsEnabled -RA RecipAddr
【参数】
表2-118 参数说明
参数 |
参数说明 |
取值 |
SmtpEnabled |
SMTP服务使能,为可选参数 |
包括: · Enable:是 · Disable:否 |
SeverAddress |
服务地址,为可选参数 |
- |
ServerPort |
服务端口,为可选参数 |
1-65535 |
AnonymousEnabled |
匿名使能,为可选参数 |
包括: · Enable:是 · Disable:否 |
SenderName |
发件人名称,为可选参数 |
- |
SenderPwd |
发件人密码,为可选参数 |
- |
SenderAddr |
发件人邮箱地址,为可选参数 |
- |
AlarmSeverity |
告警级别,为可选参数 |
可修改的告警等级,包括: "Critical" "Minor+Major+Critical" "All" |
TlsEnabled |
TLS使能,为可选参数 |
包括: · Enable:是 · Disable:否 |
RecipAddr |
接收告警的邮件地址,为可选参数 |
示例: [1:1:admin:administrator+2:0:test:abc] 表示设置2个收件人信息,每个收件信息由四个参数组成,用冒号分隔,以2:0:test:abc为例说明 · 2表示编号,可选1-15 · 1表示启用,0表示禁用 · Test HDM用户名,G6服务器上表示邮件地址信息 · abc表示主题 |
【使用指南】
无
【举例】
# 设置smtp服务。
-> hREST.bat -H 192.168.0.49 -U admin –P Password@_ setsmtp -S Enable -A 192.168.0.16 -P10999 -AN Enable -AS All -TLS Enable -RA [1:1:admin:administrator+2:1:test:abc]
Success: set smtp successfully
本命令用于导出工具操作日志。
【命令】
hREST -H host -p port -U username -P password exportlog –F filepath
【使用指南】
支持带内,需要注意的是当带外格式使用时会校验host地址是否连通,所以不建议此方式。日志文件为zip格式,建议文件名以.zip为后缀。
【参数】
表2-119 参数说明
参数 |
描述 |
取值 |
filepath |
保存配置文件的路径及文件名,为必配参数 |
参数为空时,将自动保存到本工具目录下的config文件夹中 |
【举例】
# 导出工具操作日志。
-> hREST –H 192.168.10.6 –U ****** -P ****** exportlog -F ../abc.zip
Success: export tool operation logs successful
本命令用于获取服务器硬件信息。
【命令】
hREST -H host -p port -U username -P password gethardware
【举例】
# 获取设备信息。
-> hREST –H 192.168.10.6 –U ****** -P ****** gethardware
--------------------------------------------------
[Systems]
AssetTag : T2023
ChassisPartNumber : 210235A3SUH18A000020
HostName : HDM20112102010000000001
Id : 1
IndicatorLED : Lit
MaintenanceSerialNumber : 210235A3SUH18A000019
Manufacturer :
Model : H3C Uniserver R4900 G3
Name : Computer System
BiosVendor : AMI
IndependentPowerSupply : False
PowerOnStrategy : RestorePreviousState
PartNumber :
PowerState : On
SerialNumber : 20112102010000000001
SystemType : Physical
UUID : 274c393a-c99c-1000-03a1-202211221744
Uptime_hours : 3
[HealthState]
OverallHealth : Critical
Board : OK
Fans : OK
Memory : OK
PCIe : OK
PSU : Critical
CPU : OK
Storage : OK
Temperature : OK
[Processor]
Id : 1
Name : CPU1
FrequencyMHz : 3200
L1CacheKiB : 512
L2CacheKiB : 8192
L3CacheKiB : 25344
Temperature : 77
ProcessorType : CPU
ProcessorArchitecture : x86
InstructionSet : x86-64
Manufacturer : Intel(R) Corporation
Model : Intel(R) Xeon(R) Gold 6134 CPU @ 3.20GHz
MaxSpeedMHz : 3700
TotalCores : 8
TotalThreads : 16
Socket : 1
[Status]
Health : OK
State : Enabled
[ProcessorId]
IdentificationRegisters : 54-06-05-00-FF-FB-EB-BF
----------------------------------------------
[Memory]
Id : DIMM120
Model : 18ASF2G72PDZ-2G6D1
CapacityMiB : 16384
Manufacturer : Micron
OperatingSpeedMhz : 2666
SerialNumber : 163C5F94
MemoryDeviceType : DDR4
DataWidthBits : 0
DeviceLocator : CPU1CH2A2
RankCount : 2
PartNumber : 18ASF2G72PDZ-2G6D1
Authenticity : Normal
Technology : RDIMM
VDDQVolt : 1.2 V
PolicyEnabled : False
PassphraseCapable : False
BaseModuleType : RDIMM
ErrorCorrection : SingleBitECC
IsRankSpareEnabled : False
IsSpareDeviceEnabled : False
[Status]
Health : OK
State : Enabled
----------------------------------------------
[Drive]
Id : DiskFront0
Name : DiskFront0
Manufacturer : HGST
Model : HGST HUS726T6TALE6L4
Protocol : SATA
CapacityBytes : 6003333529600
PredictedMediaLifeLeftPercent : null
MediaType : HDD
CapableSpeedGbs : 6
NegotiatedSpeedGbs : 6
Revision : VKGAW414
ConnectionID : 8
DriveNumberInBios : 0
DriveNumberInOS : 0
FirmwareStatus : Online
Panel : Front 0
TemperatureCelsius : 41
SerialNumber : V8G3W0RM
[Status]
Health : OK
State : Enabled
----------------------------------------------
[PCIe]
Location : PCIe Card13
ProductName : NIC-X540-T2-T-10Gb-2P
VendorID : 0x8086
VendorName : Intel
SerialNumber : N/A
ProductID : 0
NegotiatedSpeed : 5.0GT/s
NegotiatedProtocol : Gen 2
NegotiatedLinkWidth : x8
MaxSpeed : 5.0GT/s
MaxProtocol : Gen 2
PartNumber : N/A
MaxLinkWidth : None
FirmwareVersion : 1.2074.0
[Status]
Status : Enabled
Health : OK
----------------------------------------------
[NVMe]
SlotID : DiskN1Slot164
VendorName : DAPUSTOR
ProductName : Roealsen
PDStatus : Normal
PercentLife : 100
SerialNumber : RS5U59A223005CPE
ModelNumber : DPRD3104T0T603T2000
Capacity : 3518437208883.2
FirmwareVersion : FF002090
PortType : PCIe
----------------------------------------------
--------------------------------------------------
【输出说明】
表2-120 输出说明
参数 |
描述 |
Systems.AssetTag |
设备资产标签 |
Systems.ChassisPartNumber |
主板chassis域部件号 |
Systems.HostName |
设备主机名 |
Systems.Id |
设备ID |
Systems.IndicatorLED |
设备指示灯状态,包括: · On:常亮 · Off:常灭 · Blink:闪烁 |
Systems.MaintenanceSerialNumber |
生产序列号 |
Systems.Manufacturer |
设备生产厂商 |
Systems.Model |
设备型号 |
Systems.Name |
设备名称 |
Systems.BiosVendor |
BIOS厂商 |
Systems.IndependentPowerSupply |
是否支持独立供电 |
Systems.PowerOnStrategy |
电源恢复配置命令 · TurnOn:保持上电 · RestorePreviousState:与之前保持一致 · StayOff:保持下电 |
Systems.PartNumber |
部件号 |
Systems.PowerState |
当前主机状态,包括: · On:开机 · Off:关机 |
Systems.SerialNumber |
产品序列号 |
Systems.SystemType |
系统类型: · Physical:物理机 · Virtual:虚拟机 |
Systems.UUID |
设备的全局唯一标识符 |
Systems.Uptime_hours |
主机上电时间 |
HealthState.OverallHealth |
整体健康状态 |
HealthState.Board |
主板健康状态 |
HealthState.Fans |
风扇健康状态 |
HealthState.Memory |
内存健康状态 |
HealthState.PCIe |
PCIe卡健康状态 |
HealthState.PSU |
电源健康状态 |
HealthState.CPU |
处理器健康状态 |
HealthState.Storage |
存储健康状态 |
HealthState.Temperature |
温度传感器健康状态 |
Processor.Id |
CPU编号 |
Processor.Name |
CPU名称 |
Processor.FrequencyMHz |
CPU主频 |
Processor.L1CacheKiB |
CPU一级缓存大小 |
Processor.L2CacheKiB |
CPU二级缓存大小 |
Processor.L3CacheKiB |
CPU三级缓存大小 |
Processor.ProcessorType |
CPU类型 |
Processor.ProcessorArchitecture |
CPU架构 |
Processor.InstructionSet |
CPU指令集 |
Processor.Manufacturer |
CPU制造商 |
Processor.Model |
CPU型号 |
Processor.MaxSpeedMHz |
CPU最大主频 |
Processor.TotalCores |
CPU核心数 |
Processor.TotalThreads |
CPU总线程数 |
Processor.Socket |
CPU槽位号 |
Processor.State |
CPU使能状态 |
Processor.Health |
CPU健康状态 |
Processor.IdentificationRegisters |
CPU ProcessID |
Memory.Id |
内存ID |
Memory.Model |
内存型号 |
Memory.CapacityMiB |
内存容量 |
Memory.Manufacturer |
内存制造商 |
Memory.OperatingSpeedMhz |
内存速率 |
Memory.SerialNumber |
内存序列号 |
Memory.MemoryDeviceType |
内存类型 |
Memory.DataWidthBits |
内存数据位宽 |
Memory.DeviceLocator |
内存丝印号 |
Memory.RankCount |
内存Rank数量 |
Memory.PartNumber |
内存部件号 |
Memory.Authenticity |
内存认证: · Vendor certified:厂家已经过认证 · Normal:厂家未经过认证 |
Memory.Technology |
内存技术: · RDIMM · UDIMM · SODIMM · LRDIMM · NVDIMM |
Memory.VDDQVolt |
内存电压值 |
Memory.PolicyEnabled |
电源管理策略使能 |
Memory.PassphraseCapable |
支持安全加密功能 |
Memory.BaseModuleType |
内存资源基本模块类型 |
Memory.ErrorCorrection |
错误纠正: · NoECC · SingleBitECC · MultiBitECC · AddressParity |
Memory.IsRankSpareEnabled |
备用Rank使能(未实现,固定false) |
Memory.IsSpareDeviceEnabled |
备用设备使能 |
Memory.Health |
内存健康状态 |
Memory.State |
内存使能状态 |
Drive.Id |
物理盘ID |
Drive.Name |
物理盘名称 |
Drive.Manufacturer |
物理盘生产厂商 |
Drive.Model |
物理盘型号 |
Drive.Protocol |
物理盘接口协议 |
Drive.CapacityBytes |
物理盘存储容量 |
Drive.PredictedMediaLifeLeftPercent |
物理盘预计剩余寿命 |
Drive.MediaType |
物理盘媒体没醒 |
Drive.CapableSpeedGbs |
物理盘最大传输速率 |
Drive.NegotiatedSpeedGbs |
物理盘协商速率 |
Drive.Revision |
物理盘固件版本 |
Drive.ConnectionID |
物理盘连接ID |
Drive.DriveNumberInBios |
Bios下编号 说明:对于NVMe,非Trimode配置时为PCIe槽位号 |
Drive.DriveNumberInOS |
物理盘系统下编号 |
Drive.FirmwareStatus |
指定物理盘状态: LSI-9300卡 · Ready:Ready
LSI其它卡 · Ready:Ready · UnconfiguredGood:未配置 · UnconfiguredBad:配置异常 · HotSpare:热备盘 · Offline:离线 · FAILED:故障 · Rebuilding:重建 · Optimal:Optimal · Online:已配置 · JBOD:JBOD · Unknown:未知 · PFA:预故障 · Copyback:回拷
PMC卡 · Offline:离线 · PFA:预故障 · Raw:RAW状态 · Hotspare:热备盘 · Ready:准备好 · Optimal:Optimal · Unsupported:不支持创建逻辑盘 · Unknown:未知
Marvell卡: · Unconfigured:未配置 · Configured:已配置 · PFA:预故障
NVMe盘: · Spare_below · Temp_Anomaly · Subsys_Degraded · Read_only · Cache_Failed · Normal "Abnormal" "Predict_Fail" |
Drive.Panel |
物理盘位置信息 |
Drive.TemperatureCelsius |
物理盘温度,单位摄氏度 |
Drive.SerialNumber |
物理盘序列号 |
Drive.Health |
物理盘健康状态 |
Drive.State |
物理盘使能状态 |
PCIe.Location |
PCIe设备的丝印 |
PCIe.ProductName |
PCIe设备资源名称 |
PCIe.VendorID |
PCIe设备资源厂商ID |
PCIe.VendorName |
PCIe设备的生产厂商 |
PCIe.SerialNumber |
PCIe设备的序列号 |
PCIe.ProductID |
子系统ID |
PCIe.NegotiatedSpeed |
协商速率 |
PCIe.NegotiatedProtocol |
协商协议 |
PCIe.NegotiatedLinkWidth |
协商带宽 |
PCIe.MaxSpeed |
最大速率 |
PCIe.MaxProtocol |
PCIe最高协议 |
PCIe.PartNumber |
PCIe部件号 |
PCIe.MaxLinkWidth |
最大带宽 |
PCIe.FirmwareVersion |
固件版本 |
PCIe.Status |
状态 |
PCIe.Health |
健康状态 |
NVMe.SlotID |
NVMe盘槽位号 |
NVMe.VendorName |
NVMe盘厂商名称 |
NVMe.ProductName |
NVMe盘产品名称 |
NVMe.PDStatus |
NVMe盘状态: · Spare_below · Temp_Anomaly · Subsys_Degraded · Read_only · Cache_Failed · Normal |
NVMe.PercentLife |
NVMe盘剩余寿命 |
NVMe.SerialNumber |
NVMe盘序列号 |
NVMe.ModelNumber |
NVMe盘型号 |
NVMe.Capacity |
NVMe盘存储容量 |
NVMe.FirmwareVersion |
NVMe盘固件版本 |
NVMe.PortType |
NVMe盘接口类型 |