• 产品与解决方案
  • 行业解决方案
  • 服务
  • 支持
  • 合作伙伴
  • 新华三人才研学中心
  • 关于我们
docurl=/cn/Service/Document_Software/Software_Download/Server/Catalog/Management_tool/hREST/202011/1359467_30005_0.htm

hREST&Software&1.07版本软件以及版本说明

hREST&Software&1.07版本软件以及版本说明

2020/11/28 16:05:08


下载:

 
 

 

1 hrest工具简介·· 1

1.1 使用介绍·· 1

1.1.1 命令行工具·· 1

1.1.2 版本支持·· 1

1.2 命令通用说明·· 1

2 hrest命令列表·· 3

2.1 获取帮助命令·· 3

2.2 获取CPU信息·· 5

2.3 获取内存信息·· 6

2.4 获取物理盘信息·· 8

2.5 设置物理盘·· 9

2.6 获取逻辑盘信息·· 10

2.7 创建逻辑盘·· 11

2.8 删除逻辑盘·· 13

2.9 获取RAID卡信息·· 14

2.10 获取存储信息·· 15

2.11 获取事件日志·· 17

2.12 删除事件日志·· 19

2.13 查询网口信息·· 19

2.14 设置网口IPv4地址·· 22

2.15 设置网口IPv6地址·· 22

2.16 获取网口VLAN信息·· 23

2.17 设置网口VLAN· 24

2.18 查询网口模式·· 24

2.19 设置HDM网口模式·· 25

2.20 获取网卡信息·· 25

2.21 获取IP登录规则信息·· 27

2.22 设置IP登录规则·· 28

2.23 获取NVMe SSD信息·· 29

2.24 获取功率封顶信息·· 30

2.25 设置功率封顶·· 30

2.26 获取电源信息·· 31

2.27 切换主备电源·· 32

2.28 控制系统上下电·· 33

2.29 获取设备信息·· 33

2.30 设置资产标签·· 35

2.31 获取角色信息·· 36

2.32 获取启动信息·· 37

2.33 获取健康状态·· 37

2.34 获取操作日志·· 38

2.35 获取系统时间·· 40

2.36 设置系统时区·· 40

2.37 获取系统温度·· 41

2.38 获取用户信息·· 42

2.39 添加用户·· 44

2.40 修改用户信息·· 45

2.41 删除用户·· 46

2.42 获取BIOS信息·· 47

2.43 设置BIOS选项·· 47

2.44 重置BIOS选项·· 48

2.45 获取风扇信息·· 48

2.46 设置风扇转速·· 50

2.47 设置关闭带内设置用户·· 51

2.48 导出配置·· 51

2.49 导入配置·· 52

2.50 获取固件版本信息·· 52

2.51 获取NTP信息·· 53

2.52 设置NTP信息·· 54

2.53 获取SNMP信息·· 55

2.54 设置SNMP信息·· 57

2.55 获取服务配置信息·· 59

2.56 设置服务配置信息·· 60

2.57 下载SDS日志·· 61

2.58 获取虚拟媒体信息·· 62

2.59 升级固件·· 63

2.60 获取PCIe设备列表·· 64

2.61 获取KVM截图·· 65

2.62 设置LDAP· 66

2.63 新增或修改LDAP用户·· 67

2.64 删除LDAP用户·· 69

2.65 设置ADActive Directory·· 69

2.66 新增或修改ADActive Directory)用户·· 70

2.67 删除ADActive Directory)用户·· 71

2.68 获取GPU信息·· 72

2.69 获取VNC会话信息·· 73

2.70 获取防火墙状态信息·· 74

2.71 设置防火墙状态·· 74


1 hrest工具简介

hrest命令行工具使用Python语言开发,主要基于HTTPs协议和RedfishRESTfulIPMI)接口协议,是一款便于用户管理服务器的客户端工具。用户可通过本工具的查询、设置等命令对服务器进行管理。

1.1  使用介绍

1.1.1  命令行工具

本工具将Python运行基础包、Redfish源码以及程序运行所依赖外部包,放于同一个工程目录下,软件执行时可直接调用,可以做到免安装且无需环境配置。当前hrest工具支持WindowsLinux操作系统,涉及到操作系统,无特殊说明情况下,统一为64位。

执行步骤如下:

(1)    工程文件hrest_linux.tar.gzWindows版本对应hrest_windows.zip)包拷贝至系统下;

(2)    解包文件并进去工程目录hREST_linuxhREST_windows

(3)    进入bin 文件夹;

(4)    输入命令 ./hrest –H ******  -U ****** -P ****** subcommand Windows环境对应命令:hrest –H ******  -U ****** -P ****** subcommand);

(5)    回车执行命令。

1.1.2  版本支持

1. HDM版本要求

推荐HDM-1.30.15及其以后版本。涉及部分功能对HDM版本有特殊要求,可查看命令说明中的使用指南。

2. 操作系统

支持的Windows系统包括:

·              Windows Server 2012 R2

·              Windows 7

·              Windows 10

支持的Linux系统包括:

·              CentOS 6.2

·              CentOS 7.3

1.2  命令通用说明

hrest命令的通用格式为:

hrest -H host -p port -U username -P password <command>

hrest命令参数区分大小写。由于操作系统特性,在Linux系统通常格式为:

./hrest -H host -p port -U username -P password <command>

在执行hrest命令时,需要指定以下参数,此处统一说明。

·              -H host:指定被管理设备的HDM IP地址。

·              -p port:指定HTTPS协议端口号,默认为“443”,为可选参数。

·              -U username -P password:指定被管理设备的HDM用户名及其密码。

·              <command>:关于<command>参数的说明,下文将详细介绍。

 


2 hrest命令列表

2.1  获取帮助命令

本命令用于获取工具帮助信息。

【命令】

hrest -h/--help

【参数】                                        

表2-1 参数说明

参数

描述

-h/--help

获取帮助信息

 

【举例】

# 获取工具帮助信息

-> hrest –h

