Revision records

"Name": "Chassis Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the chassis collection resource model.
@odata.id	String	Link to the chassis collection resource.
@odata.type	String	Type of the chassis collection resource.
Members	List of chassis resources.
@odata.id	String	Link to a chassis resource.
[email protected]	Integer	Number of chassis resources.
Name	String	Name of the chassis collection resource.

The server returns status code 200 for a successful operation.

Obtain server information by its chassis resource ID

Description

Obtain information about the server by its chassis resource ID.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Chassis/1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Chassis.Chassis(SerialNumber,Id,IndicatorLED,PowerState,ChassisType,PartNumber,Description,Thermal,Oem,PCIeDevices,Status,Links,Name,Drives,Power,SKU,NetworkAdapters,LogServices,Manufacturer,AssetTag,Model,[email protected])",

"@odata.id": "/redfish/v1/Chassis/1",

"@odata.type": "#Chassis.v1_7_0.Chassis",

"AssetTag": "ABC",

"ChassisType": "Rack Mount Chassis",

"Description": "Computer System Chassis",

"Oem": {

"Public": {

"DeviceMaxNum": {

"CPUNum": 2,

"FanNum": 6,

"MemoryNum": 24,

"PowerSupplyNum": 2,

"PCIeNum": 10,

"DiskNum": 20,

"StorageCardNum":4

}

"Mainboard": {

"BoardName": "RS33M2C9S",

"SerialNumber": "210231A1110000000001",

}

"Boards": {

"@odata.id": "/redfish/v1/Chassis/1/Boards"

}

"PCIeDevices": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/10"

}

"Drives": {

"@odata.id": "/redfish/v1/Chassis/1/Drives"

"Id": "1",

"IndicatorLED": "Off",

"Lit",

"Blinking",

"Off"

"Links": {

"ComputerSystems": [

{

"@odata.id": "/redfish/v1/Systems/1"

}

"ManagedBy": [

{

"@odata.id": "/redfish/v1/Managers/1"

}

]

"LogServices": {

"@odata.id": "/redfish/v1/Chassis/1/LogServices"

"Manufacturer": "H3C",

"Model": "RS33M2C9S",

"Name": "Computer System Chassis",

"NetworkAdapters": {

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters"

"PartNumber": "",

"Power": {

"@odata.id": "/redfish/v1/Chassis/1/Power"

"PowerState": "On",

"SKU": "",

"SerialNumber": "",

"Status": {

"Health": "Warning",

"State": "Enabled"

"Thermal": {

"@odata.id": "/redfish/v1/Chassis/1/Thermal"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the chassis resource model.
@odata.id	String	Link to the chassis resource.
@odata.type	String	Type of the chassis resource.
Drives	Object	Link to the physical drive collection resource.
Id	String	ID of the chassis resource, a unique identifier of the chassis in the chassis collection.
Name	String	Name of the chassis resource.
ChassisType	String	Chassis type.
Description	String	Description of the interface.
AssetTag	String	Asset tag.
IndicatorLED	String	UID LED status. Supported options: · Lit—The LED is steady on. · Blinking—The LED is flashing. · Off—The LED is off.
[email protected]	Array	Available UID LED status. Supported options: · Lit—The LED is steady on. · Blinking—The LED is flashing. · Off—The LED is off.
Links	Links to service resources.
ComputerSystems	Object	Computer system resource.
ManagedBy	Object	System manager resource.
LogServices	Object	Link to the chassis log collection resource.
Power	Object	Power information resource.
PowerState	String	Current power state of the chassis. Supported options: · On. · Off.
Thermal	Object	Chassis thermal properties.
Manufacturer	String	Manufacturer.
Model	String	Model.
PartNumber	String	Part number.
SKU	String	SKU code.
SerialNumber	String	Serial number.
Status	Object	Resource states: · Health—Whether the resource is healthy. · State—Whether the resource has been enabled.
@odata.id	String	Link to a resource.
PCIeDevices	Array	Links to PCIe devices.
Oem.Public.DeviceMaxNum.CPUNum	Integer	Maximum number of processors in the chassis.
Oem.Public.DeviceMaxNum.FanNum	Integer	Maximum number of fans in the chassis.
Oem.Public.DeviceMaxNum.MemoryNum	Integer	Maximum number of DIMMs in the chassis.
Oem.Public.DeviceMaxNum.PowerSupplyNum	Integer	Maximum number of power supplies in the chassis.
Oem.Public.DeviceMaxNum.PCIeNum	Integer	Maximum number of PCIe modules in the chassis.
Oem.Public.DeviceMaxNum.DiskNum	Integer	Maximum number of drives in the chassis.
Oem.Public.DeviceMaxNum.StorageCardNum	Integer	Maximum number of storage controllers in the chassis.
Oem.Public.Mainboard.BoardName	String	· For all servers except for the R6900 and R8900: Product name of the system board. · For the R6900 and R8900: Product name of the midplane.
Oem.Public.Mainboard.SerialNumber	String	· For all servers except for the R6900 and R8900: Serial number of the system board. · For the R6900 and R8900: Serial number of the midplane.
Oem.Public.Boards	Object	Links to boards.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.93	Added the Oem.Public.DeviceMaxNum.StorageCardNum field.
HDM-2.10.00	Added the Oem.Public.Boards field.
HDM-2.08.00	Added the PCIeDevices field.
HDM-1.30.18P52	Added the Oem.Public.DeviceMaxNum.PCIeNum and Oem.Public.DeviceMaxNum.DiskNum fields.
HDM-1.30.14	Changed the Mainboard.BoardName and Mainboard.SerialNumber fields to Oem.Public.Mainboard.BoardName and Oem.Public.Mainboard.SerialNumber, respectively.
HDM-1.30.12	Changed the DeviceMaxNum field to Oem.Public.DeviceMaxNum.
HDM-1.30.10	Added the Mainboard.BoardName, and Mainboard.SerialNumber field.
HDM-1.30.09	Added the DeviceMaxNum fields, including the CPUNum, FanNum, MemoryNum, and PowerSupplyNum fields.
HDM-1.30.07	Added the Drives field.

Set the UID LED

Description

Set the UID LED on the server.

Privilege module

Remote control

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Chassis/chassis_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"IndicatorLED":ledstate

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
IndicatorLED	Action on the UID LED.	String. Supported options: · Lit—Turn on the LED. · Off—Turn off the LED. · Blinking—Set the LED status to flashing.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Chassis/1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"@odata.id": "/redfish/v1/Chassis/1",

"@odata.type": "#Chassis.v1_7_0.Chassis",

"AssetTag": "ZB17-01-Unis Huashan 20110228",

"ChassisType": "Rack Mount Chassis",

"Description": "Computer System Chassis",

"Oem": {

"Public": {

"DeviceMaxNum": {

"CPUNum": 2,

"FanNum": 6,

"MemoryNum": 24,

"PowerSupplyNum": 2

}

"Mainboard": {

"BoardName": "RS33M2C9S",

"SerialNumber": "210231A1110000000001",

}

"Boards": {

"@odata.id": "/redfish/v1/Chassis/1/Boards"

}

"PCIeDevices": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/10"

}

"Drives": {

"@odata.id": "/redfish/v1/Chassis/1/Drives"

"Id": "1",

"IndicatorLED": "Blinking",

"Lit",

"Blinking",

"Off"

"Links": {

"ComputerSystems": [

{

"@odata.id": "/redfish/v1/Systems/1"

}

"ManagedBy": [

{

"@odata.id": "/redfish/v1/Managers/1"

}

]

"LogServices": {

"@odata.id": "/redfish/v1/Chassis/1/LogServices"

"Manufacturer": "H3C",

"Model": "RS33M2C9S",

"Name": "Computer System Chassis",

"NetworkAdapters": {

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters"

"PartNumber": "",

"Power": {

"@odata.id": "/redfish/v1/Chassis/1/Power"

"PowerState": "On",

"SKU": "",

"SerialNumber": "",

"Status": {

"Health": "Warning",

"State": "Enabled"

"Thermal": {

"@odata.id": "/redfish/v1/Chassis/1/Thermal"

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

For information about the response fields, see "Obtain server information by its chassis resource ID."

Change history

Version	Change description
HDM-1.30.09	· Added the response. · Changed the status code for a successful operation to 200. · Added Blinking as an option of the IndicatorLED field.

Version

Change description

HDM-1.30.09

· Added the response.

· Changed the status code for a successful operation to 200.

· Added Blinking as an option of the IndicatorLED field.

Obtain physical drive collection information

Description

Obtain information about all physical drives from the server. Physical drives include NVMe drives and HDDs.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/Drives

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://172.16.20.162/redfish/v1/Chassis/1/Drives

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#DriveCollection.DriveCollection(*)",

"@odata.id": "/redfish/v1/Chassis/1/Drives",

"@odata.type": "#Drive.v1_4_0.Drive",

"Members": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront2"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskSlot3"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1"

}

"[email protected]": 3,

"Name": "Drives Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the physical drive collection resource model.
@odata.id	String	Link to the physical drive collection resource.
@odata.type	String	Type of the physical drive collection resource.
Members	Array	Links to physical drive resources. The DiskSlotx string represents an NVMe drive, in which the x argument represents the PCIe slot number.
[email protected]	Integer	Number of physical drives.
Name	String	Name of the physical drive collection resource.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.07	Added the /redfish/v1/Chassis/chassis_id/Drives interface.

Obtain physical drive information

Description

Obtain information about a specific physical drive from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/Drives/drive_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.
drive_id	ID of the physical drive resource.	You can obtain available physical drive resource IDs from physical drive collection information.

Examples

# Obtain information about a member drive of a logical drive.

Method and URL:

GET http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront0

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront0",

"@odata.type": "#Drive.v1_4_0.Drive",

"CapacityBytes": 6003333529600,

"FailurePredicted": false,

"HotspareType": "None",

"Id": "DiskFront0",

"IndicatorLED": "Off",

"Location": [{

"Info": "DiskFront0",

"InfoFormat": "DeviceName"

}],

"Manufacturer": "HGST",

"MediaType": "HDD",

"Model": "HUS726060AL5210",

"Name": "DiskFront0",

"NegotiatedSpeedGbs": 12,

"CapableSpeedGbs": 12,

"Oem": {

"Public": {

"CapableSpeedGTs":null,

"ConnectionID": 83,

"DriveNumberInBios": 0,

"DriveNumberInOS": 0,

"FirmwareStatus": "Online",

"HoursOfPoweredUp":6504.18,

"NegotiatedSpeedGTs": null,

"OwnerVolume": {

"Name": "",

"RaidControllerID": 0,

"PatrolState": "DoneOrNotPatrolled",

"RebuildState": "DoneOrNotRebuilt",

"RebuildProgress": null,

"SpareforLogicalDrives": [],

"SASAddress": [

"5000039418218546",

"Status": {

"Health": "OK",

"State": "Enabled"

"VolumeRaidLevel": "RAID0",

"element_num": 3

"Panel": "Front 0",

"TemperatureCelsius": 36

}

"PredictedMediaLifeLeftPercent": "null",

"Protocol": "SAS",

"Revision": "A907",

"SerialNumber": "K1H33AHD",

"Status": {

"Health": "OK",

"State": "Enabled"

}

"StatusIndicator":"OK",

}

Response code: 200

# Obtain information about a physical drive that has not been used for creating a logical drive.

Method and URL:

GET http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront2

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront6",

"@odata.type": "#Drive.v1_4_0.Drive",

"CapacityBytes": 6003333529600,

"FailurePredicted": false,

"Id": "DiskFront6",

"Location": [{

"Info": "DiskFront6",

"InfoFormat": "DeviceName"

}],

"Manufacturer": "HGST",

"MediaType": "HDD",

"Model": "HUS726060AL5210",

"Name": "DiskFront6",

"NegotiatedSpeedGbs": 12,

"CapableSpeedGbs": 12,

"Oem": {

"Public": {

"CapableSpeedGTs":null,

"ConnectionID": 87,

"DriveNumberInBios": 6,

"DriveNumberInOS": 6,

"FirmwareStatus": "Unconfigured_Good",

"NegotiatedSpeedGTs": null, "Panel": "Front 6",

"TemperatureCelsius": 35

}

"PredictedMediaLifeLeftPercent": "null",

"Protocol": "SAS",

"Revision": "A907",

"SerialNumber": "K1H2PJPF",

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response code: 200

# Obtain information about an NVMe drive.

Method and URL:

GET https://172.16.20.162/redfish/v1/Chassis/1/Drives/DiskN1Slot204

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskSlot204",

"@odata.type": "#Drive.v1_4_0.Drive",

"CapableSpeedGbs": null, //NVMe drives do not support this field. For more information, see CapableSpeedGTs

"CapacityBytes": 2199023255552,

"Id": "DiskSlot204",

"Location": [

{

"Info": "Box2-4",

"InfoFormat": "DeviceName"

}

"Manufacturer": "INTEL",

"MediaType": "SSD",

"Model": "SSDPE2KX020T7",

"Name": "P4500",

"NegotiatedSpeedGbs": null, //NVMe drives do not support this field. For more information, see CapableSpeedGTs

"Oem": {

"Public": {

"CapableSpeedGTs":8,

"DriveNumberInBios": "Slot 204",

"DriveNumberInOS": "Slot 204",

"FirmwareStatus": "Normal",

"NegotiatedSpeedGTs": 8,

"Panel": "Box2-4"

}

"PredictedMediaLifeLeftPercent": "96",

"Protocol": "PCIe",

"Revision": "QDV101D1",

"SerialNumber": "PHLF725200RL2P0HGN",

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the physical drive resource model.
@odata.id	String	Link to the physical drive resource.
@odata.type	String	Type of the physical drive resource.
CapacityBytes	Integer	Capacity of the physical drive.
Id	String	ID of the physical drive resource. For an NVMe drive, this field displays the PCIe slot number of the drive.
Location.Info	String	Mark of the physical drive.
Location.InfoFormat	String	Format of the physical drive mark. Supported options include DeviceName.
Manufacturer	String	Manufacturer.
MediaType	String	Drive media type. Supported options: · HDD. · SSD.
Model	String	Drive model.
Name	String	Name of the physical drive.
NegotiatedSpeedGbs	Integer	Negotiated speed of the drive interface, in Gbps. This field is not available for NVMe drives.
CapableSpeedGbs	Integer	Maximum speed of the drive interface, in Gbps. This field is not available for NVMe drives.
FailurePredicted	Boolean	Whether a predictive alarm is detected on the specified physical drive (not an NVMe drive). Options include: · true · false
Protocol	String	Protocol used by the drive: · SAS. · SATA. · PCIe.
Oem.Public.NegotiatedSpeedGTs	Integer	Negotiated speed of the drive interface, in GTs. This field is available only for NVMe drives.
Oem.Public.CapableSpeedGTs	Integer	Maximum speed of the drive interface, in GTs. This field is available only for NVMe drives.
Oem.Public.DriveNumberInBios	Integer	Drive number in the BIOS. For an NVMe drive, this field displays the PCIe slot number.
Oem.Public.DriveNumberInOS	Integer	Drive number in OS. For an NVMe drive, this field displays the PCIe slot number.
Oem.Public.FirmwareStatus	String	Drive state. The supported states vary by storage controller type and drive type. · States supported for the LSI-9300 controller: Ready. · States supported for an LSI controller other than the LSI-9300: ¡ Ready. ¡ Unconfigured_Good. ¡ Unconfigured_Bad. ¡ Hot_Spare. ¡ Offline. ¡ FAILED. ¡ Rebuilding. ¡ Optimal. ¡ Online. ¡ JBOD. ¡ Unknown. ¡ Predict_Fail. ¡ Copyback. · States supported for an PMC controller: ¡ Offline. ¡ PFA. ¡ Raw. ¡ Hotspare. ¡ Ready. ¡ Optimal. ¡ Unknown. ¡ Rebuilding. ¡ RebuildWait. · States supported for an NVMe drive: ¡ Spare_below. ¡ Temp_Anomaly. ¡ Subsys_Degraded. ¡ Read_only. ¡ Cache_Failed. ¡ Normal. ¡ Predict_Fail.
Oem.Public.Panel	String	Slot number.
Oem.Public.ConnectionID	Integer	Physical drive connection ID. This field is unavailable for NVMe drives.
Oem.Public.TemperatureCelsius	String	Drive temperature in Celsius. This field is unavailable for NVMe drives.
PredictedMediaLifeLeftPercent	Integer or string	Remaining lifetime of the drive, in percent. This field displays null if the drive does not support this feature.
Revision	String	Drive version.
SerialNumber	String	Drive serial number.
Status.Health	String	Health status.
Status.State	String	Drive enabling state.
Oem.Public.OwnerVolume.Name	String	Name of the logical drive to which the physical drive belongs.
Oem.Public.OwnerVolume.RaidControllerID	String	ID of the storage controller for the logical drive.
Oem.Public.OwnerVolume.Status.Health	String	Health status of the logical drive to which the physical drive belongs.
Oem.Public.OwnerVolume.Status.State	String	Enabling status of the logical drive to which the physical drive belongs.
Oem.Public.OwnerVolume.VolumeRaidLevel	String	RAID level of the logical drive to which the physical drive belongs.
Oem.Public.OwnerVolume.element_num	String	Number of member drives in the logical drive to which the physical drive belongs.
HotspareType	String	Hot spare status of the specified driver. Options include None, Global, and Dedicated.
IndicatorLED	String	In-band LED status of the specified driver. Options include On and Off. This field is available for LSI RAID controllers.
StatusIndicator	String	Status of the specified driver. Options include: · OK. · FAIL. · Rebuild. · PredictiveFailureAnalysis. · Hotspare. · InAFailedArray. · InACriticalArray.
Oem.Public.HoursOfPoweredUp	Integer	Uptime of the specified driver.
Oem.Public.SASAddress	Array	SAS address of the specified driver.
Oem.Public.PatrolState	String	Patrolling status of the specified driver. Options include DoneOrNotPatrolled and Patrolling.
Oem.Public.RebuildState	String	Data rebuilding status of the specified driver. Options include DoneOrNotRebuilt and Rebuilding.
Oem.Public.RebuildProgress	String	Data rebuilding progress of the specified driver.
Oem.Public.SpareforLogicalDrives	String	Logical drive list of the specified hot spare drive. This field cannot be obtained and is hard coded as null.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-6.04	Revised the description of application scenarios for the IndicatorLED field to support only query of in-band LED information.
HDM-3.39	Added the Oem.Public.NegotiatedSpeedGTs and Oem.Public.CapableSpeedGTs fields to query the speed information of NVMe drives. The NegotiatedSpeedGbs and CapableSpeedGbs fields support only non-NVMe drives.
HDM-3.36	Added support of Predict_Fail for NVMe drives in Oem.Public.FirmwareStatus.
HDM-3.35	Added the FailurePredicted field.
HDM-2.93	Added the following fields: · HotspareType. · IndicatorLED. · StatusIndicator. · Oem.Public.HoursOfPoweredUp. · Oem.Public.SASAddress. · Oem.Public.PatrolState. · Oem.Public.RebuildState. · Oem.Public.RebuildProgress. · Oem.Public.SpareforLogicalDrives.
HDM-2.11.92 HDM-2.25	Changed the value format for the VolumeRaidLevel field from RAID x to RAIDx, where x represents a RAID level. This change removes the space between RAID and the RAID level number.
HDM-1.30.18P5X HDM-2.0.03	· Changed the data type for the PredictedMediaLifeLeftPercent and Location fields to integer or array, respectively. · Added the Location field for NVMe drives. NOTE: The changes take effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.11	· Added the CapableSpeedGbs field. This field was also added to version HDM-1.30.11P72. · Added DeviceName as an option of the InfoFormat field.
HDM-1.30.10	Added the Location.Info and Location.InfoFormat fields.
HDM-1.30.09	Changed the health status options of logical drives to be the same with the options in HDM.
HDM-1.30.07	Added support for obtaining information about NVMe drives.
HDM-1.30.06	· Added the Oem.Public.FirmwareStatus field. · Replaced MediaType field with the following fields: MediaType, Protocol, and NegotiatedSpeedGbs.
HDM-1.11.28	Changed the interface from /redfish/v1/Systems/system_id/Storage/RAIDStorage0/Volumes/hdd_id (available in HDM-1.11.27 and earlier versions) to /redfish/v1/Chassis/chassis_id/Drives/drive_id.

Set the physical drive state

Description

Set the state of a physical drive.

Privilege module

Remote control

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Drives/drive_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

// Set the drive state.

{

"Oem":{

"Public":{

"FirmwareStatus":diskstate

}

// Set a global hot spare drive or cancel a global hot spare drive.

{

"HotspareType": hotsparetype

}

// Set a dedicated hot spare drive or cancel a dedicated hot spare drive.

{

"HotspareType": " hotsparetype ",

"Oem":{

"Public":{

"SpareforLogicalDrives":[

{

"@odata.id": volumepath

}

]

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
drive_id	ID of the physical drive resource.	You can obtain available physical drive resource IDs from physical drive collection information.
Oem.Public.FirmwareStatus	Drive state.	String. Supported options: · Unconfigured_Good. · Unconfigured_Bad. · JBOD. NOTE: The switchover between the Unconfigured_Bad state and the JBOD state is not allowed.
HotspareType	Driver hot spare state.	· None—Hot spare not configured. · Global—Global hot spare. · Dedicated—Dedicated hot spare. LSI cards support global and dedicated hot spares. PMC cards support only global hot spares.
Oem.Public.SpareforLogicalDrives	List of logical drives for the dedicated hot spare.	Array
Oem.Public.SpareforLogicalDrives @odata.id	Associated logical volume access path when dedicated hot spare is set.	You can obtain the available logical drive list by querying the specified physical drives when creating a hot spare drive. For example, /redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0 Hot spare settings are only supported for the target logical drives.

Examples

# Set the physical drive state.

Method and URL:

PATCH http://192.168.30.120/redfish/v1/Chassis/1/Drives/DiskFront0

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

{

"Oem":{

"Public":{

"FirmwareStatus":"Unconfigured_Bad"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront0",

"CapableSpeedGbs": 12,

"CapacityBytes": 300067880960,

"Id": "DiskFront0",

"Location": [

{

"Info": "DiskFront0",

"InfoFormat": "DeviceName"

}

"Manufacturer": "HGST",

"MediaType": "HDD",

"Model": "HUC156030CSS200",

"Name": "DiskFront0",

"NegotiatedSpeedGbs": 12,

"Oem": {

"Public": {

"ConnectionID": 25,

"DriveNumberInBios": 0,

"DriveNumberInOS": 0,

"FirmwareStatus": "Unconfigured_Bad",

"Panel": "Front 0",

"TemperatureCelsius": 38

}

"PredictedMediaLifeLeftPercent": "null",

"Protocol": "SAS",

"Revision": "AA01",

"SerialNumber": "0THK3XXP",

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response code: 200

# Set a dedicated hot spare drive.

Method and URL:

PATCH http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront3

Request header:

X-Auth-Token:TOKEN

Content-Type:application/json

Request body:

{

"HotspareType": "Dedicated",

"Oem":{

"Public":{

"SpareforLogicalDrives":[

{"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Valumes/ LogicalDrive0" },

{"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Valumes/ LogicalDrive1" }

]

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront6",

"@odata.type": "#Drive.v1_4_0.Drive",

"CapableSpeedGbs": 6,

"CapacityBytes": 960193626112,

"HotspareType": "None",

"Id": "DiskFront6",

"IndicatorLED": "OFF",

"Location": [

{

"Info": "DiskFront6",

"InfoFormat": "DeviceName"

}

"Manufacturer": "Samsung",

"MediaType": "SSD",

"Model": "SAMSUNG MZ7LM960",

"Name": "DiskFront6",

"NegotiatedSpeedGbs": 6,

"Oem": {

"Public": {

"ConnectionID": 9,

"DiskSize": null,

"DiskSpeed": null,

"DriveNumberInBios": 6,

"DriveNumberInOS": 6,

"FirmwareStatus": "Hot_Spare",

"HoursOfPoweredUp": null,

"Panel": "Front 6",

"PatrolState": "DoneOrNotPatrolled",

"RebuildProgress": null,

"RebuildState": "DoneOrNotRebuilt",

"SASAddress": [

"300062B204D3260C",

"SpareforLogicalDrives": [

"TemperatureCelsius": 40

}

"PredictedMediaLifeLeftPercent": null,

"Protocol": "SATA",

"Revision": "GXT5204Q",

"SerialNumber": "S2TZNX0J307156",

"Status": {

"Health": "OK",

"State": "Enabled"

"StatusIndicator": " OK "

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

For information about the response fields, see "Obtain physical drive information."

Change history

Version	Change description
HDM-6.02	Added support for configuring hot spare drives and added the HotspareType, Oem.Public.SpareforLogicalDrives, and Oem.Public.SpareforLogicalDrives @odata.id fields.
HDM-2.38	Edited the privilege module to remote control.
HDM-2.13.00	Added the redfish/v1/Chassis/chassis_id/Drives/drive_id interface.

Obtain thermal properties

Description

Obtain information about thermal properties from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/Thermal

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Chassis/1/Thermal

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Thermal.Thermal(Oem,Fans,Id,FanSummary,Name,Temperatures)",

"@odata.id": "/redfish/v1/Chassis/1/Thermal",

"@odata.type": "#Thermal.v1_4_0.Thermal",

"FanSummary": {

"Redundancy": [

{

"Name": "FAN_Redundancy",

"Status": {

"Health": "OK",

"State":"Enabled"

}

]

"Count": 6

"Fans": [

{

"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/0",

"Name": "Fan1",

"MaxReadingRange": 16500,

"MemberId": "0",

"MinReadingRange": 0,

"Oem": {

"Public": {

"SpeedRatio": 52,

"Position": "Chassis",

"SlotNumber": 1,

}

"PartNumber": "N/A",

"Reading": 8600,

"ReadingUnits": "RPM",

"Status": {

"Health": "OK",

"State": "Enabled"

}

…………

"Id": "Thermal",

"Name": "Thermal",

"Oem": {

"Public": {

"FanSpeedAdjustmentMode": "Custom",

"FanSpeedLevelPercents": 1

}

"Temperatures": [

{

"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/0",

"LowerThresholdCritical": null,

"LowerThresholdFatal": null,

"LowerThresholdNonCritical": null,

"MemberId": "0",

"Name": "01-Inlet Temp",

"PhysicalContext": "Room",

"ReadingCelsius": 31,

"SensorNumber": 1,

"Status": {

"Health": "OK",

"State": "Enabled"

"UpperThresholdCritical": 52,

"UpperThresholdFatal": 54,

"UpperThresholdNonCritical": 50

{

"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/1",

"LowerThresholdCritical": null,

"LowerThresholdFatal": null,

"LowerThresholdNonCritical": null,

"MemberId": "1",

"Name": "02-CPU 1",

"PhysicalContext": "Room",

"ReadingCelsius": 39,

"SensorNumber": 2,

"Status": {

"Health": "OK",

"State": "Enabled"

"UpperThresholdCritical": null,

"UpperThresholdFatal": null,

"UpperThresholdNonCritical": 88

…………

]

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the thermal resource model.
@odata.id	String	Link to the thermal resource.
@odata.type	String	Type of the thermal resource.
Id	String	ID of the thermal resource.
Name	String	Name of the thermal resource.
Oem.Public.FanSpeedAdjustmentMode	String	Fan speed mode. Supported options: · Silent. · Balanced. · Powerful. · Custom.
Oem.Public.FanSpeedLevelPercents	Integer	Fan speed level. Value range: 1 to 20. A greater value indicates a higher speed. This field is available only when the FanSpeedAdjustmentMode field is set to Custom.
Oem.Public.FirmwareVersion	String	Current version of the fan module. This field is available only for R5500G5 AMD or INTEL servers.
FanSummary.Count	Integer	Maximum number of fan sensors.
FanSummary.Redundancy.Name	String	Name of the redundant fan sensor.
FanSummary.Redundancy.Status	Object	State of the redundant fan sensor. Supported options: · State—Whether the redundant fan sensor has been enabled. A value of Disabled indicates that a redundant fan sensor is not available. · Health—Whether the redundant fan sensor is healthy.
Fans	Fan information. This field is empty for blade servers.
@odata.id	String	Link to a thermal resource.
Fans.Name	String	Fan name.
MaxReadingRange	Integer	Maximum fan rotation speed.
MinReadingRange	Integer	Minimum fan rotation speed.
MemberId	String	Fan ID.
Reading	Integer	Current fan rotation speed.
Status	Object	Resource status: · Health—Health status. · State—Enabling status.
Oem.Public.SpeedRatio	Integer	Speed ratio.
Oem.Public.Position	String	Container of the fan sensor.
Oem.Public.SlotNumber	Integer	Slot number of the fan sensor.
PartNumber	Object	Part number.
ReadingUnits	Object	Unit of the value in the Reading field. Supported options: · RPM. · Percent.
Temperatures	Temperature sensor properties.
@odata.id	String	Link to a temperature sensor resource.
MemberId	String	Temperature sensor ID.
LowerThresholdCritical	Integer or string	Lower major undervoltage alarm threshold. If the threshold is not specified, N/A is displayed.
LowerThresholdFatal	Integer or string	Lower critical undervoltage alarm threshold. If the threshold is not specified, N/A is displayed.
LowerThresholdNonCritical	Integer or string	Lower minor undervoltage alarm threshold. If the threshold is not specified, N/A is displayed.
Name	String	Temperature sensor name.
PhysicalContext	String	Area or equipment where the temperature sensor can be used.
SensorNumber	Integer	Temperature sensor number.
ReadingCelsius	Integer	Current reading of the temperature sensor. If the sensor does not have any reading, this field displays N/A.
Status	Object	Resource state information: · Health—Health state. · State—Enabling state.
UpperThresholdCritical	Integer or string	Upper major overtemperature alarm threshold. If the threshold is not specified, N/A is displayed.
UpperThresholdFatal	Integer or string	Upper critical overtemperature alarm threshold. If the threshold is not specified, N/A is displayed.
UpperThresholdNonCritical	Integer or string	Upper minor overtemperature alarm threshold. If the threshold is not specified, N/A is displayed.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.33	Added the Oem.Public.FirmwareVersion field. This field is available only for R5500G5 AMD or INTEL servers.
HDM-2.16.00	Added the FanSummary.Redundancy Name and FanSummary.Redundancy Status fields.
HDM-2.13.00	Revised the list of options for the FanSpeedAdjustmentMode field.
HDM-2.11.92 HDM-2.25	Added the Oem.Public.SlotNumber field.
HDM-1.30.18P5X HDM-2.0.03	· Changed the name of the Fans.FanName field to Fans.Name. · Added support of the Fans.PartName field. · Added the Fans.Oem.Public.Position field. NOTE: The changes take effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.16	Modified the Fans field to leave the field empty for blade servers.
HDM-1.30.13	Changed the data type for the Temperatures.MemberId field from integer to string.
HDM-1.30.11	· Changed the data type for the Fans.MemberId field from integer to string. · Added the Oem.Public.FanSpeedAdjustmentMode and Oem.Public. FanSpeedLevelPercents fields.
HDM-1.30.09	· Deleted the Oem field and its contents for the root service resource. · Added the Temperatures.MemberId, FanSummary, Fans.oem, Fans.PartNumber, and Fans.ReadingUnits fields.

Set the fan speed mode

Description

Set the fan speed mode of the server.

Privilege module

Power control

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Thermal

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"Oem":{

"FanSpeedAdjustmentMode":speedmode,

"FanSpeedLevelPercents":speedlevel

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
Oem.Public.FanSpeedAdjustmentMode	Fan speed mode.	Supported options: · Silent. · Balanced. · Powerful. · Custom.
Oem.Public.FanSpeedLevelPercents	Custom fan speed level.	Value range: 1 to 20. A higher value represents a faster speed. This field is available only when the FanSpeedAdjustmentMode field is set to Custom.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Chassis/1/Thermal

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"Oem":{

"Public": {

"FanSpeedAdjustmentMode":"Custom",

"FanSpeedLevelPercents":18

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#Thermal.Thermal(Fans,Id,FanSummary,Name,Temperatures)",

"@odata.id": "/redfish/v1/Chassis/1/Thermal",

"@odata.type": "#Thermal.v1_4_0.Thermal",

"FanSummary": {

"Count": 6

"Fans": [

{

"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/0",

"Name": "Fan1",

"MaxReadingRange": 16500,

"MemberId": "0",

"MinReadingRange": 0,

"Oem": {

"Public": {

"SpeedRatio": 52,

"Position": "Chassis",

"SlotNumber": 0

}

"PartNumber": "N/A",

"Reading": 8600,

"ReadingUnits": "RPM",

"Status": {

"Health": "OK",

"State": "Enabled"

}

…………

"Id": "Thermal",

"Name": "Thermal",

"Oem": {

"Public": {

"FanSpeedAdjustmentMode": "Custom",

"FanSpeedLevelPercents": 18

}

"Temperatures": [

{

"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/0",

"LowerThresholdCritical": "N/A",

"LowerThresholdFatal": "N/A",

"LowerThresholdNonCritical":"N/A",

"MemberId": "0",

"Name": "01-Inlet Temp",

"PhysicalContext": "Room",

"ReadingCelsius": 22,

"SensorNumber": 1,

"Status": {

"Health": "OK",

"State": "Enabled"

"UpperThresholdCritical": 52,

"UpperThresholdFatal": 54,

"UpperThresholdNonCritical": 50

…………

]

}

Response code: 200

Response field description

For information about the response fields, see "Obtain thermal properties."

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.16.00	Revised the list of options for the FanSpeedAdjustmentMode field.
HDM-1.30.18P5X HDM-2.0.03	Changed the name of the Fans.FanName field to Fans.Name. NOTE: The change takes effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.12	· Changed the AdjustFanSpeedMode field to FanSpeedAdjustmentMode. · Added the response. For more information about the response, see "Obtain thermal properties."
HDM-1.30.10	· Added the FanSpeedLevelPercents field. · Changed the available values of the AdjustFanSpeedMode field from integers in the range of 1 to 20 to the following options: Optimal, Increased, Maximum, and Custom.

Obtain air inlet temperature history resource information

Description

Obtain information about the air inlet temperature history resource from the server.

This interface is not available for blade servers.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/Thermal/InletHistoryTemperature

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.

Examples

Method and URL:

GET http://172.16.13.176/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Thermal.Thermal(Description,HistoricalInletTemp,Name,Id)",

"@odata.id": "/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature",

"@odata.type": "#Thermal.v1_4_0.Thermal",

"Description": "Air Inlet Historical Temperature",

"HistoricalInletTemp": [

{

"avg": 22,

"max": 22,

"min": 22,

"time": "2019-10-16 12:18:56"

.........

{

"avg": 24,

"max": 24,

"min": 24,

"time": "2019-10-24 00:42:13"

}

"Id": "InletHistoryTemperature",

"Name": "InletHistoryTemperature"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the air inlet temperature history resource model.
@odata.id	String	Link to the air inlet temperature history resource.
@odata.type	String	Type of the air inlet temperature history resource.
Description	String	Description of the interface.
HistoricalInletTemp.avg	Integer	Average temperature.
HistoricalInletTemp.max	Integer	Maximum temperature.
HistoricalInletTemp.min	Integer	Minimum temperature.
HistoricalInletTemp.time	String	Sample time.

Change history

Version	Change description
HDM-1.30.09	Added the redfish/v1/Chassis/chassis_id/Thermal/InletHistoryTemperature interface.

Obtain power information

Description

Obtain power information from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/Power

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.

Examples

Response:

{

"@odata.context": "/redfish/v1/$metadata#Power.Power(PowerControl,Voltages,Id,Name,PowerSupplies)",

"@odata.id": "/redfish/v1/Chassis/1/Power",

"@odata.type": "#Power.v1_5_0.Power",

"AllPowerStatus": {

"Oem": {

"Public": {

"HostPowerStatus": "On",

"JBODPowerStatus": null,

"JBOGPowerStatus": null,

"OverallPowerStatus": "On",

"SmartNICPowerStatus": null

}

"Id": "Power",

"Name": "Power",

"PowerControl": [

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerControl/1",

"MaxNum": 2,

"MemberId": "1",

"Name": "System Power Control 1",

"Oem": {

"Public": {

"CurrentCPUPowerWatts": 115,

"CurrentFanPowerWatts": 28,

"CurrentMemoryPowerWatts": 2,

"CurrentDiskPowerWatts": 2

}

"PowerConsumedWatts": 146,

"PowerLimit": {

"CorrectionInMs": 30000,

"LimitException": "HardPowerOff",

"LimitInWatts": 766

"PowerMetrics": {

"MaxConsumedWatts": 10000,

"MinConsumedWatts": 150

"Status": {

"Health": "OK",

"State": "Enabled"

}

"PowerSupplies": [

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/1",

"FirmwareVersion": "1M.0009.0021.002",

"LineInputVoltage": 233,

"LineInputVoltageType": "ACMidLine",

"Manufacturer": "FSP-GROUP",

"MemberId": "1",

"Model": "PSR550-12A",

"Name": "PSU1",

"Oem": {

"Public": {

"ActiveStandby": "Active",

"InputAmperage": 0.636,

"LineInputCurrent": 0.636,

"PowerCurrentWatts": 131,

"PowerID": "1",

"PowerOutputWatts": 131,

"ReadingAmperes": null,

"SlotNumber": 1

}

"PowerCapacityWatts": 550,

"PowerSupplyType": "ACorDC",

"SerialNumber": "01234567",

"Status": {

"Health": "OK",

"State": "Enabled"

}

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/2",

"FirmwareVersion": "4M.0002.0006.005;1M.0009.0021.003",

"LineInputVoltage": 232,

"LineInputVoltageType": "ACMidLine",

"Manufacturer": "FSP-GROUP",

"MemberId": "2",

"Model": "PSR550-12A",

"Name": "PSU2",

"Oem": {

"Public": {

"ActiveStandby": "Active",

"InputAmperage": 0.636,

"LineInputCurrent": 0.636,

"PowerCurrentWatts": 141,

"PowerID": "2",

"PowerOutputWatts": 141,

"ReadingAmperes": null,

"SlotNumber": 2

}

"PowerCapacityWatts": 550,

"PowerSupplyType": "ACorDC",

"SerialNumber": "210213A05NH179003656",

"Status": {

"Health": "OK",

"State": "Enabled"

}

"Voltages": [

{

"LowerThresholdCritical": 2.96,

"LowerThresholdFatal": "N/A",

"LowerThresholdNonCritical": "N/A",

"MaxReadingRange": 255,

"MinReadingRange": 0,

"Name": "SYS_3.3V",

"ReadingVolts": 3.2,

"SensorNumber": 48,

"Status": {

"Health": "OK",

"State": "Enabled"

"UpperThresholdCritical": 3.6,

"UpperThresholdFatal": "N/A",

"UpperThresholdNonCritical": "N/A"

...

]

}

Response field description

Field	Data type	Description
@odata.context	String	OData description of the power resource model.
@odata.id	String	Link to the power resource.
@odata.type	String	Type of the power resource.
PowerControl	Power control properties.
MaxNum	Integer	Maximum number of power supplies.
PowerConsumedWatts	Integer	Current power.
PowerCapacityWatts	Integer	Output rated power.
PowerMetrics.MaxConsumedWatts	Integer	Maximum power consumption.
PowerMetrics.MinConsumedWatts	Integer	Minimum power consumption.
PowerLimit.CorrectionInMs	Integer	Maximum time (in milliseconds) allowed for the system to reduce power consumption to a value below the power cap value.
PowerLimit.LimitException	String	Action to take if the power cannot be maintained below the power cap value. Supported options: · NoAction—Take no action when the power cap value is exceeded. · HardPowerOff—Turn the power off immediately when the power cap value is exceeded.
PowerLimit.LimitInWatts	Integer	Power cap value. This field displays null if power capping is disabled.
Status.Health	String	Power control health status.
Status.State	String	Power control enabling status.
Oem.Public.CurrentCPUPowerWatts	Integer	Current CPU power.
Oem.Public.CurrentMemoryPowerWatts	Integer	Current memory power.
Oem.Public.CurrentFanPowerWatts	Integer	Current fan power.
Oem.Public.CurrentDiskPowerWatts	Integer	Current drive power.
PowerSupplies	Power supply information.
FirmwareVersion	String	Firmware version.
LineInputVoltage	Integer	Input voltage.
LineInputVoltageType	String	Input voltage type. Supported option is ACMidLine.
Manufacturer	String	Manufacturer of the power supply.
Model	String	Model of the power supply.
Name	String	Name of the power supply.
PowerCapacityWatts	Integer	Power capacity of the power supply.
Oem.Pubilc.PowerID	String	ID of the power supply.
Oem.Pubilc.ActiveStandby	String	Active/standby state.
Oem.Pubilc.PowerCurrentWatts	String	Current input power of the power supply.
Oem.Pubilc.InputAmperage	Integer	Input electrical current of the power supply.
Oem.Pubilc.ReadingAmperes	Integer	Current reading of the electrical current sensor.
Oem.Public.SlotNumber	Integer	Slot number of the power supply.
Oem.Public.LineInputCurrent	Integer	Input current of the power supply.
Oem.Public.PowerOutputWatts	Integer	Output power of the power supply.
PowerSupplyType	String	Power supply type. Supported options: · Unknown. · AC. · DC. · ACorDC.
PartNumber	String	Part number of the power supply. This field is supported only for some power supplies.
SerialNumber	String	Power supply serial number.
Status.Health	String	Health status of the power supply.
Status.State	String	Enabling status of the power supply.
MemberId	String	ID of the power supply resource, a unique identifier of the power supply in the power supply collection.
Voltages	Voltage information.
LowerThresholdCritical	Integer or string	Lower major alarm threshold. If the threshold is not specified, N/A is displayed.
LowerThresholdFatal	Integer or string	Lower critical alarm threshold. If the threshold is not specified, N/A is displayed.
LowerThresholdNonCritical	Integer or string	Lower minor alarm threshold. If the threshold is not specified, N/A is displayed.
MaxReadingRange	Integer	Maximum reading.
MinReadingRange	Integer	Minimum reading.
Name	String	Sensor name.
ReadingVolts	Integer or string	· For linear sensors, the field displays the voltage reading or N/A if no voltage exists. · For non-linear sensors, supported options: ¡ Voltage fault trigger—A voltage fault is triggered. ¡ Voltage fault release—A voltage fault is removed.
SensorNumber	Integer	Sensor number.
Status.Health	String	Voltage sensor health status.
Status.State	String	Voltage sensor enabling status.
UpperThresholdCritical	Integer or string	Upper major alarm threshold. If the threshold is not specified, N/A is displayed.
UpperThresholdFatal	Integer or string	Upper critical alarm threshold. If the threshold is not specified, N/A is displayed.
UpperThresholdNonCritical	Integer or string	Upper minor alarm threshold. If the threshold is not specified, N/A is displayed.
AllPowerStatus	Power status information.
Oem.Public.HostPowerStatus	String	System board power status. Options include On and Off.
Oem.Public.JBODPowerStatus	String	JBOD primary power status. This field is fixed as null.
Oem.Public.JBOGPowerStatus	String	JBOG primary power status. This field is fixed as null.
Oem.Public.OverallPowerStatus	String	Overall power status. This status is consistent with the host status. Options include On and Off.
Oem.Public.SmartNICPowerStatus	String	Primary power status of intelligent network adapters. This field displays null when no intelligent network adapter is connected. Options include Off, On, null.

Change history

Version	Change description
HDM-3.10	Added the AllPowerStatus.Oem.Public.HostPowerStatus, AllPowerStatus.Oem.Public.JBODPowerStatus, AllPowerStatus.Oem.Public.JBOGPowerStatus, AllPowerStatus.Oem.Public.OverallPowerStatus, and AllPowerStatus.Oem.Public.SmartNICPowerStatus fields.
HDM-2.93	Added the AllPowerStatus.Oem.Public.HostPowerStatus, AllPowerStatus.Oem.Public.JBODPowerStatus, AllPowerStatus.Oem.Public.JBOGPowerStatus, AllPowerStatus.Oem.Public.OverallPowerStatus, and AllPowerStatus.Oem.Public.SmartNICPowerStatus fields
HDM-2.38	Added the PowerSupplies.Oem.Public.LineInputCurrent and PowerSupplies.Oem.Public.PowerOutputWatts fields.
HDM-2.11.92 HDM-2.25	· Added the PowerSupplies.Oem.Public.SlotNumber field. · Deleted the value No-input of the PowerSupplyType field.
HDM-2.0.04	Deleted the PowerControl.PowerLimit.PowerLimitEnable field.
HDM-1.30.15P02	Added the PowerControl.Oem.Public.CurrentCPUPowerWatts, PowerControl.Oem.Public.CurrentMemoryPowerWatts, PowerControl.Oem.Public.CurrentFanPowerWatts, PowerSupplies.Oem.Public.InputAmperage, and PowerSupplies.Oem.Public.ReadingAmperes fields.
HDM-1.30.14	Added Voltage fault trigger as an option of Voltages.ReadingVolts field.
HDM-1.30.12	Replaced the PowerControl.PowerLimitState field with PowerControl.PowerLimit.PowerLimitEnable.
HDM-1.30.09	· Added the PowerSupplies.MemberId field. · Added support for displaying N/A in the Voltages.ReadingVolts field. · Added support for displaying N/A in a threshold field if the threshold is not specified. · Deleted the Oem.Public field and its subset of fields.
HDM-1.30.07	Added the Oem.Public field and its subset of fields.
HDM-1.30.06	Added the PowerSupplies.Oem.Pubilc.PowerCurrentWatts field.

Configure power settings

Description

Perform a power supply active/standby switchover or configure power capping for the server.

This interface is not available for blade servers.

Privilege module

Power control

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Power

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body 1:

// Perform a power supply active/standby switchover:

{

"PowerControl":[{

"Oem":{

"Public":{

"PowerID":id,

"ActiveStandby":mode

}

}]

}

Request body 2:

// Configure power capping state and power capping:

{

"PowerControl":[

{

"PowerLimit":{

"LimitInWatts":limit_value,

"LimitException":limit_exception

}

]

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
PowerControl.Oem.Public.PowerID	Power supply ID.	Integer.
PowerControl.Oem.Public.ActiveStandby	Power supply mode.	String. Supported options: · Active. · Standby.
PowerControl.PowerLimit.LimitInWatts	Power cap value.	Integer or the null string. The integer value range is 150 to 10000 W. If you specify a capping value, power capping is also enabled. To disable power capping, set this field to null.
PowerControl.PowerLimit.LimitException	Action to take if the power cap value is exceeded.	String. Supported options: · NoAction—Perform no action. · HardPowerOff—Power off the server.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Chassis/1/Power

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body 1:

// Perform a power supply active/standby switchover:

{

"PowerControl":[{

"Oem":{

"Public":{

"PowerID":1,

"ActiveStandby":"Standby"

}

}]

}

Request body 2:

// Enable and configure power capping:

{

"PowerControl":[{

"PowerLimit":{

"LimitInWatts":766,

"LimitException":"NoAction"

}

}]

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#Power.Power(PowerControl,Voltages,Id,Name,PowerSupplies)",

"@odata.id": "/redfish/v1/Chassis/1/Power",

"@odata.type": "#Power.v1_5_0.Power",

"Id": "Power",

"Name": "Power",

"PowerControl": [

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerControl/1",

"MaxNum": 2,

"MemberId": "1",

"Name": "System Power Control 1",

"PowerConsumedWatts": 146,

"PowerLimit": {

"CorrectionInMs": 30000,

"LimitException": "HardPowerOff",

"LimitInWatts": 766

"PowerMetrics": {

"MaxConsumedWatts": 10000,

"MinConsumedWatts": 150

"Status": {

"Health": "OK",

"State": "Enabled"

}

"PowerSupplies": [

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/1",

"FirmwareVersion": "1M.0009.0024.002",

"LineInputVoltage": 238,

"LineInputVoltageType": "ACMidLine",

"Manufacturer": "FSP-GROUP",

"MemberId": "1",

"Model": "PSR800-12A",

"Name": "PSU1",

"Oem": {

"Public": {

"ActiveStandby": "Active",

"InputAmperage": 0.519,

"PowerCurrentWatts": 105,

"PowerID": "1",

"ReadingAmperes": 7.04,

"SlotNumber":1

}

"PowerCapacityWatts": 800,

"PowerSupplyType": "AC",

"SerialNumber": "01234",

"Status": {

"Health": "OK",

"State": "Enabled"

}

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/2",

"FirmwareVersion": "4M.0002.0006.005;1M.0009.0024.003",

"LineInputVoltage": 234,

"LineInputVoltageType": "ACMidLine",

"Manufacturer": "FSP-GROUP",

"MemberId": "2",

"Model": "PSR800-12A",

"Name": "PSU2",

"Oem": {

"Public": {

"ActiveStandby": "Active",

"PowerCurrentWatts": 144,

"PowerID": "2"

}

"PowerCapacityWatts": 800,

"PowerSupplyType": "AC",

"SerialNumber": "210213A05PH17A000320",

"Status": {

"Health": "OK",

"State": "Enabled"

}

"Voltages": [

{

"LowerThresholdCritical": 2.96,

"LowerThresholdFatal": "N/A",

"LowerThresholdNonCritical": "N/A",

"MaxReadingRange": 255,

"MinReadingRange": 0,

"Name": "SYS_3.3V",

"ReadingVolts": 3.2,

"SensorNumber": 48,

"Status": {

"Health": "OK",

"State": "Enabled"

"UpperThresholdCritical": 3.6,

"UpperThresholdFatal": "N/A",

"UpperThresholdNonCritical": "N/A"

...

]

}

Response code: 200

Response field description

For information about the response fields, see "Obtain power information."

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.0.04	· Deleted the PowerControl.PowerLimit.PowerLimitEnable field. Power capping is controlled by using the LimitInWatts field. · Added the LimitInWatts field. This field provides both power capping control and capping value configuration capabilities.
HDM-1.30.18P5X HDM-2.0.03	Changed the format of the PowerControl field in the request body from {…} to [{…}]. NOTE: The change takes effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.12	· Changed the PowerControl.PowerLimit.PowerEnable field to PowerControl.PowerLimit.PowerLimitEnable. · Configured the server to return an error code for blade servers because blade servers do not support this operation.
HDM-1.30.08	Changed the maximum value of the LimitInWatts field from 1800 to 10000.

Obtain power history information

Description

Obtain power history information from the server.

This interface is not available for blade servers.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/PowerHistoryData

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.

Examples

Method and URL:

GET http://172.16.13.176/redfish/v1/Chassis/1/Power/PowerHistoryData

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Power.Power(Description,Name,HistoricalPower,Id)",

"@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData",

"@odata.type": "#Power.v1_5_0.Power",

"Description": "Historical Power",

"HistoricalCPU": [

{

"avg": 247,

"max": 292,

"min": 6,

"time": "2019-10-16 22:59:01"

.........

{

"avg": 246,

"max": 256,

"min": 240,

"time": "2019-10-24 00:42:12"

}

"Id": "PowerHistoryData",

"Name": "PowerHistoryData"}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the system resource model.
@odata.id	String	Link to the system resource.
@odata.type	String	Type of the system resource.
Description	String	Description of the interface.
HistoricalCPU.avg	Integer	Average power.
HistoricalCPU.max	Integer	Maximum power.
HistoricalCPU.min	Integer	Minimum power.
HistoricalCPU.time	String	Sampling time.

Change history

Version	Change description
HDM-1.30.09	Added the redfish/v1/Chassis/chassis_id/PowerHistoryData interface.

Obtain module collection information

Description

Obtain information about all modules in the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/Boards

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.

Examples

Response:

{

"@odata.context": "/redfish/v1/$metadata#BoardsCollection.BoardsCollection(Members,Name,[email protected])",

"@odata.id": "/redfish/v1/Chassis/1/Boards",

"@odata.type": "#BoardsCollection.BoardsCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard6"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard2"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/BackPanel1"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/BackPanel4"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard8"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/M.2"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard5"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard4"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/BaseBoard"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/MB-BMC"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard7"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/mLOM"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/MB-BIOS"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/Expander"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/HBA_Raid"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/Riser1"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/BackPanel2"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard1"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/Riser2"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/BackPanel3"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard3"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/Riser3"

}

"[email protected]": 22,

"Name": "Boards Collection"

}

Response field description

Field	Data type	Description
@odata.context	String	OData description of the module collection resource model.
@odata.id	String	Link to the module collection resource.
@odata.type	String	Type of the module collection resource.
Members	Array	Links to module resources.
Name	String	Name of the module collection resource.
[email protected]	Integer	Number of modules installed on the server.

Obtain module information

Description

Obtain information about a specific module from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/Boards/board_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.
board_id	ID of the module resource.	You can obtain available module resource IDs from module collection information.

Examples

Response:

{

"@odata.context": "/redfish/v1/$metadata#BoardsInstance.BoardsInstance",

"@odata.id": "/redfish/v1/Chassis/1/Boards/BaseBoard",

"@odata.type": "#Boards.v1_0_0.Boards",

"BoardId": "2147553296",

"DeviceId": "0",

"Id": "BaseBoard",

"ManufactureDate": "2018-10-27",

"Manufacturer": "H3C",

"Name": "BaseBoard",

"PartNumber": "0302A3SE",

"ProductName": "BS03M4C1SFH",

"SerialNumber": "02A3SEH189000022",

"Status": {

"Health": "OK",

"State": "Enabled"

"Version": "1"

}

Response field description

Field	Data type	Description
@odata.context	String	OData description of the module resource model.
@odata.id	String	Link to the module resource.
@odata.type	String	Type of the module resource.
BoardId	String	Privilege module ID.
DeviceId	String	Device ID.
Id	String	ID of the module resource.
ManufactureDate	Date	Date of manufacture.
Manufacturer	String	Manufacturer.
PartNumber	String	Part number.
ProductName	String	Product name.
SerialNumber	String	Serial number.
Status.Health	String	Health status of the module.
Status.Enable	String	Enabling status of the module.
Version	String	Privilege module version.
Name	String	Privilege module resource name.

Obtain PCIe module collection information

Description

Obtain information about all PCIe modules in the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/PCIeDevices

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.

Examples

Response:

{

"@odata.context": "/redfish/v1/$metadata#PCIeDevicesCollection.PCIeDevicesCollection(*)",

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices",

"@odata.type": "#PCIeDeviceCollection.PCIeDeviceCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/9"

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3"

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/2"

}

"[email protected]": 3,

"Name": "PCIeDevices Collection"

}

Response field description

Field	Data type	Description
@odata.context	String	OData description of the PCIe module collection resource model.
@odata.id	String	Link to the PCIe module collection resource.
@odata.type	String	Type of the PCIe module collection resource.
Members	Integer	Links to PCIe module resources.
[email protected]	Integer	Number of PCIe modules.
Name	String	Name of the PCIe module collection resource.

Change history

Version	Change description
HDM-1.30.09	Changed links to PCIe module resources.

Obtain PCIe module information

Description

Obtain information about a specific PCIe module from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/PCIeDevices/pciedevices_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.
pciedevices_id	ID of the PCIe module resource.	You can obtain available PCIe module resource IDs from PCIe module collection information.

Examples

Response:

For PCIE modules other than GPU modules:

{

"@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3",

"@odata.type": "#PCIeDevice.v1_2_0.PCIeDevice",

"Description": "RAID-LSI-9361-8i(1G)-A1-X",

"FirmwareVersion": "NULL",

"Id": "PCIeCard3",

"Links": {

"Chassis":

[

{

"@odata.id": "/redfish/v1/Chassis/1"

}

"PCIeFunctions":

[

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3/Functions/1"

}

]

"PCIeInterface":{

"LanesInUse":8,

"MaxLanes":8

}

"Manufacturer": "LSI Logic",

"Model": "RAID-LSI-9361-8i(1G)-A1-X",

"Name": "PCIeCard3",

"Oem": {

"Public": {

"PCIeCardType": "RAID",

"DeviceLocator": "PCIe Card3",

"Position": 3,

"SlotNumber": 3

}

"SerialNumber": "02A2X0H185001019",

"Status": {

"Health": "OK",

"State": "Enabled"

}

For GPU modules:

{

"@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/5",

"@odata.type": "#PCIeDevice.v1_2_0.PCIeDevice",

"Description": "Tesla V100-PCIE-16G",

"FirmwareVersion": "88.00.1A.00.03",

"Id": "PCIeCard5",

"Links": {

"Chassis": [

{

"@odata.id": "/redfish/v1/Chassis/1"

}

"PCIeFunctions": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/5/Functions/1"

}

]

"Manufacturer": "NVIDIA",

"Model": "Tesla V100-PCIE-16G",

"Name": "Tesla V100-PCIE-16G",

"Oem": {

"Public": {

"DeviceLocator": "PCIe Card5",

"MemorySizeMiB": 16384,

"PCIeCardType": "GPU",

"Position": 5,

"PowerCapacityWatts": 70,

"PowerWatts": 70,

"SlotNumber": 5

}

"PCIeInterface": {

"LanesInUse": 16,

"MaxLanes": null

"SerialNumber": "0323617020478",

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response field description

Field	Data type	Description
@odata.context	String	OData description of the PCIe module resource model.
@odata.id	String	Link to the PCIe module resource.
@odata.type	String	Type of the PCIe module resource.
Description	String	Description of the PCIe module.
FirmwareVersion	String	Firmware version of the PCIe module. This field displays NULL if obtaining the firmware version is not supported.
Id	String	ID of the PCIe module resource.
Links	Links to PCIe module resources.
@odata.id	String	Links to PCIe properties.
Chassis	Array	Link to a chassis resource.
PCIeFunctions	Array	Link to a PCIe function.
PCIeInterface.LanesInUse	Integer	Number of PCIe lanes currently negotiated by the PCIe module.
PCIeInterface.MaxLanes	Integer	Maximum number of PCIe lanes supported by the PCIe module.
Manufacturer	String	Manufacturer of the PCIe module.
Model	String	PCIe module model.
Name	String	PCIe module resource name.
Oem.Public.PCIeCardType	String	Type of the PCIe module. Supported options: · GPU. · FPGA. · NIC. · RAID. · SAS. · FC. · IB. · OEM. · QAT. · SWITCH.
Oem.Public.DeviceLocator	String	Mark on the PCIe module.
Oem.Public.FunctionType	String	Type of the PCIe module. This field is not supported.
Oem.Public.McuFirmwareVersion	String	MCU firmware version of the PCIe module. This field is not supported.
em.Public.Position	Integer	PCIe module location.
Oem.Public.SlotNumber	Integer	Slot number of the PCIe module.
Oem.Public.PowerWatts	Integer	Current power of the specified GPU module. Note that some NVIDIA GPUs require the installation of drivers and you must execute the nvidia-smi -pm 1 command to obtain the current power information.
Oem.Public.PowerCapacityWatts	Integer	Rated power of the specified GPU modules.
Oem.Public.MemorySizeMiB	Integer	Video memory capacity of the specified GPU module.
SerialNumber	String	Serial number.
Status	String	Resource status. Supported options: · Health—Health status. · State—Enabling status.

Change history

Version	Change description
HDM-2.38	Added the Oem.Public.PowerWatts, Oem.Public.PowerCapacityWatts, and Oem.Public.MemorySizeMiB fields for GPU modules.
HDM-2.27	Added value QAT for the PCIeCardType field.
HDM-2.26	Added value SWITCH for the PCIeCardType field.
HDM-2.11.97 HDM-2.25	Added the PCIeInterface.MaxLanes field.
HDM-2.11.93 HDM-2.25	Added the PCIeInterface.LanesInUse field.
HDM-2.11.92 HDM-2.25	Added the Oem.Public.PCIeCardType and Oem.Public.SlotNumber fields.
HDM-1.30.18P56 HDM-2.0.07	Changed the data type for the Links.Chassis and Links.PCIeFunctions fields from object to array.
HDM-1.30.11	Added support for obtaining the serial number.
HDM-1.30.09	Added the redfish/v1/Chassis/chassis_id/PCIeDevices/pciedevices_id interface.

Obtain PCIe function information

Description

Obtain information about the function of a specific PCIe module from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/PCIeDevices/pciedevices_id/Functions/1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.
pciedevices_id	ID of the PCIe module resource.	You can obtain available PCIe module resource IDs from PCIe module collection information.

Examples

Response:

{

"@odata.context": "/redfish/v1/$metadata#PCIeDevicesFunctionsInstance.PCIeDevicesFunctionsInstance",

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3/Functions/1",

"@odata.type": "#PCIeFunction.v1_2_0.PCIeFunction",

"DeviceId": "0x005D",

"Id": "1",

"Manufacturer": "LSI Logic",

"Name": "Function1",

"Oem": {

"Public": {

"BusNumber": "0x5e",

"Datawidth": "x8",

"DeviceClass": "MassStorageController",

"DeviceNumber": "0x00",

"FunctionNumber": "0",

"LinkWidthAbility": "x16",

"MaxProtocol": "Gen 3",

"MaxSpeed": "8.0GT/s",

"Negotiatedspeed": "8.0GT/s",

"Protocol": "Gen 3",

"Slot": "3"

}

"ProductName": "RAID-LSI-9361-8i(1G)-A1-X",

"Status": {

"Health": "OK",

"State": "Enabled"

"SubsystemId": "0x9361",

"SubsystemVendorId": "0x1000",

"VendorId": "0x1000"

}

Response field description

Field	Data type	Description
@odata.context	String	OData description of the PCIe module resource model.
@odata.id	String	Link to the PCIe module resource.
@odata.type	String	Type of the PCIe module resource.
DeviceId	String	ID of the PCIe module.
VendorId	String	Manufacturer ID.
Id	String	ID of the PCIe function resource.
SubsystemId	String	Subsystem ID.
SubsystemVendorId	String	Subsystem manufacturer ID.
Manufacturer	String	Manufacturer.
PartNumber	String	Part number.
ProductName	String	Product name.
SerialNumber	String	Serial number.
Status	Object	PCIe module status: · Health—Health status. · State—Enabling status.
Oem.Public.Datawidth	String	Negotiated link width.
Oem.Public.MaxSpeed	String	Maximum speed.
Oem.Public.Negotiatedspeed	String	Negotiated speed.
Oem.Public.Protocol	String	Negotiated protocol.
Oem.Public.Slot	String	PCIe slot number.
Oem.Public.BusNumber	String	Bus number of the PCIe module.
Oem.Public.DeviceClass	String	Class of the PCIe module.
Oem.Public.DeviceNumber	String	PCIe module number.
Oem.Public.FunctionNumber	String	PCIe function number.
Oem.Public.LinkWidthAbility	String	Maximum link bandwidth.
Oem.Public.MaxProtocol	String	Highest protocol
Oem.Public.MaxDatawidth	String	Maximum bandwidth.
Name	String	PCIe function resource name.

Change history

Version	Change description
HDM-2.93	Added the Oem.Public.MaxProtocol. Oem.Public.MaxDatawidth, and Oem.Public.LinkWidthAbility fields.
HDM-1.30.18P56	Changed the data type for the Status field from string to object. NOTE: The change takes effect only in HDM-1.30.18P5X versions.
HDM-1.30.09	· Added the following fields: Oem.Public.BusNumber, Oem.Public.DeviceClass, Oem.Public.DeviceNumber, and Oem.Public.FunctionNumber. · Deleted the PartNumber and SerialNumber fields.
HDM-1.30.08	Added the PartNumber and SerialNumber fields.

Obtain network adapter collection information

Description

Obtain information about all network adapters in the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#NetworkAdapterCollection.NetworkAdapterCollection",

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters",

"@odata.type": "#NetworkAdapterCollection.NetworkAdapterCollection",

"Description": "Collection of ethernet interfaces for this system",

"Members": [

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM"

}

"Name": "NetworkAdapter Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the network adapter collection resource model.
@odata.id	String	Link to the network adapter collection resource.
@odata.type	String	Type of the network adapter collection resource.
Description	String	Description of the network adapter collection resource.
Members	Links to network adapter resources.
@odata.id	String	Link to a network adapter resource.
[email protected]	Integer	Number of installed network adapters.

The server returns status code 200 for a successful operation.

Obtain network adapter information

Description

Obtain information about a specific network adapter from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapter_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.
networkadapter_id	ID of the network adapter resource.	You can obtain available network adapter resource IDs from network adapter collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response 1:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6",

"@odata.type": "#NetworkAdapter.v1_1_0.NetworkAdapter",

"Controllers": [

{

"ControllerCapabilities": {

"NetworkPortCount": 2

"FirmwarePackageVersion": "1.1197.0",

"Links": {

"NetworkPorts": [

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/1"

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/2"

}

GET http://172.16.13.176/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts

"PCIeDevices": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/6"

}

"[email protected]": 1

}

"Id": "PCIeSlot6",

"Manufacturer": "Intel",

"Model": "CNA-10GE-2P-560F-B2-1",

"Name": "PCIeSlot6",

"NetworkPorts": {

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts"

"Oem": {

"Public": {

"CapableSpeedGbs": "10",

"CardManufacturer": "Intel",

"CardModel": "2*10GE",

"FirmwareVersion": "1.1197.0",

"NetworkTechnology": [

"Ethernet"

"DeviceLocator": "MEZZ2",

"Position": "PCIeSlot6",

"RootBDF": "0000:5D:02.0",

"SerialNumber": "02A2N31234567890",

"TemperatureCelsius": 53,

"SlotNumber":6

}

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response code: 200

Response 2:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM",

"@odata.type": "#NetworkAdapter.v1_1_0.NetworkAdapter",

"Controllers": [

{

"ControllerCapabilities": {

"NetworkPortCount": 4

"FirmwarePackageVersion": "1.1767.0",

"Links": {

"NetworkPorts": [

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM/NetworkPorts/1"

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM/NetworkPorts/2"

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM/NetworkPorts/3"

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM/NetworkPorts/4"

}

"[email protected]": 4,

"PCIeDevices": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3"

}

"[email protected]": 1

}

"Id": "mLOM",

"Manufacturer": "Intel",

"Model": "NIC-GE-4P-360T-L3",

"Name": "mLOM",

"NetworkPorts": {

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM/NetworkPorts"

"Oem": {

"Public": {

"CapableSpeedGbs": "0",

"CardManufacturer": "Intel",

"CardModel": "4*0GE",

"FirmwareVersion": "1.1767.0",

"Position": "mLOM",

"SerialNumber": "02A3GKH17B000267",

"TemperatureCelsius": "null",

"SlotNumber":9

}

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response code: 200

Response field description

Field	Date type	Description
@odata.context	String	OData description of the network adapter resource model.
@odata.id	String	Link to the network adapter resource.
@odata.type	String	Type of the network adapter resource.
Manufacturer	String	Chip manufacturer of the network adapter.
Model	String	Network adapter model.
Name	String	Network adapter name.
Id	String	Network adapter ID.
Oem.Public	Custom properties of the network adapter.
CapableSpeedGbs	String	Speed.
FirmwareVersion	String	Firmware version.
NetworkTechnology	Array	Network protocol used by the network adapter. Supported options: · Ethernet. · FC. · iSCSI. · FCoE. · OPA. · IB. Support for this field depends on network adapter model.
DeviceLocator	String	Mark on the network adapter.
Position	String	Network adapter location, for example, mLOM, sLOM, and Embedded.
SerialNumber	String	Serial number.
Status	Object	Resource status: · Health—Health status. · State—Enabling status.
TemperatureCelsius	String	Temperature.
SlotNumber	Integer	Slot number of the network adapter.
RootBDF	String	Root port BDF of the network adapter. This field is supported by R4900 G3 servers, X10000 servers, R4300 G3 servers, R6700 G3 servers, R5300G3 servers, and all G5 servers.
CardManufacturer	String	Manufacturer of the network adapter.
CardModel	String	Interface type on the network adapter.
Controllers	Network adapter properties.
FirmwarePackageVersion	String	Version of the firmware package.
Links	Link to a network port of the network adapter.
NetworkPorts	Network port collection for the network adapter.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.42	Added the support of the RootBDF field for the R5300G3 servers.
HDM-2.17.00	Deleted the Oem.public.NIC_id field.
HDM-2.11.94 HDM-2.25	Added the support of the RootBDF field for the R4300 G3 and R6700 G3 servers.
HDM-2.11.92 HDM-2.25	Added the Oem.Public.SlotNumber field.
HDM-2.10.00	Added the Oem.Publc.DeviceLocator field.
HDM-2.08.00	Changed the description of the Manufacturer field to chip manufacturer.
HDM-1.30.18P5X HDM-2.0.03	Changed the name of the Controllers.Link field to Controllers.Links. NOTE: This change takes effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.17	· Added support of the RootBDF field for the X10000. · Added the NetworkTechnology field for some network adapters.
HDM-1.30.14	· Deleted the RootBDF field for all servers except for the R4900 G3. · Changed the format of the Controllers field from {...} to [{...}]. · Changed the format of the Controllers.PCIeDevices field from {...} to [{...}]. · Added the Id field. · Deleted the Oem.Publc.NegotiatedSpeedGTs field.
HDM-1.30.09	· Added the RootBDF field. This field is supported only by the R4900 G3. · Added the following fields: CardManufacturer, Controllers, Link, and NetworkPorts.

Obtain network port collection information

Description

Obtain information about all network ports from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapters_id/NetworkPorts

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.
networkadapters_id	ID of the network adapter resource.	You can obtain available network adapter resource IDs from network adapter collection information.

Examples

Method and URL:

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts",

"@odata.type": "#NetworkPortCollection.NetworkPortCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts/1"

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts/2"

}

"Name": "Network Port Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the network port collection resource model.
@odata.id	String	Link to the network port collection resource.
@odata.type	String	Type of the network port collection resource.
Name	String	Name of the network port collection resource.
Members	Links to network port resources.
@odata.id	String	Link to a network port resource.
[email protected]	Integer	Number of network ports.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.08	Added the redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapters_id/NetworkPorts interface.

Obtain network port information

Description

Obtain information about a specific network port from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapter_id/NetworkPorts/networkport_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.
networkadapter_id	ID of the network adapter resource.	You can obtain available network adapter resource IDs from network adapter collection information.
networkport_id	ID of the network port resource.	You can obtain available network port resource IDs from network port collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts/1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#NetworkPort.NetworkPort",

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/4",

"@odata.type": "#NetworkPort.v1_1_0.NetworkPort",

"AssociatedNetworkAddresses": [

"60:0B:03:6F:E3:DE"

"Id": "4",

"Name": "4",

"Oem": {

"Public": {

"BDF": "0000:86:00.3",

"PortType": "ElectricalPort",

"AutoNeg": true,

"FullDuplex": true,

"PortMaxSpeed": "10000Mb/s",

"LldpService":{

"LldpEnabled": true,

"WorkMode": "Tx"

}

"PhysicalPortNumber": "4",

"LinkStatus": "N/A",

"CurrentLinkSpeedMbps": 10000

}

Response code: 200

Response field description

Field	Date type	Description
@odata.context	String	OData description of the network port resource model.
@odata.id	String	Link to the network port resource.
@odata.type	String	Type of the network port resource.
AssociatedNetworkAddresses	Array	MAC addresses of the network port.
Id	String	Network port resource ID.
Name	String	Ethernet port resource name.
PhysicalPortNumber	String	Physical port number of the network port.
LinkStatus	String	Port status. Supported options: · Up. · Down. · N/A. This field displays N/A if the server or the network adapter does not support this field or if the query failed to obtain the port status, for example, because of BIOS reboot, BIOS shutdown, NCSI disablement, or other conditions. Support for this field depends on network adapter model.
CurrentLinkSpeedMbps	Integer	Negotiated speed of the network port in Mbps.
Oem.Public	Custom properties of the network port.
PortType	String	Type of the network port. Supported options: · OpticalPort—Fiber port. · ElectricalPort—Copper port. · N/A—Unknown port.
BDF	String	BDF of the network port.
AutoNeg	Boolean	Autonegotiation of the network port. Supported options: · true. · false.
FullDuplex	Boolean	Full duplex of the network port. Supported options: · true. · false.
PortMaxSpeed	String	Maximum speed of the network port, in Mbps. For example, 10000 Mbps.
LldpService.LldpEnabled	Boolean	LLDP enablement status of the network port. Supported options: · true. · false. · null. If the server does not support the LLDP service, this field displays null.
LldpService.WorkMode	String	LLDP operating mode. The filed value Tx indicates the LLDP transmit mode.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.11.97 HDM-2.19	Added the Oem.Public.LldpService.LldpEnabled field.
HDM-2.11.92	Added the Oem.Public.LldpService.WorkMode field.
HDM-2.11.00	Added the PortMaxSpeed field.
HDM-2.10.00	· Added the CurrentLinkSpeedMbps field. · Deleted the NegotiateSpeedGbs field.
HDM-2.09.00	Added the AutoNeg and FullDuplex fields.
HDM-1.30.21 HDM-2.06.00	Changed the name of the NegotiateSpeedGTs filed to NegotiateSpeedGbs.
HDM-1.30.17	Added network adapters compatible with the LinkStatus field.
HDM-1.30.13	Added the LinkStatus and NegotiateSpeedGTs fields, which are available only for HBA cards.
HDM-1.30.11	· Changed the data type for the AssociatedNetworkAddresses field from string to array. · Changed the data type for the PhysicalPortNumber field from integer to string.
HDM-1.30.09	Added the redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapter_id/NetworkPorts/networkports_id interface.

Configure network port settings

Description

Configure a network port on the server.

Privilege module

Basic configuration

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapteras_id/NetworkPorts/networkport_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"Oem": {

"Public": {

"LldpService":{

"LldpEnabled": true,

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
Oem.Public.LldpService.LldpEnabled	Boolean	LLDP enablement status of the network port. Supported options: · true. · false.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts/1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"Oem": {

"Public": {

"LldpService":{

"LldpEnabled": true,

}

Response code: 200

Response:

{

"@odata.context": "/redfish/v1/$metadata#NetworkPort.NetworkPort",

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/4",

"@odata.type": "#NetworkPort.v1_1_0.NetworkPort",

"AssociatedNetworkAddresses": [

"60:0B:03:6F:E3:DE"

"Id": "4",

"Name": "4",

"Oem": {

"Public": {

"BDF": "0000:86:00.3",

"PortType": "ElectricalPort",

"AutoNeg": true,

"FullDuplex": true,

"PortMaxSpeed": "10000Mb/s"

"LldpService":{

"LldpEnabled": true,

"WorkMode": "Tx"

}

"PhysicalPortNumber": "4",

"LinkStatus": "N/A",

"CurrentLinkSpeedMbps": 10000

}

Change history

Version

Change description

HDM-2.11.97

HDM-2.19

Added the redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapteras_id/NetworkPorts/networkport_id interface.

Obtain drive alarm threshold information

Description

Obtain information about alarm thresholds of drives in the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Chassis/chassis_id/Drives/AlarmThreshold

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
chassis_id	ID of the chassis resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Chassis/1/Drives/AlarmThreshold

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#AlarmThreshold.AlarmThreshold",

"@odata.id": "/redfish/v1/Chassis/1/Drives/AlarmThreshold",

"@odata.type": "#AlarmThresholdService.v1_0_0.AlarmThresholdService",

"BadTrack": {

"AlarmLimit": 32767,

"EnableFlag": false

"Life": {

"AlarmLimit": 90,

"MajorAlarmLimit ": 95,

"MediaError": {

"MediaErrorCnt": 255,

"MediaErrorEnableFlag": false

"PredFail": {

"PredFailCnt": 255,

"PredFailEnableFlag": false

"RevBlock": {

"AlarmLimit": 10,

"EnableFlag": true

"UNC": {

"AlarmLimit": 255,

"EnableFlag": false

}

Response field description

Field	Date type	Description
@odata.context	String	OData description of the drive alarm threshold resource model.
@odata.id	String	Link to the drive alarm threshold resource.
@odata.type	String	Type of the drive alarm threshold resource.
BadTrack	Bad sector alarming for drives. This feature is available only for HDDs.
AlarmLimit	Integer	Number of bad sector that can trigger an alarm. Value range: 0 to 65535.
EnableFlag	Boolean	Whether bad sector alarming is enabled. Supported options: · true—Enabled. · false—Disabled.
Life	Drive life alarming. This feature is available only for SSDs and NVMe drives. This feature is enabled by default. The default value for AlarmLimit is 90, and the default value for MajorAlarmLimit is 100.
AlarmLimit	Integer	Remaining drive life that can trigger a minor alarm. Value range: 0 to 100 in percent.
MajorAlarmLimit	Integer	Remaining drive life that can trigger a major alarm. Value range: 0 to 100 in percent.
EnableFlag	Boolean	Whether remaining life alarming is enabled. Supported options: · true—Enabled. · false—Disabled.
MediaError	Media error alarming. This feature is available only for HDDs and SSDs.
AlarmLimit	Integer	Number of media errors that can trigger an alarm. Value range: 0 to 65535.
EnableFlag	Boolean	Whether media error alarming is enabled. Supported options: · true—Enabled. · false—Disabled.
PredFail	Predictive failure alarming. This feature is available only for HDDs and SSDs.
AlarmLimit	Integer	Number of predictive failures that can trigger an alarm. Value range: 0 to 255.
EnableFlag	Boolean	Whether predictive failure alarming is enabled. Supported options: · true—Enabled. · false—Disabled.
RevBlock	Reserved block alarming. This feature is available only for SSDs.
AlarmLimit	Integer	Number of reserved blocks that can trigger an alarm. Value range: 0 to 100.
EnableFlag	Boolean	Whether reserved block alarming is enabled. Supported options: · true—Enabled. · false—Disabled.
UNC	Uncorrectable error alarming. This feature is available only for HDDs and SSDs.
AlarmLimit	Integer	Number of uncorrectable errors that can trigger an alarm. Value range: 0 to 255.
EnableFlag	Boolean	Whether uncorrectable error alarming is enabled. Supported options: · true—Enabled. · false—Disabled.

Change history

Version

Change description

HDM-3.37

HDM-6.02

Added the MajorAlarmLimit field for querying the threshold for major erase alarms. The AlarmLimit field is used to query the threshold for minor erase alarms. The Life feature is enabled by default.

HDM-1.30.09

Added the redfish/v1/Chassis/chassis_id/Drives/AlarmThreshold interface.

Configure drive alarm threshold settings

Description

Configure the alarm threshold settings for drives.

Privilege module

Maintenance

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Chassis/1/Drives/AlarmThreshold

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"BadTrack": {

"AlarmLimit": Limit,

"EnableFlag": Flag

"Life": {

"AlarmLimit": Limit,

"MajorAlarmLimit": Limit,

"EnableFlag": Flag

"MediaError": {

"MediaErrorCnt": Limit,

"MediaErrorEnableFlag": Flag

"PredFail": {

"PredFailCnt": Limit,

"PredFailEnableFlag": Flag

"RevBlock": {

"AlarmLimit": Limit,

"EnableFlag": Flag

"UNC": {

"AlarmLimit": Limit,

"EnableFlag": Flag

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
BadTrack	Bad sector alarming. This feature is available only for HDDs.
AlarmLimit	Number of bad sectors that can trigger an alarm.	Integer. Value range: 0 to 65535.
EnableFlag	Enable or disable bad sector alarming.	Boolean. Supported options: · true—Enable. · false—Disabled.
Life	Remaining drive life alarming. This feature is available only for SSDs and NVMe drives. This feature is enabled by default. The default AlarmLimit is 90 and the default MajorAlarmLimit is 100.
AlarmLimit	Remaining drive life that can trigger a minor alarm.	Integer. Value range: 0 to 100 in percent.
MajorAlarmLimit	Remaining drive life that can trigger a major alarm.	Integer. Value range: 0 to 100 in percent.
EnableFlag	Enable or disable remaining drive life alarming.	Boolean. Supported options: · true—Enable. · false—Disable.
MediaError	Media error alarming. This feature is available only for HDDs and SSDs.
AlarmLimit	Number of media errors that can trigger an alarm.	Integer. Value range: 0 to 65535.
EnableFlag	Enable or disable media error alarming.	Boolean. Supported options: · true—Enable. · false—Disable.
PredFail	Predictive failure alarming. This feature is available only for HDDs and SSDs.
AlarmLimit	Number of predictive failures that can trigger an alarm.	Integer. Value range: 0 to 255.
EnableFlag	Enable or disable predictive failure alarming.	Boolean. Supported options: · true—Enable. · false—Disable.
RevBlock	Reserved block alarming. This feature is available only for SSDs.
AlarmLimit	Number of reserved blocks that can trigger an alarm.	Integer. Value range: 0 to 100.
EnableFlag	Enable or disable reserved block alarming.	Boolean. Supported options: · true—Enable. · false—Disable.
UNC	Uncorrectable error alarming. This feature is available only for HDDs and SSDs.
AlarmLimit	Number of uncorrectable errors that can trigger an alarm.	Integer. Value range: 0 to 255.
EnableFlag	Enable or disable uncorrectable error alarming.	Boolean. Supported options: · true—Enable. · false—Disable.

Examples

Method and URL:

PATCH https://192.168.20.207/redfish/v1/Chassis/1/Drives/AlarmThreshold

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"BadTrack": {

"AlarmLimit": 32767,

"EnableFlag": true

"Life": {

"AlarmLimit": 20,

"MajorAlarmLimit": 30,

"EnableFlag": true

"MediaError": {

"MediaErrorCnt": 32767,

"MediaErrorEnableFlag": true

"PredFail": {

"PredFailCnt": 213,

"PredFailEnableFlag": true

"RevBlock": {

"AlarmLimit": 10,

"EnableFlag": true

"UNC": {

"AlarmLimit": 177,

"EnableFlag": true

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#AlarmThreshold.AlarmThreshold",

"@odata.id": "/redfish/v1/Chassis/1/Drives/AlarmThreshold",

"@odata.type": "#AlarmThresholdService.v1_0_0.AlarmThresholdService",

"BadTrack": {

"AlarmLimit": 32767,

"EnableFlag": true

"Life": {

"AlarmLimit": 20,

"MajorAlarmLimit": 30,

"EnableFlag": true

"MediaError": {

"MediaErrorCnt": 32767,

"MediaErrorEnableFlag": true

"PredFail": {

"PredFailCnt": 213,

"PredFailEnableFlag": true

"RevBlock": {

"AlarmLimit": 10,

"EnableFlag": true

"UNC": {

"AlarmLimit": 177,

"EnableFlag": true

}

Response code: 200

Response field description

For information about the response fields, see "Obtain drive alarm threshold information."

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-3.37

HDM-6.02

Added the MajorAlarmLimit field for querying the threshold for major erase alarms. The AlarmLimit field is used to query the threshold for minor erase alarms. The Life feature is enabled by default.

HDM-1.30.09

Added the redfish/v1/Chassis/Drives/AlarmThreshold interface.

Operations on system resources

Obtain system collection information

Description

Obtain information about all system resources from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#ComputerSystemCollection.ComputerSystemCollection",

"@odata.id": "/redfish/v1/Systems",

"@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1"

}

"Name": "Systems Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the system collection resource model.
@odata.id	String	Link to the system collection resource.
@odata.type	String	Type of the system collection resource.
Members	List of system resources.
@odata.id	String	Link to a system resource.
[email protected]	Integer	Number of system resources.
Name	String	Name of the system collection resource.

The server returns status code 200 for a successful operation.

Obtain system resource information

Description

Obtain information about a specific system resource from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem(*)",

"@odata.id": "/redfish/v1/Systems/1",

"@odata.type": "#ComputerSystem.v1_5_0.ComputerSystem",

"Actions": {

"#ComputerSystem.Reset": {

"On",

"ForceOff",

"ForceRestart",

"GracefulShutdown"

"Nmi",

"ForcePowerCycle"

"target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset"

}

"AssetTag": "ZB17-01-Unis Huashan 20110228",

"Bios": {

"@odata.id": "/redfish/v1/Systems/1/Bios"

"BiosVersion": "2.00.30 V100R001B02D030",

"Boot": {

"BootSourceOverrideEnabled": "Once",

"Once",

"Continuous"

"BootSourceOverrideMode": "None",

"None",

"Legacy",

"UEFI"

"BootSourceOverrideTarget": "None",

"None",

"Pxe",

"Hdd",

"Cd",

"BiosSetup"

]

"ChassisPartNumber": "0235AQ7",

"Description": "System 1",

"Healthstate": {

"OverallHealth": "Critical",

"board": "OK",

"fans": "OK",

"memory": "OK",

"pcie": "OK",

"power": "Warning",

"processor": "OK",

"storage": "Critical",

"temperature": "OK",

"HostName": "HDM12315555777745557765",

"Id": "1",

"IndicatorLED": "Off",

"Links": {

"Chassis": [

{

"@odata.id": "/redfish/v1/Chassis/1"

}

"ManagedBy": [

{

"@odata.id": "/redfish/v1/Managers/1"

}

]

"LogServices": {

"@odata.id": "/redfish/v1/Systems/1/LogServices"

"MaintenanceSerialNumber": "210231A1110000000001",

"Manufacturer": "H3C",

"Memory": {

"@odata.id": "/redfish/v1/Systems/1/Memory"

"MemorySummary": {

"Count":5,

"Status":{

"Health":"OK",

"HealthRollup":"OK",

"State":"Enabled"

"TotalSystemMemoryGiB": 4

"Model": "RS33M2C9S",

"Name": "Computer System",

"NetworkInterfaces": {

"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"

"Oem": {

"Public": {

"BiosVendor": "AMI",

"IndependentPowerSupply": false,

"PowerOnStrategy": "RestorePreviousState"

}

"PCIeDevices": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/0"

}

"PCIeFunctions": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/0/Functions/1"

}

"PartNumber": "",

"PowerState": "On",

"ProcessorSummary": {

"Count": 2

"Model": "Intel(R)?Genuine?processor",

"Status":{

"Health":"OK",

"HealthRollup":"OK",

"State":"Enabled"

"TotalCores": 32,

"TotalThreads": 64

"Processors": {

"@odata.id": "/redfish/v1/Systems/1/Processors"

"SecureBoot": {

"@odata.id": "/redfish/v1/Systems/1/SecureBoot"

"SerialNumber": "12315555777745557765",

"Status": {

"Health": "Warning",

"State": "Enabled"

"Storage": {

"@odata.id": "/redfish/v1/Systems/1/Storages"

"SystemType": "Physical",

"UUID": "00000000-0000-03e2-b211-d21d7029e12c",

"Uptime_hours": "0",

"kvm": {

"@odata.id": "/redfish/v1/Systems/1/kvm"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the system resource model.
@odata.id	String	Link to the system resource.
@odata.type	String	Type of the system resource.
Actions	Available operations for the system resource.
ComputerSystem.Reset	Object	System reset operation.
[email protected]	Array	Available system reset operations. Supported options: · On—Power-on. · ForceOff—Forced power-off. · ForceRestart—Forced restart. · GracefulShutdown—Graceful power-off. · Nmi—Triggers a non-maskable interrupt. · ForcePowerCycle—Forced power-cycle.
target	String	Link to the system reset operation.
AssetTag	String	Asset tag of the system resource.
Bios	Object	Link to the BIOS resource.
BiosVersion	String	BIOS version.
Boot	Boot settings of the system resource.
BootSourceOverrideEnabled	String	Current enabling status of the boot settings. Supported options: · Once—Effective only for the next startup. · Continuous—Always effective.
[email protected]	Array	Available enabling status of boot settings. Supported options: · Once—Effective only for the next startup. · Continuous—Always effective.
BootSourceOverrideMode	String	Current boot mode. Supported options: · None. · Legacy—Legacy mode. · UEFI—UEFI mode.
[email protected]	Array	Available boot modes. Supported options: · None. · Legacy—Legacy mode. · UEFI—UEFI mode.
BootSourceOverrideTarget	String	Current boot device. Supported options: · None. · Hdd. · Pxe. · BiosSetup. · Cd.
[email protected]	Array	Available boot devices. Supported options: · None. · Hdd. · Pxe. · BiosSetup. · Cd.
ChassisPartNumber	String	Server package name.
Healthstate	Object	System health status.
Healthstate.OverallHealth	String	Overall health status.
Healthstate.storage	String	Health status of the storage controllers, drives, and NVMe drives.
Healthstate.fans	String	Fan health status.
Healthstate.memory	String	Memory health status.
Healthstate.pcie	String	PCIe module health status.
Healthstate.power	String	Power health status.
Healthstate.processor	String	Processor health status.
Healthstate.temperature	String	Temperature sensor health status.
Healthstate.board	String	Server board health status.
Id	String	ID of the system resource.
IndicatorLED	String	UID LED status. Supported options: · Lit—The LED is steady on. · Off—The LED is off. · Blinking—The LED is flashing.
Links	Links to service resources.
Chassis	Object array	Link to chassis resources.
ManagedBy	Object array	Link to manager resources.
LogServices	Object	Link to the log service collection resource.
MaintenanceSerialNumber	String	Maintenance serial number.
Manufacturer	String	Manufacturer.
Memory	Object	Link to a memory resource.
Model	String	Product model.
Name	String	System resource name.
NetworkInterfaces	Object	Link to a network interface resource.
Oem.Public.PowerOnStrategy	String	Power on strategy. Supported options: · TurnOn—Power on. · RestorePreviousState—Restore the power status before the device was powered off. · StayOff—Power off.
Oem.Public.BiosVendor	String	BIOS vendor of the resource.
Oem.Public.IndependentPowerSupply	Boolean	Whether independent power supply is supported for the standard PCIe slot. This feature is only supported by R5300 G3 and R5300 G5 servers.
PartNumber	String	Part number.
PowerState	String	Power status. Supported options: · On. · Off.
Processors	Object	Link to the processor collection resource.
SerialNumber	String	Serial number of the server.
SecureBoot	Object	This field is not supported in the current software version. Link to the secure boot resource.
Status	Object	Resource states: · Health—Whether the resource is healthy. · State—Whether the resource has been enabled.
Storages	Object	Link to the storage collection resource.
SystemType	String	System type. Supported options: · Physical. · Virtual.
UUID	String	UUID of the server.
Uptime_hours	String	Time elapsed since the server was powered on.
kvm	Object	Link to the KVM resource.
HostName	String	Host name of the system resource.
PCIeDevices	Object	Links to PCIe module resources.
PCIeFunctions	Object	Links to PCIe function resources.
MemorySummary.TotalSystemMemoryGiB	Integer	Total memory size in GB.
MemorySummary.Status.Health	String	Current health status of memory.
MemorySummary.Status.State	String	Current enabling status of memory.
MemorySummary.Status.HealthRollup	String	Current health status of memory.
MemorySummary.Count	String	Number of present DIMMs.
ProcessorSummary.Count	Integer	Number of installed processors.
ProcessorSummary.Status.Health	String	Current health status of processors.
ProcessorSummary.Status.State	String	Current enabling status of processors.
ProcessorSummary.Status.HealthRollup	String	Current health status of processors.
ProcessorSummary.Model	String	Model of processor 1.
ProcessorSummary.TotalCores	Integer	Total cores of all processors.
ProcessorSummary.TotalThreads	Integer	Total threads of all processors.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-3.34	Added the ChassisPartNumber field.
HDM-2.93	Added the Oem.Public.IndependentPowerSupply field.
HDM-2.13.00	· Deleted the current, disk, voltage, raid and HostSystem fields from the Healthstate element. · Added the storage field to the Healthstate element.
HDM-2.0.07	Added the HostSystem field to the Healthstate element.
HDM-1.30.18P5X HDM-2.0.03	Changed the value range of the AssetTag and HostName fields to 1 to 48. NOTE: The change takes effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.18SP91	Added the ProcessorSummary.Status.Health, ProcessorSummary.Status.State, ProcessorSummary.Status.HealthRollup, ProcessorSummary.Model, ProcessorSummary.TotalCores, ProcessorSummary.TotalThreads, MemorySummary.Status.Health, MemorySummary.Status.State, MemorySummary.Status.HealthRollup, and MemorySummary.Count fields.
HDM-1.30.15P02	Added the Oem.Public.BiosVendor field.
HDM-1.30.14	Added the pcie and board fields.
HDM-1.30.12	· Deleted Disabled option from the BootSourceOverrideEnabled and [email protected] fields. · Added None as an option of the BootSourceOverrideMode and [email protected] fields.
HDM-1.30.11	Added the raid field.
HDM-1.30.09	Added the following fields: HostName, PCIeDevices, PCIeFunctions, MemorySummary, and ProcessorSummary.
HDM-1.30.07	Added the SerialNumber field.
HDM-1.30.06	Added the Oem.Public.PowerOnStrategy field.
HDM-1.11.30	Modified the supported options of the BootSourceOverrideTarget field to None, Hdd, Pxe, BiosSetup, and Cd.

Configure system resource properties

Description

Configure the properties of a specific system resource.

Privilege module

Remote control

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Systems/system_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"AssetTag": "test_123",

"HostName": "123",

"Boot": {

"BootSourceOverrideMode": mode,

"BootSourceOverrideTarget": target

"BootSourceOverrideEnabled": enable

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
AssetTag	Asset tag.	String. Value range: 1 to 48. The field displays null if no asset tag is configured.
HostName	Host name.	String. Value range: 1 to 63.
Boot.BootSourceOverrideMode	Next boot mode.	Supported options: · None. · Legacy—Legacy mode. · UEFI—UEFI mode.
Boot.BootSourceOverrideTarget	Next boot device.	Supported options: · None. · Pxe. · Hdd. · Cd. · BiosSetup—This option is available only when the BootSourceOverrideEnabled field is set to Once.
Boot.BootSourceOverrideEnabled	Effective type of the boot settings.	Supported options: · Once—Effective only at the next startup. · Continuous—Always effective. This option is available only for G5 servers. It is not available on G3 blade servers.

Usage guidelines

The BootSourceOverrideEnabled, BootSourceOverrideMode, and BootSourceOverrideTarget fields are all mandatory in the request.

If the Boot.BootSourceOverrideEnabled field is set to continuous, the BootSourceOverrideMode and BootSourceOverrideTarget fields cannot both be None.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"AssetTag": "test_123",

"HostName": "HDM12315555777745557765",

"Boot": {

"BootSourceOverrideMode": "UEFI",

"BootSourceOverrideTarget": "Pxe",

"BootSourceOverrideEnabled": "Once"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem(*)",

"@odata.id": "/redfish/v1/Systems/1",

"@odata.type": "#ComputerSystem.v1_5_0.ComputerSystem",

"Actions": {

"#ComputerSystem.Reset": {

"On",

"ForceOff",

"ForceRestart",

"GracefulShutdown"

"Nmi",

"ForcePowerCycle"

"target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset"

}

"AssetTag": "ZB17-01-Unis Huashan 20110228",

"Bios": {

"@odata.id": "/redfish/v1/Systems/1/Bios"

"BiosVersion": "2.00.30 V100R001B02D030",

"Boot": {

"BootSourceOverrideEnabled": "Once",

"Once",

"Continuous"

"BootSourceOverrideMode": "Legacy",

"None",

"Legacy",

"UEFI"

"BootSourceOverrideTarget": "None",

"None",

"Pxe",

"Hdd",

"Cd",

"BiosSetup"

"Description": "System 1",

"Healthstate": {

"OverallHealth": "Critical",

"board": "OK",

"fans": "OK",

"memory": "OK",

"pcie": "OK",

"power": "OK",

"processor": "OK",

"storage": "Critical",

"temperature": "OK",

"HostName": "HDM12315555777745557765",

"Id": "1",

"IndicatorLED": "Off",

"Links": {

"Chassis": [

{

"@odata.id": "/redfish/v1/Chassis/1"

}

"ManagedBy": [

{

"@odata.id": "/redfish/v1/Managers/1"

}

]

"LogServices": {

"@odata.id": "/redfish/v1/Systems/1/LogServices"

"Maintenance serial number": "210231A1110000000001",

"Manufacturer": "H3C",

"Memory": {

"@odata.id": "/redfish/v1/Systems/1/Memory"

"MemorySummary": {

"TotalSystemMemoryGiB": 4

"Model": "RS33M2C9S",

"Name": "Computer System",

"NetworkInterfaces": {

"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"

"Oem": {

"Public": {

"PowerOnStrategy": "RestorePreviousState"

}

"PCIeDevices": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/0"

}

"PCIeFunctions": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/0/Functions/1"

}

"PartNumber": "",

"PowerState": "On",

"ProcessorSummary": {

"Count": 2

"Processors": {

"@odata.id": "/redfish/v1/Systems/1/Processors"

"SecureBoot": {

"@odata.id": "/redfish/v1/Systems/1/SecureBoot"

"SerialNumber": "12315555777745557765",

"Status": {

"Health": "Warning",

"State": "Enabled"

"Storage": {

"@odata.id": "/redfish/v1/Systems/1/Storages"

"SystemType": "Physical",

"UUID": "00000000-0000-03e2-b211-d21d7029e12c",

"Uptime_hours": "0",

"kvm": {

"@odata.id": "/redfish/v1/Systems/1/kvm"

}

Response code: 200

Response field description

For information about the response fields, see "Obtain system resource information."

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.97	Changed the value length of the HostName field to 1 to 63.
HDM-2.26	Added the restriction that the BootSourceOverrideMode and BootSourceOverrideTarget fields cannot both be set to None, to be consistent with the Web interface.
HDM-1.30.18P5X HDM-2.0.03	Changed the value length of the AssetTag and HostName fields to 1 to 48. NOTE: The changes take effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.12	· Deleted the Disabled option from the Boot.BootSourceOverrideEnabled field. · Added None as an option of the Boot.BootSourceOverrideMode field.
HDM-1.30.11	Added the BootSourceOverrideEnabled field.
HDM-1.30.09	Added the redfish/v1/Systems/system_id interface.

Perform a power operation

Description

Perform a system power reset operation (power-on, forced power-off, graceful power-off, or forced restart).

Privilege module

Power control

Request

Method and URL:

POST https://device_ip/redfish/v1/Systems/system_id/Actions/ComputerSystem.Reset

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"ResetType": state

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
ResetType	Operation type.	Supported options: · On—Power-on. · ForceOff—Forced power-off. · ForceRestart—Forced restart. · GracefulShutdown—Graceful power-off. · Nmi—Triggers a non-maskable interrupt. · ForcePowerCycle—Forced power-cycle.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Systems/1/Actions/ComputerSystem.Reset

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"ResetType": "GracefulShutdown"

}

Response:

{

"error": {

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. SeeExtendedInfo for more information.",

"@Message.ExtendedInfo": [

{

"@odata.type":"/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"MessageId":"Base.1.0.Success",

"RelatedProperties": [],

"Message": "SuccessfullyCompleted Request",

"MessageArgs": [],

"Severity": "OK",

"Resolution":"None"

}

]

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-1.30.18P5X

HDM-2.0.03

· Added the RelatedProperties and MessageArgs fields to the response.

· Added Nmi and ForcePowerCycle as options of the ResetType field.

NOTE:

The changes take effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.

Obtain processor collection information

Description

Obtain information about all processors from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Processors

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.

Examples

Response:

{

"@odata.context": "/redfish/v1/$metadata#ProcessorCollection.ProcessorCollection",

"@odata.id": "/redfish/v1/Systems/1/Processors",

"@odata.type": "#ProcessorCollection.ProcessorCollection",

"Description": "Collection of processors for this system",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1/Processors/1"

{

"@odata.id": "/redfish/v1/Systems/1/Processors/2"

}

"Name": "Processors Collection",

"Oem": {

"Public": {

"CpuUsageRatePercent": 60

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the processor collection resource model.
@odata.etag	String	ETag of the processor collection resource.
@odata.id	String	ID of the processor collection resource.
@odata.type	String	Type of the processor collection resource.
Description	String	Description of the processor collection resource.
Members	Array	List of processor resources.
[email protected]	Integer	Number of processor resources.
Name	String	Name of the processor collection resource.
Oem.Public.CpuUsageRatePercent	Integer	Processor usage, in percent. Value range: 0 to 100. This field is supported only when FIST SMS is installed. This field displays null if the usage failed to be obtained.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.09	Changed the CpuUsageRate(%) field to CpuUsageRatePercent.
HDM-1.30.07	Added the Oem.Public.CpuUsageRate(%) field.

Set alarm threshold for processor usage

Description

Set the alarm threshold for processor usage.

Privilege module

Remote control

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Processors

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Oem":{

"Public":{

"UsageAlarmThreshold":value

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
Oem.Public. UsageAlarmThreshold	Alarm threshold for processor usage.	Integer. Value range: 0 to 100.

Usage guidelines

The redfish/v1/Systems/system_id/Processors interface does not support the If-Match condition.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Systems/1/Processors

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Oem":{

"Public":{

"UsageAlarmThreshold":75

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Systems/1/Processors",

"Oem": {

"Public": {

"UsageAlarmThreshold": 75

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.09	Changed the status code for a successful operation to 200.
HDM-1.30.07	Added the redfish/v1/Systems/system_id/Processors interface.

Obtain processor information

Description

Obtain information about a specific processor from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Processors/cpu_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
cpu_id	ID of the processor resource.	You can obtain available processor IDs from processor collection resource information.

Examples

Response:

{

"@odata.context": "/redfish/v1/$metadata#Processor.Processor(*)",

"@odata.id": "/redfish/v1/Systems/1/Processors/1",

"@odata.type": "#Processor.v1_3_0.Processor",

"Id": "1",

"InstructionSet": "x86-64",

"Manufacturer": "Intel(R) Corporation",

"MaxSpeedMHz": 3350,

"Model": "Intel(R) Genuine processor",

"Name": "CPU1",

"Oem": {

"Public": {

"L1CacheKiB": 1024,

"L2CacheKiB": 16384,

"L3CacheKiB": 22528,

"SerialNumber": "15-14-15-AD-95-11-69-A4",

"Temperature": 61,

"FrequencyMHz": 2000

}

"Ppin": "15-14-15-AD-95-11-69-A4",

"ProcessorArchitecture": "x86",

"ProcessorId": {

"IdentificationRegisters": "00-00-00-00-00-00-00-00"

"ProcessorType": "CPU",

"Socket": 1,

"Status": {

"Health": "OK",

"State": "Enabled"

"TotalCores": 16,

"TotalThreads": 32

}

Response field description

Field	Data type	Description
@odata.context	String	OData description of the processor resource model.
@odata.id	String	ID of the processor resource.
@odata.type	String	Type of the processor resource.
Id	String	ID of the processor resource.
InstructionSet	String	Instruction set of the processor.
Manufacturer	String	Manufacturer of the processor.
MaxSpeedMHz	Integer	Maximum frequency of the processor. For Intel processors, the maximum frequency is Turbo frequency..
Model	String	Model of the processor.
Name	String	Name of the processor.
ProcessorType	String	Type of the processor. Supported options: · CPU. · GPU. · FPGA. · DSP. · Accelerator. · OEM.
Socket	Integer	Slot number of the processor.
Status.Health	String	Health status of the processor.
Status.State	String	Enabling status of the processor.
TotalCores	Integer	Total number of cores in the processor.
TotalThreads	Integer	Maximum number of threads supported by the processor.
Oem.Public.L1CacheKiB	Integer	L1 cache size.
Oem.Public.L2CacheKiB	Integer	L2 cache size.
Oem.Public.L3CacheKiB	Integer	L3 cache size.
Oem.Public.SerialNumber	String	Serial number of the processor.
Oem.Public.Temperature	Integer	Processor temperature.
Oem.Public.FrequencyMHz	Integer	Base frequency of the processor.
Ppin	String	Protected Processor Inventory Number (PPIN).
ProcessorArchitecture	String	Architecture of the processor.
ProcessorId	Object	ID of the processor.

Change history

Version	Change description
HDM-1.30.15P02	Added the Oem.Public.SerialNumber field.
HDM-1.30.14	Changed the value of the ProcessorArchitecture field from x86_64 to x86.
HDM-1.30.13	Added the Oem.Public.FrequencyMHz field.
HDM-1.30.11	· Changed the value of the ProcessorArchitecture field from x86 to x86_64. · Changed the data type for the Socket field from string to integer. · Added support for the Ppin field.
HDM-1.30.10	Added the Ppin field, but obtaining information about this field was not supported.
HDM-1.30.09	· Added the Oem.Public.Temperature field. · Deleted the PPIN field.
HDM-1.30.08	Added the PPIN field.

Obtain memory collection information

Description

Obtain information about all memory modules from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Memory

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/Memory

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#MemoryCollection.MemoryCollection",

"@odata.id": "/redfish/v1/Systems/1/Memory",

"@odata.type": "#MemoryCollection.MemoryCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1/Memory/DIMM110"

{

"@odata.id": "/redfish/v1/Systems/1/Memory/DIMM210"

}

"Name": "Memory Collection",

"Oem": {

"Public": {

"PowerWatts": "null"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the memory collection resource model.
@odata.id	String	Link to the memory collection resource.
@odata.type	String	Type of the memory collection resource.
Members	Array	List of memory resources.
[email protected]	Integer	Number of memory resources.
Name	String	Name of the memory collection resource.
Oem.Public.PowerWatts	String	Memory power consumption. This field displays null if obtaining the memory power consumption is not supported.

The server returns status code 200 for a successful operation.

Obtain memory information

Description

Obtain information about a specific memory module from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Memory/memory_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
memory_id	ID of the memory resource.	You can obtain available memory resource IDs from memory collection resource information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/Memory/DIMM110

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Memory.Memory(*)",

"@odata.id": "/redfish/v1/Systems/1/Memory/DIMM110",

"@odata.type": "#Memory.v1_5_0.Memory",

"BaseModuleType": "RDIMM",

"CapacityMiB": 8192,

"DataWidthBits": 0,

"DeviceLocator": "CPU1CH1A1",

"ErrorCorrection": "SingleBitECC",

"Id": "DIMM110",

"IsRankSpareEnabled": false,

"IsSpareDeviceEnabled": false,

"Manufacturer": "Hynix Semiconductor",

"MemoryDeviceType": "DDR4",

"MemoryLocation": {

"Channel": 1,

"Controller": 0,

"Slot": 0,

"Socket": 1

"Name": "DIMM110",

"Oem": {

"Public": {

"Authenticity": "Vendor certified",

"Model": "HMA81GR7AFR8N-VK",

"Technology": "RDIMM",

"VDDQVolt": "1.2 V"

}

"OperatingSpeedMhz": 2666,

"PartNumber": "HMA81GR7AFR8N-VK",

"PowerManagementPolicy": {

"PolicyEnabled": false

"RankCount": 1,

"SecurityCapabilities": {

"PassphraseCapable": false

"SerialNumber": "325C8E63",

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the memory resource model.
@odata.id	String	Link to the memory resource.
@odata.type	String	Type of the memory resource.
BaseModuleType	String	Base module type of the memory resource.
DeviceLocator	String	Location of the memory module.
CapacityMiB	Integer	Memory capacity, in MB.
DataWidthBits	Integer	Data bandwidth for the memory resource.
ErrorCorrection	String	Error correction method. Supported options: · MultiBitECC.
Id	String	ID of the memory resource.
IsRankSpareEnabled	Boolean	This field is not available in the current software version. The field value is fixed to false. Spare rank enabling status.
IsSpareDeviceEnabled	Boolean	Spare device enabling status.
MemoryDeviceType	String	Type of the memory module. Options include: · DDR3. · DDR4. · SDRAM.
MemoryLocation.Channel	Integer	Channel number of the memory module.
MemoryLocation.Slot	Integer	Slot number of the memory module (DIMM).
MemoryLocation.Controller	Integer	Controller number of the memory module.
MemoryLocation.Socket	Integer	Socket number of the processor.
Oem.Public.Authenticity	String	Memory authenticity. Supported options: · Vendor certified. · Normal.
Oem.Public.Model	String	Model of the memory module.
Oem.Public.Technology	String	Memory technology used by the memory module. Supported options: · RDIMM. · UDIMM. · SODIMM. · LRDIMM. · NVDIMM.
Oem.Public.VDDQVolt	String	Voltage of the memory module.
Name	String	Name of the memory module.
OperatingSpeedMhz	Integer	Maximum frequency of the memory module, in MHz.
PartNumber	String	Part number of the memory module.
PowerManagementPolicy.PolicyEnabled	Boolean	Enabling status of the power management policy for the memory module.
RankCount	Integer	Number of ranks in the memory module.
SecurityCapabilities.PassphraseCapable	Boolean	Security capabilities of the memory module.
SerialNumber	String	Serial number of the memory module.
Status.Health	String	Health status of the memory module.
Status.State	String	Enabling status of the memory module.
Manufacturer	String	Manufacturer of the memory module.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-3.35	Added the DataWidthBits field.
HDM-1.30.19	Added the MemoryLocation.Controller field.
HDM-1.30.18P5X HDM-2.0.03	Changed the data type for the MemoryLocation.Slot field from string to integer. NOTE: The change takes effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.15P02	Added the Oem.Public.Model field.
HDM-1.30.13	Added the SerialNumber field.
HDM-1.30.10	Changed the format of the DeviceLocator field from A1 to CPUA1.
HDM-1.30.09	· Added the following fields: BaseModuleType, DeviceLocator, and Oem.Public.Authenticity. · Deleted the SerialNumber field.
HDM-1.30.08	Added the SerialNumber field.
HDM-1.11.29	Replaced VendorID field with Manufacturer.

Obtain storage controller collection information

Description

Obtain information about all storage controllers from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Storages

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/Storages

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#StorageCollection.StorageCollection",

"@odata.id": "/redfish/v1/Systems/1/Storages",

"@odata.type": "#StorageCollection.StorageCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0"

}

"Name": "Storage Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the storage controller collection resource model.
@odata.id	String	Link to the storage controller collection resource.
@odata.type	String	Type of the storage controller collection resource.
Members	Array	List of storage controller resources.
[email protected]	Integer	Number of storage controller resources.
Name	String	Name of the storage controller resource list.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.11.28	Changed the interface from https://device_ip/redfish/v1/Systems/system_id/Storage to https://device_ip/redfish/v1/Systems/system_id/Storages.

Obtain storage controller information

Description

Obtain information about a specific storage controller from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
raid_id	ID of the storage controller resource.	You can obtain available storage controller IDs from storage controller collection resource information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Storage.Storage(*)",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0",

"@odata.type": "#Storage.v1_4_0.Storage",

"Drives": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront10"

}

"Id": "RAIDStorage0",

"Name": "RAIDStorage0",

"StorageControllers": [

{

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0#/StorageControllers/0",

"AssetTag": "RAID-LSI-9361-8i(2G)-1-X",

"FirmwareVersion": "4.680.00-8442",

"Manufacturer": "LSI",

"MemberId": "0",

"Model": "RAID-LSI-9361-8i(2G)-1-X",

"Name": "RAID-LSI-9361-8i(2G)-1-X",

"Oem": {

"Public": {

"BBUstate": "Miss",

"ConfigurationVersion": "3.1705.00-0018",

"DDRECCCount": 0,

"JBODState": true,

"MaintainPDFailHistory": true,

"MaxStripeSizeBytes": 1048576,

"MinStripeSizeBytes": 65536,

"MemorySizeMiB": 2048,

"Mode": "RAID",

"PackageVersion": "50.1.0-0501",

"PatrolReadConfig": {

"CompletedCounts": 0,

"DelayToStart": "1/12/2021 ; 22:46:29",

"OperationMode": "Auto",

"PeriodOfHours": 3,

"RunningStatus": "Stopped",

"SupportSSD": "Enabled",

"TotalCounts": 64

"SASAddress": "null",

"CapacitanceStatus": {

"State": "Enabled",

"Health": "OK"

"SupportedRAIDLevels": [

"RAID0",

"RAID1",

"RAID5",

"RAID6",

"RAID10",

"RAID50",

"RAID60"

]

"TemperatureCelsius": 44,

"VolumeConsistencyCheckConfig": {

"CompletedVolumeCounts": 1,

"DelayToStart": "1/13/2021 ; 0:42:40",

"OperationMode": "Sequential",

"PeriodOfHours": 5,

"RunningStatus": "Stopped",

"TotalVolumeCounts": 1

}

"SmarterCopyBackState": false,

}

"SerialNumber": "SK92066892",

"SpeedGbps": 12,

"Status": {

"Health": "OK",

"State": "Enabled"

"SupportedDeviceProtocols": [

"SAS"

]

}

"Oem": {

"Public": {

"AssociatedCard": {

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3

}

"Volumes": {

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the storage controller resource model.
@odata.id	String	Link to the storage controller resource.
@odata.type	String	Type of the storage controller resource.
Drives	Array	List of physical drive resources.
[email protected]	Integer	Number of physical drive resources.
Id	String	ID of the storage controller resource.
Name	String	Name of the storage controller resource.
StorageControllers.Model	String	Model of the storage controller.
StorageControllers.AssetTag	String	Asset tag of the storage controller.
StorageControllers.FirmwareVersion	String	Firmware version of the storage controller.
StorageControllers.Manufacturer	String	Manufacturer of the storage controller.
StorageControllers.Name	String	Name of the storage controller.
StorageControllers.Oem.Public.MemorySizeMiB	Integer	Cache size the storage controller, in MiB.
StorageControllers.Oem.Public.BBUstate	String	Supercapacitor status. This field displays null if this feature is not supported.
StorageControllers.Oem.Public.JBODState	Boolean	JBOD status.
StorageControllers.Oem.Public.SupportedRAIDLevels	Array	RAID levels supported by the storage controller.
StorageControllers.Oem.Public.PackageVersion	String	Package version of the LSI controller.
StorageControllers.Oem.Public.Mode	String	Mode of the storage controller. Supported options: · Non-RAID. · RAID. · HBA. · Mixed. · JBOD. · SimpleVolume. · AutoVolume.
StorageControllers.Oem.Public.ConfigurationVersion	String	Configuration version of the storage controller.
StorageControllers.Oem.Public.SASAddress	String	Address of the storage controller. This field displays null if no address is obtained.
StorageControllers.Oem.Public.CapacitanceStatus	Object	Capacitance state of the storage controller. Supported fields: · Health—Whether the storage controller is healthy. · State—Whether the storage controller has been enabled. If the storage controller is enabled, this field displays Enabled. If the storage controller is not present, this field displays Disabled.
StorageControllers.Oem.Public.AssociatedCard	Object	Link to the associated storage controller.
StorageControllers.Oem.Public.TemperatureCelsius	Integer	Temperature of the storage controller.
StorageControllers.SerialNumber	String	Serial number of the storage controller. This field displays null if no serial number is obtained.
StorageControllers.SpeedGbps	Integer	Speed of the storage controller interface.
StorageControllers.Status.Health	String	Health status of the storage controller.
StorageControllers.Status.State	String	Enabling status of the storage controller.
StorageControllers.SupportedDeviceProtocols	Integer	Supported protocols by the storage controller.
[email protected]	Integer	Number of drivers managed by the storage controller.
Volumes	String	List of logical drives.
StorageControllers.Oem.Public.MaintainPDFailHistory	Boolean	Enabling status of fault recording for the storage controller. This field displays null for storage controllers that do not support the feature.
StorageControllers.Oem.Public.CopyBackState	Boolean	Enabling status of the copy back feature for the storage controller.
StorageControllers.Oem.Public.MaxStripeSizeBytes	Integer	Maximum stripe size supported by the storage controller.
StorageControllers.Oem.Public.MinStripeSizeBytes	Integer	Minimum stripe size supported by the storage controller.
StorageControllers.Oem.Public.DDRECCCount	Integer	Number of correctable errors of the storage controller.
StorageControllers.Oem.Public.PatrolReadConfig.OperationMode	String	Operation mode. Supported options: · Auto. · Manual. · Disabled. This field displays null if no operation mode is supported.
StorageControllers.Oem.Public.PatrolReadConfig.PeriodOfHours	Integer	PR operation cycle. This field displays null if it is not supported.
StorageControllers.Oem.Public.PatrolReadConfig.RunningStatus	String	Running status of PR. Supported fields: · Stopped. · Ready. · Active. · Paused. · Aborted. This field displays null if it is not supported.
StorageControllers.Oem.Public.PatrolReadConfig.TotalCounts	Integer	Total number of hard drives that can perform PR at the same time. This field displays null if it is not supported.
StorageControllers.Oem.Public.PatrolReadConfig.CompletedCounts	Integer	Total number of hard drives that have completed PR this time. This field displays null if it is not supported.
StorageControllers.Oem.Public.PatrolReadConfig.DelayToStart	String	Next startup time. This field displays null if it is not supported.
StorageControllers.Oem.Public.PatrolReadConfig.SupportSSD	String	Whether SSD is supported for PR. Supported options: · Enable—SSD is supported. · Disable—SSD is not supported. · OnlyMixed—SSD is not supported. This field displays null if it is not supported.
StorageControllers.Oem.Public.VolumeConsistencyCheckConfig.OperationMode	String	Operation mode. Supported options: · Disable—Disable cc. · Sequential—Execute CC in logical drive sequentially. · Concurrent—Execute CC on all logical drives simultaneously. This field displays null if it is not supported.
StorageControllers.Oem.Public.VolumeConsistencyCheckConfig.PeriodOfHours	Integer	Consistency check interval. This field displays null if it is not supported.
StorageControllers.Oem.Public.VolumeConsistencyCheckConfig.RunningStatus	String	Running status of cc. Supported options: · Stopped. · Ready. · Active. · Aborted. This field displays null if it is not supported.
StorageControllers.Oem.Public.VolumeConsistencyCheckConfig.TotalVolumeCounts	Integer	Total number of logical drives that can perform CC simultaneously. This field displays null if it is not supported.
StorageControllers.Oem.Public.VolumeConsistencyCheckConfig.CompletedVolumeCounts	Integer	Total number of logical drives that have completed cc. This field displays null if it is not supported.
StorageControllers.Oem.Public.VolumeConsistencyCheckConfig.DelayToStart	String	The next startup time (not displayed when the operating mode is Disable). This field displays null if it is not supported.
StorageControllers.Oem.Public.SmarterCopyBackState	Boolean	Copy back status of SMART errors.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-6.06	Added the StorageControllers.Oem.Public.SmarterCopyBackState field.
HDM-6.05	Added the OperationMode, PeriodOfHours, RunningStatus, TotalCounts, CompletedCounts, DelayToStart, and SupportSSD fields under StorageControllers.Oem.Public.PatrolReadConfig. Added the OperationMode, PeriodOfHours, RunningStatus, TotalVolumeCounts, CompletedVolumeCounts, and DelayToStart fields under StorageControllers.Oem.Public. VolumeConsistencyCheckConfig.
HDM-2.93	Added the StorageControllers.Oem.Public.TemperatureCelsius field.
HDM-2.93	Added the Oem.Public.DDRECCCount, Oem.Public.MaintainPDFailHistory, Oem.Public.MaxStripeSizeBytes, Oem.Public.MinStripeSizeBytes, and Oem.Public.CopyBackState fields.
HDM-2.33	Added support of the JBOD, SimpleVolume, and AutoVolume modes for storage controllers.
HDM-2.11.92	Added the StorageControllers.Oem.Public.CapacitanceStatus field.
HDM-2.10.00	Added the StorageControllers.Oem.Public.PackageVersion field.
HDM-2.0.10	Added the Oem.Public.AssociatedCard field.
HDM-2.0.03	Added the StorageControllers.Oem.Public.Mode and StorageControllers.Oem.Public.ConfigurationVersion fields.
HDM-1.30.18P5X HDM-2.0.03	Changed the data type for the StorageControllers.Oem.Public.JBODState field from string to Boolean. NOTE: The change takes effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.22	Added the Oem.Public.AssociatedCard field.
HDM-1.30.11	· Changed the MemorySize field to MemorySizeMiB. · Changed the data type for the MemorySizeMiB field from string to integer. · Added the StorageControllers.Oem.Public.SASAddress field.
HDM-1.30.10	Added the following fields: Model, StorageControllers.SpeedGbps, and StorageControllers.SupportedDeviceProtocols.
HDM-1.30.09	Deleted the Link field.
HDM-1.11.28	Changed the interface from https://device_ip/redfish/v1/Systems/system_id/Storage/raid_id to https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id.

Edit storage controller information

Description

Edit information about a specific storage controller from the server. Only the related functions of LSI 9460-8i and 9560-8i cards are implemented, other cards are not involved.

Array controllers might take some time to modify policies, so the response displays policy information before the modification.

Privilege module

Remote control

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"StorageControllers": [{

"Oem":{

"Public": {

"VolumeConsistencyCheckConfig": {

"OperationMode": OperationMode,

"PeriodOfHours": PeriodOfHours,

"DelayToStart": DelayToStart

"PatrolReadConfig": {

"SupportSSD": SupportSSD,

"OperationMode": OperationMode,

"PeriodOfHours": PeriodOfHours,

"DelayToStart": DelayToStart

"CopyBackState":cb_state,

"SmarterCopyBackState":smartcb_state,

"JBODState": jbod_state,

"Mode":"mode",

}

}]

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
raid_id	ID of the storage controller.	Query from the storage controller collection.
VolumeConsistencyCheckConfig. OperationMode	String	Operation mode. Supported options: · Disable—Disable cc. · Sequential—Execute CC in logical drive sequentially. · Concurrent—Execute CC on all logical drives simultaneously.
VolumeConsistencyCheckConfig. PeriodOfHours	Integer	Consistency check cycle in hours, in a range of 1 to 8640.
VolumeConsistencyCheckConfig. DelayToStart	Integer	Delay time for this CC start, in minutes. The value range is 0 to 43200.
PatrolReadConfig.SupportSSD	String	Whether SSD is supported for PR. Supported options: · Enable—SSD is supported. · Disable—SSD is not supported.
PatrolReadConfig.OperationMode	String	Operation mode. Supported options: · Disable—Disable PR. · Enable—Enable PR. When disabling a PR, no additional parameters are required.
PatrolReadConfig.PeriodOfHours	Integer	PR operation cycle in hours, in a range of 1 to 8640.
PatrolReadConfig.DelayToStart	Integer	Delay time for this PR start, in minutes. The value range is 0 to 43200.
CopyBackState	Boolean	Enabling status of the copy back feature: · true · false This field is available only for LSI MR controllers.
SmarterCopyBackState	Boolean	Enabling status of SMART error copy back: · true · false This field is available only for LSI MR controllers.
JBODState	Boolean	Enabling status of JBOD: · true · false This field is available only for LSI MR controllers.
Mode	String	Storage controller mode: · RAID · HBA · Mixed · JBOD

Examples

Method and URL:

PATCH https://172.14.33.150/redfish/v1/Systems/1/Storages/RAIDStorage2

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"StorageControllers":[

{

"Oem":{

"Public":{

"VolumeConsistencyCheckConfig": {

"OperationMode":"Sequential",

"PeriodOfHours":5,

"DelayToStart":0

"PatrolReadConfig": {

"SupportSSD":"Enable",

"OperationMode":"Enable",

"PeriodOfHours":3,

"DelayToStart":4

"CopyBackState":false,

"SmarterCopyBackState":false,

"JBODState": false,

"Mode":"RAID"

}

]

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#Storage.Storage(*)",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage2",

"@odata.type": "#Storage.v1_4_0.Storage",

"Drives": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskRear30"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskRear31"

}

"Id": "RAIDStorage2",

"Name": "RAIDStorage2",

"StorageControllers": [

{

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage2#/StorageControllers/2",

"AssetTag": "RAID-LSI-9460-8i(2G)",

"FirmwareVersion": "5.160.00-3415",

"Manufacturer": "Broadcom",

"MemberId": "2",

"Model": "RAID-LSI-9460-8i(2G)",

"Name": "RAID-LSI-9460-8i(2G)",

"Oem": {

"Public": {

"AssociatedCard": {

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/2"

"BBUstate": "Miss",

"CapacitanceStatus": {

"Health": null,

"State": "Disabled"

"ConfigurationVersion": "5.1600.00-0006",

"CopyBackState": true,

"DDRECCCount": 0,

"JBODState": true,

"MaintainPDFailHistory": true,

"MaxStripeSizeBytes": 1048576,

"MemorySizeMiB": 2048,

"MinStripeSizeBytes": 65536,

"Mode": "RAID",

"PackageVersion": "51.16.0-3804",

"PatrolReadConfig": {

"CompletedCounts": 0,

"DelayToStart": "1/12/2021 ; 22:46:29",

"OperationMode": "Auto",

"PeriodOfHours": 3,

"RunningStatus": "Stopped",

"SupportSSD": "Enabled",

"TotalCounts": 64

"SASAddress": "500062B20791F080",

"SupportedRAIDLevels": [

"RAID0",

"RAID1",

"RAID5",

"RAID6",

"RAID10",

"RAID50",

"RAID60"

"TemperatureCelsius": 61,

"VolumeConsistencyCheckConfig": {

"CompletedVolumeCounts": 1,

"DelayToStart": "1/13/2021 ; 0:42:40",

"OperationMode": "Sequential",

"PeriodOfHours": 5,

"RunningStatus": "Stopped",

"TotalVolumeCounts": 1

}

"SerialNumber": "SPB2200215",

"SpeedGbps": 12,

"Status": {

"Health": "OK",

"State": "Enabled"

"SupportedDeviceProtocols": [

"SAS"

]

}

"Volumes": {

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage2/Volumes"

}

Response field description

The server returns status code 200 for a successful operation. For more information about the response, see "Obtain storage controller information."

Array controllers might take some time to modify policies, so the response displays policy information before the modification.

Change history

Version	Change description
HDM-6.06	Added the CopyBackState, SmarterCopyBackState, JBODState, and Mode fields.
HDM-6.05	Added the interface.

Obtain logical drive collection information

Description

Obtain information about all logical drives from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Storages/RAIDStorage_id/Volumes

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
RAIDStorage_id	ID of the storage controller resource.	You can obtain available storage controller IDs from storage controller collection resource information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#VolumeCollection.VolumeCollection",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes",

"@odata.type": "#VolumeCollection.VolumeCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0"

}

The server returns status code 200 for a successful operation.

"Name": "Volume Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the logical drive collection resource model.
@odata.id	String	Link to the logical drive collection resource model.
@odata.type	String	Type of the logical drive collection resource model.
Members	Array	List of logical drive resources.
[email protected]	Integer	Number of logical drive resources.
Name	String	Name of the logical drive collection resource.

Change history

Version	Change description
HDM-1.11.28	Changed the interface from https://device_ip/redfish/v1/Systems/system_id/Storage/RAIDStorage_id/Volumes to https://device_ip/redfish/v1/Systems/system_id/Storages/RAIDStorage_id/Volumes.

Create a logical drive

Description

Create a logical drive on the server.

Privilege module

Remote control

Request

Method and URL:

POST https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Oem":{

"Name":name,

"InitState": initstate,

"StripSize":stripsize,

"Level": raid_level,

"SpanNum": spanname,

"NumDrives": num_drives,

"ReadPolicy": read_policy,

"WritePolicy": write_policy,

"IOPolicy": io_policy,

"DriveCache": drive_cache_policy,

"AccessPolicy": access_policy,

"Size": size,

"SizeUnit": unit,

"AccelerationMethod": acceleration,

"PhysicalDiskList":

[{

"group_id":group_id,

"id":connnection_id

...

]

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
Name	Name of the logical drive.	String
InitState	Initialization type.	Supported options: · No. · Fast. · Full. This feature is not available for PMC storage controllers.
StripSize	Stripe size.	· Available sizes for the LSI 9440 storage controller: 64KB. · Available sizes for the LSI 9361 and LSI 9460 storage controllers: ¡ 64KB. ¡ 128KB. ¡ 256KB. ¡ 512KB. ¡ 1MB. · Available sizes for the PMC storage controllers: ¡ 16KB. ¡ 32KB. ¡ 64KB. ¡ 128KB. ¡ 256KB. ¡ 512KB. ¡ 1MB.
Level	RAID level.	Supported options: · RAID 0. · RAID 1. · RAID 5. · RAID 6. · RAID 00—This option is not available for PMC storage controllers. · RAID 10. · RAID 50. · RAID 60. · RAID 1 ADM—This level supports only three disks. · RAID 10 ADM.
SpanNum	Number of spans.	Integer. The available values vary by RAID level. For PMC storage controllers: · For RAID levels 0, 1, 5, 6, 10, 1 ADM, and 10 ADM, only 0 is available. · For RAID levels 50 and 60, the value must be greater than 1. For LSI storage controllers: · For RAID levels 0, 1, 5, and 6, only 1 is available. · For RAID levels 00, 10, 50, and 60, the value must be greater than 1.
NumDrives	Number of physical drives per span.	Integer. The available values vary by RAID level. For LSI storage controller: · For RAID 0, the value must be greater than 0 and less than the number of installed physical drives. · For RAID 1, the value must be an even number greater than 0. · For RAID 5 and RAID 6, the value must be greater than 2. · For RAID 00, the value must be greater than 0 and the total number of physical drives in all spans cannot be greater than the number of installed physical drives. · For RAID 10, the value must be an even number greater than 0 and the total number of physical drives in all spans cannot be greater than the number of installed physical drives. · For RAID 50 and RAID 60, the value must be greater than 2 and the total number of physical drives in all spans cannot be greater than the number of installed physical drives. For PMC storage controllers, the field displays the actual number of member drives.
WritePolicy	Write policy.	Supported options: · Write Through. · Write Back. · Always Write Back. This field is not available for PMC storage controllers.
ReadPolicy	Read policy.	Supported options: · No Read Ahead. · Read Ahead. This field is not available for PMC storage controllers.
IOPolicy	IO policy.	Supported options: · Direct. · Cached. This field is not available for PMC storage controllers.
DriveCache	Drive cache policy.	Supported options: · Unchanged. · Enable. · Disable. This field is not available for PMC storage controllers.
AccessPolicy	Access policy.	Supported options: · Read/Write. · Read only. · Blocked. This field is not available for PMC storage controllers.
Size	Capacity of the logical drive.	Integer. If the value you set is 0, the default maximum capacity is used.
SizeUnit	Unit of the capacity.	Supported options: · MB. · GB. · TB. The minimum capacity of a logical drive is 100 MB.
AccelerationMethod	Acceleration policy.	String. This field is available only for PMC storage controllers whose firmware supports MCTP. Supported options: · Controller Cache—This option is available only for MCTP PMC storage controllers. · None. · IO Bypass—This option is available only for SSDs.
PhysicalDiskList	List of member physical drives.
group_id	ID of the group to which physical drives belong.	Integer. This field is not available for PMC storage controllers. If you create RAID 00, 10, 50, or 60 with physical drives from multiple groups, make sure physical drives are evenly divided in the groups.
id	Connection ID of a physical drive.	You can obtain available physical drive IDs from physical drive information.

Usage guidelines

This feature is supported on the following storage controllers:

· The 9361, 9440, 9460, L460, P5408, and H5408 LSI storage controllers.

· The H460 and P460 PMC storage controllers whose firmware supports MCTP.

Examples

For LSI storage controllers:

Method and URL:

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Oem":{

"Name":"LogicalDisk0",

"InitState": "No",

"StripSize":"64KB",

"Level":"RAID 0",

"SpanNum": 1,

"NumDrives": 1,

"ReadPolicy": "Read Ahead",

"WritePolicy": "Write Through",

"IOPolicy": "Direct",

"DriveCache": "Disable",

"AccessPolicy": "Blocked",

"Size": 199,

"SizeUnit": "GB",

"PhysicalDiskList":

[{

"group_id":0,

"id":11

}]

}

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "Create volume succesfully. See ExtendedInfo for more information."

}

Response code: 200

For PMC storage controllers:

Method and URL:

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Oem":{

"Name":"LogicalDisk1",

"StripSize":"32KB",

"Level":"RAID 0",

"SpanNum": 0,

"NumDrives": 1,

"Size": 199,

"SizeUnit": "GB",

"AccelerationMethod": "None",

"PhysicalDiskList":

[{

"id":5

}]

}

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "Create volume succesfully. See ExtendedInfo for more information."

}

Response code: 200

For RAID 10 AMD:

Method and URL:

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Oem":{

"Name":"LogicalDisk1",

"StripSize":"32KB",

"Level":"RAID 10 ADM",

"SpanNum": 0,

"NumDrives": 1,

"Size": 199,

"SizeUnit": "GB",

"AccelerationMethod":"None",

"PhysicalDiskList":

[{

"id":0

{

"id":1

{

"id":2

{

"id":3

{

"id":4

{

"id":5

}]

}

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "Create volume succesfully. See ExtendedInfo for more information."

}

Response code: 200

Response field description

Field	Data type	Description
@odata.type	String	OData description of the message registry.
@Message.ExtendedInfo.Message	String	Detailed information in ExtendedInfo.
MessageId	String	Message ID.
Resolution	String	Recommended actions for the error.
Severity	String	Severity level of the error. Supported options: · OK. · Warning. · Critical.
code	String	String indicating a specific message ID in the message registry.
message	String	Details of the message.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-6.02	Corrected the spelling of the @Message.ExtendedInfo.Message field.
HDM-2.38	Capitalized the read policy and write policy values. For example, changed the Write through value to Write Through.
HDM-1.30.19	Added support of RAID 1 ADM and RAID 10 ADM for PMC storage controllers.
HDM-1.30.12	Changed status code for a successful operation to 200.
HDM-1.30.07	Added IO Bypass as an option of the AccelerationMethod field.
HDM-1.12.05	· Added support for PMC storage controllers. · Added the AccelerationMethod field.
HDM-1.11.32	Changed the DiskCachePolicy field to DriveCache.
HDM-1.11.28	Added the redfish/v1/Systems/system_id/Storages/storage_id/Volumes interface.

Delete a logical drive

Description

Delete a specific logical drive from the server.

Privilege module

Remote control

Request

Method and URL:

DELETE https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
storage_id	ID of the storage controller resource.	Example: RAIDStorage0.
volume_id	ID of the logical drive resource.	Example: LogicalDrive0.

Examples

Method and URL:

DELETE https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "Delete volume succesfully. See ExtendedInfo for more information."

}

Response code: 200

Response field description

Field	Data type	Description
@odata.type	String	OData description of the message registry.
@Message.ExtendedInfo.Message	String	Detailed information in ExtendedInfo.
MessageId	String	Message ID.
Resolution	String	Recommended actions for the error.
Severity	String	Severity level of the error. Supported options: · OK. · Warning. · Critical.
code	String	String indicating a specific message ID in the message registry.
message	String	Details of the message.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-6.02	Corrected the spelling of the @Message.ExtendedInfo.Message field.
HDM-1.30.12	· Added the response. · Changed the status code for a successful operation from 201 to 200.
HDM-1.30.09	Changed the status code for a successful operation from 204 to 201.
HDM-1.11.28	Added the redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id interface.

Obtain logical drive information

Description

Obtain information about a specific logical drive from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/logical_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
storage_id	ID of the storage controller resource.	You can obtain available storage controller IDs from storage controller collection information.
logical_id	ID of the logical drive resource.	You can obtain available logical drive IDs from logical drive collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

For PBSI PMC storage controllers:

{

"@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0",

"@odata.type": "#Volume.v1_0_3.Volume",

"CapacityBytes": 3837295591424,

"Encrypted": false,

"Id": "LogicalDrive0",

"Links": {

"Drives": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"

}

]

[email protected]:2

"Name": "",

"Oem": {

"Public": {

"RaidControllerID": 0,

"VolumeRaidLevel": "RAID0"

}

"Status": {

"Health": "OK",

"State": "Enabled"

}

For MCTP PMC storage controllers:

{

"@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0",

"@odata.type": "#Volume.v1_0_3.Volume",

"CapacityBytes": 3840594149376,

"Encrypted": false,

"Id": "LogicalDrive0",

"Links": {

"Drives": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"

}

]

"Name": "Logical Drive 1",

"Oem": {

"Public": {

"AccelerationMethod": "IO Bypass",

"OptimumIOSizeBytes": 262144,

"RaidControllerID": 0,

"VolumeRaidLevel": "RAID0"

}

"Status": {

"Health": "OK",

"State": "Enabled"

}

For LSI storage controllers:

{

"@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0",

"@odata.type": "#Volume.v1_0_3.Volume",

"CapacityBytes": 10737418240,

"Encrypted": false,

"Id": "LogicalDrive0",

"Links": {

"Drives": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"

}

]

"Name": "l1",

"Oem": {

"Public": {

"AccessPolicy": "Read/Write",

"BootEnable": false,

"DriveCache": "Unchanged",

"IOPolicy": "Direct",

"NumDrivePerSpan": 2,

"OptimumIOSizeBytes": 65536,

"RaidControllerID": 0,

"ReadPolicy": "No Read Ahead",

"SpanNumber": 1,

"VolumeRaidLevel": "RAID0",

"WritePolicy": "Write Through"

"DefaultReadPolicy": "ReadAhead",

"DefaultWritePolicy": "WriteBackWithBBU",

"DefaultCachePolicy": "DirectIO",

"CurrentCachePolicy": "DirectIO",

"BGIEnable": true,

"SSDCachecadeVolume": false,

"ConsistencyCheck": false,

"SSDCachingEnable": null,

}

"RedundantType": "NonRedundant",

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response field description

Field	Data type	Description
@odata.context	String	OData description of the logical drive resource model.
@odata.id	String	Link to the logical drive resource.
@odata.type	String	Type of the logical drive resource.
CapacityBytes	Integer	Capacity of the logical drive, in bytes.
Encrypted	Boolean	Whether to encrypt data in the logical drive.
Id	String	ID of the logical drive resource.
Links.Drives	String	Links to member drives of the logical drive.
[email protected]	Integer	Number of physical drives attached to the logical drive.
Name	String	Name of the logical drive.
Oem.Public	Custom properties of the logical drive.
AccessPolicy	String	Access policy of the logical drive. Supported options: · Read/Write. · Read only. · Blocked. This field is not available for PMC storage controllers.
BootEnable	Boolean	Whether the logical drive is a boot device.
DriveCache	String	Cache policy of physical drives in the logical drive. Supported options: · Unchanged. · Enable. · Disable. This field is not available for PMC storage controllers.
IOPolicy	String	IO policy of the logical drive. Supported options: · Direct. · Cached. This field is not available for PMC storage controllers.
NumDrivePerSpan	Integer	Number of member drives in each span. This field is not available for PMC storage controllers.
RaidControllerID	Integer	ID of the storage controller that manages the logical drive.
ReadPolicy	String	Read policy of the logical drive. Supported options: · No Read Ahead. · Read Ahead. This field is not available for PMC storage controllers.
SpanNumber	Integer	Number of spans contained in the logical drive.
VolumeRaidLevel	String	RAID level of the logical drive. Supported options: · RAID 0. · RAID 1. · RAID 5. · RAID 6. · RAID 00—This option is not available for PMC storage controllers. · RAID 10. · RAID 50. · RAID 60.
WritePolicy	String	Write policy of the logical drive. Supported options: · Write Through. · Write Back. · Always Write Back. This field is not available for PMC storage controllers.
DefaultReadPolicy	String	Default read policy of the logical drive. Options include: NoReadAhead ReadAhead
DefaultWritePolicy	String	Default write policy of the logical drive. Options include: WriteThrough WriteBack Always Writeack
DefaultCachePolicy	String	Default IO policy of the logical drive. Options include: CachedIO DirectIO
CurrentCachePolicy	String	Current IO policy of the logical drive.
BGIEnable	Boolean	Enabling status of background initialization.
SSDCachecadeVolume	Boolean	Whether the logical drive is a CacheCade logical drive. The field information cannot be obtained and is fixed at null.
ConsistencyCheck	Boolean	Enabling status of consistency check.
SSDCachingEnable	Boolean	Whether a CacheCade logical drive can be used. The field information cannot be obtained and is fixed at null.
OptimumIOSizeBytes	Integer	Strip size. Supported options vary by storage controller model. · For the LSI 9440 controller: ¡ 65536—64 KB. · For the LSI 9361 and LSI 9460 controllers: ¡ 65536—64 KB. ¡ 131072—128 KB. ¡ 262144—256 KB. ¡ 524288—512 KB. ¡ 1048576—1 MB. · For PMC storage controllers: ¡ 16384—16 KB. ¡ 32768—32 KB. ¡ 65536—64 KB. ¡ 131072—128 KB. ¡ 262144—256 KB. ¡ 524288—512 KB. ¡ 1048576—1 MB.
AccelerationMethod	String	Acceleration policy. Supported options: · Controller Cache. · None. · IO Bypass—This option is available only for SSDs. This field is available only for PMC storage controllers.
Status.Health	String	Health status of the logical drive.
Status.State	String	Enabling status of the logical drive.
RedundantType	String	Redundancy type of the logical drive. The redundancy type is corresponding to the RAID level. Options include: · RawDevice. · NonRedundant (RAID 0 and RAID 00). · Mirrored (RAID 1) · StripedWithParity (RAID 5 and RAID6). · SpannedMirrors (RAID 10). · SpannedStripesWithParity (RAID50 and RAID 60).

Change history

Version	Change description
HDM-2.93	Added the following fields: · RedundantType. · Oem.Public.DefaultReadPolicy. · Oem.Public.DefaultWritePolicy. · Oem.Public.DefaultCachePolicy. · Oem.Public.CurrentCachePolicy. · Oem.Public.BGIEnable. · Oem.Public.SSDCachecadeVolume. · Oem.Public.ConsistencyCheck. · Oem.Public.SSDCachingEnable.
HDM-2.11.92 HDM-2.25	· Changed the value format for the VolumeRaidLevel field from RAID x to RAIDx, where x represents a RAID level. This change removes the space between RAID and the RAID level number. · Added the [email protected] field.
HDM-1.30.11	Changed the data type for the OptimumIOSizeBytes field from string to integer.
HDM-1.30.10	Added the Oem.Public.AccelerationMethod field.
HDM-1.30.09	· Changed the data type for the BootEnable field to Boolean. · Added the Oem.Public.OptimumIOSizeBytes field.
HDM-1.30.06	Added the NumDrivePerSpan and SpanNumber fields.
HDM-1.11.31	Changed the BootDrive field to BootEnable and the DiskCachePolicy field to DriveCache.
HDM-1.11.29	Added the BootDrive field.
HDM-1.11.28	Changed the interface from https://device_ip/redfish/v1/Systems/system_id/Storage/storage_id/Volumes/logical_id tohttps://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/logical_id.

Edit logical drive properties

Description

Edit properties of the specified logical drive. PMC storage controllers do not support this operation.

Array controllers might take some time to modify policies, so the response displays policy information before the modification.

Privilege module

Remote control

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/logical_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Oem":{

"Public": {

"WritePolicy": read_policy,

"ReadPolicy": write_policy

"AccessPolicy":access_policy,

"DriveCache":drive_cache

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
storage_id	ID of the storage controller resource.	You can obtain available storage controller IDs from storage controller collection information.
logical_id	ID of the logical drive resource.	You can obtain available logical drive IDs from logical drive collection information.
WritePolicy	Write policy	Supported values include Write Through, Write Back, Always Write Back. This field is not available for PMC storage controllers.
ReadPolicy	Read policy	Supported values include No Read Ahead and Read Ahead. This field is not available for PMC storage controllers.
AccessPolicy	Access policy	Supported options include Read/Write, ReadOnly, and Blocked. This field is not available for PMC storage controllers.
DriveCache	Cache policy of physical drives	Supported options include Unchanged, Enable, and Disable. This field is not available for PMC storage controllers.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Oem":{

"Public": {

"WritePolicy": "Write Through",

"ReadPolicy": "Read Ahead",

"AccessPolicy":"ReadOnly",

"DriveCache":"Unchanged"

}

Response:

For LSI storage controllers:

{

"@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",

"@odata.etag": "W/\"1598299739\"",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0",

"@odata.type": "#Volume.v1_0_3.Volume",

"CapacityBytes": 8000046628864,

"Encrypted": false,

"Id": "LogicalDrive0",

"Links": {

"Drives": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront7"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront8"

}

]

"Name": "111",

"Oem": {

"Public": {

"AccessPolicy": "Read/Write",

"BootEnable": true,

"DriveCache": "Unchanged",

"IOPolicy": "Direct",

"NumDrivePerSpan": 2,

"OptimumIOSizeBytes": 262144,

"RaidControllerID": 0,

"ReadPolicy": "No Read Ahead",

"SpanNumber": 1,

"VolumeRaidLevel": "RAID 1",

"WritePolicy": "Write Back"

}

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response field description

The server returns status code 200 for a successful operation.

Array controllers might take some time to modify policies, so the response displays policy information before the modification.

Change history

Version	Change description
HDM-6.06	Added the AccessPolicy and DriveCache fields.
HDM-2.38	Capitalized the read policy and write policy values. For example, changed the Write through value to Write Through.
HDM-2.33	Added the https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/logical_id interface.

Obtain BIOS setting collection information

Description

Obtain information about the BIOS setting collection from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Bios

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.

Examples (1)

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/Bios

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@Redfish.Settings": {

"@odata.type": "Settings.v1_0_4.Settings",

"SettingsObject": {

"@odata.id": "/redfish/v1/Systems/1/Bios/Settings"

}

"@odata.context": "/redfish/v1/$metadata#Bios.Bios",

"@odata.id": "/redfish/v1/Systems/1/Bios",

"@odata.type": "#Bios.v1_0_3.Bios",

"Actions": {

"#Bios.ChangePassword": {

"target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ChangePassword"

"#Bios.ResetBios": {

The server returns status code 200 for a successful operation.

"Reset"

"target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ResetBios"

}

"AttributeRegistry": "BiosAttributeRegistry0ACLC.0.42.0",

"Attributes": {

…

"Description": "BIOS Configuration Current Settings",

"Id": "Bios",

"Name": "BIOS Configuration Current Settings"

}

Response code: 200

Examples (2)

You can use the curl tool to export the JSON-formatted content returned by this API to a specified file. In the example, you can export it to the file named bios.json.

[root@localhost test]# curl -k -X GET -H "X-Auth-Token:oKaC4f9YeGAiydbTLsqtPuhmngO7rYaW4NxHg6unV5c=" "https://192.168.34.218/redfish/v1/Systems/1/Bios" -o bios.json

Response field description

Field	Data type	Description
SettingsObject	List of BIOS setting objects.
@odata.id	String	Link to a BIOS setting resource.
@odata.context	String	OData description of the BIOS setting collection resource model.
@odata.id	String	Link to the BIOS setting collection resource.
@odata.type	String	Type of the BIOS setting collection resource.
AttributeRegistry	String	Resource ID of the BIOS Attribute Registry.
Actions	Available operations on a BIOS resource.
Bios.ResetBios	Object	Restore default BIOS settings.
[email protected]	Array	Available restoration operations. Options include: · Reset.
target	String	Link to the default BIOS setting restoration operation.
Bios.ChangePassword	Object	Change a BIOS password.
target	String	Link to the BIOS password change operation.
Attributes	Object	For more information about configurable BIOS settings, see "BIOS configuration items."
Description	String	Description of the BIOS configuration.
Id	String	ID of the BIOS configuration.
Name	String	Name of the BIOS configuration.

Change history

Version	Change description
NA	Added Examples 2 for exporting the response to the specified .json file.
HDM-2.16.00	Revised the values for the Description and Name fields.
HDM-1.30.09	Changed the SD field to Settings.

Obtain pending BIOS setting information

Description

Obtain information about pending BIOS settings from the server. Pending BIOS settings refer to BIOS settings that will take effect at the next boot.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Bios/Settings

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/Bios/Settings

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Bios.Bios",

"@odata.id": "/redfish/v1/Systems/1/Bios/Settings",

"@odata.type": "#Bios.v1_0_1.Bios",

"AttributeRegistry": "BiosAttributeRegistry0ACLC.0.33.0",

"Attributes": {

"BootOrder1": "Hard Disk",

"BootOrder2": "Network",

"BootOrder3": "CD/DVD",

"BootOrder4": "Other Device"

"Description": "BIOS Configuration Pending Settings",

"Id": "Settings",

"Name": "BIOS Configuration Pending Settings"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the BIOS resource model.
@odata.id	String	Link to the BIOS resource.
@odata.type	String	Type of the BIOS resource.
AttributeRegistry	String	Resource ID of the BIOS Attribute Registry.
Attributes	Object	Attributes of the pending BIOS configuration.
Description	String	Description of the pending BIOS configuration.
Id	String	ID of the pending BIOS configuration.
Name	String	Name of the pending BIOS configuration.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.16.00	Revised the values for the Description and Name fields.
HDM-1.30.11	Deleted the BootSourceOverrideMode and BootSourceOverrideTarget fields.
HDM-1.30.09	Changed the SD field to Settings.

Configure a BIOS setting

Description

Configure a specific BIOS setting for the server.

Privilege module

Remote control

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Systems/system_id/Bios/Settings

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"Attributes": {

"BootOrder1": BootOrder1,

"BootOrder2": BootOrder2,

"BootOrder3": BootOrder3,

"BootOrder4": BootOrder4

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
Attributes	BIOS settings to be configured.	For more information about configurable BIOS settings, see "BIOS configuration items." The four boot options are all mandatory in each request and each boot option supports only one value.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Systems/1/Bios/SD

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"Attributes": {

"BootOrder1": "Hard Disk",

"BootOrder2": "Network",

"BootOrder3": "CD/DVD",

"BootOrder4": "Other Device"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/Bios/Settings/$entity",

"@odata.id": "/redfish/v1/Systems/1/Bios/Settings",

"@odata.type": "#Bios.v1_0_0.Bios",

"AttributeRegistry": "BiosAttributeRegistry.1.0.1",

"Attributes": {

"BootOrder1": "Hard Disk",

"BootOrder2": "Network",

"BootOrder3": "CD/DVD",

"BootOrder4": "Other Device"

"Description": "BIOS Configuration Pending Settings",

"Id": "Settings",

"Name": "BIOS Configuration Pending Settings"

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

For information about the response fields, see "Obtain pending BIOS setting information."

Change history

Version	Change description
HDM-2.17.00	Added the restriction that the four boot options are all mandatory in the request.
N/A	Modified the field names BootOption#1, BootOption#2, BootOption#3, BootOption#4 to BootOption1, BootOption2, BootOption3, and BootOption4, respectively, for G5 servers.
HDM-1.30.11	Deleted the BootSourceOverrideMode and BootSourceOverrideTarget fields.
HDM-1.30.09	· Changed the SD field to Settings. · Changed the status code for a successful operation to 200. · Added the response.

Set a BIOS password

Description

Set a BIOS password for the server.

This interface does not support the if-match request.

After configuring the password, you must reboot the BIOS one to two times for the new password to take effect. To avoid an invalid password, do not perform any operation on the server during the reboot.

Privilege module

Remote control

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Systems/system_id/Bios/Actions/Bios.ChangePassword

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"UserName":name,

"Password":password

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
UserName	User type.	Supported options: · Admin. · User.
Password	Password string.	The password must be a case-sensitive string of 8 to 20 characters and meet the following requirements: · Contain a minimum of two of the following types: ¡ Uppercase letters. ¡ Lowercase letters. ¡ Digits. · Contain either of the following types: ¡ Spaces. ¡ Special characters ` ~ ! @ # $ % ^ & * ( ) _ + - = [ ] \ { } \| ; ' : " , . / < > ?

Usage guidelines

The redfish/v1/Systems/system_id/Bios/Actions/Bios.ChangePassword interface does not support the If-Match condition.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Systems/1/Bios/Actions/Bios.ChangePassword

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"UserName":"User",

"Password":"Password@_"

}

Response:

N/A

Response code: 204

Response field description

The server returns status code 204 for a successful operation.

Change history

Version	Change description
HDM-1.30.09	Added password complexity check, which functions the same way as the password complexity check feature of the BIOS.

Restore the default BIOS settings

Description

Restore the default BIOS settings.

Privilege module

Remote control

Request

Method and URL:

POST https://device_ip/redfish/v1/Systems/system_id/Bios/Actions/Bios.ResetBios

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"ResetType": "Reset"

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
ResetType	Operation type.	Supported options: · Reset.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Systems/1/Bios/Actions/Bios.ResetBios

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"ResetType": "Reset"

}

Response:

N/A

Response code: 204

Response field description

The server returns status code 204 for a successful operation.

Create a KVM resource

Description

Create a KVM resource.

Privilege module

Remote control

Request

Method and URL:

POST https://device_ip/redfish/v1/Systems/system_id/kvm

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Systems/1/kvm

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

}

Response:

{

"@odata.context": "/redfish/v1/$metadataSystems/1",

"@odata.id": "/redfish/v1/Systems/1/kvm",

"@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",

"H5_KVM_Authority": {

"@odata.id": "/redfish/v1/Systems/1/kvm/doo64Mgdr3bd6Ph5"

}

Response field description

Field	Data type	Description
@odata.context	String	OData description of the KVM resource model.
@odata.id	String	Link to the KVM resource.
@odata.type	String	Type of the KVM resource.
H5_KVM_Authority	Object	Link to the unencrypted KVM resource. The URL in http://path format indicates that the H5 KVM is unencrypted. The URL in https://path format indicates that the H5 KVM is encrypted. You can visit https://192.168.18.18 with the link attached to the end from a browser to access H5 KVM of the server without being authenticated. For example, visit https://192.168.18.18/redfish/v1/Systems/1/kvm/doo64Mgdr3bd6Ph5.

Change history

Version	Change description
HDM-2.13.00	· Changed the operation from GET to POST. · Revised the request body from N/A to {}.
HDM-1.30.11	Restored the interface.
HDM-1.30.09	Disabled the interface.

Obtain event log service collection information

Description

Obtain information about all current event log service resources from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/LogServices

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#LogServiceCollection.LogServiceCollection",

"@odata.id": "/redfish/v1/Systems/1/LogServices",

"@odata.type": "#LogServiceCollection.LogServiceCollection",

"Description": "Collection of log services for this system",

"Members": [

"/redfish/v1/Systems/1/LogServices/Log1"

"Name": "Log Services Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the event log service collection resource model.
@odata.id	String	Link to the event log service collection resource.
@odata.type	String	Type of the event log service collection resource.
Name	String	Name of the event log service collection resource.
[email protected]	Integer	Number of event log service resources.
Members	List of event log service resources.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.06	Added the redfish/v1/Systems/system_id/LogServices interface.

Obtain event log service resource information

Description

Obtain information about a specific event log service resource from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
LogService_id	ID of the log service resource.	You can obtain available log service resource IDs from log service collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#LogService.LogService(DateTimeLocalOffset,Id,Name,ServiceEnabled,MaxNumberOfRecords,DateTime,OverWritePolicy,[email protected],Entries)",

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1",

"@odata.type": "#LogService.v1_1_0.LogService",

"Actions": {

"#LogService.ClearLog": {

" "

"target": "/redfish/v1/Systems/1/LogServices/Log1/Actions/LogService.ClearLog"

}

"DateTime": "2019-11-04T08:20:22+08:00",

"DateTimeLocalOffset": "UTC+08:00",

"Entries": {

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries"

"Id": "Log1",

"MaxNumberOfRecords": 3639,

"Name": "System Service Log",

"OverWritePolicy": "WrapsWhenFull",

"Unknown",

"WrapsWhenFull",

"NeverOverWrites"

"ServiceEnabled": true,

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the event log service resource model.
@odata.id	String	Link to the event log service resource.
@odata.type	String	Type of the event log service resource.
Id	String	ID of the event log service resource.
Name	String	Name of the event log service resource.
MaxNumberOfRecord	Integer	Maximum number log entries that can be recorded in the event log service resource.
OverWritePolicy	String	Overwrite policy for the event log service resource. Supported options: · Unknown. · WrapsWhenFull. · NeverOverWrite.
[email protected]	Array	List of allowable values for the overwrite policy.
DateTime	String	System time of the event log service resource.
DateTimeLocalOffset	String	Time zone of the event log service resource.
ServiceEnabled	String	Enabling status of the event log service resource. Supported options: · true—Enabled. · false—Disabled.
Actions #LogService.ClearLog	Object	Action of clearing event log entries.
target	String	Link to clear event log entries of the event log service.
Entries	Object	Link to the event log collection resource.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.10	Changed the time offset of the DateTimeLocalOffset field from UTC to UTC+08:00.
HDM-1.30.06	Added the redfish/v1/Systems/system_id/LogServices/LogServices_id interface.

Obtain event log entry collection information

Description

Obtain information about all current event log entries of a log service from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id/Entries

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
LogService_id	ID of the log service resource.	You can obtain available log service resource IDs from log service collection information.

Example 1

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1/Entries

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries",

"@odata.type": "#LogEntryCollection.LogEntryCollection",

"Description": "Collection of entries for this log service",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1716"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1715"

…

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/3"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/2"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1"

}

"[email protected]": 1716,

"[email protected]": "/redfish/v1/Systems/1/LogServices/Log1/Entries?$skip=50",

"Name": "Log Service Entries Collection"

}

Response code: 200

Example 2

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1/Entries?$skip=10&$top=10&$expand=*

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries",

"@odata.type": "#LogEntryCollection.LogEntryCollection",

"Description": "Collection of entries for this log service",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1875",

"Created": "2021-06-05T06:30:20+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1875",

"Level": "Info",

"Message": "Drive Presence",

"MessageArgs": [

"1"

"Name": "Log Entry 1875",

"SensorName": "Disk_F3_Status",

"SensorType": "Drive Slot (Bay)",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1874",

"Created": "2021-06-05T06:30:20+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1874",

"Level": "Info",

"Message": "Drive Presence",

"MessageArgs": [

"1"

"Name": "Log Entry 1874",

"SensorName": "Disk_F2_Status",

"SensorType": "Drive Slot (Bay)",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1873",

"Created": "2021-06-05T06:30:20+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1873",

"Level": "Info",

"Message": "Drive Presence",

"MessageArgs": [

"1"

"Name": "Log Entry 1873",

"SensorName": "Disk_F1_Status",

"SensorType": "Drive Slot (Bay)",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1872",

"Created": "2021-06-05T06:30:20+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1872",

"Level": "Info",

"Message": "Drive Presence",

"MessageArgs": [

"1"

"Name": "Log Entry 1872",

"SensorName": "Disk_F0_Status",

"SensorType": "Drive Slot (Bay)",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1871",

"Created": "2021-06-05T06:30:18+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1871",

"Level": "Info",

"Message": "Processor Presence detected",

"MessageArgs": [

"1"

"Name": "Log Entry 1871",

"SensorName": "CPU4_Status",

"SensorType": "Processor",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1870",

"Created": "2021-06-05T06:30:18+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1870",

"Level": "Info",

"Message": "Processor Presence detected",

"MessageArgs": [

"1"

"Name": "Log Entry 1870",

"SensorName": "CPU3_Status",

"SensorType": "Processor",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1869",

"Created": "2021-06-05T06:30:18+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1869",

"Level": "Info",

"Message": "Processor Presence detected",

"MessageArgs": [

"1"

"Name": "Log Entry 1869",

"SensorName": "CPU2_Status",

"SensorType": "Processor",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1868",

"Created": "2021-06-05T06:30:18+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1868",

"Level": "Info",

"Message": "Processor Presence detected",

"MessageArgs": [

"1"

"Name": "Log Entry 1868",

"SensorName": "CPU1_Status",

"SensorType": "Processor",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1867",

"Created": "2021-06-05T06:30:09+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1867",

"Level": "Info",

"Message": "S0 / G0 \"working\"",

"MessageArgs": [

"1"

"Name": "Log Entry 1867",

"SensorName": "ACPI_State",

"SensorType": "System ACPI Power State",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1866",

"Created": "2021-06-05T06:30:06+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1866",

"Level": "Info",

"Message": "Transition to Running",

"MessageArgs": [

"1"

"Name": "Log Entry 1866",

"SensorName": "FAN4_D_R_Status",

"SensorType": "Fan",

"Severity": "OK"

}

"[email protected]": 1885,

"Name": "Log Service Entries Collection"

}

Response field description

Field	Data type	Description
@odata.context	String	OData description of the event log entry collection resource model.
@odata.id	String	Link to the event log entry collection resource.
@odata.type	String	Type of the event log entry collection resource.
Name	String	Name of the event log entry collection resource.
[email protected]	Integer	Number of event log entry resources.
[email protected]	String	Link to an event log entry resource. By default, all event log entry resources are displayed on one page. This field allows you to display event log entry resources on multiple pages.
Members	List of event log entry resources.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.06	Added the redfish/v1/Systems/system_id/LogServices/LogService_id/Entries interface.

Obtain event log entry resource information

Description

Obtain information about a specific event log entry resource from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id/Entries/Entry_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
LogService_id	ID of the log service resource.	You can obtain available log service resource IDs from log service collection information.
Entry_id	ID of the log entry resource.	You can obtain available log entry resource IDs from log entry collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1/Entries/29

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry(EntryCode,Level,Id,SensorType,Name,MessageArgs,Message,EntryType,Description,Severity,SensorName,Created)",

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/29",

"@odata.type": "#LogEntry.v1_3_0.LogEntry",

"Created": "2019-11-04T07:39:56+08:00",

"Description": "System Event Log",

"Severity": "OK",

"EntryCode": "Asserted",

"EntryType": "Event",

"EventTimestamp": "2019-11-04T07:39:56+08:00",

"Id": "29",

"Level": "Info",

"Message": "Drive presence",

"MessageArgs": [

"1"

"Name": "Log Entry 29",

"SensorName": "HDD_F05_Status",

"SensorType": "Drive Slot (Bay)"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the event log entry resource model.
@odata.id	String	Link to the event log entry resource.
@odata.type	String	Type of the event log entry resource.
Name	String	Name of the event log entry resource.
Description	String	Description of the event log entry resource.
Severity	String	Severity of the log entry. Supported options: · OK. · Warning. · Critical.
Level	String	Security level of the log entry. Supported options: · Info. · Minor. · Major. · Critical.
Created	String	Creation time of the event log entry.
EntryType	String	Type of the event log entry. Supported options: · Event. · SEL. · Oem.
EventTimestamp	String	Time at which the event occurred.
Message	String	Description of the event log entry.
Id	String	Event ID.
EntryCode	String	Event code. Supported options: · Asserted—The event is triggered · Deasserted—The event is cleared.
MessageArgs	Array	Message arguments.
SensorName	String	Sensor name.
SensorType	String	Sensor type.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.52	Added the EventTimestamp field.
HDM-2.16.00	· Changed the data type for the Id field from integer to string. · Modified the values for the EntryCode field from ASSERTED and DEASSERTED to Asserted and Deasserted, respectively.
HDM-1.30.06	Added the redfish/v1/Systems/system_id/LogServices/LogServices_id/Entries/Entries_id interface.

Clear event log entry information

Description

Delete event log entries for a specific event log service from the server.

Privilege module

Basic configuration

Request

Method and URL:

POST https://device_ip/redfish/v1/Systems/system_id/LogServices/LogServices_id/Actions/

LogService.ClearLog

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
LogServices_id	ID of the log service resource.	You can obtain available log service resource IDs from log service collection information.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1/Actions/LogService.ClearLog

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

}

Response:

{

"eroor": {

"@Message.ExtendedInfo": [

{

"@Message.ExtendedInfo": {

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageArgs": "[]",

"MessageId": "Base.1.0.Success",

"RelatedProperties": "[]",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.25	Assigned the interface to the basic configuration privilege module.
HDM-1.30.09	· Changed the status code for a successful operation to 200. · Added the response.
HDM-1.30.06	Added the redfish/v1/Systems/system_id/LogServices/LogServices_id/Actions/ LogService.ClearLog interface.

Obtain GPU information

Description

Obtain GPU information from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/GPU

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.

Examples

Method and URL:

GET http://172.16.13.176/redfish/v1/Systems/1/GPU

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Systems/1/GPU",

"Description": "Get GPU info for this system",

"GPUMaxNum":8,

"Healthstate": {

"OverallHealth": "Critical"

"GPU": [

{

"FirmwareVersion": "88.00.1A.00.03",

"ID": "0x1",

"Manufacture": "NVIDIA",

"Model": "Tesla V100-PCIE-16GB",

"Name": "Tesla V100-PCIE-16GB",

"PartNumber": "1DB4-893-A1",

"PowerConsumedWatts": 0,

"SerialNumber": "0323617020478",

"SlotNum": 2,

"HBMTemperature": 45, //This field is only supported by Enflame GPUs.

"DriverVersion": V1.2, //This field is only supported by Enflame GPUs.

"ECCEnable": Enable, //This field is only supported by Enflame GPUs.

"GCUVoltage": 1.203, //This field is only supported by Enflame GPUs.

"HBMVoltage": 1.0, //This field is only supported by Enflame GPUs.

"Status": {

"Health": "OK",

"State": "Enable"

"TemperatureCelsius": 50

}

"Oem":{

"Public":{

"PowerControl": [

{

"PowerLimit": {

"CorrectionInMs": 30000,

"LimitException": "HardPowerOff",

"LimitInWatts": 2000,

"PowerLimitEnable": true,

"PowerMetrics": {

"MaxConsumedWatts": 4000,

"MinConsumedWatts": 1000

}

]

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the system resource model.
@odata.id	String	Link to the system resource.
Description	String	Description of the interface.
GPU.FirmwareVersion	String	GPU firmware version.
GPU.ID	String	GPU ID.
GPU.Manufacture	String	Manufacturer.
GPU.Model	String	Model.
GPU.Name	String	Product name.
GPU.PartNumber	String	Part number.
GPU.PowerConsumedWatts	Integer	Power. If this field is 0, install the GPU driver in the OS.
GPU.SerialNumber	String	Serial number.
GPU.SlotNum	Integer	Slot number.
DriverVersion	String	Driver version number. This field is only supported by Enflame GPUs.
ECCEnable	Boolean	ECC enabling status. This field is only supported by Enflame GPUs.
GCUVoltage	Integer	GCU voltage in volt. This field is only supported by Enflame GPUs.
HBMVoltage	Integer	HBM voltage in volt. This field is only supported by Enflame GPUs.
HBMTemperature	Integer	HBM chip temperature sensor value in Celsius degree. This field is only supported by Enflame GPUs.
GPU.Status.Health	String	GPU health status.
GPU.Status.State	String	Whether the GPU is present.
GPU.TemperatureCelsius	Integer	GPU temperature in Celsius degree.
[email protected]	Integer	Number of GPUs.
PowerControl.PowerLimit.CorrectionInMs	Integer	Correction time of power capping in ms.
PowerControl.PowerLimit.LimitException	String	Action upon power capping failure. Options include NoAction and HardPowerOff.
PowerControl.PowerLimit.LimitInWatts	Integer	Power cap value.
PowerControl.PowerLimit.PowerLimitEnable	Boolean	Enabling status of power capping.
PowerControl.PowerMetrics.MaxConsumedWatts	Integer	Maximum power cap value.
PowerControl.PowerMetrics.MinConsumedWatts	Integer	Minimum power cap value.
GPUMaxNum	Integer	Maximum supported number of GPUs. For 5300 G3, 5300 G5, 5500 G5 AMD, and 4930 G5 servers, the maximum number of GPUs is determined by GPU adapter type. For servers with no GPU adapter, the maximum number of GPUs is determined by the maximum PCIe slot number minusing the number of embedded network adapter slots and minusing the number of mezzanine board slots.
OverallHealth	String	GPU overall health status.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-3.39.01	Added the HBMTemperature feld.
HDM-3.26	Added the DriverVersion, ECCEnable, GCUVoltage, and HBMVoltage fields.
HDM-2.93	Added the GPUMaxNum, GPU.Status.Health, GPU.Status.State, and OverallHealth fields.
HDM-2.33	Added the PowerControl.PowerLimit.CorrectionInMs, PowerControl.PowerLimit.LimitException, PowerControl.PowerLimit.LimitInWatts, PowerControl.PowerLimit.PowerLimitEnable, PowerControl.PowerMetrics.MaxConsumedWatts, and PowerControl.PowerMetrics.MinConsumedWatts fields.
HDM-1.30.09	Added the redfish/v1/Systems/system_id/GPU interface.

Configure GPU information

Description

Configure GPU power capping. This operation is supported only by R5500 G5 servers.

Privilege module

Power control

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Systems/system_id/GPU

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Oem":{

"Public":{

"PowerControl":[

{

"PowerLimit":{

"LimitInWatts":2000,

"LimitException":"NoAction"

}

]

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	ID of the system resource.	Only value 1 is supported.
PowerControl.PowerLimit.LimitException	Action upon a power capping failure.	Supported values include NoAction and HardPowerOff.
PowerControl.PowerLimit.LimitInWatts	Power cap value.	The power cap value range is 1000 W to 4000 W. Power capping is enabled automatically when you set a power cap value in the range of 1000 W to 4000 W. When power capping is disabled, this field displays null, and the power cap value and action upon power cap failure retain the values configured last time.

Examples

Method and URL:

PATCH http://172.16.13.176/redfish/v1/Systems/1/GPU

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

//Enable GPU power capping and configure the power cap value.

{

"Oem":{

"Public":{

"PowerControl":[

{

"PowerLimit":{

"LimitInWatts":2000,

"LimitException":"NoAction"

}

]

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Systems/1/GPU",

"Description": "Get GPU info for this system",

"GPU": [

{

"FirmwareVersion": "88.00.1A.00.03",

"ID": "0x1",

"Manufacture": "NVIDIA",

"Model": "Tesla V100-PCIE-16GB",

"Name": "Tesla V100-PCIE-16GB",

"PartNumber": "1DB4-893-A1",

"PowerConsumedWatts": 0,

"SerialNumber": "0323617020478",

"SlotNum": 2,

"Status": {

"Health": "OK",

"State": "Enable"

"TemperatureCelsius": 50

}

"Oem":{

"Public":{

"PowerControl": [

{

"PowerLimit": {

"CorrectionInMs": 30000,

"LimitException": "HardPowerOff",

"LimitInWatts": 2000,

"PowerLimitEnable": true,

"PowerMetrics": {

"MaxConsumedWatts": 4000,

"MinConsumedWatts": 1000

}

]

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

For more information about the response field description, see "Obtain GPU information."

Change history

Version	Change description
HDM-2.33	Added the PowerControl.PowerLimit.CorrectionInMs, PowerControl.PowerLimit.LimitException, PowerControl.PowerLimit.LimitInWatts, PowerControl.PowerLimit.PowerLimitEnable, PowerControl.PowerMetrics.MaxConsumedWatts, and PowerControl.PowerMetrics.MinConsumedWatts fields.

Obtain host monitoring information

Description

Obtain host monitoring information.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring

Request header:

X-Auth-Token:TOKEN

Content-Type:application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address used to log in to the device.	IPv4 or IPv6
TOKEN	Authentication token in the request message.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	System resource ID.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring

Request header:

X-Auth-Token:TOKEN

Content-Type:application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#PerformanceMonitoring.PerformanceMonitoring",

"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring",

"@odata.type": "#PerformanceMonitoring.v1_0_0.PerformanceMonitoring",

"DriveHistoryUsageRate": {

"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate"

"MemoryHistoryUsageRate": {

"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the host monitoring resource model.
@odata.id	String	Link to the host monitoring resource.
@odata.type	String	Type of the host monitoring resource.
MemoryHistoryUsageRate	Object	Link to the memory usage resource.
DriveHistoryUsageRate	Object	Link to the disk usage resource.

Change history

Version	Change description
HDM-6.01	Added the interface.

Obtain memory usage information

Description

Obtain memory usage information

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate

Request header:

X-Auth-Token:TOKEN

Content-Type:application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address used to log in to the device.	IPv4 or IPv6
TOKEN	Authentication token in the request message.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	System resource ID.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate

Request header:

X-Auth-Token:TOKEN

Content-Type:application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#MemoryHistoryUsageRate.MemoryHistoryUsageRate",

"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate",

"@odata.type": "#MemoryHistoryUsageRate.v1_0_0.MemoryHistoryUsageRate",

"HistoricalUsageRate": [

{

"Time": "2023-05-24T05:55:05+08:00",

"UsageRatePercents": 0

}

]

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the memory history usage monitoring resource model.
@odata.id	String	Link to the memory history usage monitoring resource.
@odata.type	String	Type of the memory history usage monitoring resource.
HistoricalUsageRate	Array	History data.
UsageRatePercents	Integer	Current usage.
Time	String	Current time.

Change history

Version	Change description
HDM-6.01	Added the interface.

Obtain disk usage information

Description

Obtain disk usage information.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate

Request header:

X-Auth-Token:TOKEN

Content-Type:application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address used to log in to the device.	IPv4 or IPv6
TOKEN	Authentication token in the request message.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	System resource ID.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate

Request header:

X-Auth-Token:TOKEN

Content-Type:application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#DriveHistoryUsageRate.DriveHistoryUsageRate",

"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate",

"@odata.type": "#DriveHistoryUsageRate.v1_0_0.DriveHistoryUsageRate",

"HistoricalUsageRate": [

{

"Time": "2021-01-26T04:49:30-03:00",

"TotalCapacityMB": 47897200,

"UsageRatePercents": 4.04,

"UsedCapacityGB": 1934608

}

]

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the disk history usage monitoring resource model.
@odata.id	String	Link to the disk history usage monitoring resource.
@odata.type	String	Type of the disk history usage monitoring resource.
HistoricalUsageRate	Array	History data.
UsageRatePercents	Integer	Current usage.
TotalCapacityMB	Integer	Total partition capacity.
UsedCapacityGB	Integer	Used partition capacity. This field is reserved. Ignore this field in the current software version.
Time	String	Current time.

Change history

Version	Change description
HDM-6.01	Added the interface.

Clear foreign configurations of physical drives for a storage controller

Description

Clear foreign configurations of physical drives for a storage controller.

Privilege module

Remote control

Request

POST https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id/Actions/Oem/Public/Storage.ClearForeignConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type:application/json

Request body :

}

Parameters

Parameter	Description	Value
device_ip	IP address used to log in to the device.	IPv4 or IPv6 address.
system_id	System resource ID.	Only value 1 is supported.
raid_id	ID of the storage controller.	Query from the storage controller collection.
TOKEN	Authentication token in the request message.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearForeignConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type:application/json

Request body:

{

}

Response:

{

"@Message.ExtendedInfo": [

{

"@odata.type": "#Message.v1_1_1.Message",

"Message": "Successfully Completed Request",

"MessageArgs": [],

"MessageId": "Base.1.8.1.Success",

"Severity": "OK",

"Resolution": "None"

}

"Oem": {

"Public": {

"CompletionCode": 0,

"Description": "Success"

}

Response code: 200

Response field description

Field	Data type	Description
@Message.ExtendedInfo	Extended information of the error message.
@odata.type	String	OData description of the message resource.
MessageId	String	Message ID.
Message	String	Detailed information.
MessageArgs	Array	Message parameters.
Severity	String	Severity levels. The available options supported by Redfish include: · OK · Warning · Critical
Resolution	String	Recommended action.

Change history

Version	Change description
HDM-6.06	Added the interface.

Clear all the configurations of a storage controller

Description

Clear the default configuration of a storage controller.

Privilege module

Remote control

Request

POST https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id/Actions/Oem/Public/Storage.ClearConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type:application/json

Request body:

{

}

Parameters

Parameter	Description	Value
device_ip	IP address used to log in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token in the request message.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
system_id	System resource ID.	Only value 1 is supported.
raid_id	ID of the storage controller.	Query from the storage controller collection.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type:application/json

Request body:

{

}

Response:

{

"@Message.ExtendedInfo": [

{

"@odata.type": "#Message.v1_1_1.Message",

"Message": "Successfully Completed Request",

"MessageArgs": [],

"MessageId": "Base.1.8.1.Success",

"Severity": "OK",

"Resolution": "None"

}

"Oem": {

"Public": {

"CompletionCode": 0,

"Description": "Success"

}

Response code: 200

Response field description

Field	Data type	Description
@Message.ExtendedInfo	Extended information of the error message.
@odata.type	String	OData description of the message resource.
MessageId	String	Message ID.
Message	String	Detailed information.
MessageArgs	Array	Message parameters.
Severity	String	Severity levels. The available options supported by Redfish include: · OK · Warning · Critical
Resolution	String	Recommended action.

Change history

Version	Change description
HDM-6.06	Added the interface.

Operations on manager resources

Obtain manager collection information

Description

Obtain information about all managers from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#ManagerCollection.ManagerCollection",

"@odata.id": "/redfish/v1/Managers",

"@odata.type": "#ManagerCollection.ManagerCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1"

}

"Name": "Manager Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the manager collection resource model.
@odata.id	String	Link to the manager collection resource.
@odata.type	String	Type of the manager collection resource.
Members	List of manager resources.
@odata.id	String	Link to a manager resource.
[email protected]	Integer	Number of manager resources.
Name	String	Name of the manager collection resource.

The server returns status code 200 for a successful operation.

Obtain manager resource information

Description

Obtain information about a specific manager resource from the server.

Privilege module

Information query

Request

GET https://device_ip/redfish/v1/Managers/manager_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Manager.Manager(*)",

"@odata.id": "/redfish/v1/Managers/1",

"@odata.type": "#Manager.v1_4_0.Manager",

"Actions": {

"#Manager.Reset": {

"ForceRestart"

"target": "/redfish/v1/Managers/1/Actions/Manager.Reset"

"#Manager.RollBack": {

" "

"target": "/redfish/v1/Managers/1/Actions/Manager.RollBack"

}

"CommandShell": {

"ConnectTypesSupported": [

"SSH"

"MaxConcurrentSessions": 3,

"ServiceEnabled": true

"DateTime": "2020-12-03T19:46:32-08:00",

"DateTimeLocalOffset": "UTC-08:00",

"Description": "BMC",

"EthernetInterfaces": {

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces"

"FirmwareVersion": "2.17 HDM V100R001B05D020_DEBUG",

"GraphicalConsole": {

"ConnectTypesSupported": [

"KVMIP"

"MaxConcurrentSessions": 4,

"ServiceEnabled": true

"Id": "1",

"KvmService": {

"@odata.id": "/redfish/v1/Managers/1/KvmService"

"Links": {

"ManagerForChassis": [

{

"@odata.id": "/redfish/v1/Chassis/1"

}

"ManagerForServers": [

{

"@odata.id": "/redfish/v1/Systems/1"

}

]

"LogServices": {

"@odata.id": "/redfish/v1/Managers/1/LogServices"

"ManagerType": "BMC",

"Model": "HDM",

"Name": "Manager",

"NetworkProtocol": {

"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"

"NtpService": {

"@odata.id": "/redfish/v1/Managers/1/NtpService"

"Oem": {

"Public": {

"FirmwareVendor": "AMI",

"LanguageSet": "EN, CN"

}

"SerialConsole": {

"ConnectTypesSupported": [

"SSH"

"MaxConcurrentSessions": 3,

"ServiceEnabled": true

"SerialInterfaces": {

"@odata.id": "/redfish/v1/Managers/1/SerialInterfaces"

"ServiceEntryPointUUID": "acc120aa-307b-03d7-e611-b6cf70fd67de",

"SmtpService": {

"@odata.id": "/redfish/v1/Managers/1/SmtpService"

"LldpService": {

"@odata.id": "/redfish/v1/Managers/1/LldpService"

}

"SnmpService": {

"@odata.id": "/redfish/v1/Managers/1/SnmpService"

"Status": {

"Health": "OK",

"State": "Enabled"

"SyslogService": {

"@odata.id": "/redfish/v1/Managers/1/SyslogService"

"UUID": "acc120aa-307b-03d7-e611-b6cf70fd67de",

"VirtualMedia": {

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia"

"VncService": {

"@odata.id": "/redfish/v1/Managers/1/VncService"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the manager resource model.
@odata.id	String	Link to the manager resource.
@odata.type	String	Type of the manager resource.
Actions	Available actions for the manager resource.
Manager.Reset	Object	HDM restart.
Manager.RollBack	Object	HDM primary/secondary switchover.
Manager.FactoryReset	Object	To be supported. Restoring HDM factory-default settings.
CommandShell	CLI console properties.
ConnectTypesSupported	Array	Supported link types. Supported options: · SSH.
MaxConcurrentSessions	Integer	Maximum number of links.
ServiceEnabled	Boolean	Enabling status.
DateTime	String	System date and time of the manager resource.
DateTimeLocalOffset	String	Time zone of the manager resource.
Description	String	Description of the manager resource.
EthernetInterfaces	Object	Link to network port information.
FirmwareVersion	String	HDM firmware version.
GraphicalConsole	Graphical console properties.
ConnectTypesSupported	Array	Supported link types. Supported options: · KVMIP.
MaxConcurrentSessions	Integer	Maximum number of links.
ServiceEnabled	Boolean	Enabling status.
Id	String	ID of the manager resource.
KvmService	String	Link to the KVM service.
Links	Object	Links to manager resources.
LogServices	Object	Link to the log service collection resource.
ManagerType	String	Type of the manager resource. Supported options: · BMC.
Model	String	Model of the manager resource. Supported options: · HDM.
Name	String	Name of the manager resource.
NetworkProtocol	Object	Link to the service.
NtpService	Object	Link to NTP information.
Oem.Public.FirmwareVendor	String	Firmware vendor of the manager resource.
Oem.Public.LanguageSet	String	Supported languages.
Oem.Public.Wireless	Object	Link to the wireless resource. This field is available only for some G5 servers.
SerialConsole	Serial console properties.
ConnectTypesSupported	Array	Supported link types. Supported options: · SSH.
MaxConcurrentSessions	Integer	Maximum number of links.
ServiceEnabled	Boolean	Enabling status.
SerialInterfaces	Object	Link to serial port information.
ServiceEntryPointUUID	String	UUID of the service resource managed by this manager.
SmtpService	Object	Link to SMTP information.
SnmpService	Object	Link to SNMP information.
LldpService	Object	Link to LLDP service resource information.
Status	Object	Resource state fields: · Health—Whether the resource is healthy. · State—Whether the resource has been enabled.
SyslogService	Object	Link to syslog information.
UUID	String	UUID of the manager resource.
VirtualMedia	Object	Link to virtual media information.
VncService	Object	Link to the VNC service.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.42	Added the LldpService field.
HDM-2.17.00	Added the Oem.Public.Wireless field.
HDM-1.30.18P5X HDM-2.0.03	Changed the value of the Model field to HDM. NOTE: The change takes effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.1P01	Added the Oem.Public.FirmwareVendor field.
HDM-1.30.10	· Deleted support of IPMI for the CommandShell.ConnectTypesSupported and SerialConsole.ConnectTypesSupported fields. · Changed maximum number of concurrent sessions to 3.
HDM-1.30.09	Added the LanguageSet, Model, and Links fields.

Edit manager resource information

Description

Edit information about a specific manager resource (time zone) for the server.

Privilege module

Basic configuration

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Managers/manager_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"DateTimeLocalOffset": "UTC-04:30"

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
DateTimeLocalOffset	Time zone information in a string.	N/A.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Managers/1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"DateTimeLocalOffset": "UTC-04:30"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#Manager.Manager(*)",

"@odata.id": "/redfish/v1/Managers/1",

"@odata.type": "#Manager.v1_4_0.Manager",

"Actions": {

"#Manager.Reset": {

"ForceRestart"

"target": "/redfish/v1/Managers/1/Actions/Manager.Reset"

"#Manager.RollBack": {

POST https://10.10.10.10/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent

" "

"target": "/redfish/v1/Managers/1/Actions/Manager.RollBack"

}

"CommandShell": {

"ConnectTypesSupported": [

"SSH"

"MaxConcurrentSessions": 3,

"ServiceEnabled": true

"DateTime": "2017-05-17T12:08:01-04:30",

"DateTimeLocalOffset": "UTC-04:30",

"Description": "BMC",

"EthernetInterfaces": {

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces"

"FirmwareVersion": "2.42 HDM V100R001B05D052_DEBUG",

"GraphicalConsole": {

"ConnectTypesSupported": [

"KVMIP"

"MaxConcurrentSessions": 4,

"ServiceEnabled": true

"Id": "1",

"KvmService": {

"@odata.id": "/redfish/v1/Managers/1/KvmService"

"Links": {

"ManagerForChassis": [

{

"@odata.id": "/redfish/v1/Chassis/1"

}

"ManagerForServers": [

{

"@odata.id": "/redfish/v1/Systems/1"

}

]

"LldpService": {

"@odata.id": "/redfish/v1/Managers/1/LldpService"

"LogServices": {

"@odata.id": "/redfish/v1/Managers/1/LogServices"

"ManagerType": "BMC",

"Model": "HDM",

"Name": "Manager",

"NetworkProtocol": {

"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"

"NtpService": {

"@odata.id": "/redfish/v1/Managers/1/NtpService"

"Oem": {

"Public": {

"#Manager.ExportConfiguration": {

"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ExportConfiguration"

"#Manager.ImportConfiguration": {

"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportConfiguration"

"FirmwareVendor": "AMI",

"LanguageSet": "EN, CN",

"Wireless": {

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Wireless"

}

"SerialConsole": {

"ConnectTypesSupported": [

"SSH"

"MaxConcurrentSessions": 3,

"ServiceEnabled": true

"SerialInterfaces": {

"@odata.id": "/redfish/v1/Managers/1/SerialInterfaces"

"ServiceEntryPointUUID": "6b567877-c434-04a1-e611-37d02a72d9d0",

"SmtpService": {

"@odata.id": "/redfish/v1/Managers/1/SmtpService"

"SnmpService": {

"@odata.id": "/redfish/v1/Managers/1/SnmpService"

"Status": {

"Health": "OK",

"State": "Enabled"

"SyslogService": {

"@odata.id": "/redfish/v1/Managers/1/SyslogService"

"UUID": "6b567877-c434-04a1-e611-37d02a72d9d0",

"VirtualMedia": {

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia"

"VncService": {

"@odata.id": "/redfish/v1/Managers/1/VncService"

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.51	Added the https://device_ip/redfish/v1/Managers/manager_id interface.

Obtain NTP information

Description

Obtain NTP information from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/NtpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/NtpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#NtpService.NtpService",

"@odata.id": "/redfish/v1/Managers/1/NtpService",

"@odata.type": "#NtpService.v1_0_0.NtpService",

"AlternateNtpServer": "2.cn.pool.ntp.org",

"Description": "NtpService Gettings",

"NtpAddressOrigin": "Static",

"Oem": {

"Public": {

"TimeZone": "UTC+8",

"TertiaryNtpServer": "3.cn.pool.ntp.org",

"RefreshInterval":652

}

"PreferredNtpServer": "1.cn.pool.ntp.org",

"ServiceEnabled": true

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the NTP service resource model.
@odata.id	String	Link to the NTP service resource.
@odata.type	String	Type of the NTP service resource.
AlternateNtpServer	String	Secondary NTP server address.
PreferredNtpServer	String	Primary NTP server address.
Description	String	Description of the NTP service.
NtpAddressOrigin	String	NTP server address obtaining method. Supported options: · Static.
ServiceEnabled	Boolean	Enabling status of the NTP service.
Oem.Public.TimeZone	String	Time zone.
Oem.Public.TertiaryNtpServer	String	Tertiary NTP server address.
Oem.Public.RefreshInterval	Integer	Refresh interval of the NTP server, in seconds. Value range: 600 to 2592000.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.13.00	Added the Oem.Public.RefreshInterval field.
HDM-1.30.12	Added the Oem.Public.TertiaryNtpServer field.
HDM-1.30.09	Added the NtpAddressOrigin field.

Configure NTP settings

Description

Configure NTP settings from the server.

Privilege module

Basic configuration

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Managers/manager_id/NtpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"AlternateNtpServer": AlternateNtpServer,

"PreferredNtpServer": PreferredNtpServer,

"ServiceEnabled": true,

"Oem":{

"Public":{

"TimeZone":"UTC+3"",

"TertiaryNtpServer": TertiaryNtpServer,

"RefreshInterval":652

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
PreferredNtpServer	Primary NTP server address.	String.
AlternateNtpServer	Secondary NTP server address.	String.
ServiceEnabled	Enabling status of the NTP service.	Boolean.
Oem.Public.TimeZone	Time zone.	String.
Oem.Public.TertiaryNtpServer	Tertiary NTP server address.	String.
Oem.Public.RefreshInterval	Refresh interval of the NTP server, in seconds. Value range: 600 to 2592000.	Integer.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Managers/1/NtpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"AlternateNtpServer": "192.168.1.1",

"PreferredNtpServer": "192.168.1.2",

"ServiceEnabled": true,

"Oem":{

"Public":{

"TimeZone":"UTC+3",

"TertiaryNtpServer": "192.168.1.3",

"RefreshInterval":652

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#NtpService.NtpService",

"@odata.id": "/redfish/v1/Managers/1/NtpService",

"@odata.type": "#NtpService.v1_0_0.NtpService",

"AlternateNtpServer": "192.168.1.1",

"Description": "NtpService Gettings",

"NtpAddressOrigin": "Static",

"Oem": {

"Public": {

"TimeZone": "UTC+3",

"TertiaryNtpServer": "192.168.1.3",

"RefreshInterval":652

}

"PreferredNtpServer": "192.168.1.2",

"ServiceEnabled": false

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.13.00	Added the Oem.Public.RefreshInterval field.
HDM-1.30.12	Added the Oem.Public.TertiaryNtpServer field.
HDM-1.30.09	· Changed the status code for a successful operation to 200. · Added the response.

Obtain SNMP information

Description

Obtain SNMP information from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/SnmpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Response:

GET https://192.168.18.18/redfish/v1/Managers/1/SnmpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#SnmpService.SnmpService(SnmpV3PrivProtocol,Id,ReadOnlyCommunity,Name,SnmpV3Enabled,SnmpTrapNotification,LongPasswordEnabled,ReadWriteCommunity,SnmpV2CEnabled,SnmpV3AuthProtocol,SnmpV1Enabled,Actions,Description)",

"@odata.id": "/redfish/v1/Managers/1/SnmpService",

"@odata.type": "#SnmpService.v1_0_0.SnmpService",

"Actions": {

"#SnmpService.SubmitTestEvent": {

"target": "/redfish/v1/Managers/1/SnmpService/Actions/SnmpService.SubmitTestEvent"

}

"Description": "SnmpService Gettings",

"Id": "SnmpService",

"LongPasswordEnabled": false,

"Name": "SNMP",

"ReadOnlyCommunity": "******",

"ReadWriteCommunity": "",

"SnmpTrapNotification": {

"AlarmSeverity": "Minor+Major+Critical",

"CommunityName": "public",

"ServiceEnabled": true,

"TrapMode": "NodeMode",

"TrapServer": [

{

"Enabled": true,

"MemberId": "1",

"TrapServerAddress": "10.99.160.48",

"TrapServerPort": 65535

{

"Enabled": true,

"MemberId": "2",

"TrapServerAddress": "10.99.160.216",

"TrapServerPort": 162

{

"Enabled": true,

"MemberId": "3",

"TrapServerAddress": "",

"TrapServerPort": 162

{

"Enabled": true,

"MemberId": "4",

"TrapServerAddress": "",

"TrapServerPort": 162

{

"Enabled": true,

"MemberId": "5",

"TrapServerAddress": "",

"TrapServerPort": 162

{

"Enabled": true,

"MemberId": "6",

"TrapServerAddress": "",

"TrapServerPort": 162

{

"Enabled": true,

"MemberId": "7",

"TrapServerAddress": "",

"TrapServerPort": 162

{

"Enabled": true,

"MemberId": "8",

"TrapServerAddress": "",

"TrapServerPort": 162

}

"TrapServerIdentity": "HDM638889",

"TrapV3User": "",

"TrapVersion": "v2c"

"SnmpV1Enabled": false,

"SnmpV2CEnabled": true,

"SnmpV3AuthProtocol": "",

"SnmpV3Enabled": true,

"SnmpV3PrivProtocol": ""

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the SNMP service resource model.
@odata.id	String	Link to the SNMP service resource.
@odata.type	String	Type of the SNMP service resource.
Actions	Available operations for the SNMP resource.
SnmpService.SubmitTestEvent	Object	Link to the SNMP trap testing.
Description	String	Description of the SNMP resource.
Id	String	SNMP resource ID.
LongPasswordEnabled	Boolean	Whether the long community string feature is enabled.
Name	String	SNMP resource name.
ReadOnlyCommunity	String	Read-only community name.
ReadWriteCommunity	String	Read/write community name.
SnmpTrapNotification.CommunityName	String	Trap community name.
SnmpTrapNotification.ServiceEnabled	String	Enabling status of the SNMP trap service.
SnmpTrapNotification.TrapMode	String	Trap mode. Supported options: · NodeMode. · EventMode.
SnmpTrapNotification.AlarmSeverity	String	Severity level. Supported options: · Major+Critical. · Minor+Major+Critical. · All.
SnmpTrapNotification.TrapServer	Trap server properties.
TrapServer.Enabled	Boolean	Enabling status of the SNMP trap servers.
TrapServer.MemberId	String	Trap server ID. The trap server ID range is 1 to 8.
TrapServer.TrapServerAddress	String	Trap server address.
TrapServer.TrapServerPort	Integer	Trap server port.
SnmpTrapNotification.TrapServerIdentity	String	Trap server identifier.
SnmpTrapNotification.TrapV3User	String	SNMPv3 user.
SnmpTrapNotification.TrapVersion	String	SNMP trap version.
SnmpV1Enabled	Boolean	Enabling status of SNMPv1.
SnmpV2CEnabled	Boolean	Enabling status of SNMPv2c.
SnmpV3AuthProtocol	String	SNMPv3 authentication algorithm. Supported options: · sha. · md5.
SnmpV3Enabled	Boolean	Enabling status of SNMPv3.
SnmpV3PrivProtocol	String	SNMPv3 encryption algorithm. Supported options: · des. · aes.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.33	Expanded the server support to eight trap servers.
HDM-2.10.00	Replaced the Critical option for the AlarmSeverity field with Major+Critical.
HDM-1.30.12	Changed supported option ALL of the AlarmSeverity field to All.
HDM-1.30.11P01	Changed the supported options of the AlarmSeverity field to Critical, Minor+Major+Critical, and All.
HDM-1.30.11	Added the SnmpTrapNotification.TrapMode field.
HDM-1.30.10	Changed the supported options of the AlarmSeverity field to Critical, Major+Critical, and ALL.
HDM-1.30.09	Changed the data type for the TrapServer.TrapServerPort field from string to integer.
HDM-1.30.06	· Added the redfish/v1/Managers/manager_id/SnmpService interface. · Added the AlarmSeverity field. · Added support for four trap servers.
HDM-1.12.05	Deleted the redfish/v1/Managers/manager_id/SnmpService interface.

Configure SNMP settings

Description

Configure SNMP settings from the server. Before configuring SNMPv3 user settings, make sure SNMP extended privileges are enabled for the corresponding users.

Privilege module

Basic configuration

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Managers/manager_id/SnmpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"SnmpV1Enabled":false,

"SnmpV2CEnabled":true,

"LongPasswordEnabled":false,

"ReadOnlyCommunity":readonlycommunity,

"ReadWriteCommunity":readwritecommunity,

"CommunityName":communityname,

"ServiceEnabled":true,

"TrapVersion":"v3",

"TrapV3User":username,

"AlarmSeverity": alarmseverity,

"TrapMode": trapmode,

"TrapServer":

[

{

"MemberId":"1",

"Enabled":true,

"TrapServerPort":TrapServer1_portnumber,

"TrapServerAddress": TrapServer1_address

}

]

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
SnmpV1Enabled	Enable or disable SNMPv1.	Boolean.
SnmpV2CEnabled	Enable or disable SNMPv2.	Boolean.
LongPasswordEnabled	Enable or disable the long community string feature.	Boolean.
ReadOnlyCommunity	Read-only community name.	String. An empty string indicates that the read-only community has been deleted.
ReadWriteCommunity	Read/write community name.	String. An empty string indicates that the read/write community has been deleted.
CommunityName	Trap community name.	String, up to 31 characters.
ServiceEnabled	Enable or disable the SNMP trap service.	String.
TrapVersion	SNMP trap version.	String. Supported options: · v1. · v2c. · v3. When SNMPv3 3 is used, the CommunityName field is not required.
TrapV3User	SNMPv3 user.	String.
AlarmSeverity	Severity level.	String. Supported options: · Major+Critical. · Minor+Major+Critical. · All.
TrapMode	Trap mode.	String. Supported options: · NodeMode. · EventMode.
TrapServer	Trap server properties. When SNMPv3 is used, you must configure the TrapV3User option.
TrapServer.MemberId	Trap server ID.	String. The trap server ID range is 1 to 8.
TrapServer.Enabled	Enable or disable the SNMP trap server.	Boolean.
TrapServer.TrapServerPort	Trap server port number.	Integer.
TrapServer.TrapServerAddress	Trap server address.	String. IPv4 or IPv6 address.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Managers/1/SnmpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"SnmpV1Enabled":false,

"SnmpV2CEnabled":true,

"LongPasswordEnabled":false,

"ReadOnlyCommunity":"rocommstr",

"ReadWriteCommunity":"rwcommstr",

"CommunityName":"public",

"ServiceEnabled":true,

"TrapVersion":"v1",

"TrapV3User":"admin",

"AlarmSeverity": "Major+Critical",

"TrapMode":"EventMode",

"TrapServer":

[

{

"MemberId":"1",

"Enabled":true,

"TrapServerPort": TrapServer1_portnumber,

"TrapServerAddress": TrapServer1_address

}

]

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#SnmpService.SnmpService(SnmpV3PrivProtocol,Id,ReadOnlyCommunity,Name,SnmpV3Enabled,LongPasswordEnabled,ReadWriteCommunity,SnmpV2CEnabled,SnmpV3AuthProtocol,SnmpV1Enabled,SnmpTrapNotification,Description)",

"@odata.id": "/redfish/v1/Managers/1/SnmpService",

"@odata.type": "#SnmpService.v1_0_0.SnmpService",

"Actions": {

"#SnmpService.SubmitTestEvent": {

"target": "/redfish/v1/Managers/1/SnmpService/Actions/SnmpService.SubmitTestEvent"

}

"Description": "SnmpService Gettings",

"Id": "SnmpService",

"LongPasswordEnabled": false,

"Name": "SNMP",

"ReadOnlyCommunity": "rocommstr",

"ReadWriteCommunity": "rwcommstr",

"SnmpTrapNotification": {

"AlarmSeverity": "Major+Critical",

"CommunityName": "public",

"ServiceEnabled": true,

"TrapMode":"EventMode",

"TrapServer": [

{

"Enabled": false,

"MemberId": "1",

"TrapServerAddress": "192.168.11.11",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "2",

"TrapServerAddress": "192.168.11.22",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "3",

"TrapServerAddress": "192.168.11.33",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "4",

"TrapServerAddress": "192.168.11.44",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "5",

"TrapServerAddress": "192.168.11.55",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "6",

"TrapServerAddress": "192.168.11.66",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "7",

"TrapServerAddress": "192.168.11.77",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "8",

"TrapServerAddress": "192.168.11.88",

"TrapServerPort": 163

}

"TrapServerIdentity": "HDM12345678912345678900",

"TrapV3User": "",

"TrapVersion": "v1"

"SnmpV1Enabled": false,

"SnmpV2CEnabled": true,

"SnmpV3AuthProtocol": "",

"SnmpV3Enabled": false,

"SnmpV3PrivProtocol": ""

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.52	Removed the CommunityName field when SNMPv3 is used.
HDM-2.33	Expanded the server support to eight trap servers.
HDM-2.25	Included the support of the ReadOnlyCommunity and ReadWriteCommunity fields for empty strings.
HDM-2.10.00	Replaced the Critical option for the AlarmSeverity field with Major+Critical.
HDM-1.30.11P01	Changed the supported options of the AlarmSeverity field to Critical, Minor+Major+Critical, and All.
HDM-1.30.11	Added the SnmpTrapNotification.TrapMode field.
HDM-1.30.10	Changed the supported options of the AlarmSeverity field to Critical, Major+Critical, and All.
HDM-1.30.09	· Added support of IPv6 addresses for the TrapServer.TrapServerAddress field. · Added the response.
HDM-1.30.06	· Added the redfish/v1/Managers/manager_id/SnmpService interface. · Added the AlarmSeverity field. · Added the TrapServerPort field as one of trap server properties. · Added support for four trap servers.
HDM-1.12.05	Deleted the redfish/v1/Managers/manager_id/SnmpService interface.

Perform SNMP trap testing

Description

Perform SNMP trap testing on the server.

Privilege module

Basic configuration

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/SnmpService/Actions/SnmpService.SubmitTestEvent

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"MemberId": "id"

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
MemberId	Trap member ID.	String. The trap member ID range is 1 to 8.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Managers/1/SnmpService/Actions/SnmpService.SubmitTestEvent

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"MemberId":"1" --

}

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@Message.ExtendedInfo": {

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageArgs": "[]",

"MessageId": "Base.1.0.Success",

"RelatedProperties": "[]",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

Response code: 200

Response field description

Field	Data type	Description
code	String	String indicating a specific message ID in the message registry.
message	String	Error message corresponding to a message in the message registry.
@odata.type	String	OData description of the message resource.
@Message.ExtendedInfo	String	Extended information of the error message.
MessageId	String	Message ID.
RelatedProperties	Array	Related properties for the message.
Message	String	Details of the message.
MessageArgs	Array	Message arguments.
Severity	String	Severity level. Supported options: · OK. · Warning. · Critical.
Resolution	String	Recommended actions for the error.

Change history

Version	Change description
HDM-2.33	Expanded the support to eight trap servers.
HDM-1.30.09	Added the response.
HDM-1.30.06	· Added the redfish/v1/Managers/manager_id/SnmpService interface. · Added the MemberId field.
HDM-1.12.05	Deleted the redfish/v1/Managers/manager_id/SnmpService interface.

Obtain SMTP information

Description

Obtain SMTP information from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/SmtpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Usage guidelines

Non-administrator users can obtain only their own recipient addresses.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/SmtpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#SmtpService.SmtpService(AnonymousLoginEnabled,ServerPort,Name,ServiceEnabled,Id,RecipientAddresses,TLSEnabled,SenderAddress,Description,AlarmSeverity,Actions,ServerAddress)",

"@odata.id": "/redfish/v1/Managers/1/SmtpService",

"@odata.type": "#SmtpService.v1_0_0.SmtpService",

"Actions": {

"#SmtpService.SubmitTestEvent": {

"target": "/redfish/v1/Managers/1/SmtpService/Actions/SmtpService.SubmitTestEvent"

}

"AlarmSeverity": "Critical",

"AnonymousLoginEnabled": true,

"Description": "Smtpservice Gettings",

"Id": "Smtp",

"Name": "Smtp",

"RecipientAddresses": [

{

"EmailAddress": "",

"Enabled": false,

"MemberId": "1"

{

"EmailAddress": "",

"Enabled": false,

"MemberId": "9"

…

"SenderAddress": "",

"ServerAddress": "",

"ServerPort": 25,

"ServiceEnabled": true,

"TLSEnabled": false

}

Response field description

Field	Data type	Description
@odata.context	String	OData description of the SMTP information resource model.
@odata.id	String	Link to the SMTP information resource.
@odata.type	String	Type of the SMTP information resource.
Actions	Available operations for the SMTP resource.
SmtpService.SubmitTestEvent	Object	Link to SNMP notification testing.
AlarmSeverity	String	Severity level. Supported options: · Critical. · Major+Critical. · Minor+Major+Critical. · All.
AnonymousLoginEnabled	Boolean	Enabling status of anonymous login.
SenderAddress	String	Sender email address.
ServerAddress	String	Server address.
ServerPort	Integer	Server port.
ServiceEnabled	Boolean	Enabling status of the SMTP service.
TLSEnabled	Boolean	Enabling status of TLS.
RecipientAddresses.EmailAddress	String	Recipient email address.
RecipientAddresses.Enabled	Boolean	Enabling status of a recipient.
RecipientAddresses.MemberId	String	ID of a recipient.

Change history

Version	Change description
HDM-3.30	Added Major+Critical as an option to the AlarmSeverity field.
HDM-1.30.12	Changed option ALL of the AlarmSeverity field to All.
HDM-1.30.11P01	Changed the supported options of the AlarmSeverity field to Critical, Minor+Major+Critical, and All.
HDM-1.30.10	Changed the supported options of the AlarmSeverity field to Critical, Major+Critical, and ALL.
HDM-1.30.09	Changed the supported options of the AlarmSeverity field to Critical, Warning+Critical, and ALL.
HDM-1.30.08	Added the AlarmSeverity field.

Configure SMTP settings

Description

Configure SMTP settings from the server.

Privilege module

Basic configuration

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Managers/manager_id/SmtpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"ServiceEnabled":true,

"ServerAddress":serveraddress,

"ServerPort":portnumber,

"TLSEnabled":false,

"AnonymousLoginEnabled":false,

"SenderUserName":username,

"SenderPassword":password,

"SenderAddress":senderaddress

"AlarmSeverity": AlarmSeverity_value,

"RecipientAddresses":[

{

"MemberId":"15",

"Enabled":false,

"UserName":"admin",

"Description":"1"

}

]

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
ServiceEnabled	Enable or disable the SMTP service.	Boolean.
ServerAddress	Server address.	String.
ServerPort	Server port.	Integer.
TLSEnabled	Enable or disable TLS.	Boolean.
AnonymousLoginEnabled	Enable or disable anonymous login.	Boolean.
SenderUserName	Sender username.	String.
SenderPassword	Sender password.	String.
SenderAddress	Sender address.	String.
AlarmSeverity	Severity level.	String. Supported options: · Critical. · Major+Critical. · Minor+Major+Critical. · All.
RecipientAddresses	Recipient address properties.
RecipientAddresses.MemberId	Member ID.	String. Value range: 1 to 15.
RecipientAddresses.Enabled	Enable or disable a recipient.	Boolean.
RecipientAddresses.UserName	Username.	String.
RecipientAddresses.Description	Email subject.	String.

Usage guidelines

To avoid configuration errors, the fields in the request body must be all configured.

Non-administrator users can configure only their own recipient addresses.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Managers/1/SmtpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"ServiceEnabled":true,

"ServerAddress":"192.168.1.3",

"ServerPort":26,

"TLSEnabled":false,

"AnonymousLoginEnabled":false,

"SenderUserName":"Public",

"SenderPassword":"public@123",

"SenderAddress":"[email protected]",

"AlarmSeverity": "Critical",

"RecipientAddresses":[

{

"MemberId":"15",

"Enabled":false,

"UserName":"admin",

"Description":"1"

{

"MemberId":"1",

"Enabled":false,

"UserName":"admin",

"Description":"2"

…

]

}

Response:

{

"@odata.id": "/redfish/v1/Managers/1/SmtpService",

"@odata.type": "#SmtpService.v1_0_0.SmtpService",

"Actions": {

"#SmtpService.SubmitTestEvent": {

"target": "/redfish/v1/Managers/1/SmtpService/Actions/SmtpService.SubmitTestEvent"

}

"AlarmSeverity": "Critical",

"AnonymousLoginEnabled": false,

"Description": "Smtpservice Gettings",

"Id": "Smtp",

"Name": "Smtp",

"RecipientAddresses": [

{

"EmailAddress": "",

"Enabled": false,

"MemberId": "1"

{

"EmailAddress": "",

"Enabled": false,

"MemberId": "2"

…

"SenderAddress": "[email protected]",

"SenderPassword": "null",

"SenderUserName": "Public",

"ServerAddress": "192.168.1.3",

"ServerPort": 26,

"ServiceEnabled": true,

"TLSEnabled": false

}

Response field description

For information about the response fields, see "Obtain SMTP information."

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-3.30	Added Major+Critical as an option to the AlarmSeverity field.
HDM-2.17.00	Added the restriction that non-administrator users can configure only their own recipient addresses.
HDM-1.30.12	Changed the data type for the MemberId field from integer to string.
HDM-1.30.11P01	Changed the supported options of the AlarmSeverity field to Critical, Minor+Major+Critical, and All.
HDM-1.30.10	· Changed the supported options of the AlarmSeverity field to Critical, Major+Critical, and All. · Added the MemberId, Enabled, UserName, and Description fields.
HDM-1.30.09	Changed the supported options of the AlarmSeverity field to Critical, Warning+Critical, and All.
HDM-1.30.08	Added the AlarmSeverity field.

Perform SMTP testing

Description

Perform SMTP testing on the server.

Privilege module

Basic configuration

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/SmtpService/Actions/SmtpService.SubmitTestEvent

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"MemberId": "id"

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
MemberId	Recipient ID.	String.

Usage guidelines

Non-administrator users can perform SMTP testing by using their own email address.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Managers/1/SmtpService/Actions/SmtpService.SubmitTestEvent

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"MemberId": "1"

}

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

Response code: 200

Response field description

Field	Data type	Description
@odata.type	String	OData description of the message resource.
@Message.ExtendedInfo.Message	String	Detailed information in ExtendedInfo.
MessageId	String	Message ID.
Resolution	String	Recommended actions for the error.
Severity	String	Severity level. Supported options: · OK. · Warning. · Critical.
code	String	String indicating a specific message ID in the message registry.
message	String	Details of the message.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-6.02	Corrected the spelling of the @Message.ExtendedInfo.Message field.
HDM-2.17.00	Added the restriction that non-administrator users can perfrom SMTP testing only by using their own email address.
HDM-1.30.09	· Changed the status code for a successful operation to 200. · Added the response.

Obtain syslog information

Description

Obtain syslog information from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/SyslogService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/SyslogService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#SyslogService.SyslogService(*)",

"@odata.id": "/redfish/v1/Managers/1/SyslogService",

"@odata.type": "#HwSyslogService.v1_0_0.HwSyslogService",

"Actions": {

"#SyslogService.ImportClientCertificate": {

"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportClientCertificateActionInfo",

"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportClientCertificate"

"#SyslogService.ImportPrivateKeyCertificate": {

"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportPrivateKeyCertificateActionInfo",

"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportPrivateKeyCertificate"

"#SyslogService.ImportRootCertificate": {

"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportRootCertificateActionInfo",

"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportRootCertificate"

}

"#SyslogService.SubmitTestEvent": {

"target":"/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent",

"@Redfish.ActionInfo":"/redfish/v1/Managers/1/SyslogService/SubmitTestEventActionInfo"

}

"AlarmSeverity": "Normal",

"AuthenticateMode": "TwoWay",

"Id": "SyslogService",

"Name": "Syslog Service",

"ServerIdentitySource": "HostName",

"MessageFormat":"Custom",

"ServiceEnabled": true,

"SyslogServers": [

{

"Address": "10.99.205.123",

"Enabled": true,

"LogType": [

"OperationLog"

"MemberId": "1",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"LogType": [],

"MemberId": "2",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"LogType": [],

"MemberId": "3",

"Port": 514

{

"Address": "10.0.0.1",

"Enabled": true,

"LogType": [

"OperationLog",

"EventLog",

"SecurityLog"

"MemberId": "4",

"Port": 514

{

"Address": "192.168.10.51",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "5",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"MemberId": "6",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"MemberId": "7",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"MemberId": "8",

"Port": 514

}

"TransmissionProtocol": "UDP"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the syslog information resource model.
@odata.id	String	Link to the syslog information resource.
@odata.type	String	Type of the syslog information resource.
ServiceEnabled	Boolean	Enabling status of the syslog service.
AlarmSeverity	String	Severity of the log events. Supported option: · Normal.
TransmissionProtocol	String	Protocol used for syslog message transmission. Supported options: · UDP. · TCP. · TLS.
MessageFormat	String	SYSLOG packet format. Supported options: · Custom. · RFC3164. · RFC5424.
AuthenticateMode	String	Authentication mode. Supported options: · OneWay. · TwoWay.
ServerIdentitySource	String	Syslog server identifier. Supported options: · HostName. · BoardSN—SN of the system board. · ProductAssetTag. · ProductSN.
SyslogServers.Address	String	Syslog server address.
SyslogServers.Enabled	String	Enabling status of the syslog server.
SyslogServers.MemberId	String	Member ID of the syslog server. The member ID range is 1 to 8.
SyslogServers.Port	Integer	Syslog server port.
SyslogServers.LogType	Array	Log type. Supported options: · OperationLog. · EventLog. · SecurityLog.
Actions	Actions on the syslog information resource.
SyslogService.ImportRootCertificate	Object	Import the syslog root certificate.
target	String	Operation link.
Redfish.ActionInfo	String	Link to obtain action information.
SyslogService.ImportClientCertificate	Object	Import the syslog local certificate.
SyslogService.SubmitTestEvent	Object	Send test events.

Change history

Version	Change description
HDM-6.03	Added the MessageFormat field to Syslog.
HDM-3.35	Added the SyslogService.SubmitTestEvent field.
HDM-2.75	Added ProductSN as an option to the ServerIdentitySource field.
HDM-2.33	Expanded the server support to eight syslog servers.
HDM-2.11.92	Added the @odata.type field.
HDM-1.30.18P5X HDM-2.0.03	· Deleted ProductSN from the ServerIdentitySource field and added BoardSN as an option. · Added TLS as an option to the TransmissionProtocol field. · Added the AuthenticateMode and Actions fields. NOTE: The changes take effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.11	Changed the supported options of the ServerIdentitySource field to HostName, ProductSN, and ProductAssetTag.
HDM-1.30.10	Changed the supported options of the ServerIdentitySource field to Host name, Product Serial number, and Asset tag.
HDM-1.30.09	Restored the redfish/v1/Managers/manager_id/SyslogService interface for new syslog requirements. Modifications were made to the interface and hardware and software compatibility must be re-configured.
HDM-1.30.08	Disabled the redfish/v1/Managers/manager_id/SyslogService interface.

Configure syslog settings

Description

Configure syslog settings form the server.

Privilege module

Basic configuration

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Managers/manager_id/SyslogService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"ServerIdentitySource": "HostName",

"ServiceEnabled": true,

"SyslogServers": [

{

"Address": "192.168.10.11",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "1",

"Port": 514

}

"TransmissionProtocol": "UDP"

"MessageFormat": "Custom"

}

Response code: 200

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
ServiceEnabled	Enable or disable the syslog service.	Boolean.
TransmissionProtocol	Protocol used for syslog message transmission.	String. Supported options: · UDP. · TCP. · TLS.
MessageFormat	SYSLOG packet format.	String. Supported options: · Custom. · RFC3164. · RFC5424. The default format is Custom.
AuthenticateMode	Authentication mode.	String. Supported options: · OneWay. · TwoWay.
ServerIdentitySource	Syslog server identifier.	String. Supported options: · HostName. · BoardSN. · ProductAssetTag. · ProductSN.
SyslogServers.Address	Syslog server address.	String.
SyslogServers.Enabled	Enable or disable the syslog server.	Boolean.
SyslogServers.MemberId	Member ID of the syslog server.	String. The member ID range is 1 to 8.
SyslogServers.Port	Syslog server port.	Integer.
SyslogServers.LogType	Log type.	Array. Supported options: · OperationLog. · EventLog. · SecurityLog.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Managers/1/SyslogService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"ServerIdentitySource": "HostName",

"ServiceEnabled": true,

"SyslogServers": [

{

"Address": "192.168.10.11",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "1",

"Port": 514

}

"TransmissionProtocol": "UDP"

"MessageFormat": "Custom"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/SyslogService",

"@odata.type": "#SyslogService.v1_0_0.SyslogService",

"Id": "SyslogService",

"Name": "Syslog Service",

"Actions": {

"#SyslogService.ImportClientCertificate": {

"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportClientCertificateActionInfo",

"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportClientCertificate"

"#SyslogService.ImportPrivateKeyCertificate": {

"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportPrivateKeyCertificateActionInfo",

"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportPrivateKeyCertificate"

"#SyslogService.ImportRootCertificate": {

"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportRootCertificateActionInfo",

"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportRootCertificate"

}

"ServerIdentitySource": "HostName",

"ServiceEnabled": true,

"SyslogServers": [

{

"Address": "192.168.10.11",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "1",

"Port": 514

{

"Address": "192.168.10.22",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "2",

"Port": 514

{

"Address": "192.168.10.33",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "3",

"Port": 514

{

"Address": "192.168.10.44",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "4",

"Port": 514

{

"Address": "192.168.10.51",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "5",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"MemberId": "6",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"MemberId": "7",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"MemberId": "8",

"Port": 514

}

"TransmissionProtocol": "UDP"

"MessageFormat": "Custom"

}

Response code: 200

Change history

Version	Change description
HDM-6.03	Added the MessageFormat field to Syslog. By default, the message format is Custom.
HDM-2.75	Added ProductSN as an option to the ServerIdentitySource field.
HDM-2.33	Expanded the server support to eight syslog servers.
HDM-1.30.18P5X HDM-2.0.03	· Deleted ProductSN from the ServerIdentitySource field and added BoardSN as an option. · Added TLS as an option to the TransmissionProtocol field. · Added the AuthenticateMode and Actions fields. NOTE: The changes take effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.11	Changed the supported options of the ServerIdentitySource field to HostName, ProductSN, and ProductAssetTag.
HDM-1.30.10	Changed the supported options of the ServerIdentitySource field to Host name, Product Serial number, and Asset tag.
HDM-1.30.09	Restored the redfish/v1/Managers/manager_id/SyslogService interface for new syslog requirements. Modifications were made to the interface and hardware and software compatibility must be re-configured.
HDM-1.30.08	Disabled the redfish/v1/Managers/manager_id/SyslogService interface.

Use SYSLOG to send test events

Description

Send test events.

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.SubmitTestEvent

Request header:

X-Auth-Token: auth_value

Content-Type: header_type

Request body:

{

"MemberId":value

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
manager_id	Manager ID.	For rack servers, this field is fixed to 1. For high-density servers, this field is BladeN, where N represents the node slot number, for example, Blade0. For blade servers, this field is BladeN (where N represents the compute node slot number) or SwiN (where N represents the switch module slot number), for example, Swi0.
auth_value	Authentication parameter value in the request message.	The parameter value is generated when a session is created by using /redfish/v1/SessionService/Sessions.
header_type	Supported message format.	Options include: · application/json · application/json;charset=utf-8
value	Number.	Integer in the range of 0 to 3.

Usage guidelines

None.

Examples

Method and URL:

Request header:

X-Auth-Token: 6599174c38c36838737d9749179e1ee1

Content-Type: application/json

Request body:

{

"MemberId":"0"

}

Response:

{

"error": {

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information.",

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"MessageId": "Base.1.0.Success",

"RelatedProperties": [],

"Message": "Successfully Completed Request",

"MessageArgs": [],

"Severity": "OK",

"Resolution": "None"

}

]

}

Response code: 200

Response field description

Field	Data type	Description
code	String	String for a specific message ID in the message registry.
message	String	Human-readable error message corresponding to the message in the message registry.
@odata.type	String	OData description for the message resource.
MessageId	String	Message ID.
RelatedProperties	Array	Message related properties.
Message	String	Detailed information.
MessageArgs	Array	Message arguments.
Severity	String	Severity. Supported options: · OK. · Warning. · Critical.
Resolution	String	Recommended actions.

Change history

Version	Change description
HDM-3.35	Added the interface.

Import the syslog root certificate

Description

Import the syslog root certificate.

Privilege module

Security

Request

POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.ImportRootCertificate

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Type":type,

"Content":value

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
type	Content type.	Type of the content in the value field. Supported options: · text—Certificate content. · URI—Local or remote certificate URI.
value	Content.	Content or URI of the certificate. Only SFTP is supported for file transmission. Make sure the specified content matches the content type.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportRootCertificate

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Type": "URI",

"Content":"sftp://y17057:[email protected]/cacert.pem"

}

Response:

{

"error": {

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information.",

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"MessageId": "Base.1.0.CertImportOKNone",

"RelatedProperties": "[]",

"Message": "The certificate has been imported successfully.",

"MessageArgs": "[]",

"Severity": "OK",

"Resolution": "None"

}

]

}

Response code: 200

Response field description

Field	Data type	Description
code	String	Message ID in the message registry.
message	String	Simplified error description for the message in the message registry.
@odata.type	String	Type of the message resource.
MessageId	String	Message ID.
RelatedProperties	Array	Message related properties.
Message	String	Message details.
MessageArgs	Array	Message arguments.
Severity	String	Message severity level. Supported options: · OK. · Warning. · Critical.
Resolution	String	Recommended solutions.

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-1.30.18P5X

HDM-2.0.03

Added the redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.ImportRootCertificate interface.

NOTE:

This interface is available only in HDM-1.30.18P5X and HDM-2.0.03 versions.

Import a local certificate

Description

Import a syslog local certificate.

Privilege module

Security

Request

POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.ImportClientCertificate

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Type":type,

"Content":value

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
type	Content type.	Type of the content in the value field. Supported options: · text—Certificate content. · URI—Local or remote certificate URI.
value	Content.	Content or URI of the certificate. Only SFTP is supported for file transmission. Make sure the specified content matches the content type.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportClientCertificate

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Type": "URI",

"Content":"sftp://y17057:[email protected]/cert.pem"

}

Response:

{

"error": {

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information.",

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"MessageId": "Base.1.0.CertImportOKNone",

"RelatedProperties": "[]",

"Message": "The certificate has been imported successfully.",

"MessageArgs": "[]",

"Severity": "OK",

"Resolution": "None"

}

]

}

Response code: 200

Response field description

Field	Data type	Description
code	String	Message ID in the message registry.
message	String	Simplified error description for the message in the message registry.
@odata.type	String	Type of the message resource.
MessageId	String	Message ID.
RelatedProperties	Array	Message related properties.
Message	String	Message details.
MessageArgs	Array	Message arguments.
Severity	String	Message severity level. Supported options: · OK. · Warning. · Critical.
Resolution	String	Recommended solutions.

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-1.30.18P5X

HDM-2.0.03

Added the redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.ImportClientCertificate interface.

NOTE:

This interface is available only in HDM-1.30.18P5X and HDM-2.0.03 versions.

Import a private key certificate

Description

Import a private key certificate.

Privilege module

Security

Request

POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.ImportPrivateKeyCertificate

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Type":type,

"Content":value

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
type	Content type.	Type of the content in the value field. Supported options: · text—Certificate content. · URI—Local or remote certificate URI.
value	Content.	Content or URI of the certificate. Only SFTP is supported for file transmission. Make sure the specified content matches the content type.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportPrivateKeyCertificate

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Type": "URI",

"Content":"sftp://y17057:[email protected]/key.pem"

}

Response:

{

"error": {

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information.",

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"MessageId": "Base.1.0.CertImportOKNone",

"RelatedProperties": "[]",

"Message": "The certificate has been imported successfully.",

"MessageArgs": "[]",

"Severity": "OK",

"Resolution": "None"

}

]

}

Response code: 200

Response field description

Field	Data type	Description
code	String	Message ID in the message registry.
message	String	Simplified error description for the message in the message registry.
@odata.type	String	Type of the message resource.
MessageId	String	Message ID.
RelatedProperties	Array	Message related properties.
Message	String	Message details.
MessageArgs	Array	Message arguments.
Severity	String	Message severity level. Supported options: · OK. · Warning. · Critical.
Resolution	String	Recommended solutions.

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-1.30.18P5X

HDM-2.0.03

Added the redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.ImportPrivateKeyCertificate.

NOTE:

This interface is available only in HDM-1.30.18P5X and HDM-2.0.03 versions.

Obtain service information

Description

Obtain information (including port number and enabling status) about HTTPS, IPMI, KVM, SNMP, SSH, virtual media, Remote_XDP, iHDT, and VNC services.

Privilege module

Information query

Request

GET https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#ManagerNetworkProtocol.ManagerNetworkProtocol",

"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol",

"@odata.type": "#ManagerNetworkProtocol.v1_2_0.ManagerNetworkProtocol",

"CD-Media": {

"Port": 5120,

"ProtocolEnabled": true

"Description": "Network Protocol Details",

"FQDN": "HDM638889.h3c.com",

"FD-Media": {

"Port": 5122,

"ProtocolEnabled": true

"HTTP": {

"Port": 80,

"ProtocolEnabled": true

"HTTPS": {

"Port": 443,

"ProtocolEnabled": true

"HD-Media": {

"Port": 5123,

"ProtocolEnabled": true

"HostName": "HDM638889",

"IPMI": {

"Port": 623,

"ProtocolEnabled": true

"Id": "NetworkProtocol",

"KVMIP": {

"Port": 7578,

"ProtocolEnabled": true

"Name": "Manager Network Protocol",

"Remote-Xdp": {

"Port": 6868,

"ProtocolEnabled": false

"SNMP": {

"Port": 161,

"ProtocolEnabled": true

"SSH": {

"Port": 22,

"ProtocolEnabled": true

"Status": {

"Health": "OK",

"State": "Enabled"

"Telnet": {

"Port": 23,

"ProtocolEnabled": false

"VNC": {

"Port": 5900,

"ProtocolEnabled": false

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the syslog information resource model.
@odata.id	String	Link to the syslog information resource.
@odata.type	String	Type of the syslog information resource.
Description	String	Description of the syslog information resource.
HTTPS.Port	Integer	HTTPS service port number. (Secure Web service port number.)
HTTPS.ProtocolEnabled	Boolean	Enabling status of the HTTPS service.
HTTP.Port	Integer	HTTP service port number. (Insecure Web service port number.)
HTTP.ProtocolEnabled	Boolean	Enabling status of the HTTP service.
IPMI.Port	Integer	Insecure IPMI service port number.
IPMI.ProtocolEnabled	Boolean	Enabling status of the IPMI service.
KVMIP.Port	Integer	Insecure KVM service port number.
KVMIP.ProtocolEnabled	Boolean	Enabling status of the KVM service
Remote-Xdp.Port or iHDT.Port	Integer	Insecure XDP service port or insecure iHDT service port. This field displays Remote-Xdp for Intel servers and iHDT for G5 AMD servers.
Remote-Xdp.ProtocolEnabled or iHDT. ProtocolEnabled	Boolean	Enabling status of the XDP service or the iHDT service. This field displays Remote-Xdp for Intel servers and iHDT for G5 AMD servers.
SNMP.Port	Integer	Insecure SNMP service port number.
SNMP.ProtocolEnabled	Boolean	Enabling status of the SNMP service.
SSH.Port	Integer	Secure SSH service port number.
SSH.ProtocolEnabled	Boolean	Enabling status of the SSH service.
FD-Media.Port	Integer	Insecure FD media service port number.
FD-Media.ProtocolEnabled	Boolean	Enabling status of the FD media service.
CD-Media.Port	Integer	Insecure CD media service port number.
CD-Media.ProtocolEnabled	Boolean	Enabling status of the CD media service.
HD-Media.Port	Integer	Insecure HD media service port number.
HD-Media.ProtocolEnabled	Boolean	Enabling status of the HD media service.
Telnet Port	Integer	Insecure Telnet service port number.
Telnet.ProtocolEnabled	Boolean	Enabling status of the Telnet media service.
VNC.Port	Integer	Insecure VNC service port number.
VNC.ProtocolEnabled	Boolean	Enabling status of the VNC media service.
HostName	String	Host name.
FQDN	String	Fully qualified domain name for HDM.
Id	String	Service ID.
Name	String	Name of the service collection resource.
Status.Health	String	Resource health status.
Status.State	String	Resource enabling status.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.19	Added the support for iHDT service.
HDM-1.30.14	Indicated that the IPMI.Port field refers to an insecure service port.
HDM-1.30.11	Deleted Solssh service information.
HDM-1.30.10	Changed the Cd-Media, Fd-Media, Hd-Media to CD-Media, FD-Media, and HD-Media, respectively.
HDM-1.30.09	Added fields about HTTP, Remote, Solssh, Fd-Media, Cd-Media, Hd-Media, Telnet, VNC, and FQDN information.

Configure service settings

Description

Specify the port number or set the enabling status for the HTTPS, IPMI, KVM, SNMP, SSH, virtual media, Remote_XDP, iHDT, and VNC services.

Privilege module

Security

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"ServerType": {

"Port": portid,

"ProtocolEnabled": state

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
ServerType	Type of the service to be set.	Supported options: · IPMI. · KVMIP. · SNMP. · SSH. · CD-Media. · VNC. · Remote_XDP or iHDT.
ServerType.Port	Service port number.	Integer. For more information, see "Obtain service information."
ServerType.ProtocolEnabled	Enable or disable the service.	Boolean. Supported options: · true—Enable. · false—Disable.

Usage guidelines

You can configure the settings only for one service at a time.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"SSH": {

"Port": 123,

"ProtocolEnabled": true

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#ManagerNetworkProtocol.ManagerNetworkProtocol",

"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol",

"@odata.type": "#ManagerNetworkProtocol.v1_2_0.ManagerNetworkProtocol",

"CD-Media": {

"Port": 777,

"ProtocolEnabled": true

"Description": "Network Protocol Details",

"FD-Media": {

"Port": 5122,

"ProtocolEnabled": true

"FQDN": "HDM22222A45B0B004.h3c.com",

"HD-Media": {

"Port": 5123,

"ProtocolEnabled": true

"HTTP": {

"Port": 80,

"ProtocolEnabled": true

"HTTPS": {

"Port": 443,

"ProtocolEnabled": true

"HostName": "HDM22222A45B0B004",

"IPMI": {

"Port": 664,

"ProtocolEnabled": true

"Id": "NetworkProtocol",

"KVMIP": {

"Port": 7578,

"ProtocolEnabled": true

"Name": "Manager Network Protocol",

"Remote-Xdp": {

"Port": 6868,

"ProtocolEnabled": false

"SNMP": {

"Port": 161,

"ProtocolEnabled": true

"SSH": {

"Port": 123,

"ProtocolEnabled": true

"Solssh": {

"Port": 52123,

"ProtocolEnabled": false

"Status": {

"Health": "OK",

"State": "Enabled"

"Telnet": {

"Port": 23,

"ProtocolEnabled": false

"VNC": {

"Port": 5900,

"ProtocolEnabled": true

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.27	Added the support for the iHDT service.
HDM-2.19	Added the support for the Remote_XDP service.
HDM-1.30.14	Indicated that the IPMI port field refers to an insecure service port.
HDM-1.30.10	Changed the VirtualMedia field to CD-Media.

Restart HDM

Description

Restart HDM for the server.

Privilege module

Maintenance

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Manager.Reset

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"ResetType":type

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ResetType	HDM restart method.	String. Options include: · ForceRestart.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Manager.Reset

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"ResetType":"ForceRestart"

}

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

Response code: 200

Response field description

Field	Data type	Description
@odata.type	String	OData description of the message resource.
@Message.ExtendedInfo.Message	String	Detailed information in ExtendedInfo.
MessageId	String	Message ID.
Resolution	String	Recommended actions for the error.
Severity	String	Severity level. Supported options: · OK. · Warning. · Critical.
code	String	String indicating a specific message ID in the message registry.
message	String	Details of the message.

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-6.02

Corrected the spelling of the @Message.ExtendedInfo.Message field.

HDM-1.30.09

· Changed the status code for a successful operation to 200.

· Added the response.

Switch over between primary and backup HDM firmware images

Description

Perform a primary/backup HDM firmware image switchover.

Privilege module

Maintenance

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Manager.RollBack

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Manager.RollBack

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

}

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

Response code: 200

Response field description

Field	Data type	Description
@odata.type	String	OData description of the message resource.
@Message.ExtendedInfo.Message	String	Detailed information in ExtendedInfo.
MessageId	String	Message ID.
Resolution	String	Recommended actions for the error.
Severity	String	Severity level. Supported options: · OK. · Warning. · Critical.
code	String	String indicating a specific message ID in the message registry.
message	String	Details of the message.

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-6.02

Corrected the spelling of the @Message.ExtendedInfo.Message field.

HDM-1.30.09

· Changed the status code for a successful operation to 200.

· Added the response.

Obtain network port collection information

Description

Obtain information about all network ports from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection",

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces",

"@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection",

"Description": "Collection of Ethernet Interfaces for this Manager",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth0"

{

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth1"

}

"Name": "Ethernet Network Interface Collection",

"Oem": {

"Public": {

"PortMode": "Bonding",

"NcsiEnabled": false

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the network port collection resource.
@odata.id	String	Link to the network port collection resource.
@odata.type	String	Type of the network port collection resource.
Description	String	Description of the network port collection resource.
Members	Array	Links to network port resources.
[email protected]	Integer	Number of network ports.
Oem.Public.PortMode	String	Network port mode. Supported options: · Normal. · Bonding. · Activestandby.
Oem.Public.NcsiEnabled	Boolean	Enabling status of NCSI. Supported options: · true · false

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.52	Added the Oem.Public.NcsiEnabled field.
HDM-1.30.12	Added the Oem.Public.PortMode field.
HDM-1.30.09	Changed the display of the network port collection information.

Set the network port mode

Description

Set the network port mode for BMC.

Privilege module

Basic configuration

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"Oem":{

"Public":{

"PortMode":value

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
Oem.Public.PortMode	Network port mode.	String. Supported options: · Normal. · Bonding. · Activestandby.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"Oem":{

"Public":{

"PortMode": "Bonding"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection",

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces",

"@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection",

"Description": "Collection of Ethernet Interfaces for this Manager",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth0"

{

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth1"

}

"Name": "Ethernet Network Interface Collection",

"Oem": {

"Public": {

"PortMode": "Bonding"

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-1.30.12

· Changed the function of this feature from configuring the active/standby port mode to setting the network port mode.

· Deleted the ActiveStandbyMode field.

· Added the Oem.Public.PortMode field.

HDM-1.30.07

Added the redfish/v1/Managers/manager_id/EthernetInterfaces interface.

Obtain network port information

Description

Obtain information about a specific network port from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/networkinterface_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
networkinterface_id	ID of the network port resource.	You can obtain available network port resource IDs from network port collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces/eth1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",

"@odata.id": "/redfish/v1/Managers/manager_id/EthernetInterfaces/eth0",

"@odata.type": "#EthernetInterface.v1_4_0.EthernetInterface",

"AutoNeg": true,

"Description": "Ethernet Interface eth0",

"FQDN": "HDM638889.h3c.com",

"FullDuplex": true,

"HostName": "HDM638889",

"IPv4Addresses": [

{

"Address": "0.0.0.0",

"AddressOrigin": "DHCP",

"Gateway": "0.0.0.0",

"SubnetMask": "0.0.0.0"

}

"IPv6Addresses": [

{

"Address": "fe80::327b:acff:fec1:20ab",

"AddressOrigin": "LinkLocal",

"PrefixLength": 64

}

"IPv6DefaultGateway": "::",

"IPv6StaticAddresses": [],

"Id": "eth0",

"InterfaceEnabled": true,

"Links": {

"Oem": {

"Public": {

"EthernetInterface": {

"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces"

}

"MACAddress": "30:7B:AC:C1:20:AB",

"MTUSize": 1500,

"MaxIPv6StaticAddresses": 16,

"Name": "eth0",

"NameServers": [

"10.99.205.2"

"Oem": {

"Public": {

"IPv4Enabled": true,

"IPv6Enabled": true,

"AdaptiveFlag": false,

{

"LinkStatus": "Connected",

"Location": "PCIeSlot1"

"Type": "Dedicated"

{

"LinkStatus": "Connected",

"Location": "PCIeSlot1"

"PortNumber": 0,

"Type": "Shared"

{

"LinkStatus": "Disconnected",

"Location": "PCIeSlot1"

"PortNumber": 1,

"Type": "Shared"

{

"LinkStatus": "Disconnected",

"Location": "PCIeSlot1"

"PortNumber": 2,

"Type": "Shared"

{

"LinkStatus": "Disconnected",

"Location": "PCIeSlot1"

"PortNumber": 3,

"Type": "Shared"

}

]

}

"PermanentMACAddress": "30:7B:AC:C1:20:AB",

"SpeedMbps": 1000,

"Status": {

"Health": "OK",

"State": "Enabled"

"VLAN": {

"VLANEnable": false,

"VLANId": 0

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the network port resource model.
@odata.id	String	Link to the network port resource.
@odata.type	String	Type of the network port resource.
Description	String	Description of the network port resource.
AutoNeg	Boolean	Enabling status of auto-negotiation.
FQDN	String	Fully qualified domain name of HDM.
FullDuplex	Boolean	Enabling status of full duplex.
HostName	String	Host name.
IPv4Addresses.Address	String	IPv4 address.
IPv4Addresses.AddressOrigin	String	IPv4 protocol.
IPv4Addresses.Gateway	String	IPv4 gateway.
IPv4Addresses.SubnetMask	String	IPv4 subnet mask.
IPv6Addresses.Address	String	IPv6 address.
IPv6Addresses.AddressOrigin	String	IPv6 protocol.
IPv6Addresses.PrefixLength	Integer	IPv6 prefix length.
IPv6DefaultGateway	String	Default IPv6 gateway.
IPv6StaticAddresses	Array	Static IPv6 addresses.
Id	String	Network port ID.
Link.Oem.Public.EthernetInterface	Array	Links to network port resources.
[email protected]	Array	Port list and port information.
LinkStatus	String	Network port connection status. Supported options: · Connected. · Disconnected.
PortNumber	Integer	Shared network port number.
Type	String	Network port type. Supported options: · Dedicated. · Shared.
InterfaceEnabled	Boolean	Enabling status of the network port.
MACAddress	String	MAC address.
MTUSize	String	MTU size.
MaxIPv6StaticAddresses	String	Maximum length of a static IPv6 address.
Name	String	Name of the network port.
NameServers	Array	IP address of the DNS server.
Oem.Public.IPv4Enabled	Boolean	Enabling status of IPv4.
Oem.Public.IPv6Enabled	Boolean	Enabling status of IPv6.
Oem.Public.AdaptiveFlag	Boolean	Auto-selection status. Supported options: · true—Enabled. · false—Disabled.
PermanentMACAddress	String	Fixed MAC address.
SpeedMbps	String	Transmission speed, in Mbps.
VLAN.VLANEnable	String	Enabling status of the VLAN service.
VLAN.VLANId	Integer	VLAN ID.
Status.Health	String	Health status.
Status.State	String	Enabling of health status.
Location	String	Network adapter location. If the network adapter is on the system board, this field displays mainboard. If the network adapter is on a location other than the system board, this field displays PCIeSlot+slot.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.97	Added the Oem.Public.IPv4Enabled and Oem.Public.IPv6Enabled fields.
HDM-2.92	Added the Oem.Public.Location field.
HDM-1.30.13	Added the [email protected] fields, including the LinkStatus, PortNumber, and Type fields.
HDM-1.30.09	Added the Link.Oem.Public.EthernetInterface and IPv6StaticAddresses fields.
HDM-1.30.06	Added the Oem.Public.AdaptiveFlag field.

Configure network port settings

Description

Configure the settings of a specific network port for the server.

Privilege module

Basic configuration

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/networkinterface_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

}

"IPv4Addresses":[{

"Address":"10.10.10.10",

"SubnetMask":"255.255.255.0",

"Gateway":"10.10.10.1",

"AddressOrigin":"Static"

}],

"IPv6Addresses":[{

"Address":"2015::1",

"PrefixLength":64,

"AddressOrigin":"Static"

}],

"IPv6StticAddresses":[{

"Address":"2015::1",

"PrefixLength":64

}],

"IPv6DefaultGateway":"2015::9",

"HostName":"HDM2019",

"VLAN":{

"VLANEnable":true,

"VLANId":60

"NameServers": [

"10.10.10.254",

"10.10.10.253"

"Oem":{

"Public":{

"IPv4Enabled":true,

"IPv6Enabled":true

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
networkinterface_id	Network port resource ID	You can obtain available network port resource IDs from network port collection information.
IPv4Addresses.Address	IPv4 address.	String.
IPv4Addresses.Gateway	IPv4 gateway.	String.
IPv4Addresses.SubnetMask	IPv4 subnet mask.	String.
IPv4Addresses.AddressOrigin	IPv4 address obtaining method.	String. Supported options: · Static. · DHCP.
IPv6Addresses.Address	IPv6 address.	String.
IPv6Addresses.PrefixLength	IPv6 prefix length.	Integer.
IPv6Addresses.AddressOrigin	IPv6 address obtaining method.	String. Supported options: · Static. · DHCPv6.
IPv6StaticAddresses	Static IPv6 addresses.	Array.
IPv6DefaultGateway	Default IPv6 gateway.	String.
HostName	Host name.	String.
Vlan	VLAN ID.	Integer.
NameServers	IP address of the primary and secondary DNS servers.	Array. The primary server address is displayed first. This field is available when the HDM management network uses a dynamic address.
Oem.Public.IPv4Enabled	Enabling status of IPv4.	Boolean.
Oem.Public.IPv6Enabled	Enabling status of IPv6.	Boolean.

Usage guidelines

When the IP address obtaining method is set to DHCP or DHCPv6, you cannot configure the other network port settings.

The Oem.Public.{IPv4Enabled,IPv6Enabled} fields can be used to disable the shared ports when both fields are set to false for all the shared ports. You cannot use this method to disable the dedicated port.

Examples (1)

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces/eth0

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"IPv4Addresses":[{

"Address":"10.10.10.10",

"SubnetMask":"255.255.255.0",

"Gateway":"10.10.10.1",

"AddressOrigin":"Static"

}],

"IPv6Addresses":[{

"Address":"2015::1",

"PrefixLength":64,

"AddressOrigin":"Static"

}],

"IPv6StaticAddresses":[{

"Address":"2015::1",

"PrefixLength":64

}],

"IPv6DefaultGateway":"2015::9",

"HostName":"HDM638889",

"VLAN":{

"VLANEnable":true,

"VLANId":60

}

"NameServers": [

"10.10.10.254",

"10.10.10.253"

"Oem":{

"Public":{

"IPv4Enabled":true,

"IPv6Enabled":true

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",

"@odata.id": "/redfish/v1/Managers/manager_id/EthernetInterfaces/eth0",

"@odata.type": "#EthernetInterface.v1_4_0.EthernetInterface",

"AutoNeg": true,

"Description": "Ethernet Interface eth0",

"FQDN": "HDM638889.h3c.com",

"FullDuplex": true,

"HostName": "HDM638889",

"IPv4Addresses":[

{

"Address":"10.10.10.10",

"SubnetMask":"255.255.255.0",

"Gateway":"10.10.10.1",

"AddressOrigin":"Static"

}

"IPv6Addresses":[

{

"Address": "fe80::c636:6bff:fe3f:aa22",

"AddressOrigin": "LinkLocal",

"PrefixLength": 64

{

"Address":"2015::1",

"PrefixLength":64,

"AddressOrigin":"Static"

}

"IPv6DefaultGateway":"2015::9",

"IPv6StaticAddresses":[

{

"Address":"2015::1",

"AddressOrigin": "Static",

"PrefixLength":64

}

"Id": "eth0",

"InterfaceEnabled": true,

"Links": {

"Oem": {

"Public": {

"EthernetInterface": {

"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces"

}

"MACAddress": "30:7B:AC:C1:20:AB",

"MTUSize": 1500,

"MaxIPv6StaticAddresses": 16,

"Name": "eth0",

"NameServers": [

"10.10.10.254",

"10.10.10.253"

"Oem": {

"Public": {

"IPv4Enabled":true,

"IPv6Enabled":true,

"AdaptiveFlag": false,

{

"LinkStatus": "Connected",

"Type": "Dedicated"

{

"LinkStatus": "Connected",

"PortNumber": 0,

"Type": "Shared"

{

"LinkStatus": "Disconnected",

"PortNumber": 1,

"Type": "Shared"

{

"LinkStatus": "Disconnected",

"PortNumber": 2,

"Type": "Shared"

{

"LinkStatus": "Disconnected",

"PortNumber": 3,

"Type": "Shared"

}

]

}

"PermanentMACAddress": "30:7B:AC:C1:20:AB",

"SpeedMbps": 1000,

"Status": {

"Health": "OK",

"State": "Enabled"

"VLAN":{

"VLANEnable":true,

"VLANId":60

}

Response code: 200

Examples (2)

# Disable the shared ports.

Method and URL:

PATCH https://192.168.34.157/redfish/v1/Managers/1/EthernetInterfaces/eth0

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"Oem":{

"Public":{

"IPv4Enabled":false,

"IPv6Enabled":false

}

Response code: 200

Response:

{

"@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface(FQDN,Id,NameServers,AutoNeg,SpeedMbps,HostName,FullDuplex,Description,Status,MACAddress,Name,Oem,MaxIPv6StaticAddresses,Links,MTUSize,PermanentMACAddress,InterfaceEnabled)",

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth0",

"@odata.type": "#EthernetInterface.v1_4_0.EthernetInterface",

"FQDN": "HDM.",

"HostName": "HDM",

"Id": "eth0",

"MACAddress": "3C:22:03:01:10:49",

"MTUSize": 1500,

"MaxIPv6StaticAddresses": 16,

"Name": "Manager Ethernet Interface",

"NameServers": [

"::"

"PermanentMACAddress": "3C:22:03:01:10:49",

"SpeedMbps": 10,

"VLAN": []

}

Response field description

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-3.36	Added Examples 2 to illustrate disabling shared ports when both Oem.Public.{IPv4Enabled,IPv6Enabled} are set to false for shared ports.
HDM-2.97	Added the Oem.Public.IPv4Enabled and Oem.Public. IPv6Enabled fields.
HDM-1.30.18P5X HDM-2.0.03	Added the NameServers field. NOTE: The change takes effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.09	· Added the IPv6StaticAddresses, IPv6DefaultGateway, HostName, and Vlan fields. · Changed the status code for a successful operation to 200. · Added the response.
HDM-1.11.31	Added the AddressOrigin field.

Obtain virtual media collection information

Description

Obtain information about all virtual media from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#VirtualMediaCollection.VirtualMediaCollection",

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia",

"@odata.type": "#VirtualMediaCollection.VirtualMediaCollection",

"Description": "Collection of Virtual Media redirected to host via this Manager",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/HD"

{

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/CD"

}

"Name": "Virtual Media Collection"

}

Response code: 200

Response field description

Field	Date type	Description
@odata.context	String	OData description of the virtual media collection resource model.
@odata.id	String	Link to the virtual media collection resource.
@odata.type	String	Type of the virtual media collection resource.
Description	String	Description of the virtual media collection resource.
Name	String	Name of the virtual media collection resource.
[email protected]	Integer	Number of virtual media resources.
Members	List of virtual media resources.
@odata.id	String	Link to a virtual media resource.

The server returns status code 200 for a successful operation.

Obtain CD-Media information

Description

Obtain information about the CD-Media resource from the server.

Privilege module

Information query

Request

GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia(Name,Id)",

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/CD",

"@odata.type": "#VirtualMedia.v1_0_3.VirtualMedia",

"Connected": [

{

"ImageName": "bnx2x-1.714.18-dd-xs6.5-3.10.0+2-x86_64.iso",

"MediaIndex": "0",

"MediaTypes": "CD/DVD"

{

"ImageName": "netxtreme2-7.14.46-dd-sles11sp3-3.0.76_0.11-x86_64.iso",

"MediaIndex": "1",

"MediaTypes": "CD/DVD"

}

"Id": "CD",

"Name": "VirtualMedia",

"NotConnected": [

{

"ID": "1",

"ImageName": "netxtreme2-7.14.46-dd-sles12sp2-4.4.21_69-x86_64.iso",

"MediaTypes": "CD/DVD"

{

"ID": "3",

"ImageName": "REPO-1.11.02.iso",

"MediaTypes": "CD/DVD"

{

"ID": "2",

"ImageName": "ONEStor-Ubuntu_14.04.3.18.iso",

"MediaTypes": "CD/DVD"

}

]

}

Response code: 200

Response field description

Field	Date type	Description
@odata.context	String	OData description of the CD-Media resource model.
@odata.id	String	Link to the CD-Media resource.
@odata.type	String	Type of the CD-Media resource.
Id	String	ID of the CD-Media resource.
Name	String	Name of the CD-Media resource.
MediaTypes	String	Media image type. Supported options: · CD/DVD.
ImageName	String	Media image name.
MediaIndex	String	Media index.
Connected	String	Connected images.
NotConnected	String	Disconnected images.

The server returns status code 200 for a successful operation.

Obtain HD-Media information

Description

Obtain information about the HD-Media resource from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/HD

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/HD

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia(Name,Id)",

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/HD",

"@odata.type": "#VirtualMedia.v1_2_0.VirtualMedia",

"Id": "HD",

"Name": "VirtualMedia",

"Connected": [

{

"MediaIndex": "0",

"ImageName": "testa.img",

"MediaTypes": "Hard disk"

{

"MediaIndex ": "1",

"ImageName": "testb.img",

"MediaTypes": "Hard disk"

}

"NotConnected": [

{

"ID": "1",

"ImageName": "test1.img",

"MediaTypes": "Hard disk"

{

"ID": "2",

"ImageName": "test2.img",

"MediaTypes": "Hard disk"

}

]

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the HD-Media resource model.
@odata.id	String	Link to the HD-Media resource.
@odata.type	String	Type of the HD-Media resource.
Id	String	ID of the HD-Media resource.
Name	String	Name of the HD-Media resource.
MediaIndex	String	HD-Media index.
MediaTypes	String	Media image type. Supported options: · Hard disk.
ImageName	String	Media image name.

The server returns status code 200 for a successful operation.

Connect to virtual media (CD)

Description

Connect the server to the virtual media.

Privilege module

Remote media

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

NFS:

{

"VmmControlType":"Connect",

"Image":"nfs://IP/Share/ERP.iso"

}

CIFS:

{

"VmmControlType":"Connect",

"Image":"cifs://user:password@IP/img/ERP.iso"

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
VmmControlType	Operation on virtual media.	Supported option is Connect.
Image	Virtual media URI.	Supported protocols include: · NFS. · CIFS. The image name such as ERP.iso cannot exceed 128 characters.

Examples

# Connect the server to the virtual media through NFS.

Method and URL:

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"VmmControlType":"Connect",

"Image":"nfs://192.168.190.51/Share/image.so"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/TaskService/Tasks/1",

"@odata.type": "#TaskCollection.TaskCollection",

"Id": "1",

"Messages": [],

"Name": "Media Mounting Task",

"StartTime": "2020-08-11T21:28:30+09:00",

"TaskState": "Mounting"

}

Response code: 202

# Connect the server to the virtual media through CIFS.

Method and URL:

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"VmmControlType":"Connect",

"Image":"cifs://user123:[email protected]/img/image.so"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/TaskService/Tasks/1",

"@odata.type": "#TaskCollection.TaskCollection",

"Id": "1",

"Messages": [],

"Name": "Media Mounting Task",

"StartTime": "2020-08-11T21:28:30+09:00",

"TaskState": "Mounting"

}

Response code: 202

Response field description

Field	Data type	Description
@odata.context	String	OData description of the TaskService virtual media resource.
@odata.type	String	Type of the TaskService virtual media resource.
@odata.id	String	Link to the TaskService virtual media resource.
Id	String	ID of the TaskService virtual media resource.
Messages	String	Details of the TaskService virtual media resource.
Name	String	Name of the TaskService virtual media resource.
StartTime	String	Start time of the task.
TaskStatus	String	Status of the task.

The server returns status code 202 for a successful operation.

Change history

Version	Change description
HDM-2.99	Changed the maximum supported image name length from 256 to 128 characters.
HDM-2.09.00	Changed the status code for a successful operation from 200 to 202.
HDM-1.30.12	· Added the response. · Changed the status code for a successful operation to 200.
HDM-1.30.06	Added support for CIFS.

Connect to virtual media (HD)

Description

Connect the server to the virtual media.

Privilege module

Remote media

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/HD/Oem/Public/Actions/VirtualMedia.VmmControl

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

NFS:

{

"VmmControlType":"Connect",

"Image":"nfs://IP/Share/ERP.iso"

}

CIFS:

{

"VmmControlType":"Connect",

"Image":"cifs://user:password@IP/img/ERP.iso"

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
VmmControlType	Operation on virtual media.	Supported option is Connect.
Image	Virtual media URI.	Supported protocols include: · NFS. · CIFS. The image name such as ERP.iso cannot exceed 128 characters.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/HD/Oem/Public/Actions/VirtualMedia.VmmControl

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"VmmControlType":"Connect",

"Image":"nfs://192.168.190.51/Share/image.so"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/TaskService/Tasks/1",

"@odata.type": "#TaskCollection.TaskCollection",

"Id": "1",

"Messages": [],

"Name": "Media Mounting Task",

"StartTime": "2020-08-11T21:28:30+09:00",

"TaskState": "Mounting"

}

Response code: 202

Response field description

Field	Data type	Description
@odata.context	String	OData description of the TaskService virtual media resource.
@odata.type	String	Type of the TaskService virtual media resource.
@odata.id	String	Link to the TaskService virtual media resource.
Id	String	ID of the TaskService virtual media resource.
Messages	String	Details of the TaskService virtual media resource.
Name	String	Name of the TaskService virtual media resource.
StartTime	String	Start time of the task.
TaskState	String	Status of the task.

The server returns status code 202 for a successful operation.

Change history

Version	Change description
HDM-3.31	Added this interface.

Disconnect from virtual media (CD)

Description

Disconnect the server from the virtual media.

Privilege module

Remote media

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"VmmControlType": value

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
value	Disconnection from virtual media.	Disconnect.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"VmmControlType":"Disconnect"

}

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageArgs": "[]",

"MessageId": "Base.1.0.Success",

"RelatedProperties": "[]",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": " VirtualMedia has been disconnected succesfully. See ExtendedInfo for more information."

}

Response code: 200

Response field description

Field	Data type	Description
@odata.type	String	OData description of the message resource.
Message	String	Detailed information in ExtendedInfo.
MessageArgs	Array	Message parameters.
MessageId	String	Message ID.
RelatedProperties	Array	Related message properties.
Resolution	String	Recommended actions for the error.
Severity	String	Severity level. Supported options: · OK. · Warning. · Critical.
code	String	String indicating a specific message ID in the message registry.
message	String	Details of the message.

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-6.02

Corrected the spelling of the Message.ExtendedInfo field.

HDM-1.30.12

· Added the response.

· Changed the status code for a successful operation to 200.

Disconnect from virtual media (HD)

Description

Disconnect the server from the virtual media.

Privilege module

Remote media

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/HD/Oem/Public/Actions/VirtualMedia.VmmControl

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"VmmControlType": value

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
value	Disconnection from virtual media.	Disconnect.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/HD/Oem/Public/Actions/VirtualMedia.VmmControl

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"VmmControlType":"Disconnect"

}

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageArgs": "[]",

"MessageId": "Base.1.0.Success",

"RelatedProperties": "[]",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": " VirtualMedia has been disconnected succesfully. See ExtendedInfo for more information."

}

Response code: 200

Response field description

Field	Data type	Description
@odata.type	String	OData description of the message resource.
Message	String	Detailed information in ExtendedInfo.
MessageArgs	Array	Message parameters.
MessageId	String	Message ID.
RelatedProperties	Array	Related message properties.
Resolution	String	Recommended actions for the error.
Severity	String	Severity level. Supported options: · OK. · Warning. · Critical.
code	String	String indicating a specific message ID in the message registry.
message	String	Details of the message.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-6.02	Corrected the spelling of the Message.ExtendedInfo field.
HDM-3.31	Added the interface.

Obtain log service collection information

Description

Obtain information about all current log service resources from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/LogServices

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Response:

{

"@odata.context": "/redfish/v1/$metadata#LogServiceCollection.LogServiceCollection",

"@odata.id": "/redfish/v1/Managers/1/LogServices",

"@odata.type": "#LogServiceCollection.LogServiceCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/FirmwareUpdateLog"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/HardwareUpdateLog"

}

"[email protected]": 4,

"Name": "LogService Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the log service collection resource model.
@odata.id	String	Link to the log service collection resource.
@odata.type	String	Type of the log service collection resource.
Name	String	Name of the log service collection resource.
[email protected]	Integer	Number of log service resources.
Members	List of log service resources.
@odata.id	String	Link to a log service resource.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.06	Added the redfish/v1/Managers/manager_id/LogServices interface.

Obtain log service information

Description

Obtain information about a specific log service resource from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/LogServices/LogService_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
LogServices_id	ID of the log service resource.	You can obtain available log service resource IDs from log service collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/LogServices/AuditLog

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#LogService.LogService(MaxNumberOfRecords,DateTime,Entries,Id,DateTimeLocalOffset,Description,Name,ServiceEnabled)",

"@odata.type": "#LogService.v1_1_0.LogService",

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog",

"DateTime": "2019-11-04T09:15:47+08:00",

"DateTimeLocalOffset": "UTC+08:00",

"Description": "AuditLog for this manager",

"Entries": {

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries"

"Id": "AuditLog",

"MaxNumberOfRecords": 1000,

"Name": "AuditLog",

"ServiceEnabled": true,

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the log service resource model.
@odata.id	String	Link to the log service resource.
@odata.type	String	Type of the log service resource.
Id	String	ID of the log service resource.
Name	String	Name of the log service resource.
Description	String	Description of the log service resource.
MaxNumberOfRecord	Integer	Maximum number log entries that can be recorded in the log service resource.
DateTime	String	System time of the log service resource.
DateTimeLocalOffset	String	Time zone of the log service resource.
ServiceEnabled	String	Enabling status of the log service resource. Supported options: · true—Enabled. · false—Disabled.
Entries	Object	Link to the log collection resource.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.10	Changed the time offset of the DateTimeLocalOffset field from UTC to UTC+08:00.
HDM-1.30.06	Added the redfish/v1/Managers/manager_id/LogServices/LogServices_id interface.

Obtain log entry collection information

Description

Obtain information about all current log entries of a log service from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/LogServices/LogServices_id/Entries

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
LogServices_id	ID of the log service resource.	You can obtain available log service resource IDs from log service collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/LogServices/AuditLog/Entries

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries",

"@odata.type": "#LogEntryCollection.LogEntryCollection",

"Description": "Collection of entries for this log service",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/38"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/37"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/36"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/35"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/34"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/33"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/32"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/31"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/30"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/29"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/28"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/27"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/26"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/25"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/24"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/23"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/22"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/21"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/20"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/19"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/18"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/17"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/16"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/15"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/14"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/13"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/12"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/11"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/10"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/9"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/8"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/7"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/6"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/5"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/4"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/3"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/2"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/1"

}

"[email protected]": 38,

"[email protected]": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries?$skip=50",

"Name": "Log Service Entries Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the log entry collection resource model.
@odata.id	String	Link to the log entry collection resource.
@odata.type	String	Type of the log entry collection resource.
Name	String	Name of the log entry collection resource.
[email protected]	Integer	Number of log entry resources.
Members	List of log entry resources.
@odata.id	String	Link to a log entry resource.
[email protected]	String	URL to the log entry resources that has not been displayed.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.06	Added the redfish/v1/Managers/managers_id/LogServices/LogServices_id/Entries interface.

Obtain log entry information

Description

Obtain information about a specific log entry resource from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/LogServices/LogServices_id/Entries/Entry_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
LogServices_id	ID of the log service resource.	You can obtain available log service resource IDs from log service collection information.
Entry_id	ID of the log entry resource.	You can obtain available log entry resource IDs from log entry collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/LogServices/AuditLog/Entries/145

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry(Oem,Id,Name,Message,Created)",

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/145",

"@odata.type": "#LogEntry.v1_1_1.LogEntry",

"Created": "2019-11-04 08:37:55.941",

"EntryType": "Oem",

"Id": 145,

"Message": "HTTPS login from IP:192.168.10.26 user:admin",

"Name": "AuditLog",

"Oem": {

"Public": {

"Address": "192.168.10.26",

"Hostname": "HDM210200A00TH177000003",

"Interface": "LAN",

"User": "admin"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the log entry resource model.
@odata.id	String	Link to the log entry resource.
@odata.type	String	Type of the log entry resource.
Name	String	Name of the log entry resource.
Created	String	Creation time of the log entry.
EntryType	String	Type of the log entry. Supported options: · Event. · SEL. · Oem.
Message	String	Description of the log entry.
Id	Integer	Event ID.
Oem.Public.Address	String	Host address.
Oem.Public.Hostname	String	Host name.
Oem.Public.Interface	String	Interface type. Supported options: · N/A—Unknown session type. · LAN. · SERIAL. · SERIAL_TERMINAL. · KCS. · BT. · IPMB. · WEB. · USB · USB_SPECIAL. · SSIF. · KVM. · CLI. · SNMP.
Oem.Public.User	String	Username.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.06	Added the redfish/v1/Managers/manager_id/LogServices/LogService_id/Entries/Entry_id interface.

Obtain VNC information

Description

Obtain information about the VNC service.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/VncService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/VncService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#VncService.VncService(ComplexityCheck,NumberOfActivatedSessions,SessionTimeoutMinutes,MaximumNumberOfSessions)",

"@odata.id": "/redfish/v1/Managers/1/VncService",

"@odata.type": "#VncService.v1_0_0.VncService",

"ComplexityCheck": false,

"MaximumNumberOfSessions": 2,

"NumberOfActivatedSessions": 0,

"SessionTimeoutMinutes": 10

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the VNC information resource model.
@odata.id	String	Link to the VNC information resource.
@odata.type	String	Type of the VNC information resource.
MaximumNumberOfSessions	Integer	Maximum number of VNC sessions.
NumberOfActivatedSessions	Integer	Number of current VNC sessions.
ComplexityCheck	Boolean	Enabling status of VNC password complexity check.
SessionTimeoutMinutes	Integer	Session idle timeout for the VNC service.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.10	Changed the SSLEncryptionEnabled field to ComplexityCheck.
HDM-1.30.09	Added the redfish/v1/Managers/manager_id/VncService interface.

Edit VNC settings

Description

Edit settings of the VNC service for the server.

Privilege module

Security

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Managers/manager_id/VncService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"SessionTimeoutMinutes": SessionTimeoutMinutes_value,

"ComplexityCheck": ComplexityCheck_value,

"Password":" Password_value"

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
SessionTimeoutMinutes_value	Session idle timeout for the VNC service, in minutes.	Integer. Value range: 5 to 30.
ComplexityCheck_value	Enable or disable VNC password complexity check. · With VNC password complexity check disabled, the password must be a case-sensitive string of 1 to 8 characters. Only letters, digits, spaces and special characters `~!@#$%^&()_+-=[]\{}\|;':",./<>? are allowed. · With VNC password complexity check enabled, the password must be a case-sensitive string of 8 characters. Only letters, digits, spaces and special characters `~!@#$%^&()_+-=[]\{}\|;':",./<>? are allowed. The password must contain at least two of the following categories: Uppercase letters, lowercase letters, and digits. The password must contain at least one space or special character.	Boolean.
Password_value	Password.	String.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Managers/1/VncService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"SessionTimeoutMinutes":10,

"ComplexityCheck": false,

"Password":"root"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#VncService.VncService(ComplexityCheck,NumberOfActivatedSessions,SessionTimeoutMinutes,MaximumNumberOfSessions)",

"@odata.id": "/redfish/v1/Managers/1/VncService",

"@odata.type": "#VncService.v1_0_0.VncService",

"ComplexityCheck": false,

"MaximumNumberOfSessions": 2,

"NumberOfActivatedSessions": 0,

"SessionTimeoutMinutes": 10

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the VNC information resource model.
@odata.id	String	Link to the VNC information resource.
@odata.type	String	Type of the VNC information resource.
MaximumNumberOfSessions	Integer	Maximum number of VNC sessions.
NumberOfActivatedSessions	Integer	Number of current VNC sessions.
ComplexityCheck	Boolean	Enabling status of VNC password complexity check.
SessionTimeoutMinutes	Integer	Session idle timeout for the VNC service.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.10	Changed the SSLEncryptionEnabled field to ComplexityCheck.
HDM-1.30.09	Added the redfish/v1/Managers/manager_id/VncService interface.

Obtain KVM information

Description

Obtain information about the KVM service.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/KvmService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/Managers/1/KvmService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#KvmService.KvmService(PersistentUSBConnectionEnabled,NumberOfActivatedSessions,SessionTimeoutMinutes,MaximumNumberOfSessions)",

"@odata.id": "/redfish/v1/Managers/1/KvmService",

"@odata.type": "#KvmService.v1_0_0.KvmService",

"MaximumNumberOfSessions": 4,

"NumberOfActivatedSessions": 0,

"PersistentUSBConnectionEnabled": true,

"SessionTimeoutMinutes": 13

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the KVM resource model.
@odata.id	String	Link to the KVM resource.
@odata.type	String	Type of the KVM resource.
MaximumNumberOfSessions	Integer	Maximum number of KVM sessions.
NumberOfActivatedSessions	Integer	Number of current KVM sessions.
PersistentUSBConnectionEnabled	Boolean	Enabling status of continuous connection to the virtual keyboard and mouse.
SessionTimeoutMinutes	Integer	Session idle timeout for the KVM service.

Change history

Version	Change description
HDM-1.30.10	Added the redfish/v1/Managers/manager_id/KvmService interface.

Edit KVM settings

Description

Edit settings of the KVM service for the server.

Privilege module

Security

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Managers/manager_id/KvmService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"SessionTimeoutMinutes": SessionTimeoutMinutes_value

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
SessionTimeoutMinutes	Session idle timeout for the KVM service, in minutes.	Integer.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/Managers/1/KvmService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"SessionTimeoutMinutes":10

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#KvmService.KvmService(PersistentUSBConnectionEnabled,NumberOfActivatedSessions,SessionTimeoutMinutes,MaximumNumberOfSessions)",

"@odata.id": "/redfish/v1/Managers/1/KvmService",

"@odata.type": "#KvmService.v1_0_0.KvmService",

"MaximumNumberOfSessions": 4,

"NumberOfActivatedSessions": 0,

"PersistentUSBConnectionEnabled": true,

"SessionTimeoutMinutes": 13

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the KVM information resource model.
@odata.id	String	Link to the KVM information resource.
@odata.type	String	Type of the KVM information resource.
MaximumNumberOfSessions	Integer	Maximum number of KVM sessions.
NumberOfActivatedSessions	Integer	Maximum number of current KVM sessions.
PersistentUSBConnectionEnabled	Boolean	Enabling status of continuous connection to the virtual keyboard and mouse.
SessionTimeoutMinutes	Integer	Session idle timeout for the KVM service.

Change history

Version	Change description
HDM-1.30.10	Added the redfish/v1/Managers/manager_id/KvmService interface.

Obtain serial port collection information

Description

Obtain information about all serial ports from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/SerialInterfaces

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET http://192.168.25.83/redfish/v1/Managers/1/SerialInterfaces

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#SerialInterfaceCollection.SerialInterfaceCollection",

"@odata.id": "/redfish/v1/Managers/1/SerialInterfaces",

"@odata.type": "#SerialInterfaceCollection.SerialInterfaceCollection",

"Description": "Collection of Serial Interfaces for this System",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1/SerialInterfaces/IPMI-SOL"

}

POST https://192.168.188.188/redfish/v1/Managers/1/Actions/Oem/Public/Manager.dumpBIOS

"Name": "Serial Interface Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the serial port collection resource model.
@odata.id	String	Link to the serial port collection resource.
@odata.type	String	Type of the serial port collection resource.
Description	String	Description of the serial port collection resource.
Members	Array	Links to serial port resources.
[email protected]	Integer	Number of serial port resources.
Name	String	Name of the serial port collection resource.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.06	Added the redfish/v1/Managers/manager_id/SerialInterfaces interface.

Obtain serial port information

Description

Obtain information about a specific serial port resource from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/SerialInterfaces/serialinterface_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
serialinterface_id	ID of the serial port resource.	You can obtain available serial port resource IDs from serial port collection information.

Examples

Method and URL:

GET http://192.168.25.83/redfish/v1/Managers/1/SerialInterfaces/IPMI-SOL

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#SerialInterface.SerialInterface",

"@odata.id": "/redfish/v1/Managers/1/SerialInterfaces/IPMI-SOL",

"@odata.type": "#SerialInterface.v1_1_2.SerialInterface",

"BitRate": "115200",

"DataBits": "8",

"Description": "IPMI Serial over LAN",

"FlowControl": "Hardware",

"Id": "IPMI-SOL",

"InterfaceEnabled": true,

"Name": "IPMI-SOL",

"Parity": "None",

"StopBits": "1"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the serial port resource model.
@odata.id	String	Link to the serial port resource.
@odata.type	String	Type of the serial port resource.
BitRate	String	Baud rate. Supported options: · 1200. · 2400. · 4800. · 9600. · 19200. · 38400. · 57600. · 115200. · 230400.
DataBits	String	Number of data bits. Supported options: · 5. · 6. · 7. · 8.
Description	String	Description of the serial port.
FlowControl	String	Flow control method. Supported options: · None. · Software. · Hardware.
Id	String	ID of the serial port.
InterfaceEnabled	Boolean	Enabling status of the serial port.
Name	String	Name of the serial port.
Parity	String	Parity bit to be sent with the data bits for transmission error detection. Supported options: · None. · Even. · Odd. · Mark. · Space.
StopBits	String	Number of stop bits used to indicate the end of a serial data packet. Supported options: · 1. · 2.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.09	Added the redfish/v1/Managers/manager_id/SerialInterfaces/serialinterface_id interface.

Obtain LLDP service information

Description

Obtain information about the LLDP service.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/LldpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.20.208/redfish/v1/Managers/1/LldpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/LldpService",

"@odata.type": "#HwLldpService.v1_0_0.HwLldpService",

"Description": "LLDP Service",

"Id": "LldpService",

"LLDP": [

{

"ChassisMac": "N/A",

"ChassisName": "N/A",

"EthIndex": "eth0",

"PortDesc": "N/A",

"PortIfName": "N/A",

"VlanId": 0

{

"ChassisMac": "38:ad:be:fc:8d:e6",

"ChassisName": "H3C",

"EthIndex": "eth1",

"PortDesc": "GigabitEthernet1/0/1 Interface",

"PortIfName": "GigabitEthernet1/0/1",

"VlanId": 1

}

"LldpEnabled": false,

"Name": "LldpService"

"WorkMode": "Tx",

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the LLDP service resource model.
@odata.id	String	Link to the LLDP service resource.
@odata.type	String	OData description of the LLDP service resource.
Description	String	Function description of the LLDP service resource interface.
Id	String	ID of the LLDP service.
ChassisMac	String	MAC address of the connected switch.
ChassisName	String	System name of the connected switch.
EthIndex	String	Network port of the server for receiving LLDP frames.
PortDesc	String	Name of the uplink switch port.
PortIfName	String	Number of the uplink switch port.
VlanId	Integer	VLAN ID.
LldpEnabled	Boolean	Enabling status of LLDP frame sending.
WorkMode	String	LLDP operating mode. Supported options: · Tx (transmit mode) · Rx (transmit mode, not supported) · TxRx (transmit mode, not supported)
Name	String	Name of the LLDP service.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.42	Added the @odata.type filed.
HDM-2.11.93 HDM-2.25	Added the WorkMode field.
HDM-1.30.13	Deleted the EthRate field.
HDM-1.30.10	Added the redfish/v1/Managers/manager_id/LldpService interface.

Edit LLDP service settings

Description

Edit settings of the LLDP service for the server.

Privilege module

Basic configuration

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Managers/manager_id/LldpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"LldpEnabled": enable

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
LldpEnabled	Enable or disable LLDP frame sending.	Boolean. Supported options: · true. · false.

Examples

Method and URL:

PATCH http://172.16.13.176/redfish/v1/Managers/1/LldpService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"LldpEnabled": true

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/LldpService",

"@odata.type": "#HwLldpService.v1_0_0.HwLldpService",

"Description": "LLDP Service",

"Id": "LldpService",

"LLDP": [

{

"ChassisMac": "N/A",

"ChassisName": "N/A",

"EthIndex": "eth0",

"PortDesc": "N/A",

"PortIfName": "N/A",

"VlanId": 0

{

"ChassisMac": "38:ad:be:fc:8d:e6",

"ChassisName": "H3C",

"EthIndex": "eth1",

"PortDesc": "GigabitEthernet1/0/1 Interface",

"PortIfName": "GigabitEthernet1/0/1",

"VlanId": 1

}

"LldpEnabled": true,

"Name": "LldpService"

"WorkMode": "Tx",

}

Response code: 200

Response field description

For information about the response fields, see "Obtain LLDP service information."

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.10	Added the redfish/v1/Managers/manager_id/LldpService interface.

Obtain wireless information

Description

Obtain information about the wireless resource.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Wireless

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET https://192.168.33.120/redfish/v1/Managers/1/Oem/Public/Wireless

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Wireless.Wireless",

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Wireless",

"@odata.type": "#Wireless.v1_0_0.Wireless",

"Clients": [

{

"ClientId":1,

"MacAddress":"26:70:77:d8:db:bd ",

"IPAddress":"192.168.199.3",

"HostName":" HUAWEI_P40_Pro+"

}

"DHCPServers": [

{

"DHCPAddrEnd": "192.168.155.199",

"DHCPAddrStart": "192.168.155.56",

"IPAddress": "192.168.155.20",

"Id": 1

}

"Ssids": [

{

"ClientMaxNum": 2,

"EncryptionMode": "None",

"Id": 1,

"Name": "111111222222333",

"Password": "01234567890123456789"

}

"Status": {

"Health": "OK",

"State": "Disabled"

"WlanChannel": 11,

"WlanCurrentState": "Disabled",

"WlanEnabled": true,

"WlanTimeout": 150

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the wireless resource model.
@odata.id	String	Link to the wireless resource.
@odata.type	String	Type of the wireless resource.
WlanChannel	Integer	Wireless channel. The default wireless channel is 11.
WlanCurrentState	String	State of the wireless service.
WlanEnabled	Boolean	Enable the wireless service.
WlanTimeout	Integer	Scheduled time when the wireless service will be disabled, in hours. Value range: 0 to 200. If this field is set to 0, the wireless service will not be disabled.
Clients.ClientId	Integer	ID of the client.
Clients.MacAddress	String	MAC address of the client.
Clients.IPAddress	String	IPv4 address of the client.
Clients.HostName	String	Host name of the client.
DHCPServers.Id	Integer	ID of the DHCP server address pool for the wireless service.
DHCPServers.IPAddress	String	IP addresses of the DHCP servers.
DHCPServers.DHCPAddrStart	String	Start address of the DHCP server address pool.
DHCPServers.DHCPAddrEnd	String	End address of the DHCP server address pool.
Ssids.ClientMaxNum	Integer	Maximum number of clients that can connect to the SSIDs.
Ssids.EncryptionMode	String	Encryption mode of the wireless service. Supported options: · None. · WPA2-PSK.
Ssids.Id	Integer	ID of the wireless service.
Ssids.Name	String	Name of the wireless service.
Ssids.Password	String	Password of the wireless service.

Change history

Version	Change description
HDM-2.17.00	Added the redfish/v1/Managers/manager_id/Oem/Public/Wireless interface.

Edit wireless settings

Description

Edit settings for the wireless service.

Privilege module

Basic configuration

Request

Method and URL:

PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Wireless

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"DHCPServers": [

{

"DHCPAddrEnd": "192.168.155.189",

"DHCPAddrStart": "192.168.155.35",

"IPAddress": "192.168.155.30"

}

"Ssids": [

{

"EncryptionMode": "WPA2-PSK",

"Name": "111111222222",

"Password": "dfsgdgdsfgsdg"

}

"WlanEnabled": true,

"WlanTimeout": 0

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
WlanEnabled	Boolean	Enable the wireless service.
WlanTimeout	Integer	Scheduled time when the wireless service will be disabled, in hours. Value range: 0 to 200. If this field is set to 0, the wireless service will not be disabled.
DHCPServers.IPAddress	String	IP addresses of the DHCP servers.
DHCPServers.DHCPAddrStart	String	Start address of the DHCP server address pool.
DHCPServers.DHCPAddrEnd	String	End address of the DHCP server address pool.
Ssids.EncryptionMode	String	Encryption mode of the wireless service. Supported options: · None. · WPA2-PSK.
Ssids.Name	String	Name of the wireless service. A string of 1 to 31 characters.
Ssids.Password	String	Password of the wireless service. A string of 8 to 63 characters.

Examples

Method and URL:

PATCH https://192.168.30.85/redfish/v1/Managers/1/Oem/Public/Wireless

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"1043aaa69f0ade5f8a7a7e0d987a274b"

Request body:

{

"DHCPServers": [

{

"DHCPAddrEnd": "192.168.155.150",

"DHCPAddrStart": "192.168.155.35",

"IPAddress": "192.168.155.34"

}

"Ssids": [

{

"EncryptionMode": "WPA2-PSK",

"Name": "111111222222",

"Password": "dfsgdgdsfgsdg"

}

"WlanEnabled": true,

"WlanTimeout": 0

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#Wireless.Wireless",

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Wireless",

"@odata.type": "#Wireless.v1_0_0.Wireless",

"Clients": [],

"DHCPServers": [

{

"DHCPAddrEnd": "192.168.155.150",

"DHCPAddrStart": "192.168.155.35",

"IPAddress": "192.168.155.34",

"Id": 1

}

"Ssids": [

{

"ClientMaxNum": 2,

"EncryptionMode": "WPA2-PSK",

"Id": 1,

"Name": "111111222222",

"Password": "dfsgdgdsfgsdg"

}

"Status": {

"Health": "OK",

"State": "Disabled"

"WlanChannel": 11,

"WlanCurrentState": "Disabled",

"WlanEnabled": true,

"WlanTimeout": 0

}

Response code: 200

Response field description

For information about the response fields, see "Obtain wireless information."

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.17.00	Added the redfish/v1/Managers/manager_id/Oem/Public/Wireless interface.

Import the BIOS, BMC, and RAID controller settings

Description

Import the BIOS, BMC, and RAID controller settings.

Privilege module

Maintenance

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ImportConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

CIFS or SFTP:

{

"Type":type_value,

"Content":”cifs://username:password@ip/filename”,

"Oem": {

"Public": {

"ConfigType":type

}

HTTP, TFTP, NFS, or HTTPS:

{

"Type":type_value,

"Content":” http://ip/filename”,

"Oem": {

"Public": {

"ConfigType":type

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
Type	Method to import the configuration file.	URI.
Content	Path of the source configuration file.	· Available file transfer protocols include SFTP, HTTPS, HTTP, NFS, CIFS, and TFTP. · The path cannot contain Chinese characters. · The file name, account, and password support a maximum of 31 characters. · The full file path length cannot exceed 255 characters. · The file name, account, and password support special characters and cannot contain Chinese characters. The supported special characters are the at sign (@),exclamation point (!), dollar sign ($), caret (^), ampersand (&), left parenthesis ((), right parenthesis ()), underscore (_), plus sign (+), dot (.), semi-colon (;), left bracket ([], right bracket (]), left brace ({}, right brace (}), minus sign (-), equal sign (=), tilde (~), and back quote (`).
Oem.Public.ConfigType	Type of the configuration.	· HDM. · BIOS. · RAID.

Examples

Method and URL:

POST https://192.168.188.188/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Type":"URI",

"Content": "nfs://192.168.20.177/Share1/bios-config.json",

"Oem": {

"Public": {

"ConfigType":"BIOS"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/TaskService/Tasks/1",

"@odata.type": "#TaskCollection.TaskCollection",

"Id": "1",

"Messages": [],

"Name": "Configuration Import Task",

"StartTime": "2020-10-25T13:59:17+01:00",

"TaskState": "Importing"

}

Response code: 202

Response field description

Field	Data type	Description
@odata.context	String	OData description of the specified resource model.
@odata.id	String	Link to the specified resource.
@odata.type	String	Type of the specified resource.
Id	String	Task ID.
Name	String	Task name.
Messages	String	Description of the message.
StartTime	String	Start time of the task.
TaskState	String	State of the task.

Change history

Version	Change description
HDM-2.19	Added the redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ImportConfiguration interface.

Export the BIOS, BMC, and RAID controller settings

Description

Export the BIOS, BMC, and RAID controller settings.

Privilege module

Maintenance

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ExportConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

CIFS or SFTP:

{

"Type":type_value,

"Content":”cifs://username:password@ip/filename”,

"Oem": {

"Public": {

"ConfigType":type

}

HTTP, TFTP, NFS, or HTTPS:

{

"Type":type_value,

"Content":” http://ip/filename”,

"Oem": {

"Public": {

"ConfigType":type

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
Type	Method to export the configuration file.	URI.
Content	Destination configuration file path.	· Available file transfer protocols are SFTP, HTTPS, HTTP, NFS, CIFS, and TFTP. · The path cannot contain Chinese characters. · The file name, account, and password support a maximum of 31 characters. · The full path length cannot exceed 255 characters. · The file name, account, and password support special characters and cannot contain Chinese characters. The supported special characters are the at sign (@),exclamation point (!), dollar sign ($), caret (^), ampersand (&), left parenthesis ((), right parenthesis ()), underscore (_), plus sign (+), dot (.), semi-colon (;), left bracket ([], right bracket (]), left brace ({}, right brace (}), minus sign (-), equal sign (=), tilde (~), and back quote (`).
Oem.Public.ConfigType	Type of the configuration.	· HDM. · BIOS. · RAID.

Examples

Method and URL:

POST https://192.168.188.188/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ExportConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Type":"URI",

"Content": "nfs://192.168.20.177/Share1/bios-config.json",

"Oem": {

"Public": {

"ConfigType":"BIOS"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/TaskService/Tasks/2",

"@odata.type": "#TaskCollection.TaskCollection",

"Id": "2",

"Messages": [],

"Name": "Configuration Export Task",

"StartTime": "2020-10-25T14:11:35+01:00",

"TaskState": "Exporting"

}

Response code: 202

Response field description

Field	Data type	Description
@odata.context	String	OData description of the specified resource model.
@odata.id	String	Link to the specified resource.
@odata.type	String	Type of the specified resource.
Id	String	Task ID.
Name	String	Task name.
Messages	String	Description of the message.
StartTime	String	Start time of the task.
TaskState	String	State of the task.

Change history

Version	Change description
HDM-2.19	Added the redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ExportConfiguration interface.

Obtain serial port log server settings

Description

Obtain serial port log server settings.

Privilege module

Information query

Request

Method and URL:

GET

https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteHostLogConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET

https://192.168.77.77/redfish/v1/Managers/1/Oem/Public/Manager.RemoteHostLogConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Manager.RemoteHostLogConfiguration",

"@odata.type": "#RemoteHostLogConfiguration.v1_0_0.RemoteHostLogConfiguration",

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the specified resource model.
@odata.id	String	Link to the specified resource.
@odata.type	String	Type of the specified resource.
SysLogEnabled	Boolean	Enabling status of syslog. Supported options: · false · true
TransportProtocol	String	Transport protocol. Supported options: · UDP · TCP
HostIP	String	IPv4 or IPv6 address of the server.
HostPort	Integer	Port number.

Change history

Version	Change description
HDM-2.33	Added the redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteHostLogConfiguration interface.

Edit serial port log server settings

Description

Edit serial port log server settings.

Privilege module

Basic configuration

Request

Method and URL:

PATCH

https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteHostLogConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
SysLogEnabled	Enabling status of syslog.	Boolean. Options include false and true.
TransportProtocol	Supported transfer protocol.	String. Options include UDP and TCP.
HostIP	Server address.	String. IPv4 or IPv6 address.
HostPort	Port number.	Integer.

Examples

Method and URL:

PATCH

https://192.168.77.77/redfish/v1/Managers/1/Oem/Public/Manager.RemoteHostLogConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Manager.RemoteHostLogConfiguration",

"@odata.type": "#RemoteHostLogConfiguration.v1_0_0.RemoteHostLogConfiguration",

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514

}

Response code: 200

Response field description

For information about the response fields, see "Obtain serial port log server settings."

Change history

Version	Change description
HDM-2.33	Added the redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteHostLogConfiguration interface.

Obtain SDR log server settings

Description

Obtain SDR log server settings.

Privilege module

Information query

Request

Method and URL:

GET

https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteSDRLogConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.

Examples

Method and URL:

GET

https://192.168.77.77/redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteSDRLogConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Manager.RemoteSDRLogConfiguration",

"@odata.type": "#RemoteSDRLogConfiguration.v1_0_0.RemoteSDRLogConfiguration",

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514,

"TimeInterval": "10"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the specified resource model.
@odata.id	String	Link to the specified resource.
@odata.type	String	Type of the specified resource.
SysLogEnabled	Boolean	Enabling status of syslog. Supported options: · false · true
TransportProtocol	String	Transport protocol. Supported options: · UDP · TCP
HostIP	String	IPv4 or IPv6 address of the server.
HostPort	Integer	Port number.
TimeInterval	String	Interval in the range of 10 seconds to 2592000 seconds.

Change history

Version	Change description
HDM-2.33	Added the redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteSDRLogConfiguration interface.

Edit SDR log server settings

Description

Edit SDR log server settings.

Privilege module

Basic configuration

Request

Method and URL:

PATCH

https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteSDRLogConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514,

"TimeInterval": "10"

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
SysLogEnabled	Enabling status of syslog.	Boolean. Options include false and true.
TransportProtocol	Supported transfer protocol.	String. Options include UDP and TCP.
HostIP	Server address.	String. IPv4 or IPv6 address.
HostPort	Port number.	Integer.
TimeInterval	Interval.	String. The range is 10 seconds to 2592000 seconds.

Examples

Method and URL:

PATCH

https://192.168.77.77/redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteSDRLogConfiguration

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 51,

"TimeInterval": "10"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Manager.RemoteSDRLogConfiguration",

"@odata.type": "#RemoteSDRLogConfiguration.v1_0_0.RemoteSDRLogConfiguration",

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514,

"TimeInterval": "10"

}

Response code: 200

Response field description

For information about the response fields, see "Obtain SDR log server settings."

Change history

Version	Change description
HDM-2.33	Added the redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteSDRLogConfiguration interface.

Operations on account service resources

Export the BIOS firmware

Description

Export the BIOS firmware.

Privilege module

Maintenance

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.dumpBios

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

CIFS or SFTP

{

"Content":”cifs://username:password@ip/filename”,

}

TFTP, NFS

{

"Content":” nfs:filename”,

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	ID of the manager resource.	Only value 1 is supported.
Content	Destination configuration file path.	· Available file transfer protocols are SFTP, NFS, CIFS, and TFTP. · The path cannot contain Chinese characters. · The file name, account, and password support a maximum of 31 characters. · The full path length cannot exceed 255 characters. · The file name, account, and password support special characters and cannot contain Chinese characters. The supported special characters are the at sign (@),exclamation point (!), dollar sign ($), caret (^), ampersand (&), left parenthesis ((), right parenthesis ()), underscore (_), plus sign (+), dot (.), semi-colon (;), left bracket ([], right bracket (]), left brace ({}, right brace (}), minus sign (-), equal sign (=), tilde (~), and back quote (`).

Examples

Method and URL:

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Content": "nfs://192.168.20.177/Share1/BIOS.bin",

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

}

Response code: 202

Response field description

Field	Data type	Description
@odata.context	String	OData description of the specified resource model.

Change history

Version	Change description
HDM-2.93	Added the redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.dumpBios interface.

Obtain account service information

Description

Obtain information about the account service from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/AccountService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/AccountService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#AccountService.AccountService",

"@odata.id": "/redfish/v1/AccountService",

"@odata.type": "#AccountService.v1_3_0.AccountService",

"AccountLockoutDuration": 5,

"AccountLockoutThreshold": 5,

"Accounts": {

"@odata.id": "/redfish/v1/AccountService/Accounts"

"Description": "BMC User Accounts",

"Id": "AccountService",

"MaxPasswordLength": 20,

"MinPasswordLength": 2,

"Name": "Account Service",

"Oem": {

"Public": {

"PassWordRule": {

"PasswordComplexityCheckEnabled": false

"TwoFactorAuthenticationInformation": {

"TwoFactorAuthenticationStateEnabled": false,

"OTPServerAddress": "192.168.1.36",

"OTPServerPort": 1812,

"OTPServerSharedKey": "admin"

}

"Roles": {

"@odata.id": "/redfish/v1/AccountService/Roles"

"ServiceEnabled": true,

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the account service resource model.
@odata.id	String	Link to the account service resource.
@odata.type	String	Type of the account service resource.
Description	String	Description of the account service resource.
Id	String	ID of the account service resource.
Name	String	Name of the account service resource.
MinPasswordLength	Integer	Minimum password length.
MaxPasswordLength	Integer	Maximum password length.
AccountLockoutThreshold	Integer	Number of consecutive login failures that will cause a user account to be locked.
AccountLockoutDuration	Integer	Amount of locking time before a locked account can be used again.
Accounts	Account resources.
@odata.id	String		Link to the account resource.
Oem.Public	Custom properties of the account service.
PassWordRule.PasswordComplexityCheckEnabled	Boolean		Enabling status of password complexity check.
TwoFactorAuthenticationInformation	Object		This field is not available for blade servers.
TwoFactorAuthenticationStateEnabled	Boolean		Whether to enable two-factor authentication.
OTPServerAddress	String		Address of the OTP server.
OTPServerPort	Integer		Service port of the OTP server.
OTPServerSharedKey	String		Shared key of the OTP server. A string of 1 to 64 characters.
Roles	List of role resources.
@odata.id	String		Link to a role resource.
ServiceEnabled	Boolean		Enabling status of the account service.
Status.Health	String		Health status of the account service.
Status.State	String		Enabling status of the account service.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.26	Deleted the Oem.Public.Configuration field.
HDM-2.25	Added the TwoFactorAuthenticationInformation field.

Edit account service settings

Description

Edit the settings of the account service for the server.

Privilege module

User accounts

Request

Method and URL:

PATCH https://device_ip/redfish/v1/AccountService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"Oem": {

"Public": {

"PassWordRule": {

"PasswordComplexityCheckEnabled": true

"TwoFactorAuthenticationInformation": {

"TwoFactorAuthenticationStateEnabled": false,

"OTPServerAddress": "192.168.1.36",

"OTPServerPort": 1812,

"OTPServerSharedKey": "admin"

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
PassWordRule	Object
PasswordComplexityCheckEnabled	Boolean	Enabling status of password complexity check.
TwoFactorAuthenticationInformation	Object	This field is not available for blade servers.
TwoFactorAuthenticationStateEnabled	Boolean	Whether to enable two-factor authentication.
OTPServerAddress	String	Address of the OTP server.
OTPServerPort	Integer	Service port of the OTP server.
OTPServerSharedKey	String	Shared key of the OTP server. A string of 1 to 64 characters.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/AccountService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"Oem": {

"Public": {

"PassWordRule": {

"PasswordComplexityCheckEnabled": true

}

"TwoFactorAuthenticationInformation": {

"TwoFactorAuthenticationStateEnabled": false,

"OTPServerAddress": "192.168.1.36",

"OTPServerPort": 1812,

"OTPServerSharedKey": "admin"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#AccountService.AccountService",

"@odata.id": "/redfish/v1/AccountService",

"@odata.type": "#AccountService.v1_3_0.AccountService",

"AccountLockoutDuration": 5,

"AccountLockoutThreshold": 5,

"Accounts": {

"@odata.id": "/redfish/v1/AccountService/Accounts"

"Description": "BMC User Accounts",

"Id": "AccountService",

"MaxPasswordLength": 20,

"MinPasswordLength": 8,

"Name": "Account Service",

"Oem": {

"Public": {

"PassWordRule": {

"PasswordComplexityCheckEnabled": true

"TwoFactorAuthenticationInformation": {

"TwoFactorAuthenticationStateEnabled": false,

"OTPServerAddress": "192.168.1.36",

"OTPServerPort": 1812,

"OTPServerSharedKey": "admin"

}

"Roles": {

"@odata.id": "/redfish/v1/AccountService/Roles"

"ServiceEnabled": true,

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-2.25

Added the TwoFactorAuthenticationInformation field.

HDM-1.30.09

· Changed the status code for a successful operation to 200.

· Added the response.

Obtain user account collection information

Description

Obtain information about all user accounts from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/AccountService/Accounts

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Usage guidelines

Non-administrator users can obtain only their own account collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/AccountService/Accounts

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#ManagerAccountCollection.ManagerAccountCollection",

"@odata.id": "/redfish/v1/AccountService/Accounts",

"@odata.type": "#ManagerAccountCollection.ManagerAccountCollection",

"Members": [

{

"@odata.id": "/redfish/v1/AccountService/Accounts/1"

}

{

"@odata.id": "/redfish/v1/AccountService/Accounts/2"

}

"Name": "Accounts Collection"

}

Response field description

Field	Data type	Description
@odata.context	String	OData description of the user account collection resource model.
@odata.id	String	Link to the user account collection resource.
@odata.type	String	Type of the user account collection resource.
Name	String	Name of the user account collection resource.
Members	Integer	Link to the user account.
[email protected]	Integer	Number of user accounts.
[email protected]	String	Link to a user account resource.

Obtain user account information

Description

Obtain information about a specific user account from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/AccountService/Accounts/user_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
user _id	ID of the user.	You can obtain available user account resource IDs from user account collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/AccountService/Accounts/2

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount(Id,Links,Name,Oem,RoleId,Description,Enabled,Locked,UserName)",

"@odata.id": "/redfish/v1/AccountService/Accounts/2",

"@odata.type": "#ManagerAccount.v1_1_2.ManagerAccount",

"Description": "Default Account",

"Enabled": true,

"Id": "2",

"Links": {

"Roles": {

"@odata.id": "/redfish/v1/AccountService/Roles/Administrator"

}

"Locked": false,

"Name": "Default Account",

"Oem": {

"Public": {

"IPMIEnable": "true",

"WebEnable": "true",

"SnmpV3Enable": true,

"SnmpV3AccessPermission": "read_only",

"SnmpV3AuthProtocol": "sha",

"SnmpV3PrivProtocol": "des"

}

"RoleId": "Administrator",

"UserName": "admin"

"Password": null

}

Response code: 200

Response field description

Field	Date type	Description
@odata.context	String	OData description of the user account service resource model.
@odata.id	String	Link to the user account service resource.
@odata.type	String	Type of the user account service resource.
Description	String	Description of the user account service resource.
Enabled	Boolean	Enabling status of the account service.
Id	Integer	User ID.
Links.Roles	String	Links to role privileges.
Locked	Boolean	Account lockout status.
Name	String	Name of the user account resource.
Oem.Public.IPMIEnable	Boolean	Enabling status of the IPMI access privilege.
Oem.Public.VmediaEnable	Boolean	Enabling status of the VMedia extended privilege.
Oem.Public.WebEnable	Boolean	Enabling status of the Web extended privilege.
RoleId	String	Role name. Supported options: · Administrator. · Operator. · User. · None. · Custom_name_1. By default, the custom role name is CustomRole1. · Custom_name_2. By default, the custom role name is CustomRole2. · Custom_name_3. By default, the custom role name is CustomRole3. · Custom_name_4. By default, the custom role name is CustomRole4. · Custom_name_5. By default, the custom role name is CustomRole5.
UserName	String	Username.
Password	null	This field displays null.
Oem.Public.SnmpV3Enable	Boolean	Enabling status of SNMPv3.
Oem.Public.SnmpV3AccessPermission	String	SNMPv3 access privilege. Supported options: · read_only. · read_write.
Oem.Public.SnmpV3AuthProtocol	String	SNMPv3 authentication algorithm. Supported options: · sha. · md5.
Oem.Public.SnmpV3PrivProtocol	String	SNMPv3 encryption algorithm. Supported options: · des. · aes.

The server returns status code 200 for a successful operation.

Usage guidelines

Non-administrator users can obtain only their own account information.

Change history

Version	Change description
HDM-2.11.92	Added the Password field.
HDM-2.06.00	The value format for the RoleId field changed from Customn to CustomRolen, where n represents 1 to 5.
HDM-2.0.04	Deleted the Oem.Public.KvmEnable and Oem.Public.VmediaEnable fields.
HDM-1.30.06	Added the following fields: Oem.Public.SnmpV3Enable, Oem.Public.SnmpV3AccessPermission, Oem.Public.SnmpV3AuthProtocol, and Oem.Public.SnmpV3PrivProtocol.

Add a user account

Description

Add user accounts to the server.

Privilege module

User accounts

Request

Method and URL:

POST https://device_ip/redfish/v1/AccountService/Accounts

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Enabled": true,

"Password": password,

"UserName": name,

"RoleId": role,

"Locked": false,

"Oem": {

"Public": {

"IPMIEnable": true,

"WebEnable": true,

"SnmpV3Enable": true,

"SnmpV3AccessPermission": "read_only",

"SnmpV3AuthProtocol": "sha",

"SnmpV3PrivProtocol": "des"

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
Enabled	Enable or disable the user account.	Boolean.
UserName	Username.	String.
Password	Password. Up to 20 characters.	String.
RoleId	Role name.	String. Supported options: · Administrator. · Operator. · User. · None. · Custom_name_1. By default, the custom role name is CustomRole1. · Custom_name_2. By default, the custom role name is CustomRole2. · Custom_name_3. By default, the custom role name is CustomRole3. · Custom_name_4. By default, the custom role name is CustomRole4. · Custom_name_5. By default, the custom role name is CustomRole5.
Locked	Account lockout status	Boolean. Supported option: · false.
Oem.Public.IPMIEnable	Enable or disable the IPMI access privilege.	Boolean.
Oem.Public.WebEnable	Enable or disable the Web extended privilege.	Boolean.
Oem.Public.SnmpV3Enable	Enable or disable SNMPv3	Boolean.
Oem.Public.SnmpV3AccessPermission	SNMPv3 access privilege.	String. Supported options: · read_only. · read_write.
Oem.Public.SnmpV3AuthProtocol	SNMPv3 authentication algorithm.	String. Supported options: · sha. · md5.
Oem.Public.SnmpV3PrivProtocol	SNMPv3 encryption algorithm.	String. Supported options: · des. · aes.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/AccountService/Accounts

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Enabled": true,

"Password": "test@test123",

"UserName": "User123",

"RoleId": "User",

"Locked": false,

"Oem": {

"Public": {

"IPMIEnable": true,

"WebEnable": true,

"SnmpV3Enable": true,

"SnmpV3AccessPermission": "read_only",

"SnmpV3AuthProtocol": "sha",

"SnmpV3PrivProtocol": "des"

}

Response:

{

"@odata.type": "#ManagerAccount.v1_1_2.ManagerAccount",

"Description": "User Account",

"Enabled": true,

"Id": "3",

"Links": {

"Roles": {

"@odata.id": "/redfish/v1/AccountService/Roles/User"

}

"Locked": false,

"Name": "User Account",

"Oem": {

"Public": {

"IPMIEnable": true,

"SnmpV3AccessPermission": "read_only",

"SnmpV3AuthProtocol": "sha",

"SnmpV3Enable": true,

"SnmpV3PrivProtocol": "des",

"WebEnable": true

}

"RoleId": "User",

"UserName": "User123",

"Password": null

}

Response code: 201

Response field description

Field	Date type	Description
Enabled	Boolean	Enabling status of the user account.
Locked	Boolean	Account lockout status. Supported option: · false.
Role	String	User role.
RoleId	String	Role name.
UserName	String	Username.

The server returns status code 201 for a successful operation.

Change history

Version	Change description
HDM-2.06.00	The value format for the RoleId field changed from Customn to CustomRolen, where n represents 1 to 5.
HDM-2.0.04	Deleted the Oem.Public.KvmEnable and Oem.Public.VmediaEnable fields.
HDM-1.30.18P5X	Changed the following role IDs: · Changed User to Commonuser. · Changed None to Noaccess. NOTE: The changes take effect only in HDM-1.30.18P5X versions.
HDM-1.30.06	Added the following fields: Oem.Public.IPMIEnable, Oem.Public.WebEnable, Oem.Public.SnmpV3Enable, Oem.Public.SnmpV3AccessPermission, Oem.Public.SnmpV3AuthProtocol, and Oem.Public.SnmpV3PrivProtocol.

Edit user account settings

Description

Edit the settings of a specific user account.

Privilege module

User accounts/Password modification

Request

Method and URL:

PATCH https://device_ip/redfish/v1/AccountService/Accounts/user_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"Enabled": true,

"Password": password,

"UserName": name,

"RoleId": role,

"Locked": false,

"Oem": {

"Public": {

"IPMIEnable": true,

"WebEnable": true,

"SnmpV3Enable": true,

"SnmpV3AccessPermission": "read_only",

"SnmpV3AuthProtocol": "sha",

"SnmpV3PrivProtocol": "des"

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
user_id	ID of the user.	Integer.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
Enabled	Enable or disable the user account.	Boolean.
UserName	Username.	String.
Password	Password. Up to 20 characters.	String.
RoleId	Role name.	String. Supported options: · Administrator. · Operator. · User. · None. · Custom_name_1. By default, the custom role name is CustomRole1. · Custom_name_2. By default, the custom role name is CustomRole2. · Custom_name_3. By default, the custom role name is CustomRole3. · Custom_name_4. By default, the custom role name is CustomRole4. · Custom_name_5. By default, the custom role name is CustomRole5.
Locked	Account lockout status.	Boolean. Supported option: · false.
Oem.Public.IPMIEnable	Enable or disable the IPMI access privilege.	Boolean.
Oem.Public.WebEnable	Enable or disable the Web extended privilege.	Boolean.
Oem.Public.SnmpV3Enable	Enable or disable SNMPv3	Boolean.
Oem.Public.SnmpV3AccessPermission	SNMPv3 access privilege.	String. Supported options: · read_only. · read_write.
Oem.Public.SnmpV3AuthProtocol	SNMPv3 authentication algorithm.	String. Supported options: · sha. · md5.
Oem.Public.SnmpV3PrivProtocol	SNMPv3 encryption algorithm.	String. Supported options: · des. · aes.

Usage guidelines

Non-administrator users can edit their own settings.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/AccountService/Accounts/3

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"Enabled": true,

"Password": "test@test123",

"RoleId": "User",

"UserName": "User123",

"Locked": false,

"Oem": {

"Public": {

"IPMIEnable": true,

"WebEnable": true,

"SnmpV3Enable": true,

"SnmpV3AccessPermission": "read_only",

"SnmpV3AuthProtocol": "sha",

"SnmpV3PrivProtocol": "des"

}

Response:

{

"@odata.type": "#ManagerAccount.v1_1_2.ManagerAccount",

"Description": "User Account",

"Enabled": true,

"Id": "3",

"Links": {

"Roles": {

"@odata.id": "/redfish/v1/AccountService/Roles/User"

}

"Locked": false,

"Name": "User Account",

"Oem": {

"Public": {

"IPMIEnable": true,

"SnmpV3AccessPermission": "read_write",

"SnmpV3AuthProtocol": "sha",

"SnmpV3Enable": true,

"SnmpV3PrivProtocol": "des",

"WebEnable": true

}

"RoleId": "User",

"UserName": "User123",

"Password": null

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.06.00	The value format for the RoleId field changed from Customn to CustomRolen, where n represents 1 to 5.
HDM-2.0.04	Deleted the Oem.Public.KvmEnable and Oem.Public.VmediaEnable fields.
HDM-1.30.18P5X HDM-2.0.03	Changed the following role IDs: · Changed User to Commonuser. · Changed None to Noaccess. NOTE: The changes take effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.09	· Changed the status code for a successful operation to 200. · Added the response.
HDM-1.30.06	Added the following fields: Oem.Public.IPMIEnable, Oem.Public.WebEnable, Oem.Public.SnmpV3Enable, Oem.Public.SnmpV3AccessPermission, Oem.Public.SnmpV3AuthProtocol, and Oem.Public.SnmpV3PrivProtocol.

Delete a user account

Description

Delete a specific user account from the server.

Privilege module

User accounts

Request

Method and URL:

DELETE https://device_ip/redfish/v1/AccountService/Accounts/user_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
user_id	ID of the user.	Integer.

Examples

Method and URL:

DELETE https://192.168.18.18/redfish/v1/AccountService/Accounts/3

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@Message.ExtendedInfo": {

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "The account was successfully removed.",

"MessageArgs": [],

"MessageId": "Base.1.0.AccountRemoved",

"RelatedProperties": [],

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-1.30.09

· Changed the status code for a successful operation to 200.

· Added the response.

Obtain role collection information

Description

Obtain information about all roles from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/AccountService/Roles

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Usage guidelines

Non-administrator users can obtain only their own role collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/AccountService/Roles

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#RoleCollection.RoleCollection",

"@odata.id": "/redfish/v1/AccountService/Roles",

"@odata.type": "#RoleCollection.RoleCollection",

"Members": [

{

"@odata.id": "/redfish/v1/AccountService/Roles/Administrator"

{

"@odata.id": "/redfish/v1/AccountService/Roles/Operator"

{

"@odata.id": "/redfish/v1/AccountService/Roles/User"

{

"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole1"

{

"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole2"

{

"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole3"

{

"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole4"

{

"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole5"

{

"@odata.id": "/redfish/v1/AccountService/Roles/None"

}

"[email protected]": 9,

"Name": "Roles Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the role collection resource model.
@odata.id	String	Link to the role collection resource.
@odata.type	String	Type of the role collection resource.
Members	Array	Role resources. Supported options: · Operator. · Administrator. · User. · None. · Custom_name_1. By default, the custom role name is CustomRole1. · Custom_name_2. By default, the custom role name is CustomRole2. · Custom_name_3. By default, the custom role name is CustomRole3. · Custom_name_4. By default, the custom role name is CustomRole4. · Custom_name_5. By default, the custom role name is CustomRole5.
[email protected]	Integer	Number of role types.

The server returns status code 200 for a successful operation.

Obtain role information

Description

Obtain information about a specific role from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/AccountService/Roles/role_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
role_id	Role ID.	You can obtain available role names from role collection information.

Usage guidelines

Non-administrator users can obtain only their own role information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/AccountService/Roles/Administrator

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Role.Role(*)",

"@odata.id": "/redfish/v1/AccountService/Roles/Administrator",

"@odata.type": "#Role.v1_2_1.Role",

"AssignedPrivileges": [

"ConfigureUsers",

"ConfigureComponents",

"Login",

"ConfigureSelf"

"Description": "Administrator User Role",

"Id": "Administrator",

"IsPredefined": true,

"Name": "User Role",

"OemPrivileges": [

"OemKvm",

"OemVmm",

"OemSecurityMgmt",

"OemPowerControl",

"OemDiagnosis"

]

}

Response code: 200

Response field description

Field	Date type	Description
@odata.context	String	OData description of the role resource model.
@odata.id	String	Link to the role resource.
@odata.type	String	Type of the role resource.
AssignedPrivileges	Array	Privileges assigned to the role. Supported options: · ConfigureUsers—Configure the settings of all user accounts. · ConfigureComponents—Configure components managed by the account service. · Login—Log in to the Redfish service and read resources. · ConfigureSelf—Configure the settings of the current user account.
Description	String	Description of the role resource.
Id	String	Role name.
IsPredefined	Boolean	Whether the role is a predefined role.
Name	String	Role resource name.
OemPrivileges	Array	Custom access privileges for the server. Supported options: · OemKvm. · OemVmm. · OemSecurityMgmt. · OemPowerControl. · OemDiagnosis.

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-2.0.04

· Revised the privileges.

· Revised the array of options for the AssignedPrivileges and OemPrivileges fields.

HDM-1.30.06

Added the OemPrivileges field.

Edit role settings

Description

Edit the settings for a specific role.

Privilege module

User accounts

Request

Method and URL:

PATCH https://device_ip/redfish/v1/AccountService/Roles/role_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"AssignedPrivileges": [

"ConfigureComponents",

"ConfigureSelf"

"OemPrivileges": [

"OemKvm",

"OemVmm",

"OemSecurityMgmt",

"OemPowerControl",

"OemDiagnosis"

]

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
role_id	Role ID.	You can obtain available role names from role collection information.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
OemKvm	Boolean	Remote control.
OemVmm	Boolean	Remote media.
OemSecurityMgmt	Boolean	Security.
ConfigureComponents	Boolean	Basic configuration.
OemPowerControl	Boolean	Power control.
OemDiagnosis	Boolean	Maintenance.
ConfigureSelf	Boolean	Password modification.

Usage guidelines

The role settings are editable only for customized roles.

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/AccountService/Roles/CustomRole1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"AssignedPrivileges": [

"ConfigureComponents",

"ConfigureSelf"

"OemPrivileges": [

"OemKvm",

"OemVmm",

"OemSecurityMgmt",

"OemPowerControl",

"OemDiagnosis"

]

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#Role.Role(*)",

"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole1",

"@odata.type": "#Role.v1_2_1.Role",

"AssignedPrivileges": [

"ConfigureUsers",

"ConfigureComponents",

"Login",

"ConfigureSelf"

"Description": "CustomRoel1 User Role",

"Id": "CustomRole1",

"IsPredefined": true,

"Name": "User Role",

"OemPrivileges": [

"OemKvm",

"OemVmm",

"OemSecurityMgmt",

"OemPowerControl",

"OemDiagnosis"

]

}

Response code: 200

Response field description

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.08.00	Modified the module from security to user accounts.
HDM-2.06.00	Modified the filed location.
HDM-2.0.04	Added the redfish/v1/AccountService/Roles/role_id interface.

Obtain role names

Description

Obtain role names from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/AccountService/Roles/Oem/Public/RoleNames

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/AccountService/Roles/Oem/Public/RoleNames

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#RoleCollection.RoleCollection",

"@odata.id": "/redfish/v1/AccountService/Roles/Oem/Public/RoleNames",

"@odata.type": "#RoleCollection.RoleCollection",

"Administrator": "Administrator",

"CustomRole1Name": "CustomRole1",

"CustomRole2Name": "CustomRole2",

"CustomRole3Name": "CustomRole3",

"CustomRole4Name": "CustomRole4",

"CustomRole5Name": "CustomRole5",

"Operator": "Operator",

"User": "User"

}

Response code: 200

Response field description

Field	Date type	Description
@odata.context	String	OData description of the role resource model.
@odata.id	String	Link to the role resource.
@odata.type	String	Type of the role resource.
CustomRole1Name	String	Name of custom role 1. The name is case-sensitive and must be in the range of 1 to 16 characters. Only letters, digits, dots (.), hyphens (-), underscores (_), and at signs (@) are allowed.
CustomRole2Name	String	Name of custom role 2. The name is case-sensitive and must be in the range of 1 to 16 characters. Only letters, digits, dots (.), hyphens (-), underscores (_), and at signs (@) are allowed.
CustomRole3Name	String	Name of custom role 3. The name is case-sensitive and must be in the range of 1 to 16 characters. Only letters, digits, dots (.), hyphens (-), underscores (_), and at signs (@) are allowed.
CustomRole4Name	String	Name of custom role 4. The name is case-sensitive and must be in the range of 1 to 16 characters. Only letters, digits, dots (.), hyphens (-), underscores (_), and at signs (@) are allowed.
CustomRole5Name	String	Name of custom role 5. The name is case-sensitive and must be in the range of 1 to 16 characters. Only letters, digits, dots (.), hyphens (-), underscores (_), and at signs (@) are allowed.

Change history

Version	Change description
HDM-2.33	Added the redfish/v1/AccountService/Roles/Oem/Public/RoleNames interface.

Edit a role name

Description

Edit the name of a specific role.

Privilege module

User accounts

Request

Method and URL:

PATCH https://device_ip/redfish/v1/AccountService/Roles/Oem/Public/RoleNames

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"CustomRole1Name": "CustomRole1name",

"CustomRole2Name": "CustomRole2name",

"CustomRole3Name": "CustomRole3name",

"CustomRole4Name": "CustomRole4name",

"CustomRole5Name": "CustomRole5name"

}

Parameters

Parameter		Description	Value
device_ip		IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN		Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
ifmatch_value		Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
CustomRole1Name	String		Name of custom role 1. The name is case-sensitive and must be in the range of 1 to 16 characters. Only letters, digits, dots (.), hyphens (-), underscores (_), and at signs (@) are allowed.
CustomRole2Name	String		Name of custom role 2. The name is case-sensitive and must be in the range of 1 to 16 characters. Only letters, digits, dots (.), hyphens (-), underscores (_), and at signs (@) are allowed.
CustomRole3Name	String		Name of custom role 3. The name is case-sensitive and must be in the range of 1 to 16 characters. Only letters, digits, dots (.), hyphens (-), underscores (_), and at signs (@) are allowed.
CustomRole4Name	String		Name of custom role 4. The name is case-sensitive and must be in the range of 1 to 16 characters. Only letters, digits, dots (.), hyphens (-), underscores (_), and at signs (@) are allowed.
CustomRole5Name	String		Name of custom role 5. The name is case-sensitive and must be in the range of 1 to 16 characters. Only letters, digits, dots (.), hyphens (-), underscores (_), and at signs (@) are allowed.

Examples

Method and URL:

PATCH https://192.168.18.18/AccountService/Roles/Oem/Public/RoleNames

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"CustomRole1Name": "abc",

"CustomRole2Name": "123",

"CustomRole3Name": "zxc",

"CustomRole4Name": "h3c",

"CustomRole5Name": "vbn",

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#RoleCollection.RoleCollection",

"@odata.id": "/redfish/v1/AccountService/Roles/Oem/Public/RoleNames",

"@odata.type": "#RoleCollection.RoleCollection",

"Administrator": "Administrator",

"CustomRole1Name": "abc",

"CustomRole2Name": "123",

"CustomRole3Name": "zxc",

"CustomRole4Name": "h3c",

"CustomRole5Name": "vbn",

"Operator": "Operator",

"User": "User"

}

Response code: 200

Change history

Version	Change description
HDM-2.33	Added the redfish/v1/AccountService/Roles/Oem/Public/RoleNames interface.

Export logs

Description

Export SDS or EVENT logs.

Privilege module

Maintenance

Request

Method and URL:

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.Dump

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

cifs or sftp

{

"StartTime":"",

"EndTime":"",

"Name":"",

"Telephone":"",

"EmailAddress":"",

"Type":"URI",

"LogType":"EVENT"

"Content": "cifs://username:password@ip/sharefilename/filename"

}

sftp

{

"StartTime":"",

"EndTime":"",

"Name":"",

"Telephone":"",

"EmailAddress":"",

"Type":"URI",

"LogType":"SDS"

"Content": "sftp:// username:password@ip/filename "

}

tftp, nfs

tftp:

{

"StartTime":"",

"EndTime":"",

"Name":"",

"Telephone":"",

"EmailAddress":"",

"Type":"URI",

"LogType":"EVENT"

"Content": "tftp://ip/filename"

}

{

"StartTime":"",

"EndTime":"",

"Name":"",

"Telephone":"",

"EmailAddress":"",

"Type":"URI",

"LogType":"SDS"

"Content": "nfs://ip/share/filname"

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
manager_id	Manager ID.	This field is fixed to 1 for all server models.
Content	Export path.	File transmission protocol: sftp, nfs, cifs, or tftp Operation path: Chinese characters are not supported. Filename format: · SDS logs: .sds format · EVENT logs: .tar.gz format. The file name, account, and password each can contain up to 31 characters. The total length cannot exceed 255. Special characters @!$^&()_+.;[]{}-=~` are supported. Chinese characters are not supported.
LogType	Type of logs to be exported.	Supported options: · SDS. · EVENT. The default type is SDS.
StartTime	Start time.	Do not specify this parameter.
EndTime	End time.	Do not specify this parameter.
Name	Name.	Do not specify this parameter.
Telephone	Phone number.	Do not specify this parameter.
EmailAddress	Email address.	Do not specify this parameter.

Examples

Method and URL:

POST https://172.14.120.8/redfish/v1/Managers/1/Actions/Oem/Public/Manager.Dump

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"StartTime":"",

"EndTime":"",

"Name":"",

"Telephone":"",

"EmailAddress":"",

"Type":"URI",

"LogType":"EVENT"

"Content": "tftp://172.14.81.73/20230131.tar.gz "

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

}

Response code: 202

Response field description

Field	Data type	Description
@odata.context	String	OData description information for the role resource model.

Change history

Version	Change description
HDM-3.33	Added this interface. The interface supports using the LogType parameter to specify the type of logs to be exported.

Operations on session service resources

Create a session

Description

Create a session on the server.

Privilege module

Security

Request

Method and URL:

POST https://device_ip/redfish/v1/SessionService/Sessions

Request header:

Content-Type: application/json

Request body:

{

"UserName":name,

"Password":password

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
name	Username for creating the session.	HDM user.
password	Password for creating the session.	Password of the HDM user. Up to 20 characters.

Usage guidelines

This operation will generate an X-Auth-Token, which is required in the header of most Redfish operations for authentication. As a best practice, first create a session before you perform other operations.

You can create a maximum of 10 sessions.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/SessionService/Sessions

Request header:

Content-Type: application/json

Request body:

{

"UserName":"admin",

"Password":"Password@_"

}

Response:

{

"@odata.context": "/redfish/v1/$metadataSessionService/Sessions",

"@odata.etag": "W/\"1611832123\"",

"@odata.id": "/redfish/v1/SessionService/Sessions/db3311a9e26e8214551100534853c327",

"@odata.type": "#Session.v1_1_0.Session",

"Description": "Session for user admin",

"Id": "db3311a9e26e8214551100534853c327",

"Name": "admin Session",

"UserName": "admin"

}

Response header:

Strict-Transport-Security→max-age=31536000; includeSubdomains

Server→AMI MegaRAC Redfish Service

Location→/redfish/v1/SessionService/Sessions/db3311a9e26e8214551100534853c327

X-Auth-Token→LivOsTWPrllXaVck4Wgy64tkMt5KvGYAhYTcAyTU/38=

ETag→W/"cc1b4233d7e5f28d830d03aeabcea0ce"

Access-Control-Allow-Origin→*

Access-Control-Expose-Headers→X-Auth-Token

Access-Control-Allow-Headers→X-Auth-Token

Access-Control-Allow-Credentials→true

Cache-Control→no-cache, must-revalidate

Link→<http://redfish.dmtf.org/schemas/v1/Session.v1_1_0.json>; rel=describedby

Link→</redfish/v1/SessionService/Sessions/db3311a9e26e8214551100534853c327>; path=

Content-Type→application/json; charset=UTF-8

OData-Version→4.0

Content-Length→342

Date→Thu, 28 Jan 2021 11:08:44 GMT

Response code: 201

Response field description

Field	Data type	Description
@odata.context	String	OData description of the session resource model.
@odata.etag	String	ETag information.
@odata.id	String	Link to the session resource.
odata.type	String	Type of the session resource.
Description	String	Description of the session.
Id	String	Session ID.
Name	String	Session name.
UserName	String	Username.

The server returns status code 201 for a successful operation.

Obtain session collection information

Description

Obtain information about all sessions from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/SessionService/Sessions

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/SessionService/Sessions

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#SessionCollection.SessionCollection",

"@odata.id": "/redfish/v1/SessionService/Sessions",

"@odata.type": "#SessionCollection.SessionCollection",

"Members": [

{

"@odata.id": "/redfish/v1/SessionService/Sessions/735fe1ce672b88382a79fb0ff7e20a2e"

}

"Name": "Session Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the session collection resource model.
@odata.id	String	Link to the session collection resource.
@odata.type	String	Type of the session collection resource.
Members	Array	List of sessions.
[email protected]	Integer	Number of sessions.
Name	String	Session resource name.

The server returns status code 200 for a successful operation.

Obtain session information

Description

Obtain information about a specific session from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/SessionService/Sessions/session_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
session_id	ID of the session resource.	You can obtain available session resource IDs from session collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/SessionService/Sessions/107

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Session.Session",

"@odata.id": "/redfish/v1/SessionService/Sessions/107",

"@odata.type": "#Session.v1_1_0.Session",

"Description": "Session for user admin",

"Id": "107",

"Name": "admin Session",

"Oem": {

"UserIP": "10.99.160.48",

"UserRole": "Administrator",

"UserTag": "Web HTTPS"

"UserName": "admin"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the session resource model.
@odata.id	String	Link to the session resource.
@odata.type	String	Type of the session resource.
Id	String	ID of the session resource.
Name	String	Name of the session service resource.
UserName	String	User name of the session service resource.
Oem.UserIP	String	IP address of the user using the session service.
Oem.UserTag	String	Interface for the session service. Supported options: · Redfish.
Oem.UserRole	String	Role name.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.10	Deleted the UserId field.
HDM-1.30.09	Added the redfish/v1/SessionService/Sessions/session_id interface.

Delete a session

Description

Delete a specific session.

Privilege module

Security

Request

Method and URL:

DELETE https://device_ip/redfish/v1/SessionService/Sessions/session_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
session_id	Session ID.	You can obtain available session IDs from session collection information.

Examples

Method and URL:

DELETE https://device_ip/redfish/v1/SessionService/Sessions/session_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@Message.ExtendedInfo": {

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageArgs": "[]",

"MessageId": "Base.1.0.Success",

"RelatedProperties": "[]",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

Response code: 200

Response field description

Field	Data type	Description
code	String	String indicating a specific message ID in the message registry.
message	String	Error message corresponding to a message in the message registry.
@Message.ExtendedInfo	Object	Extended information of the error message.
@odata.type	String	OData description of the message resource.
Message	String	Details of the message.
MessageArgs	Array	Message arguments.
MessageId	String	Message ID.
RelatedProperties	Array	Related properties for the message.
Resolution	String	Recommended actions for the error.
Severity	String	Severity level. Supported options: · OK. · Warning. · Critical.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.12	Added the redfish/v1/SessionService/Sessions/session_id interface.

Obtain session information

Description

Obtain information about the current session from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/SessionService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Usage guidelines

N/A.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/SessionService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#SessionService.SessionService",

"@odata.id": "/redfish/v1/SessionService",

"@odata.type": "#SessionService.v1_1_3.SessionService"

"Description": "Session Service",

"Id": "SessionService",

"Name": "Session Service",

"ServiceEnabled": true,

"SessionTimeout": 1800,

"Sessions": {

"@odata.id": "/redfish/v1/SessionService/Sessions"

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the session service resource model.
@odata.id	String	Link to the session service resource.
@odata.type	String	Type of the session service resource.
Id	String	ID of the session service resource.
Name	String	Name of the session service resource.
ServiceEnabled	Boolean	Enabling status of the session service.
SessionTimeout	Integer	Session timeout time, in seconds. The default is 1800 seconds.
Sessions	Object	List of sessions,
@odata.id	String	Links to sessions.
Status	Object	Session management states: · Health—Whether the session management is healthy. · State—Whether the session management has been enabled.

The server returns status code 200 for a successful operation.

Edit session settings

Description

Edit session settings for the server.

Privilege module

Security

Request

Method and URL:

PATCH https://device_ip/redfish/v1/SessionService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

Request body:

{

"ServiceEnabled": true,

"SessionTimeout": 1800

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
ifmatch_value	Entity tag (ETag) that uniquely represents the requested resource.	To obtain the entity tag value of a resource, send a GET request to it and then obtain the ETag value from the response header.
ServiceEnabled	Enable or disable the session service.	Boolean
SessionTimeout	Session timeout.	Integer. Value range: 30 to 86400 seconds

Examples

Method and URL:

PATCH https://192.168.18.18/redfish/v1/SessionService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

Request body:

{

"ServiceEnabled": true,

"SessionTimeout": 1800

}

Response:

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/SessionService",

"@odata.type": "#SessionService.v1_1_3.SessionService"

"Description": "Session Service",

"Id": "SessionService",

"Name": "Session Service",

"ServiceEnabled": true,

"SessionTimeout": 1800,

"Sessions": {

"@odata.id": "/redfish/v1/SessionService/Sessions"

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the session service resource model.
@odata.id	String	Link to the session service resource.
@odata.type	String	Type of the session service resource.
Id	String	ID of the session service resource.
Name	String	Name of the session service resource.
SessionTimeout	Integer	Session timeout.
Sessions	List of sessions.
@odata.id	String	Link to the session list.
Status.Health	String	Health status.
Status.State	String	Enabling status.

The server returns status code 200 for a successful operation.

Change history

Version

Change description

HDM-1.30.09

· Changed the status code for a successful operation to 200.

· Added the response.

Operations on update service resources

Obtain update service information

Description

Obtain information about the current update service from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/UpdateService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/UpdateService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#UpdateService.UpdateService",

"@odata.id": "/redfish/v1/UpdateService",

"@odata.type": "#UpdateService.v1_2_1.UpdateService",

"Actions": {

"#UpdateService.SimpleUpdate": {

"@Redfish.ActionInfo": "/redfish/v1/UpdateService/SimpleUpdateActionInfo",

"target": "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate"

}

"Description": "Redfish Update Service",

"FirmwareInventory": {

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"

"Id": "UpdateService",

"Name": "Update Service",

"ServiceEnabled": true,

"Status": {

"Health": "OK",

"State": "Enabled"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the update service resource model.
@odata.id	String	Link to the update service resource.
@odata.type	String	Type of the update service resource.
Actions	List of executable operations for the specified resource.
UpdateService.SimpleUpdate	Object	Path to the firmware update service resource.
Id	String	ID of the update service resource.
Name	String	Name of the update service resource.
ServiceEnabled	Boolean	Enabling status of the update service.
Status.Health	String	Health status of the update service resource.
Status.State	String	Enabling status of the update service resource.
FirmwareInventory	Object	Links to available firmware resources.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.09	Deleted the Oem fields from this interface and moved the deleted fields to the TaskService interfaces.

Obtain firmware inventory collection information

Description

Obtain information about all firmware inventories from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/UpdateService/FirmwareInventory

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/UpdateService/FirmwareInventory

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#SoftwareInventoryCollection.SoftwareInventoryCollection",

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory",

"@odata.type": "#SoftwareInventoryCollection.SoftwareInventoryCollection",

"Description": "Collection of Firmware Inventory resources available to the UpdateService",

"Members": [

{

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/HDM"

{

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/CPLD"

{

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/BIOS"

{

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/PSU"

}

"[email protected]": 4,

"Name": "Firmware Inventory Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the firmware inventory collection resource model.
@odata.id	String	Link to the firmware inventory collection resource.
@odata.type	String	Type of the firmware inventory collection resource.
Description	String	Description of the firmware inventory collection resource.
Members	Array	List of firmware inventories.
[email protected]	Integer	Number of firmware inventories.
Name	String	Name of the firmware inventory collection resource.

The server returns status code 200 for a successful operation.

Obtain firmware inventory information

Description

Obtain information about a specific firmware inventory from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/UpdateService/FirmwareInventory/softid

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
softid	Firmware type.	You can obtain available firmware types from firmware inventory collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/UpdateService/FirmwareInventory/HDM

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#UpdateService/FirmwareInventory/Members/$entity",

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/HDM",

"@odata.type": "#SoftwareInventory.v1_2_0.SoftwareInventory",

"Id": "HDM",

"Name": "HDM",

"RelatedItem": [

{

"@odata.id": "/redfish/v1/Managers/1"

}

"SoftwareId": "HDM",

"Status": {

"Health": "OK",

"State": "Enabled"

"Updateable": true,

"Version": "2.10.00 HDM V100R001B05D012"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the firmware inventory resource model.
@odata.id	String	Link to the firmware inventory resource.
@odata.type	String	Type of the firmware inventory resource.
Id	String	Firmware ID.
Name	String	Firmware name.
RelatedItem	Array	ID of resources associated with the firmware.
Status. Health	String	Health status of the firmware.
Status. State	String	Enabling status of the firmware.
SoftwareId	String	Firmware type. Supported options: · HDM. · BIOS. · CPLD. The supported options for CPLD include: ¡ CPLD. ¡ AUXCPLD. ¡ STBCPLD. ¡ DBCPLD. ¡ PDBCPLD. ¡ NDCPLD. ¡ PDBSCPLD. ¡ GPUFPGA. This value is available only for the R5300G5 Redstone. · FANMCU. This value is available only for R5500 G5 AMD or Intel servers. · REPO. · PSU. You can obtain available firmware types from firmware inventory collection information.
Updateable	Boolean	Firmware validity.
Version	String	Firmware version.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-2.42	Added option REPO for the SoftwareId field.
HDM-2.33	Added option FANMCU for the SoftwareId field.
HDM-2.26	Added option GPUFPGA for the SoftwareId field.

Update firmware

Description

Update the firmware of the server.

Privilege module

Maintenance

Request

Method and URL:

POST https://device_ip/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

HTTP and TFTP:

{

"ImageURI":"http://IP/image.bin",(tftp://IP/image.bin)

"TransferProtocol": protocol,

"Oem": {

"Public": {

"ImageType":type,

"PreserveConfig":true,

"Reboot":false,

"BiosUpdateFlag":"all",

"ForceUpgrade":true //only for REPO firmware

"ImageMd5URI":"http://IP/md5.txt",(tftp://IP/md5.txt), //only for REPO firmware

}

SFTP:

{

"ImageURI":"sftp://username:passwd@IP/HDM-1.11.29P21_signed.bin",

"TransferProtocol":"SFTP",

"Oem": {

"Public": {

"ImageType":type,

"PreserveConfig":true,

"Reboot":false,

"BiosUpdateFlag":"all",

"ForceUpgrade":true //only for REPO firmware

"ImageMd5URI":"sftp://username:passwd@IP/md5.txt", //only for REPO firmware

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
ImageURI	Link to the update image.	String.
TransferProtocol	Transfer protocol.	String. Supported options: · HTTP. · TFTP. · SFTP.
Oem.Public.ImageType	Firmware type.	String. Supported options: · HDM. · BIOS. · CPLD. The supported options for CPLD include: ¡ CPLD. ¡ AUXCPLD. ¡ STBCPLD. ¡ DBCPLD. ¡ PDBCPLD. ¡ NDCPLD. ¡ PDBSCPLD. ¡ GPUFPGA. This value is available only for the R5300G5 Redstone. ¡ FANMCU. This value is available only for R5500 G5 AMD or Intel servers. · PSU. · REPO You can obtain available firmware types from firmware inventory collection information.
Oem.Public.PreserveConfig	Enabling status of preserving the existing configuration.	Boolean. Supported options: · true—Enabled. · false—Disabled.
Oem.Public.Reboot	Server reboot status.	Boolean. Supported options: · true—Reboot. · false—Not reboot.
Oem.Public.BiosUpdateFlag	Type of the BIOS firmware to update.	String. Supported options: · all—Update the BIOS firmware and ME firmware. · bios—Update the BIOS firmware. · me—Update the ME firmware. If you do not specify this field, the system updates all BIOS firmware.
Oem.Public.ForceUpgrade	Type of the REPO firmware to update.	Boolean. Supported options: · false—Allows only update from a lower version to a higher version. · true—Performs force update.
Oem.Public.ImageMd5URI	Path of the MD5 value of the update image package.	This field is only available for REPO firmware update.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"ImageURI":"http://192.168.190.51/HDM-1.11.20_signed.dbg.bin",

"TransferProtocol": "HTTP",

"Oem": {

"Public": {

"ImageType":"HDM",

"PreserveConfig":true,

"Reboot":false,

"BiosUpdateFlag":"all"

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

"@odata.type": "#TaskCollection.TaskCollection",

"Description": "Task Collection",

"Members": [

{

"@odata.id": "/redfish/v1/TaskService/Tasks/1"

}

"Name": "Task Collection"

}

Response code: 202

Response field description

The server returns status code 202 for a successful operation.

Change history

Version	Change description
HDM-2.42	Added the option REPO for the Oem.Public.ImageType field. Added the Oem.Public.ImageMd5URI and Oem.Public.ForceUpgrade fields.
HDM-2.33	Added option FANMCU for the Oem.Public.ImageType field.
HDM-2.27	Added option GPUFPGA for the Oem.Public.ImageType field.
HDM-2.11.93	Added support for IPv6 of the TFTP protocol.
HDM-1.30.17	Added the BiosUpdateFlag field. This field was also added to HDM-1.30.15P02.
HDM-1.30.09	Changed the status code for a successful operation to 202 and added the response.
HDM-1.30.07	Added support for transfer protocol SFTP.

Operations on task service resources

Obtain task service information

Description

Obtain current information about the task service from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/TaskService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/TaskService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#TaskService.TaskService",

"@odata.id": "/redfish/v1/TaskService",

"@odata.type": "#TaskService.v1_1_1.TaskService",

"CompletedTaskOverWritePolicy": "Oldest",

"DateTime": "2019-08-21T17:08:34+08:00",

"Description": "Task Service",

"Id": "TaskService",

"LifeCycleEventOnTaskStateChange": false,

"Name": "Task Service",

"ServiceEnabled": true,

"Status": {

"Health": "OK",

"State": "Enabled"

"Tasks": {

"@odata.id": "/redfish/v1/TaskService/Tasks"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the task service resource model.
@odata.id	String	Link to the task service resource.
@odata.type	String	Type of the task service resource.
Id	String	ID of the task service resource.
Name	String	Name of the task service resource.
DateTime	String	System date and time.
CompletedTaskOverWritePolicy	String	Processing policy for completed tasks. Supported options: · Oldest—Overwrite the oldest tasks.
LifeCycleEventOnTaskStateChange	Boolean	Whether to report task state changes. Supported options: · false—Do not report task state changes.
Status	Object	Resource status: · Health—Health status. · State—Enabling status.
ServiceEnabled	Boolean	Enabling status of the task service.
Tasks	Task list.
@odata.id	String	Link to the task collection resource.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.06	Added the redfish/v1/TaskService interface.

Obtain task collection inforamtion

Description

Obtain information about all tasks from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/TaskService/Tasks

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/TaskService/Tasks

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

"@odata.id": "/redfish/v1/TaskService/Tasks",

"@odata.type": "#TaskCollection.TaskCollection",

"Name": "Task Collection",

"[email protected]": 3,

"Members": [

{

"@odata.id": "/redfish/v1/TaskService/Tasks/1"

{

"@odata.id": "/redfish/v1/TaskService/Tasks/2"

{

"@odata.id": "/redfish/v1/TaskService/Tasks/3"

}

]

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the task service resource model.
@odata.id	String	Link to the task service resource.
@odata.type	String	Type of the task service resource.
Name	String	Name of the task collection resource.
[email protected]	Integer	Number of current running tasks.
Members	Task resource list.
@odata.id	String	Link to a specific task resource.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.06	Added the redfish/v1/TaskService/Tasks interface.

Obtain task inforamtion

Description

Obtain information about a specific task from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/TaskService/Tasks/task_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
task_id	Task resource ID.	You can obtain available task resource IDs from task collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/TaskService/Tasks/1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#Task.Task",

"@odata.id": "/redfish/v1/TaskService/Tasks/1",

"@odata.type": "#Task.v1_2_0.Task",

"Description": "BMC Update Task",

"EndTime": "2020-12-10T00:30:56+-8:00",

"Id": "1",

"Messages": {

"Message": "Update The BMC Firmware",

"MessageArgs": [

"BMC Firmware"

"MessageId": "HDM.1.0.FirmwareUpdateComponent",

"RelatedProperties": [

"BMC"

"Severity": "OK",

"Trigger Condition": "BMC Reset."

"Name": "Update Task",

"Oem": {

"Public": {

"Task Description": "BMC Update Task",

"Task Percentage": "33%"

}

"StartTime": "2020-12-10T00:30:50+-8:00",

"TaskState": "Verifying",

"TaskStatus": "OK"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the task service resource model.
@odata.id	String	Link to the task resource.
@odata.type	String	Type of the task resource.
Id	String	ID of the task resource.
Description	String	Description of the task resource.
Name	String	Name of the task resource.
TaskState	String	Task state. Supported options: · Running. · Uploading. · Verifying. · Updating. · Waiting For Effect. · Going To Effect. · Completed. · Failed. · Cancelled. · Mounted. · Downloading.
StartTime	String	Start time of the task.
EndTime	String	Predicted end time of the task.
TaskStatus	String	Running status of the task. Supported options: · OK. · FAILED. NOTE: For a task that updates multiple power supplies, this field displays FAILED if the update of all power supplies fails or no power supplies require an update. To view the update result for a power supply, review the operation log.
Messages	Object	Task-related information.
MessageId	String	Message ID.
RelatedProperties	Array	Related properties for the message.
Message	String	Details of the message.
MessageArgs	Array	Message arguments.
Severity	String	Severity level. Supported options: · OK. · Warning. · Critical.
Trigger Condition	String	Trigger condition. Supported options: · BMC Reset. · OS Reset. · OS Power Off. · Automatic. · Power Cycle. · PSU Reset.
Task Description	String	Task description.
Task Percentage	String	Task completion progress, in percent.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.08	Added the support for SDS log collection, MCA policy, KVM image mounting, task import, and task export.
HDM-1.30.06	Added the redfish/v1/TaskService/Tasks/taskid interface.

Delete a task

Description

Delete a specific task.

Privilege module

Maintenance

Request

Method and URL:

DELETE https://device_ip/redfish/v1/TaskService/Tasks/task_id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
task_id	Task resource ID.	You can obtain available task resource IDs from task collection information.

Examples

Method and URL:

DELETE https://192.168.18.18/redfish/v1/TaskService/Tasks/1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"error": {

"@Message.ExtendedInfo": [

{

"@Message.ExtendedInfo": {

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageArgs": [],

"MessageId": "Base.1.0.Success",

"RelatedProperties": [],

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the task service resource model.
@odata.id	String	Link to the task resource.
@odata.type	String	Type of the task resource.
Messages	Object	Task-related information.
MessageId	String	Message ID.
RelatedProperties	Array	Related properties for the message.
Message	String	Details of the message.
MessageArgs	Array	Message arguments.
Severity	String	Severity level. Supported options: · OK. · Warning. · Critical.

Change history

Version	Change description
HDM-2.93	Added the redfish/v1/TaskService/Tasks/task_id interface.

Operations on event service resources

Obtain event collection information

Description

Obtain information about all events from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/EventService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/EventService

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#EventService.EventService",

"@odata.id": "/redfish/v1/EventService",

"@odata.type": "#EventService.v1_1_0.EventService",

"Actions": {

"#EventService.SubmitTestEvent": {

"@Redfish.ActionInfo": "/redfish/v1/EventService/SubmitTestEventActionInfo",

"target": "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent"

}

"DeliveryRetryAttempts": 3,

"DeliveryRetryIntervalSeconds": 60,

"Description": "Event Service",

"EventTypesForSubscription": [

"StatusChange",

"ResourceUpdated",

"ResourceAdded",

"ResourceRemoved",

"Alert"

"Id": "EventService",

"Name": "Event Service",

"ServiceEnabled": true,

"Status": {

"Health": "OK",

"State": "Enabled"

"Subscriptions": {

"@odata.id": "/redfish/v1/EventService/Subscriptions"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the EventService resource model.
@odata.id	String	Link to the EventService resource.
@odata.type	String	Type of the event EventService resource.
Actions	Supported EventService actions. This field is not available in the current software version.
#EventService.SubmitTestE vent	Object	Send test events.
@Redfish.ActionInfo	String	Send the information obtaining link for test event actions.
DeliveryRetryAttempts	Integer	Maximum retransmission attempts for event subscription messages.
DeliveryRetryIntervalSeconds	Integer	Event subscription retransmission interval.
EventTypesForSubscription	Enumeration	Event types available for subscription. Supported options: · StatusChange. · ResourceUpdated. · ResourceAdded. · ResourceRemoved. · Alert.
ServiceEnabled	Boolean	Event report enabling status.
Id	String	ID of the event subscription resource.
Name	String	Name of the event subscription resource.
Status	Object	Resource status: · Health—Health status. · State—Enabling status.
Subscriptions	Object	Link to the event subscription collection information.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.09	Added the redfish/v1/EventService interface.

Create an event subscription

Description

Create an event subscription.

Privilege module

Basic configuration

Request

Method and URL:

POST https://device_ip/redfish/v1/EventService/Subscriptions

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Destination": "https://172.16.11.95",

"EventTypes": [

"StatusChange",

"ResourceUpdated",

"ResourceAdded",

"ResourceRemoved",

"Alert"

"HttpHeaders": {

"Content-Type": "application/json",

"OData-Version": "4.0",

"X-Auth-Token":"2e751b825163447d30d3021c98116221"

"Context": "event subscription context string",

"Protocol":"Redfish",

"MessageIds":[ ],

"OriginResources":[ ]

}

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
Destination	Event recipient.	String.
EventTypes	Types of events to be subscribed to.	Array. NOTE: Selective subscription is not supported. All types of events must be included.
HttpHeaders	HTTP header carried in messages for event report. The X-Auth-Token is generated when a session is created by using /redfish/v1/SessionService/Sessions.	Array.
Context	Event subscription context information.	String.
Protocol	Event subscription protocol.	String. Supported options: · Redfish.
MessageIds	Event subscription message ID matching list.	Array.
OriginResources	Event source matching list.	Array. The subscription will include all events, whatever value (including an empty value) is specified for this field.

Examples

Method and URL:

POST https://192.168.18.18/redfish/v1/EventService/Subscriptions

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

{

"Destination": "https://172.16.11.95",

"EventTypes": [

"StatusChange",

"ResourceUpdated",

"ResourceAdded",

"ResourceRemoved",

"Alert"

"HttpHeaders": {

"Content-Type": "application/json",

"OData-Version": "4.0",

"X-Auth-Token":"2e751b825163447d30d3021c98116221"

"Context": "event subscription context string",

"Protocol":"Redfish",

"MessageIds":[

"OriginResources":[ ]

}

Response:

{

"@odata.context": "/redfish/v1/$metadata#EventDestination.EventDestination",

"@odata.id": "/redfish/v1/EventService/Subscriptions/1",

"@odata.type": "#EventDestination.v1_3_0.EventDestination",

"Context": "event subscription context string",

"Description": "Event Subscription",

"Destination": "https://192.168.1.44",

"EventTypes": [

"ResourceRemoved",

"ResourceAdded",

"StatusChange",

"ResourceUpdated",

"Alert"

"HttpHeaders": null,

"Id": "2",

"MessageIds": [],

"Name": "Subscription 2",

"OriginResources": [],

"[email protected]": 0,

"Protocol": "Redfish"

}

Response code: 201

Response field description

The server returns status code 201 for a successful operation.

Change history

Version	Change description
HDM-2.11.97	Added the HttpHeaders field in the response body. The value for this field is null.
HDM-2.06.00	Changed the date type of the Id field from integer to string.
HDM-1.30.18P5X HDM-2.0.03	Changed value of the @odata.id field to the link to event subscription resource 1. NOTE: The change takes effect only in HDM-1.30.18P5X and HDM-2.0.03 versions.
HDM-1.30.09	Added the redfish/v1/EventService/Subscriptions interface.

Obtain event subscription collection information

Description

Obtain information about all event subscriptions from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/EventService/Subscriptions

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/EventService/Subscriptions

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#EventDestinationCollection.EventDestinationCollection",

"@odata.id": "/redfish/v1/EventService/Subscriptions",

"@odata.type": "#EventDestinationCollection.EventDestinationCollection",

"Description": "Collection for Event Subscriptions",

"Members": [

{

"@odata.id": "/redfish/v1/EventService/Subscriptions/1"

{

"@odata.id": "/redfish/v1/EventService/Subscriptions/2"

}

"Name": "Event Subscriptions Collection"

}

Response code: 200

Response field description

Field	Data type	Description
@odata.context	String	OData description of the event subscription collection resource model.
@odata.id	String	Link to the event subscription collection resource.
@odata.type	String	Type of the event subscription collection resource.
Name	String	Name of the event subscription collection resource.
Description	String	Description of the event subscription collection resource.
[email protected]	Integer	Number of event subscription resources.
Members	Event subscription resource list.
@odata.id	String	Link to an event subscription resource.

The server returns status code 200 for a successful operation.

Change history

Version	Change description
HDM-1.30.09	Added the redfish/v1/EventService/Subscriptions interface.

Obtain event subscription information

Description

Obtain information about a specific event subscription from the server.

Privilege module

Information query

Request

Method and URL:

GET https://device_ip/redfish/v1/EventService/Subscriptions/id

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Parameters

Parameter	Description	Value
device_ip	IP address for logging in to the device.	IPv4 or IPv6 address.
TOKEN	Authentication token.	The token is generated when a session is created by using /redfish/v1/SessionService/Sessions.
id	Event subscription resource ID.	You can obtain available event subscription resource IDs from event subscription collection information.

Examples

Method and URL:

GET https://192.168.18.18/redfish/v1/EventService/Subscriptions/1

Request header:

X-Auth-Token:TOKEN

Content-Type: application/json

Request body:

N/A

Response:

{

"@odata.context": "/redfish/v1/$metadata#EventDestination.EventDestination",

"@odata.id": "/redfish/v1/EventService/Subscriptions/1",

"@odata.type": "#EventDestination.v1_3_0.EventDestination",

"Context": "event subscription context string",

"Description": "Event Subscription",

"Destination": "https://172.16.11.95",

"EventTypes": [

"ResourceRemoved",

"ResourceUpdated",

"StatusChange",

"ResourceAdded",

"Alert"

"HttpHeaders": null,

"Id": "1",

"MessageIds": [

"Events.2.5.PSInputLostInfo"

"Name": "Subscription 1",

"OriginResources": [

"/redfish/v1/Chassis/1/Power#/PowerSupplies/1"