usage: hREST [-h] [-V] -H HOST [-p 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

  -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.

    getcpu          get CPUs information.

    getelog         get event log.

    getfan          get fan information.

    getfwv          get firmware version.

    gethdmlog       get hdm log.

    getsyshealth    get system health state.

    getip           get ip information.

    getvlan         get vlan information.

    getldisk        get logical drive information.

    getloginruleip  get ip login rule.

    getmemory       get memory information.

    getnetmode      get net mode.

    getmac          get mac 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.

    getscreencapture

                    get virtual media information.

    getsensor       get sensors information.

    getservice      get service information.

    getsnmp         get snmp information.

    getstorage      get storage information.

    getsysboot      get system boot information.

    gettemp         get temperature information.

    gettime         get system time.

    getuser         get user information.

    getvmm          get virtual media information.

    setbiosdefault  set bios default.

    setbmcdefault   set bmc default.

    setad           set ad(Active Directory).

    setbios         set bios parameter.

    setfan          set fan speed.

    setipv4         set IPv4 information of the BMC network port.

    setipv6         set IPv6 information of the BMC network port.

    setvlan         set VLAN information.

    setldap         set ldap.

    setloginruleip  add ip login rule.

    setnetmode      set net mode.

    setntp          set ntp information.

    setpdisk        set physical disk information.

    setpowerlimit   set power limit.

    setpmb          set power main/backup.

    setproductinfo  set product information.

    setservice      set service configuration.

    setsnmp         set snmp information.

    settimezone     time zone. for example, UTC+9 and UTC-3.

    setuser         set user.

    uploadconfig    download configuration.

 

2.2  获取CPU信息

本命令用于获取服务器CPU信息。

【命令】

hrest -H host -p port -U username -P password getcpu -CI cpu_id

【参数】

表2-2 参数说明

参数

描述

取值

cpu_id

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

 

2.3  获取内存信息

本命令用于获取服务器内存信息。

【命令】

hrest -H host -p port -U username -P password getmemory -MI memory_id

【参数】

表2-4 参数说明

参数

描述

取值

memory_id

内存槽位,为可选参数

当不携带此参数时,将展示所有内存信息

 

【举例】

# 获取槽位为A4的内存详细信息

-> hrest –H 192.168.10.6 –U ****** -P ****** getmemory –MI A4

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

CommonName                              : CPU1A4

CapacityMiB                             : 8192

Manufacturer                            : Hynix Semiconductor

OperatingSpeedMhz                       : 2666

MemoryDeviceType                        : DDR4

RankCount                               : SR DIMM

PartNumber                              : HMA81GR7AFR8N-VK

 

[MemoryLocation]

Position                                : CPU1

Channel                                 : 4

Slot                                    : A4

 

[Status]

State                                   : Enabled

Health                                  : OK

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

 

【输出说明】

表2-5 输出说明

参数

描述

CommonName                             

内存从属的CPU+Slot

CapacityMiB

内存容量

Manufacturer

内存制造商

OperatingSpeedMhz

内存速率

MemoryDeviceType

内存类型

RankCount

内存Rank数量

PartNumber

内存部件号

MemoryLocation

内存位置

State

内存使能状态

Health

内存健康状态

 

2.4  获取物理盘信息

本命令用于获取服务器物理盘信息。

【命令】

hrest -H host -p port -U username -P password getpdisk -PI physical_id

【参数】

表2-6 参数说明

参数

描述

取值

physical_id

物理盘id,为可选参数,此ID为物理盘的Connection id

当不携带此参数时,将展示所有物理信息

 

【举例】

# 获取物理盘详细信息。

-> 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

 

ControllerID                            : 0

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

【输出说明】

表2-7 输出说明

参数

描述

Panel

面板位置

Slot_phys_no

物理盘Slot

Slot

物理盘槽位号

Connection id

物理盘链接ID,组建逻辑盘时使用

Drive number in BIOS

BIOS下物理盘编号

Drive number in OS

OS下物理盘编号

Status

物理盘状态

Model

物理盘型号

Firmware version

物理盘驱动版本

Serial number

物理盘序列号

Property

物理盘型号

Capacity

物理盘存储容量

ControllerID

物理盘所在控制卡ID

 

2.5  设置物理盘

本命令用于设置物理盘状态。

【命令】

hrest -H host -p port -U username -P password setpdisk -CI controller_id –PI physical_id -S status

【参数】

表2-8 参数说明

参数

描述

取值

controller_id

控制卡ID,为必配参数

控制卡ID

physical_id

物理盘ID,为必配参数

硬盘的connected ID

status

物理盘状态,为必配参数

物理盘使用状态包括:

·          Enable:启用

·          Disable:不启用

·          JBODJBOD模式

 

【使用指南】

本命令仅可设置未组建逻辑盘且连接正常的物理盘。

【举例】

# 设置控制卡ID0connection ID22的物理盘,状态为Disable

-> hrest –H 192.168.10.6 –U ****** -P ****** setpdisk -CI 0 -PI 22 -S Disable

Success: set physical drive successfully

 

2.6  获取逻辑盘信息

本命令用于获取服务器逻辑盘信息。

【命令】

hrest -H host -p port -U username -P password getldisk -CI controller_id –LI logical_id

【参数】

表2-9 参数说明

参数

描述

取值

controller_id

控制卡ID,为可选参数

0递增的整数,不携带此参数且不携带逻辑盘ID参数时,将展示所有控制卡信息

logical_id

逻辑盘ID,为可选参数

0递增的整数,当控制卡ID参数存在时,才可携带此参数,否则提示参数错误

 

【举例】

# 获取控制卡ID0,逻辑盘id3的逻辑盘信息

-> hrest –H 192.168.10.6 –U ****** -P ****** getldisk –CI 0 –LI 0

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

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

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策略

BootEnable

是否为启动盘

Drives

组成逻辑盘的物理盘ID,此ID为物理盘在系统下的编号

Health

逻辑盘健康状态

【修改记录】

(1) HDM-1.11.27及以前版本路径为https://device_ip/redfish/v1/Systems/system_id/Storage/RAIDStorage0/Volumes/logical_id

(2) HDM-1.11.29增加字段BootDrive

(3) HDM-1.11.31 字段BootDrive修改成BootEnableDiskCachePolicy 修改成DriveCache

(4) HDM-1.30.06 增加字段NumDrivePerSpan, SpanNumber

(5) HDM-1.30.09 修改字段BootEnable为布尔型,增加字段Oem.Public.OptimumIOSizeBytes

(6) HDM-1.30.10增加字段Oem.Public.AccelerationMethod

(7) HDM-1.30.11字段OptimumIOSizeBytes返回值类型从字符串修改成数值

 

2.7  创建逻辑盘

本命令用于创建逻辑盘。

【命令】

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 acceleration_method

【用户权限】

admin

【参数】

表2-11 参数说明

参数

描述

取值

controllerid

控制卡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版本增加panelbios_phys_idslot_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

acceleration_method

加速策略,仅PMC涉及

加速策略,仅PMC卡涉及

·          1,表示None

·          2,表示Controller Cache

·          3,表示IO Bypass(仅涉及SSD硬盘)

 

【使用指南】

对于HDM带外配置功能不支持的RAID卡,此功能无法使用。

【举例】

# 添加逻辑盘。控制卡iD0,逻辑盘名称为dragon,条带大小为64,初始化类型为NoRAID级别为1,两块物理盘,connection id分别为26,23,逻辑组id0,每个SPAN的成员盘数为2,写策略为WriteThroughIO策略为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

 

2.8  删除逻辑盘

本命令用于删除逻辑盘。

【命令】

hrest -H host -p port -U username -P password delldisk –CI controllerid –LI logicalid

【参数】

表2-12 参数说明

参数

描述

取值

controllerid

控制卡ID,为必配参数

-

logicalid

逻辑盘ID,为必配参数

-

 

【使用指南】

【举例】

# 删除控制卡ID0,逻辑盘ID3的逻辑盘

-> hrest –H 192.168.10.6 –U ****** -P ****** delldisk -CI 0 -LI 3

Success: delete logical driver successfully

 

2.9  获取RAID卡信息

本命令用于获取RAID卡信息。

【命令】

hrest -H host -p port -U username -P password getraid –CI controlerid

【参数】

【使用指南】

【举例】

# 获取RAID卡信息。

-> hrest –H 192.168.10.6 –U ****** -P ****** getraid –CI 0

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

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

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

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

 

【输出说明】

图2-1 输出说明

参数

描述

CommonName

控制卡名称

SerialNumber

控制卡序列号

State

控制卡序列号

Health

控制卡缓存容量

Id

控制卡ID

Manufacturer

厂商

Model

控制卡型号

SupportedDeviceProtocols

控制卡支持协议

SASAddress

存储控制器地址

FirmwareVersion

控制卡固件版本

PackageVersion

Pakage版本

JBODState

JBOD状态

MemorySizeMiB

缓存大小

SupportedRAIDLevels

所支持RAID级别

 

2.10  获取存储信息

本命令用于获取存储信息。

【命令】

hrest -H host -p port -U username -P password getstorage –CI controlerid

【参数】

表2-13 参数说明

参数

描述

取值

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-14 输出说明

参数

描述

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

控制卡下所有物理盘序号

 

2.11  获取事件日志

本命令用于获取事件日志信息。

【命令】

hrest -H host -p port -U username -P password getelog -C count

【参数】

表2-15 参数说明

参数

描述

取值

count

获取的事件日志条数,为可选参数

当不携带此参数时,将展示所有事件信息,依赖于展示窗口限制

 

【举例】

# 获取事件日志信息。

-> 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-16 输出说明

参数

描述

Id

日志信息编号,注意该编号为HDM后台的编号,与Web页面显示有所不同

Record type

事件记录类型,包括:

·          system_event_record:系统事件类型

·          oem_recordOEM事件

Time

日志记录的时间

System software type

事件产生源,包括:

·          bios

·          smi_handler

·          system_management_softwar

·          system_software_oem

·          remote_console_software

·          oem

·          terminal_mode_remote_console_software

Generator type

产生源类型,包括:

·          system_software_id

·          ipmb_slave_address

Channel number

事件产生的通道编号

Ipmb lun

事件的LUN编号

Event format ipmi version

IPMI协议版本号

Sensor type

产生该日志的传感器的类型

Type number

日志类型编号

Sensor number

产生该日志的传感器的编号

Sensor name

产生该日志的传感器的名称

Event direction

事件是触发还是解除,包括:

·          asserted

·          deasserted

Event reading class

事件产生的类别,用于筛选,包括:

·          threshold

·          discrete

·          oem

Sensor reading value

产生传感器事件的传感器的读数

Triggered value

产生传感器事件的传感器的阈值读数

Sensor reading value type

事件产生的类别,包括:

·          trigger_based

·          oem_based

·          sensor_specific

·          unspecified

Triggered type

产生传感器事件的传感器类型

Event description

事件日志描述

Level

事件级别,包括:

·          0:显示

·          1:正常

·          2:一般

·          3:严重

·          4:致命

 

2.12  删除事件日志

本命令用于删除事件日志信息。

【命令】

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

 

2.13  查询网口信息

本命令用于查询网口信息。

【命令】

hrest -H host -p port -U username -P password getip -N ethernetid

【用户权限】

admin

【参数】

表2-17 参数说明

参数

描述

取值

ethernetid

网口名称,为可选参数,缺省状态下默认获取当前HOST地址对应的网口信息。

依据实际情形填写,例如eth0eth1或者eth1.401

【说明】

-N参数为空时,会返回命令中使用的HDM IP对应网口的信息。

需要注意的是,本工具无法获取使用串口等方式设置的临时IP信息,将返回Failure: Failed to get ip information

【举例】

# 获取网口信息。

-> hrest –H 192.168.10.6 –U ****** -P ****** getip –NI eth1

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

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

 

[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-18 输出说明

参数

描述

Id

网口ID

Name

网口名称

Description

网口描述信息

FQDN

全限定域名

FullDuplex

全双工是否开启

HostName

主机名

MACAddress

MAC地址

IPv6DefaultGateway

IPv6默认网关

InterfaceEnabled

网口是否使能

MTUSize

MTU最大值

MaxIPv6StaticAddresses

IPv6静态地址最大长度

NameServers

-

PermanentMACAddress

固定MAC地址

SpeedMbps

传输速率,单位Mbps

Health

健康状态

Status

健康状态使能

IPv4Addresses.SubnetMask

IPv4子网掩码

IPv4Addresses.AddressOrigin

IPv4协议类型

IPv4Addresses.Address

IPv4地址

IPv6Addresses.Address

IPv6地址

IPv6Addresses.AddressOrigin

IPv6协议类型

IPv6Addresses.PrefixLength

IPv6前缀长度

 

2.14  设置网口IPv4地址

本命令用于设置网口IPv4地址。

【命令】

hrest -H host -p port -U username -P password setipv4 –N ethernetid –S ipv4enable –IP address –T dhcpenable –G gateway –M subnetmask

【参数】

表2-19 参数说明

参数

描述

取值

ethernetid

网口名称,为必配参数。

依据实际情形填写,例如eth0eth1或者eth1.401

ipv4enable

启用IPv4,为可选参数

启用IPv4,包括:

·          Enabled:启用

·          Disabled:不启用

address

IP地址,为可选参数

-

dhcpenable

使能DHCP,为可选参数

IPv4地址生成方式,包括:

·          DHCP:启用DHCP

·          Static:使用静态IP

gateway

网关,为可选参数

-

subnetmask

子网掩码,为可选参数

-

 

【举例】

# 设置eth0IPv4地址。

-> 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

 

2.15  设置网口IPv6地址

本命令用于设置网口IPv6地址。

【命令】

hrest -H host -p port -U username -P password setipv6 -N ethernetid -S ipv6enable -IP address -T dhcpenable -G gateway -L prefixlength

【参数】

表2-20 参数说明

参数

描述

取值

ethernetid

网口ID,为必配参数

-

ipv6enable

启用IPv6,为可选参数

启用IPv6,包括:

·          Enabled:启用

·          Disabled:不启用

address

IP地址,为可选参数

-

dhcpenable

使能DHCP,为可选参数

IPv6地址生成方式,包括:

·          DHCP:启用DHCP

·          Static:使用静态IP

gateway

网关,为可选参数

-

prefixlength

子网前缀长度,为可选参数

-

 

【举例】

# 设置eth0网口的IPv6地址。

-> hrest –H 192.168.10.6 –U ****** -P ****** setipv6 -N eth0 -IP 2001:0:0:1A::10

Success: set network successfully

 

2.16  获取网口VLAN信息

本命令用于获取网口VLAN信息。

【命令】

hrest -H host -p port -U username -P password getvlan -NI ethernetid

【参数】

表2-21 参数说明

参数

描述

取值

ethernetid

网口名称,为必配参数。

依据实际情形填写,例如eth0eth1或者eth1.401

 

【举例】

# 获取eth0网口的VLAN信息。

-> hrest –H 192.168.10.6 –U ****** -P ****** getvlan –N eth0

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

VLANEnable                    : False

VLANId                        : 0

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

 

【输出说明】

表2-22 输出说明

参数

描述

VLANEnable

是否启用VLAN,包括:

·          True:启用VLAN

·          False启用VLAN

VLANId

VLAN ID

 

2.17  设置网口VLAN

本命令用于配置网口的VLAN

【命令】

hrest -H host -p port -U username -P password setvlan –N ethernetid -S vlanenable -I vlanid –P priority

【参数】

表2-23 参数说明

参数

描述

取值

ethernetid

网口名称,为必配参数。

依据实际情形填写,例如eth0eth1或者eth1.401

vlanenable

启用VLAN,为可选参数

启用VLAN,包括:

·          Enabled:启用

·          Disabled:不启用

vlanid

IP地址,为可选参数

取值范围是24094之间的整数

priority

VALN优先级,为可选参数

0~7之间的整数,7为最高优先级

 

【举例】

# 设置网口VLAN

-> hrest –H 192.168.10.6 –U ****** -P ****** setvlan -NI eth0 -S Enabled -I 5 -P 0

Success: set network successfully

 

2.18  查询网口模式

本命令用于查询网口模式。

【命令】

hrest -H host -p port -U username -P password getnetmode

【举例】

# 查询网口模式。

-> hrest –H 192.168.10.6 –U ****** -P ****** getnetmode

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

PortModes                               : Normal mode

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

【输出说明】

表2-24 输出说明

参数

描述

PortModes

网口模式,包括:

·          Normal mode正常模式

·          Bonding modeBond模式

·          Active/standby mode:网口自适应模式

 

2.19  设置HDM网口模式

本命令用于设置HDM网口模式。

【命令】

hrest -H host -p port -U username -P password setnetmode –M status

【参数】

表2-25 参数说明

参数

描述

取值

status

网口模式,为必配参数。

网口模式,包括:

·          Normal正常模式

·          BondBond模式

·          Adaptive:网口自适应模式

【举例】

# 设置网口Bond模式。

-> hrest –H 192.168.10.6 –U ****** -P ****** setnetmode –M Bond

Success: set network port mode succeed

 

2.20  获取网卡信息

本命令用于获取网卡信息。

【命令】

hrest -H host -p port -U username -P password getmac

【举例】

# 获取网卡信息。

-> hrest –H 192.168.10.6 –U ****** -P ****** getmac

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

Product name                            : NIC-GE-4P-360T-L3

Product code                            : NIC

Network port                            : Port 1

Location                                : mLOM

Mac address                             : 30:7B:AC:DE:64:B3

Speed                                   : 2.5GT/s

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

Product name                            : NIC-GE-4P-360T-L3

Product code                            : NIC

Network port                            : Port 2

Location                                : mLOM

Mac address                             : 30:7B:AC:DE:64:B4

Speed                                   : 2.5GT/s

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

Product name                            : NIC-GE-4P-360T-L3

Product code                            : NIC

Network port                            : Port 3

Location                                : mLOM

Mac address                             : 30:7B:AC:DE:64:B5

Speed                                   : 2.5GT/s

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

Product name                            : NIC-GE-4P-360T-L3

Product code                            : NIC

Network port                            : Port 4

Location                                : mLOM

Mac address                             : 30:7B:AC:DE:64:B6

Speed                                   : 2.5GT/s

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

 

【输出说明】

表2-26 输出说明

参数

描述

Product name

产品名称

Product code

设备类型

Network port

网络端口

Location

网卡位置

Mac address

网卡MAC地址

Speed

网卡速率

 

2.21  获取IP登录规则信息

本命令用于获取登录规则信息。

【命令】

hrest -H host -p port -U username -P password getloginruleip

【举例】

# 获取登录规则信息。

-> hrest –H 192.168.10.6 –U ****** -P ****** getloginruleip

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

IpFrom                                  : 172.16.0.3

IpTo                                    : 172.16.0.88

MacAddress                              :

Rule                                    : Blacklist

TimeRange                               : Disabled

TimeFrom                                : 0000-00-00T00:00

TimeTo                                  : 0000-00-00T00:00

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

IpFrom                                  : 172.10.3.55

IpTo                                    : 172.10.3.56

MacAddress                              : aa:aa:aa:aa:aa:aa

Rule                                    : Blacklist

TimeRange                               : Enabled

TimeFrom                                : 2020-07-01T06:25

TimeTo                                  : 2020-07-03T15:13

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

IpFrom                                  : 192.168.0.0

IpTo                                    : 192.168.255.255

MacAddress                              :

Rule                                    : Whitelist

TimeRange                               : Disabled

TimeFrom                                : 0000-00-00T00:00

TimeTo                                  : 0000-00-00T00:00

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

 

【输出说明】

表2-27 输出说明

参数

描述

IpFrom                                 

登录规则起始IP

IpTo                                   

登录规则终止IP

MacAddress

允许或禁止访问的Mac地址

Rule

防火墙类型,包括:

·          Whitelist白名单

·          Blacklist黑名单

TimeRange

是否启用规则有效期,包括:

·          Enabled:启用

·          Disabled:不启用

TimeFrom

登录规则起始时间

TimeTo

登录规则终止时间

 

2.22  设置IP登录规则

本命令用于设置登录规则,包含添加和删除登录规则。

【命令】

hrest -H host -p port -U username -P password addloginruleip  –O operator  –S rule –P starttime –Q endtime -IS ipstart –IE ipend

【参数】

表2-28 参数说明

参数

描述

取值

operator 

操作类型,为必配参数

防火墙操作类型,包括:

·          Add:添加规则

·          Del:删除规则

rule

规则类型,为必配参数

防火墙规则,包括:

·          allow:允许登录,对应白名单

·          block:阻止登录,对应黑名单

starttime 

规则起始时间,为可选参数

强格式要求,如2020-06-03T13:10

endtime

规则终止时间,为可选参数

强格式要求,如2020-06-06T13:15

ipstart

规则起始IP,为必配参数

-

ipend

规则终止IP,为可选参数

-

 

【举例】

# 添加登录规则。规则为阻止,拦截期限为2020-05-20T12:22-2020-06-03T13:10ip拦截范围为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

 

2.23  获取NVMe SSD信息

本命令用于获取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-29 输出说明

参数

描述

SlotID

PCIe槽位

VendorName

SSD制造商

ProductName

SSD产品名称

PDStatus

NVMe SSD状态

PercentLife

SSD已使用寿命

SerialNumber

SSD序列号

ModelNumber

SSD硬盘编码

Capacity

SSD容量

FirmwareVersion

SSD固件版本

PortType

SSD接口类型

 

2.24  获取功率封顶信息

本命令用于获取功率封顶信息。

【命令】

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-30 输出说明

参数

描述

PowerLimitEnable

是否开启功率封顶,包括:

·          True

·          False:否

LimitInWatts

功率封顶值

LimitException

达到封顶功率后的动作设置,包括:

·          HardPowerOff:关机

·          NoAction:无操作

 

2.25  设置功率封顶

本命令用于设置功率封顶。

【命令】

hrest -H host -p port -U username -P password setpowerlimit -S status -V limitvalue –E exception

【参数】

表2-31 参数说明

参数

描述

取值

status

是否启用功率封顶,为必配参数

是否启用功率封顶,包括:

·          Enable:启用

·          Disable:不启用

limitvalue

功率封顶值,为可选参数

-

exception

超出封顶值后操作,为可选参数

超出功率登顶后是否关机,包括:

·          Shutdown:关机

·          NoAction:无操作

 

【使用指南】

刀箱服务器不支持功率封顶设置。

【举例】

# 设置功率封顶。开启功率封顶,封顶值为600,超出封顶值后无动作。

-> hrest –H 192.168.10.6 –U ****** -P ****** setpowerlimit -S Enable -V 600 -E NoAction

Success: set power limit succeed

 

2.26  获取电源信息

本命令用于获取电源信息。

【命令】

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                            : N/A

PowerSupplyType                         : AC

PowerCapacityWatts                      : 550

LineInputVoltageType                    : ACMidLine

FirmwareVersion                         : 1M.0009.0021.001

PowerID                                 : 1

ActiveStandby                           : Active

 

[Status]

Health                                  : OK

State                                   : Enabled

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

Name                                    : PSU2

Model                                   : PSR550-12A

SerialNumber                            : 210231A8KXH17C000002

PowerSupplyType                         : AC

PowerCapacityWatts                      : 550

LineInputVoltageType                    : ACMidLine

FirmwareVersion                         : 4M.0002.0006.005;1M.0009.0021.003

PowerID                                 : 2

ActiveStandby                           : Active

 

[Status]

Health                                  : OK

State                                   : Enabled

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

 

【输出说明】

表2-32 输出说明

参数

描述

Name

电源名称

Model

电源型号

SerialNumber

电源序列号

PowerSupplyType

电源的供电类型

PowerCapacityWatts

电源的总功率

LineInputVoltageType

电源输入电压类型

FirmwareVersion

电源的固件版本

PowerID

电源ID

ActiveStandby

电源主备状态

State

电源是否使能

Health

电源健康状态

 

2.27  切换主备电源

本命令用于切换主备电源。

【命令】

hrest -H host -p port -U username -P password setpmb -I powerid -S status

【参数】

表2-33 参数说明

参数

描述

取值

powerid

电源ID,为必配参数。

-

status

电源状态,为必配参数。

电源状态包括:

·          Active:主用

·          Standby:备用

 

【举例】

# 设置电源id2的电源为备用电源。

-> hrest –H 192.168.10.6 –U ****** -P ****** setpmb –I 2 –S Standby

 Success: set power redundancy succeed

 

2.28  控制系统上下电

本命令用于控制系统上下电。

【命令】

hrest -H host -p port -U username -P password syspowerctrl -T type

【参数】

表2-34 参数说明

参数

描述

取值

type

系统上下电控制选项,为必配参数

是否启用功率封顶,包括:

·          On:正常开机

·          Off:正常关机

·          ForceOff:强制关机

·          Reset:立即重启

·          Cycle:关机并重新开机

 

【举例】

# 控制系统强制关机。

-> hrest –H 192.168.10.6 –U ****** -P ****** syspowerctrl -T ForceOff

Success: set power state succeed

 

2.29  获取设备信息

本命令用于获取设备信息。

【命令】

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

IndicatorLED                            : Off

SerialNumber                            : 12345678901234567890

PartNumber                              : 0200A00Q

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

raid                                    : OK

temperature                             : OK

volatge                                 : OK

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

 

【输出说明】

表2-35 输出说明

参数

描述

Id

设备ID

Name

设备名称

AssetTag

设备资产标签

Manufacturer

设备制造商

Model

设备型号

IndicatorLED

设备指示灯状态,包括:

·          On:常亮

·          Off:常灭

·          Blink:闪烁

SerialNumber

设备序列号

PartNumber

设备部件号

PowerState

当前上电状态

SystemType

系统类型

BiosVersion

BIOS版本

Status

设备状态,包括:

·          Health:系统资源健康状态

·          HealthRollup-

·          State:系统资源使能状态

OverallHealth

整体健康状态

board

系统板卡健康状态

current

电流健康状态

disk

硬盘健康状态

fans

风扇健康状态

memory

内存健康状态

pcie

PCIe卡健康状态

power

电源健康状态

processor

处理器健康状态

raid

RAID卡下逻辑盘健康状态

temperature

温度传感器健康状态

volatge

电压传感器健康状态

【修改记录】

 (1)HDM-1.30.14 字段Mainboard{BoardName,SerialNumber}移到Oem.Public下,hREST V1.06版本修改适配

2.30  设置资产标签

本命令用于设置资产标签。

【命令】

hrest -H host -p port -U username -P password setproductinfo -T assettag

【参数】

表2-36 参数说明

参数

描述

取值

assettag

系统资产标签,为可选参数

-

 

【举例】

# 设置资产标签。

-> hrest –H 192.168.10.6 –U ****** -P ****** setproductinfo –T test_123

Success: set asset tag succeed

 

2.31  获取角色信息

本命令用于获取角色信息。

【命令】

hrest -H host -p port -U username -P password getrole –R role

【参数】

表2-37 参数说明

参数

描述

取值

role

角色名称,为可选参数,不指定时展示所有角色信息

角色名称,包括:

·          Administrator

·          Operator

·          User

·          None

 

【举例】

# 获取角色信息。

-> hrest –H 192.168.10.6 –U ****** -P ****** getrole –R Administrator

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

Role                                    : Administrator

IsPredefined                            : True

AssignedPrivileges                      : Login, ConfigureManager, ConfigureUsers, ConfigureSelf, ConfigureComponents

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

 

【输出说明】

表2-38 输出说明

参数

描述

Role

角色类型

IsPredefined

角色是否预定义

AssignedPrivileges

权限类型,包括:

·          Login:登录

·          ConfigureUsers:用户配置

·          ConfigureSelf :配置自身

·          ConfigureComponents:常规配置

·          ConfigureManager:配置管理员

 

2.32  获取启动信息

本命令用于获取系统启动信息。

【命令】

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-39 输出说明

参数

描述

BootSourceOverrideTarget

服务器的下一次启动设备,包括:

·          None

·          Hdd

·          Pxe

·          BiosSetup

·          Cd

BootSourceOverrideEnabled

启动设置有效期,包括:

·          Once:仅生效一次, 即下次重启时生效

·          Continuous

BootSourceOverrideMode

服务器的启动模式,包括:

·          None

·          Legacy

·          UEFI

 

2.33  获取健康状态

本命令用于获取服务器健康状态信息。

【命令】

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-40 输出说明

参数

描述

System health

整体系统健康状态,包括:

·          OK:正常

·          Minor:一般

·          Major:严重

·          Critical:致命

Temperature

系统温度健康状态

Voltage

系统电压健康状态

Current

系统电流健康状态

Memory

系统内存健康状态

Fans

系统风扇健康状态

Processor

系统处理器健康状态

Disk

系统硬盘健康状态

Power

系统电源健康状态

 

2.34  获取操作日志

本命令用于获取操作日志。

【命令】

hrest -H host -p port -U username -P password gethdmlog -C count

【参数】

表2-41 参数说明

参数

描述

取值

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-42 输出说明

参数

描述

ID

HDM日志ID

Username

管理员名称

Interface

接口类型

LogIpAdd

IP地址

LogType

日志类型,包括:

·          1:审计日志

·          2:固件更新日志

·          3:操作日志

·          4:事件日志

·          5:硬件更新日志

LogContent

日志内容

Timestamp

时间戳

HostName

主机名

LogLevel

日志级别,包括:

·          INFO:信息

·          WARN:警告

 

2.35  获取系统时间

本命令用于获取系统时间。

【命令】

hrest -H host -p port -U username -P password gettime

【举例】

# 获取系统时间。

-> hrest –H 192.168.10.6 –U ****** -P ****** gettime

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

DateTime: 2019-02-27T20:00:07+08:00

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

 

【输出说明】

表2-43 输出说明

参数

描述

DateTime

当前系统时间

 

2.36  设置系统时区

本命令用于设置系统时区。

【命令】

hrest -H host -p port -U username -P password settimezone –Z timezone

【参数】

表2-44 参数说明

参数

描述

取值

timezone

时区信息,为必配参数

 

 

【举例】

# 设置系统时区。

-> hrest –H 192.168.10.6 –U ****** -P ****** settimezone -Z UTC-9

Success: set system timezone successfully: UTC-9

 

2.37  获取系统温度

本命令用于获取系统温度。

【命令】

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-45 输出说明

参数

描述

Name

温度传感器的名称

SensorNumber

温度传感器编号,为其在温度传感器列表中的唯一标识

ReadingCelsius

温度传感器的当前读数

PhysicalContext

物理环境

LowerThresholdCritical

温度传感器的低温严重告警阈

UpperThresholdCritical

温度传感器的高温严重告警阈值

LowerThresholdFatal

温度传感器的低温紧急告警阈值

UpperThresholdFatal

温度传感器的高温紧急告警阈值

LowerThresholdNonCritical

温度传感器的低温轻微告警阈值

UpperThresholdNonCritical

温度传感器的高温轻微告警阈值

Status

温度传感器的状态,包括:

·          Health:温度传感器健康状态

·          State:温度传感器是否使能,“Enabled”表示使能,“Disabled”表示不使能

 

2.38  获取用户信息

本命令用于获取用户信息。

【命令】

hrest -H host -p port -U username -P password getuser –N name

【参数】

表2-46 参数说明

参数

描述

取值

name

指定用户名,为可选参数。

参数为空时展示所有用户信息。

 

【举例】

# 获取用户信息。

-> hrest –H 192.168.10.6 –U ****** -P ****** getuser –N test

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

Id                                      : 3

UserName                                : test

RoleId                                  : Operator

Enabled                                 : True

IPMIEnable                              : True

KvmEnable                               : True

SnmpV3AccessPermission                  : read_only

SnmpV3AuthProtocol                      : sha

SnmpV3Enable                            : True

SnmpV3PrivProtocol                      : des

VmediaEnable                            : True

WebEnable                               : True

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

【输出说明】

表2-47 输出说明

参数

描述

Id

用户ID

UserName

用户名

RoleId

用户角色

Enabled

是否启用用户访问权限,包括:

·          True:启用

·          False:不启用

IPMIEnable

IPMI扩展权限使能

KvmEnable

KVM扩展权限使能

VmediaEnable

VM扩展权限使能

WebEnable

Web扩展权限使能

SnmpV3Enable

SNMP V3扩展权限使能

SnmpV3AccessPermission

SNMP V3读写权限:

·          read_only

·          read_write

SnmpV3AuthProtocol

SNMP V3鉴权算法:

·          sha

·          md5

SnmpV3PrivProtocol

SNMP V3加密算法:

·          des

·          aes

 

2.39  添加用户

本命令用于添加用户。

【命令】

hrest -H host -p port -U username -P password adduser -N name –P userpwd –R role -EN enabled –KVM kvmenable –VME vmeenable -IPMI Enable -WEB Enable -V3 SnmpV3Enable -V3APE SnmpV3AccessPermission -V3APR SnmpV3AuthProtocol -V3PP SnmpV3PrivProtocol

【参数】

表2-48 参数说明

参数

描述

取值

name

用户名,为必配参数

-

userpwd

用户密码,为必配参数

-

role

用户角色,为必配参数

用户角色,包括:

·          Administrator

·          Operator

·          User

·          None

enabled

用户访问权限,为可选参数

是否启用用户访问权限,包括:

·          Enable:启用

·          Disable:不启用

kvmenable

用户KVM权限,为可选参数

是否启用用户KVM权限,包括:

·          Enable:启用

·          Disable:不启用

vmeenable

用户Vmedia权限,为可选参数

是否启用用户Vmedia权限,包括:

·          Enable:启用

·          Disable:不启用

IPMIEnable

布尔型,为可选参数

IPMI扩展权限使能

WebEnable

布尔型,为可选参数

Web扩展权限使能

SnmpV3Enable

布尔型,为可选参数

SnmpV3扩展权限使能

SnmpV3AccessPermission

字符串,为可选参数

SnmpV3读写权限:

read_only

read_write

SnmpV3AuthProtocol

字符串,为可选参数

SnmpV3鉴权算法:

sha

md5

SnmpV3PrivProtocol

字符串,为可选参数

SnmpV3加密算法:

des

aes

 

【举例】

# 添加用户。

-> 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

 

2.40  修改用户信息

本命令用于修改用户信息,比如用户密码及用户角色。

【命令】

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

【参数】

表2-49 参数说明

参数

描述

取值

name

所要修改信息的用户名,为可选参数

参数为空时,默认修改当前用户

newpwd

用户新密码,为可选参数

-

newrole

用户新角色,为可选参数

用户新角色,包括:

·          Administrator

·          Operator

·          User

·          None

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读写权限,为可选参数

SnmpV3读写权限,包括:

·          read_only:只读

·          read_write读写

SnmpV3AuthProtocol

SnmpV3鉴权算法,为可选参数

SnmpV3鉴权算法,包括:

·          sha

·          md5

SnmpV3PrivProtocol

SnmpV3加密算法,为可选参数

SnmpV3加密算法,包括:

·          des

·          aes

 

【举例】

# 修改用户角色。

-> 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

 

2.41  删除用户

本命令用于删除用户。

【命令】

hrest -H host -p port -U username -P password deluser –N name

【参数】

表2-50 参数说明

参数

描述

取值

name

所要删除的用户名,为必配参数。

-

 

【举例】

# 删除用户名为user的用户。

-> hrest –H 192.168.10.6 –U ****** -P ****** deluser –N user

Success: delete user successfully

 

2.42  获取BIOS信息

本命令用于获取BIOS信息。

【命令】

hrest -H host -p port -U username -P password getbios –A value

【参数】

表2-51 参数说明

参数

描述

取值

value

指定BIOS属性,为可选参数

参数为空时展示全部BIOS选项信息

 

【举例】

# 获取BIOS CPUC6Report选项的信息。

-> hrest –H 192.168.10.6 –U ****** -P ****** getbios -A CPUC6Report

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

CPUC6Report                               : Auto

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

 

2.43  设置BIOS选项

本命令用于修改BIOS选项的值。

【命令】

hrest -H host -p port -U username -P password setbios –A attribute –V value

【参数】

表2-52 参数说明

参数

描述

取值

attribute

属性名称,为可选参数。

参数为空时,默认修改当前用户。

value

属性值,为可选参数。

-

 

【使用指南】

重启BIOS生效。

【举例】

# 设置BIOS选项CPUC6Report的值为Disable

-> hrest –H 192.168.10.6 –U ****** -P ****** setbios -A CPUC6Report -V Disable

Success: BIOS setup is successfully

 

2.44  重置BIOS选项

本命令用于重置BIOS选项为默认值。

【命令】

hrest -H host -p port -U username -P password setbiosdefault

【使用指南】

重启BIOS生效。

【举例】

# 恢复BIOS默认值。

-> hrest –H 192.168.10.6 –U ****** -P ****** setbiosdefault

Success: restore BIOS factory settings successfully

 

2.45  获取风扇信息

本命令用于获取风扇信息。

【命令】

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

Location                                : chassis

Model                                   : 3203A01V

RatedSpeedRPM                           : 3900

SpeedRPM                                : N/A

LowerThresholdRPM                       : N/A

[Status]

State                                   : Enabled

Health                                  : N/A

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

Id                                      : 1

FanName                                 : N/A

Location                                : chassis

Model                                   : 3203A01V

RatedSpeedRPM                           : 3900

SpeedRPM                                : N/A

LowerThresholdRPM                       : N/A

[Status]

State                                   : Enabled

Health                                  : N/A

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

Id                                      : 2

FanName                                 : N/A

Location                                : chassis

Model                                   : 3203A01V

RatedSpeedRPM                           : 3800

SpeedRPM                                : N/A

LowerThresholdRPM                       : N/A

[Status]

State                                   : Enabled

Health                                  : N/A

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

Id                                      : 3

FanName                                 : N/A

Location                                : chassis

Model                                   : 3203A01V

RatedSpeedRPM                           : 5000

SpeedRPM                                : N/A

LowerThresholdRPM                       : N/A

[Status]

State                                   : Enabled

Health                                  : N/A

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

Id                                      : 4

FanName                                 : N/A

Location                                : chassis

Model                                   : 3203A01V

RatedSpeedRPM                           : 5100

SpeedRPM                                : N/A

LowerThresholdRPM                       : N/A

[Status]

State                                   : Enabled

Health                                  : N/A

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

Id                                      : 5

FanName                                 : N/A

Location                                : chassis

Model                                   : 3203A01V

RatedSpeedRPM                           : 5100

SpeedRPM                                : N/A

LowerThresholdRPM                       : N/A

[Status]

State                                   : Enabled

Health                                  : N/A

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

【输出说明】

表2-53 输出说明

参数

描述

FanCount                      

最大风扇传感器的数量

FanSpeedAdjustmentMode       

调速模式

Id

风扇ID

FanName

风扇名称

Location                               

风扇位置

Model                               

风扇型号

RatedSpeedRPM                          

风扇转速

SpeedRPM                               

-

LowerThresholdRPM                      

低速告警阈值

State

风扇使能状态

Health

风扇健康状态

 

2.46  设置风扇转速

本命令用于设置风扇转速。

【命令】

hrest -H host -p port -U username -P password setfan –M mode –S fanspeed

【参数】

表2-54 参数说明

参数

描述

取值

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

 

2.47  设置关闭带内设置用户

本命令设置禁用带内设置用户。

【命令】

hrest -H host -p port -U username -P password closeinner

【举例】

# 设置是否禁用带内设置用户

-> hrest –H 192.168.10.6 –U ****** -P ****** closeinner

Success: set close inner set user status successfully

2.48  导出配置

本命令用于导出配置。

【命令】

hrest -H host -p port -U username -P password downloadconf -T type –F filepath

【参数】

表2-55 参数说明

参数

描述

取值

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

2.49  导入配置

本命令用于导入配置。

【命令】

hrest -H host -p port -U username -P password uploadconf -T type –F filepath

【参数】

表2-56 参数说明

参数

描述

取值

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

 

2.50  获取固件版本信息

本命令用于获取固件版本。

【命令】

hrest -H host -p port -U username -P password getfwv

【举例】

# 获取固件版本信息。

-> hrest –H 192.168.10.6 –U ****** -P ****** getfwv

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

Name                                    : ActiveBMC

Version                                 : 1.30.15P09 HDM V100R001B03D015SP09_DEBUG

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

Name                                    : BackupBMC

Version                                 : 1.30.15P08

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

Name                                    : MainBoard_CPLD

Version                                 : V007

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

Name                                    : BIOS

Version                                 : 2.00.36 V100R001B02D036

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

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

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

Name                                    : PSU1

Version                                 : 1M.0009.0021.001

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

Name                                    : PSU2

Version                                 : 4M.0002.0006.005;1M.0009.0021.003

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

【输出说明】

表2-57 输出说明

参数

描述

Name                                   

固件名称

Version                                

固件版本

 

2.51  获取NTP信息

本命令用于获取NTP信息。

【命令】

hrest -H host -p port -U username -P password getntp

【举例】

# 获取ntp信息。

-> hrest –H 192.168.10.6 –U ****** -P ****** getntp

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

ServiceEnabled                          : False

TimeZone                                : UTC-9

PreferredNtpServer                      : 1.cn.pool.ntp.org

AlternateNtpServer                      : 2.cn.pool.ntp.org

TertiaryNtpServer                       :

NtpAddressOrigin                        : Static

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

【输出说明】

表2-58 输出说明

参数

描述

ServiceEnabled

是否开启NTP自动同步

TimeZone

时区

PreferredNtpServer

NTP服务器

AlternateNtpServer

二级NTP服务器

TertiaryNtpServer

三级NTP服务器

NtpAddressOrigin

NTP模式,当前只支持Static

 

2.52  设置NTP信息

本命令用于设置NTP信息。

【命令】

(1)      hrest -H host -p port -U username -P password setntp -S status -PRE prentpserver -ALT altntpserver -TN TertiaryNtpServer

(2)      hrest -H host -p port -U username -P password setntp -Z timezone

(3)      hrest -H host -p port -U username -P password setntp -F timeinterval

【参数】

表2-59 参数说明

参数

描述

取值

status

是否开启NTP功能,为可选参数

是否启用,包括:

·          Enable:启用

·          Disable:不启用

prentpserver

首选NTP服务器,为可选参数

-

altntpserver

备用NTP服务器,为可选参数

-

TertiaryNtpServer

三级NTP服务器,为可选参数

-

timezone

NTP时区,为可选参数

-

timeinterval

NTP时间同步间隔,为可选参数

[600,250000]之间100的整数倍,该参数和其他参数不能同时设置。

 

【举例】

当设置参数和原有参数相同,可能会返回失败。

【举例】

# 开启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

2.53  获取SNMP信息

本命令用于获取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-60 输出说明

参数

描述

Description                  

SNMP资源描述

Id

功能ID

LongPasswordEnabled          

超长口令使能状态

Name

功能名称

ReadOnlyCommunity

只读团体名

ReadWriteCommunity

读写团体名

AlarmSeverity

告警等级,包括:

·          Critical

·          Minor+Major+Critical

·          All

为腾讯CID时,等级包括:

·          Critical

·          Warning+Critical

·          All

CommunityName

Trap团体名

ServiceEnabled

是否启用SNMP trap服务

TrapMode

Trap模式,包括:

·          NodeMode:模块OID模式

·          EventMode:事件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

【修改记录】

(1) HDM-1.12.05:接口删除

(2) HDM-1.30.06:接口新增,相对HDM-1.11.XX版本主要修改:新增字段AlarmSeverity,支持4TrapServer

(3) HDM-1.30.09:字段TrapServer.TrapServerPort类型从字符串修改成数值

(4) HDM-1.30.10:字段AlarmSeverity值取值为:"Critical","Major+Critical","ALL"

(5) HDM-1.30.11:字段新增SnmpTrapNotification.TrapMode

(6) HDM-1.30.11P01:字段AlarmSeverity值取值为:"Critical","Minor+Major+Critical","All"

(7) HDM-1.30.12:字段AlarmSeverity返回值中"ALL"修改成"All";腾讯CIDAlarmSeverity取值为"Critical","Warning+Critical ","All"

 

2.54  设置SNMP信息

本命令用于设置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

【参数】

表2-61 参数说明

参数

参数说明

取值

SnmpV1Enabled

SNMP协议版本1使能状态,为可选参数

SNMP协议版本1是否使能,包括:

·          Enable

·          Disable:否

SnmpV2CEnabled

SNMP协议版本2使能状态,为可选参数

SNMP协议版本2是否使能,包括:

·          Enable

·          Disable:否

LongPasswordEnabled

超长口令使能状态,为可选参数

超长口令是否使能,包括:

·          Enable

·          Disable:否

ReadOnlyCommunity

只读团体名,为可选参数

-

ReadWriteCommunity

读写团体名,为可选参数

-

CommunityName

Trap团体名,为可选参数

-

ServiceEnabled

Trap服务使能状态,为可选参数

Trap服务是否使能,包括:

·          Enable

·          Disable:否

TrapVersion

Trap版本,为可选参数

Trap版本,包括:v1v2cv3

TrapV3User

Trap V3用户,为可选参数

-

AlarmSeverity

告警等级,为可选参数

可修改的告警等级,包括:

·          Critical

·          Minor+Major+Critical

·          All

为腾讯CID时,等级包括:

·          Critical

·          Warning+Critical

·          All

TrapMode

Trap模式,为可选参数

Trap模式:

·          NodeMode:模块OID模式

·          EventMode:事件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服务地址,支持IPv4IPv6,为可选参数

-

 

【使用指南】

HDM-1.30.15P08修改SNMP修改策略,相较于hREST version 1.04版本,修改单一SNMP配置项,请求体中不再填充其他配置项,在HDM-1.30.15P08之前版本使用有配置失败风险。

【举例】

# 设置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

 

2.55  获取服务配置信息

本命令用于获取服务配置信息。

【命令】

hrest -H host -p port -U username -P password getservice –T servicttype

【参数】

表2-62 参数说明

参数

描述

取值

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-63 输出说明

参数

描述

Name

服务名称

Status

服务状态,包括:

·          Enable:活动

·          Disable:禁用

Insecure service port

服务的非安全端口

Secure service port

服务的安全端口

Idle timeout

超时时长

Maximum sessions

服务的最大会话数

 

2.56  设置服务配置信息

本命令用于设置服务配置信息。

【命令】

hrest -H host -p port -U username -P password setservice -T type -S status –M timeout –SP secure_port –NSP non_secure_port

【参数】

表2-64 参数说明

参数

描述

取值

type

服务类型,为必配参数

服务信息类型,包括:

·          Web

·          KVM

·          CD-Media

·          FD-Media

·          HD-Media

·          SSH

·          Telnet

·          IPMI

·          SNMP

·          VNC

·          Remote_XDP

status

是否开启服务,为可选参数

是否启用,包括:

·          Enabled:启用

·          Disabled:不启用

timeout

服务会话的超时时间,为可选参数

说明:

type参数取值为CD-MediaFD-MediaHD-MediaRemote_XDPSNMPIPMI时,不支持设置

超时时间长度,单位为分钟

secure_port

安全端口号

-

non_secure_port

非安全端口号

-

 

【举例】

# 设置VNC服务。

-> hrest –H 192.168.10.6 –U ****** -P ****** setservice -T VNC -S Enabled -NSP 4901

Success: set BMC network protocol services successfully

 

2.57  下载SDS日志

本命令用于下载SDS日志。

【命令】

hrest -H host -p port -U username -P password getsdslog –F filepath -P startdate –Q enddate

【参数】

表2-65 参数说明

参数

描述

取值

filepath

存储SDS日志的文件路径,为必配参数

避免出现中文字符,以免出现字符编码格式问题

startdate

SDS日志起始时间,为可选参数

---

enddate

SDS日志终止时间,为可选参数

---

 

【使用指南】

·              当不指定起始和终止日期时,默认下载全部日志。

·              下载的SDS文件名默认为SN_日期,形如HDM12345678912345678907_20191223_20191230.sds

【举例】

# 下载从2019-01-212019-01-28SDS日志到F:\sdslog

-> hrest –H 192.168.10.6 –U ****** -P ****** getsdslog –F F:\sdslog -SD 2019-01-21 -ED 2019-01-28

Success: one-click collection of log requests succeeded

 

2.58  获取虚拟媒体信息

本命令用于获取虚拟媒体信息。

【命令】

hrest -H host -p port -U username -P password getvmm –T mediatype

【参数】

表2-66 参数说明

参数

描述

取值

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-67 输出说明

参数

描述

MediaIndex

已挂载虚拟媒体ID

ID

未挂载虚拟媒体ID

ImageName

虚拟媒体名称

MediaTypes

虚拟媒体类型

 

2.59  升级固件

本命令用于升级固件,包括BIOSBMCCPLD

【命令】

hrest -H host -p port -U username -P password fwupdate –E  Mode -T Type -U Firmware

【参数】

表2-68 参数说明

参数

描述

取值

Mode

升级模式,为必配参数

升级模式,包括:

·          Manual:升级后手动重启

·          Auto:升级后自动重启

Type

固件升级类型,为必配参数

升级类型,包括:

·          BMC

·          BIOS

·          CPLD

Firmware

固件文件路径与文件名,为必配参数

-

 

【举例】

# 升级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

 

2.60  获取PCIe设备列表

本命令用于获取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-69 输出说明

参数

描述

Location                               

PCIe卡位置

ProductName                            

产品名称

VendorID                               

厂商ID

VendorName                             

厂商名称

SerialNumber                           

序列号

ProductID                              

设备ID

NegotiatedSpeed                        

协商速率

NegotiatedProtocol

协商协议

NegotiatedLinkWidth

协商带宽

MaxSpeed

最大速率

MaxProtocol

最高协议

PartNumber

部件号

Status

使能状态

Health

健康状态

 

2.61  获取KVM截图

本命令用于获取KVM截图,HDM-1.30.08之后合入。

【命令】

hrest -H host -p port -U username -P password getscreencapture -F path

【参数】

表2-70 参数说明

参数

描述

取值

path

截图存放路径,必备参数。

-

 

【举例】

-> hrest -H 192.168.10.11 -U admin -P Password@_ getscreencapture -F ../update

Success: get screen capture successfully

截图文件示例:

 

2.62  设置LDAP

本命令用于LDAP的高级设置。

【命令】

hrest -H host -p port -U username -P password setldap -BD bind_dn -CNT common_name_type -E enable -ET encryption_type -PW ldap_password –P port -SB search_base -SA server_address -ULA user_login_attribute

【参数】

表2-71 参数说明

参数

描述

取值

bind_dn

LDAP管理员用户DN,为可选参数

最大长度255

common_name_type

LDAP服务器地址类型,为可选参数

·          ip代表IP

·          fqdn:代表FQDN

enable

LDAP认证是否开启,为必配参数

LDAP认证是否开启,包括:

·          0:停用

·          1:启用

encryption_type

加密类型,为可选参数

加密类型包括

·          0无加密

·          1SSL认证类型

ldap_password

LDAP密码,为可选参数

-

port

LDAP端口号,为可选参数

-

search_base

LDAP搜索库DN,为可选参数

-

server_address

LDAP Server字符串,为可选参数

LDAP服务器地址类型为ip时,支持IPV4IPV6

LDAP服务器地址类型为fqdn时,支持域名地址

user_login_attribute

用户登录属性,为可选参数

用户登录属性,包括:

·          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

 

2.63  新增或修改LDAP用户

本命令用于新增或修改LDAP用户。

【命令】

hrest -H host -p port -U username -P password addldapuser -RI role_id -RGN role_group_name -RGD role_group_domain -RGP role_group_privilege -RGOP role_group_withoem_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-72 参数说明

参数

描述

取值

role_id

角色组ID,为必配参数

12345

role_group_name

角色组名称,为必配参数

-

role_group_domain

角色组搜索库,为必配参数

-

role_group_privilege

角色组权限,为必配参数

·          1代表空权限(未使用)

·          2代表user

·          3代表operator

·          4代表administrator

role_group_withoem_privilege

oem权限,为必配参数

该参数为预留参数,请输入“15”。

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代表无权限

 

【举例】

-> hrest -H 192.168.10.11 -U admin -P Password@_ addldapuser -RI 1 -RGN test -RGD dc=example,dc=com -RGP 3 -RGOP 15 -RGKP 1 -RGVP 1 -RGNP 1 -RGUP 1 -RGBP 1 -RGPP 1 -RGFP 1 -RGHP 1 -RGRP 1

Success: add ldap user successfully

 

2.64  删除LDAP用户

本命令用于删除LDAP用户。

【命令】

hrest -H host -p port -U username -P password delldapuser -RI role_id

【使用指南】

LDAP用户不存在时,删除依然提示成功,restful接口问题

【参数】

表2-73 参数说明

字段

描述

取值

role_id

角色组编号

12345

 

【举例】

-> hrest -H 192.168.10.11 -U admin -P Password@_ delldapuser -RI 1

Success: delete ldap user successfully

 

2.65  设置ADActive Directory

本命令用于Active Directory的高级设置。

【命令】

hrest -H host -p port -U username -P password setad -E ad_enable -UDN ad_user_domain_name -SU ad_secret_username -SP ad_secret_password -DC1 ad_domain_controller1 -DC2 ad_domain_controller2 -DC3 ad_domain_controller3

【参数】

表2-74 参数说明

字段

描述

取值

ad_enable

AD使能,为必配参数

AD使能,包括:

·          0:禁用

·          1:使能

ad_user_domain_name

AD用户域名,为可选参数

-

ad_secret_username

AD机密用户名,为可选参数

-

ad_secret_password

AD机密用户名密码,为可选参数

-

ad_domain_controller1

AD域控制器服务器地址1,为可选参数

-

ad_domain_controller2

AD域控制器服务器地址2,为可选参数

-

ad_domain_controller3

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

uccess: set ad successfully

2.66  新增或修改ADActive Directory)用户

本命令用于新增或修改ADActive 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 -RGOP role_group_withoem_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-75 参数说明

字段

描述

取值

role_id

角色组编号,为必配参数

12345

role_group_name

角色组名称,为必配参数

-

role_group_domain

角色组搜索库,为必配参数

-

role_group_privilege

角色组权限,为必配参数

·          1代表空权限(未使用)

·          2代表user

·          3代表operator

·          4代表administrator

role_group_withoem_privilege

oem权限,为必配参数

·          1代表有权限

·          0代表无权限

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代表无权限

 

【举例】

-> hrest -H 192.168.10.11 -U admin -P Password@_ addaduser -RI 1 -RGN test -RGD dc=example,dc=com -RGP 3 -RGOP 15 -RGKP 1 -RGVP 1 -RGNP 1 -RGUP 1 -RGBP 1 -RGPP 1 -RGFP 1 -RGHP 1 -RGRP 1

Success: add ad user successfully

 

2.67  删除ADActive Directory)用户

本命令用于删除ldap用户。

【命令】

hrest -H host -p port -U username -P password deladuser -RI role_id

【参数】

表2-76 参数说明

字段

描述

取值

role_id

角色组编号

12345

 

【举例】

-> hrest -H 192.168.10.11 -U admin -P Password@_ deladuser -RI 1

Success: delete ad user successfully

 

2.68  获取GPU信息

本命令用于获取服务器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-77 输出说明

参数

描述

ID

GPU编号

Name

GPU名称

SlotNum

GPU槽位号

Manufacturer

厂商名称

Model

产品型号

SerialNumber

GPU序列号

PartNumber

GPU部件号

FirmwareVersion

固件版本

PowerConsumedWatts

功率;当功率为0时需要在OS下安装驱动

TemperatureCelsius

温度,单位摄氏度

Health

健康状态

State

在位状态

 

2.69  获取VNC会话信息

本命令用于获取服务器VNC会话信息。

【命令】

hrest -H host -p port -U username -P password getvnssession

 

【举例】

# 获取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-78 输出说明

参数

描述

Id

ID

SessionID

会话ID

SessionType

会话类型

ClientIP

IP地址

UserID

用户编号

UserName

用户名

UserPrivilege

用户权限

 

2.70  获取防火墙状态信息

本命令用于获取BIOS防火墙状态信息。

【命令】

hrest -H host -p port -U username -P password getfirewall

【举例】

# 获取防火墙状态信息。

-> hrest –H 192.168.10.6 –U ****** -P ****** getfirewall

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

Status                                  : Stop

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

【输出说明】

表2-79 输出说明

参数

描述

Status

防火墙状态,包括:

·          Stop:禁用

·          WhiteList:白名单模式

·          BlackList:黑名单模式

 

2.71  设置防火墙状态

本命令用于设置防火墙状态。

【命令】

hrest -H host -p port -U username -P password setfirewall –S status

【参数】

表2-80 参数说明

参数

描述

取值

status

防火墙状态,为必配参数。

防火墙状态,包括:

·          Stop:禁用

·          WhiteList:白名单模式

·          BlackList:黑名单模式

 

【使用指南】

【举例】

# 设置防火墙状态为白名单模式。

-> hrest –H 192.168.10.6 –U ****** -P ****** setfirewall -S WhiteList

Success: set the firewall status successfully

 


1. 任何从本网站下载的软件都是H3C公司受著作权保护的产品。

2. 使用软件必须受最终用户许可协议的条款的约束,该许可协议随软件附上或包含在软件中。

3. 除非最终用户首先同意许可协议的条款,否则不能安装任何附有或内含许可协议的软件。

4. 软件仅供最终用户根据许可协议的规定下载使用。

5. 最终用户在用下载软件进行升级及使用的过程中,应严格遵守操作指导书,对于未按指导书而引起的问题,责任由使用者自负。

6. 对于任何与许可协议条款不符的软件复制或再分发均被法律明确禁止,并可导致严重的民事及刑事处罚。

7. 所下载的软件版本仅限美国以外的地区使用。

新华三官网
联系我们