Login
- Released At: 14-07-2025
- Page Views:
- Downloads:
- Table of Contents
- Related Documents
-
|
|
|
H3C G6&G7 Servers HDM2&HDM3 |
|
Redfish API Reference |
|
|
|
|
|
New H3C Technologies Co., Ltd. http://www.h3c.com
Software version: HDM2-1.80 and later, HDM2-2.17 and later, HDM3-1.25 and later, HDM3-2.04 and later Document version: V1.27 |
Copyright © 2025, New H3C Technologies Co., Ltd. and its licensors
All rights reserved
No part of this manual may be reproduced or transmitted in any form or by any means without prior written consent of New H3C Technologies Co., Ltd.
Trademarks
Except for the trademarks of New H3C Technologies Co., Ltd., any trademarks that may be mentioned in this document are the property of their respective owners.
Notice
The information in this document is subject to change without notice. All contents in this document, including statements, information, and recommendations, are believed to be accurate, but they are presented without warranty of any kind, express or implied. H3C shall not be liable for technical or editorial errors or omissions contained herein.
Revision records
|
Version |
Revision date |
HDM version |
Interface name |
Interface modification content |
|
|
May 17, 2021 |
0.00.11 |
First version release. |
|
|
|
June 10, 2022 |
0.00.14 |
Download BMC file |
Change "Path" to "Content". |
|
|
November 29, 2022 |
|
Obtain root service information |
The ProtocolFeaturesSupported object is added to the return body. |
|
|
December 1, 2022 |
|
Obtain virtual media information |
Consolidate the query of virtual CD media resources and the query of virtual HD media resources. |
|
|
December 1, 2022 |
|
Connect to virtual media |
Modify the return body of the TASK, unify it into one form. |
|
|
December 1, 2022 |
|
Disconnect from virtual media |
Modify the TASK return body to a unified format. |
|
|
December 1, 2022 |
|
Import the BIOS, BMC, and RAID controller settings |
The modification of the TASK return body is unified into one format, changing the interface permission from maintenance diagnosis to subscriber provisioning. |
|
|
December 1, 2022 |
|
Export the BIOS, BMC, and RAID controller settings |
The return body of the TASK is modified and unified into one form. The interface permissions are changed from maintenance diagnostics to subscriber provisioning. |
|
|
December 1, 2022 |
|
Delete a session |
Return the modified body in a unified form. |
|
|
December 1, 2022 |
|
Upgrade firmware |
The return format of the TASK response body has been unified due to modifications in the HDM2 upgrade process and significant changes in G5. |
|
|
December 1, 2022 |
|
Delete an event subscription |
Unified the body modification into one form. |
|
|
December 1, 2022 |
|
Obtain event log entry collection information |
The interface permissions have been changed from the query module to system audit. |
|
|
December 1, 2022 |
|
Obtain event log entry resource information |
The interface permissions have been changed from the query module to the system audit. |
|
|
December 1, 2022 |
|
Clear event log entry information |
The interface permissions have been changed from regular configuration to maintenance diagnostic. |
|
|
December 2, 2022 |
|
Obtain SMTP information |
Add the TLSEnabled field. |
|
|
December 2, 2022 |
|
Configure SMTP settings |
Add the 'TLSEnabled' field. |
|
|
December 6, 2022 |
|
Set the physical drive state |
The interface control permission has been changed from "remote control" to "remote control | maintenance diagnosis." |
|
|
December 6, 2022 |
|
Configure system resource properties |
The interface permission has been changed from "Remote Control" to "Remote Control|General Configuration|Power Control". |
|
|
December 6, 2022 |
|
Create a logical drive |
Unified form for body modification {return}. |
|
|
December 6, 2022 |
|
Delete a logical drive |
Unified the body modifications to a single form. |
|
|
December 6, 2022 |
|
Edit VNC settings |
The interface permission has been changed from "security control" to "remote control". |
|
|
December 6, 2022 |
|
Edit KVM settings |
The interface authority has been changed from "security control" to "remote control". |
|
|
December 8, 2022 |
|
Obtain server information by its chassis resource ID |
Put the 'nPCIeDevices' field into the 'Links' section. |
|
|
December 13, 2022 |
|
Obtain memory information |
Add the fields 'OperatingSpeedMegaTransfersPerSecond' and 'AllowedSpeedsMegaTransfersPerSecond' in the 'Oem.Public' section. |
|
|
December 13, 2022 |
|
Obtain syslog information Configure syslog settings |
Add the fields RootCertificateInstalled, ClientCertificateInstalled, and PrivateKeyCertificateInstalled in Oem.Public. |
|
|
December 16, 2022 |
|
Obtain information about CPU power saving Configure CPU power saving settings |
Add the field CPUPStateValid. |
|
|
December 16, 2022 |
|
Obtain account service information |
Add export path for weak password dictionary operation and add import path for weak password dictionary operation, and add field Oem.Public.PasswordRule.WeakPasswordDictionaryEnabled. |
|
|
December 16, 2022 |
|
Edit account service settings |
Add field Oem.Public.PasswordRule.WeakPasswordDictionaryEnabled. |
|
|
December 16, 2022 |
|
Import a weak password dictionary |
New interface added. |
|
|
December 16, 2022 |
|
Export a weak password dictionary |
New interface added. |
|
|
December 16, 2022 |
|
Obtain SNMP information |
The SnmpV3EngineID field has been added. sha256, sha384, and sha512 were newly added to the SnmpV3AuthProtocol field. aes192 and aes256 were newly added to the SnmpV3PrivProtocol field. |
|
|
December 16, 2022 |
|
Configure SNMP settings |
Added field SnmpV3Enabled. |
|
|
December 16, 2022 |
|
Obtain user account information |
The Oem.Public.SnmpEncryptPwdInit and Oem.Public.SnmpV3Password fields were added. The Oem.Public.SnmpV3AuthProtocol field now includes SHA256, SHA384, and SHA512. The Oem.Public.SnmpV3PrivProtocol field now includes AES192 and AES256. |
|
|
December 16, 2022 |
|
Add a user account |
The Oem.Public.SnmpV3Password field was added. The Oem.Public.SnmpV3AuthProtocol field is expanded to include SHA256, SHA384, and SHA512. The Oem.Public.SnmpV3PrivProtocol field is expanded to include AES192 and AES256. |
|
|
December 16, 2022 |
|
Edit user account settings |
Added field Oem.Public.SnmpV3Password. Oem.Public.SnmpV3AuthProtocol now includes SHA256, SHA384, and SHA512. Oem.Public.SnmpV3PrivProtocol now includes AES192 and AES256. |
|
|
December 30, 2022 |
|
Obtain storage controller information |
Add field SupportedStripSize. Added ConfigureAccessPolicy, ConfigureWritePolicy, ConfigureReadPolicy, and ConfigureDriveCachePolicy to SupportedConfigurationOperation. |
|
|
December 30, 2022 |
|
Obtain network port information |
Added the following fields: · Ipv4StaticAddresses.Address · Ipv4StaticAddresses.AddressOrigin · Ipv4StaticAddresses.Gateway · Ipv4StaticAddresses.SubnetMask · Ipv6StaticDefaultGateways. |
|
|
December 30, 2022 |
|
Configure network port settings |
Added the following fields: · Ipv4StaticAddresses.Address · Ipv4StaticAddresses.AddressOrigin · Ipv4StaticAddresses.Gateway · Ipv4StaticAddresses.SubnetMask · Ipv6StaticDefaultGateways |
|
|
January 17, 2023 |
|
Obtain system resource information |
Added fields ComputeModuleMaxCount and PresentComputeModules. |
|
|
February 14, 2023 |
|
Obtain server information by its chassis resource ID |
Add field ChassisPartNumber. |
|
|
February 20, 2023 |
|
Obtain physical drive information |
Add field PredictedMediaLifeLeftDays. |
|
|
February 20, 2023 |
|
License related interface |
Added interface. |
|
|
February 23, 2023 |
|
Obtain physical drive collection information |
Added field AlarmThreshold. |
|
|
February 23, 2023 |
|
Obtain thermal properties |
Added field InletHistoryTemperature. |
|
|
February 23, 2023 |
|
Obtain update service information |
Moved #MirrorPool.DeleteImage as a sub-field of Actions.Oem.Public. Moved #UpdateService.DumpBIOS as a sub-field of Actions.Oem.Public. Added #UpdateService.UninstallPackage and InstalledPackages. |
|
|
February 23, 2023 |
|
Bind a user to a client certificate |
Changed the URL name from "ClientCertifcate" to "ClientCertificate". |
|
|
February 23, 2023 |
|
Unbind a client certificate from a user |
Changed the URL name from "ClientCertifcate" to "ClientCertificate". |
|
|
February 23, 2023 |
|
Obtain SSH public key list information |
Added Accounts object. |
|
|
February 23, 2023 |
|
Obtain user certificate management service information |
Added Accounts object. |
|
|
February 23, 2023 |
|
Obtain power information |
Added PowerHistoryData object. |
|
|
February 23, 2023 |
|
Obtain event log service collection information |
Added object Actions.Oem.Public.#LogServices.ExportEventLog. |
|
|
February 24, 2023 |
|
Obtain network port information |
Deleted the PCIeAddress field. |
|
|
February 24, 2023 |
|
Obtain information of a firmware inventory |
Added field Model. |
|
|
February 24, 2023 |
|
Obtain memory collection information |
Deleted field MemoryRankSparing. |
|
|
February 26, 2023 |
|
Obtain SMTP information |
Added option Major+Critical to field AlarmSeverity. |
|
|
February 26, 2023 |
|
Configure SMTP settings |
Added option Major+Critical to field AlarmSeverity. |
|
|
February 27, 2023 |
|
Obtain processor information |
Added fields ChopType and Step. |
|
|
February 27, 2023 |
|
Obtain host status migration information |
Added interface. |
|
|
February 27, 2023 |
|
Obtain memory information |
Added field Oem.Public.DisabledCausation. |
|
|
February 27, 2023 |
|
Obtain security dashboard information Set security dashboard information |
Added interface. |
|
|
February 28, 2023 |
|
Obtain PCIe function information |
Added field Oem.Public.LinkWidthAbility. |
|
|
February 28, 2023 |
|
Collect SDS log entry information |
Added field LogType. |
|
|
March 1, 2023 |
|
Obtain update service information |
Deleted the TransferProtocol@Redfish.AllowableValues field from the UpdateService.DumpBIOSS and UpdateService.SimpleUpdate fields. |
|
|
March 1, 2023 |
|
Upgrade firmware |
Add values to UpgradeType. |
|
|
March 2, 2023 |
|
Obtain system resource information |
Added object Oem.Public.HostStatus. |
|
|
March 2, 2023 |
|
Obtain emergency diagnostic information |
Deleted interface. |
|
|
March 2, 2023 |
|
Modify emergency diagnostic information |
Deleted interface. |
|
|
March 2, 2023 |
|
Obtain host resource information Modify host resource information |
Deleted interface. |
|
|
March 2, 2023 |
|
Obtain information about CPU historical usage rate resource |
Deleted interface. |
|
|
March 2, 2023 |
|
Obtain information about memory historical usage rate resource |
Deleted interface. |
|
|
March 2, 2023 |
|
Obtain information about IO historical usage rate resource |
Deleted interface. |
|
|
March 2, 2023 |
|
Obtain host resource information Modify host resource information |
Added interface. |
|
|
March 2, 2023 |
|
Obtain information about CPU historical usage rate resource |
Added interface. |
|
|
March 2, 2023 |
|
Obtain information about memory historical usage rate resource |
Added interface. |
|
|
March 2, 2023 |
|
Obtain information about GPU historical usage rate resource |
Added interface. |
|
|
March 2, 2023 |
|
Obtain information about network bandwidth historical send/receive speed resource |
Added interface. |
|
|
March 2, 2023 |
|
Obtain information about disk historical usage rate resource |
Added interface. |
|
|
March 2, 2023 |
|
Obtain information about disk IO performance historical data |
Added interface. |
|
|
March 2, 2023 |
|
Obtain information about disk SCVTM historical data |
Added interface. |
|
|
March 2, 2023 |
|
Obtain information about NFS server read/write rate historical data |
Added interface. |
|
|
March 2, 2023 |
|
Obtain information about NFS client read/write rate historical data |
Added interface. |
|
|
March 2, 2023 |
|
Obtain information about system load historical data |
Added interface. |
|
|
March 2, 2023 |
|
Obtain intelligent monitoring service information |
Added interface. |
|
|
March 2, 2023 |
|
Configure intelligent monitoring service information |
Added interface. |
|
|
March 2, 2023 |
|
Obtain sensor type collection information |
Added interface. |
|
|
March 2, 2023 |
|
Obtain information of sensor list for a specified type |
Added interface. |
|
|
March 2, 2023 |
|
Obtain sensor information |
Added interface. |
|
|
March 2, 2023 |
|
Obtain manager resource information |
Added field Oem.Public.IntelligentMonitoringService. |
|
|
March 7, 2023 |
|
Obtain shared network port information |
Added HotPlugSupported field. |
|
|
March 8, 2023 |
|
Obtain message registry collection information |
Add field @odata.context. |
|
|
March 8, 2023 |
|
Obtain message registry information |
Added field @odata.context. |
|
|
March 8, 2023 |
|
Obtain wireless information |
Added field IsSameSegment. |
|
|
March 8, 2023 |
|
Obtain manager collection information |
Changed the value of field @odata.context. |
|
|
March 8, 2023 |
|
Obtain host status migration information |
The field "nSDCardState" has been changed to "DSDCardState". |
|
|
March 8, 2023 |
|
Obtain information about host resource monitoring |
Changed "TotalCapacityGiB" to "TotalCapacityMB." Changed "FreeSpaceGiB" to "FreeSpaceMB." |
|
|
March 8, 2023 |
|
Obtain information about host resource monitoring |
Changed "nDriveSCVTMHistoryData" to "DriveSVCTMHistoryData." |
|
|
March 8, 2023 |
|
Obtain information about disk SVCTM historical data |
Changed the URL name from DriveSCVTMHistoryData to DriveSVCTMHistoryData. Change the array name from HistorySCVTM to HistorySVCTM. |
|
|
March 10, 2023 |
|
Obtain physical drive information |
Added field SystemDiskNumber. |
|
|
March 13, 2023 |
|
Collect SDS log entry information |
Updated the description of the content parameter to "The interface only supports /mnt/sdmmc0p1/sds/bmc/filename." Special characters @!$^&_+.;[]{}-=~" are supported. |
|
|
March 14, 2023 |
|
Obtain manager resource information |
Added field InternalBackupFirmwareVersion for the internal release of the backup partition. |
|
|
March 15, 2023 |
|
Obtain host status migration information |
Deleted field DiagnosticServiceEnabled. |
|
|
March 15, 2023 |
|
Interface for returning task ID |
The TaskUniqueID field is added to represent the unique ID of a task. |
|
|
March 15, 2023 |
|
Import a weak password dictionary |
Added an output explanation for the 'name' field. |
|
|
March 15, 2023 |
|
Import SSL certificate |
Modified the text certificate sample. |
|
V0.9.1 |
March 16, 2023 |
HDM2-1.13 |
N/A |
Synchronized and updated the minor version number |
|
|
March 17, 2023 |
|
Obtain the license activation file |
Changed "Trial" to "Temporary" in the License type field. |
|
|
March 17, 2023 |
|
Obtain storage controller information |
Added field SupportedRAIDMode. |
|
|
March 17, 2023 |
|
Obtain information of sensor list for a specified type |
Modified the Description and Name fields. |
|
|
March 17, 2023 |
|
Obtain SMTP information |
Deleted field Oem.Public.RSAEncryptionEnabled. |
|
|
March 18, 2023 |
|
Create a logical drive |
Modified the field explanations for supported cards and strip size operations. |
|
|
March 18, 2023 |
|
Obtain the user collection resource in an AD domain |
Changed "LDAP" to "AD" in the function description. |
|
|
March 20, 2023 |
|
Obtain thermal properties |
Changed "inlet" in the explanation of the InletHistoryTemperature parameter to "inlet air intake." |
|
|
March 20, 2023 |
|
Obtain event collection information |
Added description of the "target" and "description" fields to the parameter description. |
|
|
March 20, 2023 |
|
Obtain event collection information |
Changed the "EventService resource information description" in the parameter specifications to "Event service resource's return parameter description". |
|
|
March 20, 2023 |
|
Simulate reporting test events |
Changed "Severity" to "MessageSeverity" in the parameter description. |
|
|
March 21, 2023 |
|
Obtain network port information |
Example revised. |
|
|
March 21, 2023 |
|
Configure network port settings |
Example revised. |
|
|
March 22, 2023 |
|
Obtain storage controller information |
Added the 'SpeedGTps' field and explanation to the example. |
|
|
March 22, 2023 |
|
Obtain event log service resource information |
Deleted Actions, and the @Redfish.ActionInfo and ClearType@Redfish.AllowableValues fields under #LogService.ClearLog. |
|
V0.9.2 |
March 24, 2023 |
HDM2-1.14 |
N/A |
Updated the minor version number synchronously. |
|
|
March 24, 2023 |
|
Obtain information about host resource monitoring Configure host resource monitoring information settings |
Added fields ProcessorsUsageRate and MemoryUsageRate to the response example, along with explanations for their output. |
|
|
March 24, 2023 |
|
Create a logical drive |
The P460 strip size now supports 16KB and 32KB. |
|
|
March 28, 2023 |
|
Download BMC file |
A new path, /mnt/sdmmc0p4/bsod, has been added for downloading screen recordings. |
|
|
March 29, 2023 |
|
Obtain service information |
Usage guidelines: The iHDT function is currently not supported by G6 AMD products. |
|
|
March 29, 2023 |
|
Configure service settings |
Usage guidelines: G6 AMD products currently do not support iHDT function. |
|
|
March 29, 2023 |
|
Obtain detailed session information for a specified service |
Usage guidelines: iHDT function is currently not supported on G6 AMD products. |
|
|
March 29, 2023 |
|
Delete session information for the specified service |
Usage guidelines: Function iHDT is currently not supported on G6 AMD products. |
|
|
April 4, 2023 |
|
Create a Redfish session |
Added an explanation for the LoginTime field. |
|
|
April 4, 2023 |
|
Obtain Redfish session information |
The interface description changes from querying the specified Redfish session resource information to querying the specified session resource information. Updated the explanation of UserTag and SessionType parameters. |
|
|
April 4, 2023 |
|
Obtain session collection information |
The interface description has been changed to query session set resource information instead of querying Redfish session set resource information. |
|
|
April 4, 2023 |
|
Delete a session |
The interface specification is changed from deleting a specified Redfish session to deleting a specified session. |
|
|
April 6, 2023 |
|
Other instructions |
Additional instructions have been added to provide a unified explanation for Members@odata.nextLink. |
|
V1.0 |
April 11, 2023 |
HDM2-1.15 |
|
|
|
|
April 11, 2023 |
|
Add a user account |
|
|
|
April 11, 2023 |
|
Edit the LDAP service resource |
Deleted the extra 'SSLEncryptionEnabled' field in the parameter description. |
|
|
April 11, 2023 |
|
Edit an LDAP domain user group resource |
Changed the interface name to "Modify specified LDAP domain user group resource." |
|
|
April 11, 2023 |
|
Delete a user group resource in an LDAP domain |
Changed the interface name to " Delete a user group resource in an LDAP domain". |
|
|
April 11, 2023 |
|
Edit a user group resource in an AD domain |
Modified the explanation of the "user_id" field to "AD domain user group ID that needs to be modified." |
|
|
April 11, 2023 |
|
Delete a user group resource in an AD domain |
Modified the explanation of the "user_id" field to "AD domain user group ID to be deleted." |
|
|
April 12, 2023 |
|
Obtain a single user resource in an LDAP domain |
Added field "Name" and modified field "MemberId" to "Id". |
|
|
April 12, 2023 |
|
Obtain a single user resource in an AD domain |
Changed field "MemberId" to "Id". |
|
|
April 12, 2023 |
|
Export BIOS firmware |
Changed the request body from "Oem.Public.ScriptName" to "ScriptName". |
|
|
April 14, 2023 |
|
Create a logical drive |
Modified stripe size field description: For supported storage controllers, refer to the actual specifications and obtain the supported stripe size through HDM or the BIOS. |
|
V1.0.1 |
April 15, 2023 |
HDM2-1.15 HDM2-1.50 |
N/A |
Refreshed the minimum version number. |
|
|
April 15, 2023 |
|
Configure system resource properties |
In the function description, a new usage instruction has been added: "When setting the HostName, the HostNameSetupMode field value must be set to 'Manual'". In the usage instance, the HostNameSetupMode field value has been changed to "Manual." |
|
V1.0.2 |
April 21, 2023 |
HDM2-1.16 HDM2-1.50 |
N/A |
Refreshed the minimum version number. |
|
|
April 21, 2023 |
|
Obtain processor information |
Modified the Step parameter description. |
|
|
April 21, 2023 |
|
Obtain host status migration information |
Modified the TPMType value in the example. |
|
|
April 21, 2023 |
|
Obtain trusted password module status configuration |
Changed the Type value in the example. |
|
V1.1 |
April 24, 2023 |
HDM2-1.17 HDM2-1.50 |
|
|
|
|
April 24, 2023 |
|
Deleted interface. |
|
|
|
April 24, 2023 |
|
Configure intelligent monitoring service information |
Deleted interface. |
|
|
April 24, 2023 |
|
Obtain sensor type collection information |
Deleted interface. |
|
|
April 24, 2023 |
|
Obtain information of sensor list for a specified type |
Deleted interface. |
|
|
April 24, 2023 |
|
Obtain sensor information |
Deleted interface. |
|
|
April 24, 2023 |
|
Obtain manager resource information |
Deleted the path for querying intelligent monitoring service information. |
|
|
April 24, 2023 |
|
Edit manager resource information |
Deleted query path for smart monitoring service information in the response example. |
|
V1.1.1 |
April 26, 2023 |
HDM2-1.17 HDM2-1.51 |
|
|
|
|
April 26, 2023 |
|
Add a user account |
Changed the field Id to an optional parameter. |
|
V1.1.2 |
May 9, 2023 |
HDM2-1.17 HDM2-1.52 |
|
|
|
|
May 9, 2023 |
|
Obtain system resource information |
Added field ChassisPartNumber. |
|
V1.1.3 |
May 22, 2023 |
HDM2-1.19 HDM2-1.53 |
|
|
|
|
May 26, 2023 |
|
Obtain host status migration information |
The DSDCardState field has a new state called "NotSupported," and an output explanation for this field has been added. |
|
|
May 26, 2023 |
|
Add a user account Edit user account settings |
Deleted the character restriction description for independent passwords in SNMPv3. |
|
|
May 26, 2023 |
|
System lockout interface |
Added the system lock types. |
|
|
May 29, 2023 |
|
Set a BIOS password |
Added details to the complexity instructions for the BIOS password. |
|
|
May 29, 2023 |
|
Added kerberos interfaces added in 4.5.51-4.5.60. |
Added interface. |
|
V1.2 |
June 2, 2023 |
HDM2-1.20 HDM2-1.53 |
|
|
|
|
June 2, 2023 |
|
Obtain physical drive information |
Supplemental explanations have been provided for individual field descriptions regarding NVMe display situations in Trimode configurations. |
|
|
June 5, 2023 |
|
Obtain PCIe module information |
Updated the description of the FirmwareVersion field. |
|
V1.3 |
June 7, 2023 |
HDM2-1.21 HDM2-1.54 |
|
|
|
|
June 9, 2023 |
|
Obtain intelligent monitoring drive resource information |
Added interface. |
|
|
June 9, 2023 |
|
Obtain intelligent monitoring information of a drive |
Added interface. |
|
|
June 9, 2023 |
|
Obtain physical drive information |
Added field RawValue. |
|
|
June 9, 2023 |
|
Obtain manager resource information |
Added field IntelligentMonitoringService. |
|
|
June 9, 2023 |
|
Obtain intelligent monitoring service information |
Re-enabled this interface. |
|
|
June 10, 2023 |
|
Obtain physical drive information |
Added the RawCapacity field. |
|
|
June 15, 2023 |
|
Obtain information about host resource monitoring |
Added fields DriveUsageAlarmThreshold, MemoryUsageAlarmThreshold, and ProcessorsUsageAlarmThreshold. |
|
|
June 15, 2023 |
|
Configure host resource monitoring information settings |
Added the DriveUsageAlarmThreshold, MemoryUsageAlarmThreshold, and ProcessorsUsageAlarmThreshold fields to the response example. |
|
|
June 16, 2023 |
|
Collect SDS log entry information |
Modified the description of the Content field. |
|
|
June 16, 2023 |
|
Obtain module information |
Revised the example by changing "Baseboard" to "Motherboard." Deleted the SMC return value in the Oem.Public.DeviceType field. Changed the explanation of the BMCCard to "management board" in the Oem.Public.DeviceType field. Added fields Oem.Public.CPLD1Version and Oem.Public.CPLD2Version. |
|
|
June 20, 2023 |
|
Obtain server information by its chassis resource ID |
Added field Oem.Public.DeviceMaxNum.LiquidCoolerNum. |
|
|
June 20, 2023 |
|
Obtain thermal properties |
Modified the meaning of the object 'Status' to heat dissipation module overall state information. Added the 'CoolingMedium' and 'LeakStrategy' fields. Added the object 'FanSummary.Status' and its sub-fields, the object 'LiquidSummary' and its sub-fields, and the object 'LiquidCoolers' and its sub-fields. |
|
|
June 20, 2023 |
|
Configure the heat dissipation resource information for the specified chassis |
The title name is changed to set the heat dissipation resource information for the specified chassis. The function description is changed to set the heat dissipation resource information for the specified chassis. Added field Oem.Public.LeakStrategy. |
|
|
June 20, 2023 |
|
Obtain intelligent monitoring service information |
Added fields for memory monitoring. |
|
|
June 20, 2023 |
|
Configure intelligent monitoring service information |
This interface must be re-enabled for memory monitoring. |
|
|
June 20, 2023 |
|
Obtain intelligent monitoring memory resource information |
Added interface. |
|
|
June 21, 2023 |
|
Unified management: Add managed device resources |
Modified device adding of unified management to use the task method for returning. |
|
|
June 21, 2023 |
|
Obtain intelligent monitoring service information |
Added description for MemoryPageOfflineEnabled. |
|
|
June 21, 2023 |
|
Configure intelligent monitoring service information |
Added description of MemoryPageOfflineEnabled. |
|
|
June 21, 2023 |
|
Obtain intelligent monitoring drive resource information |
Added the following fields: DriveList, HistoryDriveUsageRate, PredictedDriveUsageRate, Name, FreeSpaceMB, UsageRatePercents, Time, and TotalCapacityMB. |
|
|
June 21, 2023 |
|
Obtain intelligent monitoring service information |
Added the following fields: DrivesPredictDays, DrivesPredictEnabled, DrivesReportEnabled, and DrivesUsageThreshold. |
|
|
June 21, 2023 |
|
Configure intelligent monitoring service information |
Added the following fields: DrivesPredictDays, DrivesPredictEnabled, DrivesReportEnabled and DrivesUsageThreshold. |
|
V1.3.1 |
June 27, 2023 |
HDM2-1.21 HDM2-1.55 |
|
|
|
|
June 27, 2023 |
|
Obtain intelligent monitoring drive resource information |
Revised the response example format. |
|
|
July 4, 2023 |
|
Obtain storage controller information |
Added fields Storage.ClearConfiguration and Storage.ClearForeignConfiguration to the Actions object. |
|
|
July 4, 2023 |
|
Obtain root service information |
Added displaying of the LicenseService object. |
|
V1.3.2 |
July 7, 2023 |
HDM2-1.22 HDM2-1.56 |
|
|
|
|
July 7, 2023 |
|
Obtain performance advisor recommendation information |
Added interface. |
|
|
July 14, 2023 |
|
Obtain task inforamtion |
Corrected the string content in Messages.Trigger Condition in the document. |
|
|
July 18, 2023 |
|
Obtain update service information |
Added the following fields: Oem.Public.BMCFirmwareRestoreEnabled, Oem.Public.BIOSFirmwareRestoreEnabled, and Oem.Public.UpgradeTaskRestoreEnabled. |
|
|
July 18, 2023 |
|
Configure update service information |
Added interface. |
|
|
July 18, 2023 |
|
Obtain configuration information about fast OS installation |
Added interface. |
|
|
July 18, 2023 |
|
Create a fast OS installation configuration service |
Added interface. |
|
V1.4 |
July 22, 2023 |
HDM2-1.22 HDM2-1.57 |
|
|
|
|
July 31, 2023 |
|
Redfish introduction |
The Redfish specification has been updated to version 1.15.1 and the Schema version has been updated to 2020.3. |
|
V1.5 |
August 10, 2023 |
HDM2-1.23 HDM2-1.58 |
|
|
|
|
August 17, 2023 |
|
Add a Kerberos user group |
Added an explanation for the Id field and updated the explanations for the Name and @odata.type fields. |
|
|
August 17, 2023 |
|
Obtain a user group resource from a Kerberos controller |
The explanation for the newly added Id field has been provided, and the descriptions for the Name and @odata.type fields have been updated. |
|
|
August 17, 2023 |
|
Obtain module information |
Added fields Oem.Public.BMCCard.ChipManufacture and Oem.Public.BMCCard.ChipModel. |
|
|
August 17, 2023 |
|
Obtain power information |
Add fields PowerSupplies.Oem.Public.ManufactureDate and PowerControl.Oem.Public.MinActivePowerCount. |
|
|
August 17, 2023 |
|
Obtain system resource information |
Add minimum options for BIOS startup. Added field Oem.Public.NodeType. |
|
|
August 17, 2023 |
|
Configure system resource properties |
Added minimum options for BIOS startup. |
|
|
August 18, 2023 |
|
Obtain security dashboard information |
Added field LDAPCertificateVerification. Added a new configuration item ID in each configuration. |
|
|
August 18, 2023 |
|
Set security dashboard information |
The new field LDAPCertificateVerification has been added. Add a new configuration item ID in each configuration. |
|
|
August 18, 2023 |
|
Obtain account service information |
Add field LDAPService.ImportLDAPCertificate. |
|
|
August 18, 2023 |
|
Obtain the LDAP service resource |
Added fields CertificateVerificationEnabled, CertificateVerificationLevel, and CertificateName. |
|
|
August 19, 2023 |
|
Edit the LDAP service resource |
Added fields CertificateVerificationEnabled and CertificateVerificationLevel. |
|
|
August 19, 2023 |
|
Import an LDAP CA certificate |
Added interface. |
|
|
August 19, 2023 |
|
Obtain processor information |
Added field Oem.Public.ThermalDesignPower. |
|
|
August 19, 2023 |
|
Added field Oem.Public.CapacityGiB. |
|
|
|
August 19, 2023 |
|
Obtain storage controller information |
Added fields StorageControllers.Oem.Public.InternalPortCount and StorageControllers.Oem.Public.ExternalPortCount. |
|
|
August 19, 2023 |
|
The value of the Oem.Public.FirmwareStatus field under Marvell card logic drive status is adjusted: Ready changed to Unconfigured, Online changed to Configured. |
|
|
|
August 19, 2023 |
|
Obtain logical drive information |
The field value of the Oem.Public.FirmwareStatus field under Marvell card logic drive status is adjusted: Optimal changed to Functional. |
|
|
August 19, 2023 |
|
Obtain serial port redirection settings |
The value of the ConnectType field is adjusted: Deleted the BMC and RAID values. |
|
|
August 19, 2023 |
|
Set serial port redirection settings |
Adjusted the value of the ConnectType field: Deleted the BMC and RAID values. |
|
V1.6 |
September 11, 2023 |
HDM2-1.24 HDM2-1.60 |
|
|
|
|
September 15, 2023 |
|
Obtain power information |
Added field PowerControl.PowerLimit.PowerLimitEnable. |
|
|
September 19, 2023 |
|
Obtain thermal properties Obtain power information |
Changed the return value when the sensor threshold is unavailable from 4294967295 to null. |
|
|
September 19, 2023 |
|
Obtain performance advisor recommendation information |
Modified the interface description to get performance advisor recommendation information. |
|
|
September 21, 2023 |
|
Alarm report interface |
Changed the name to: Fault alarm reporting message example. |
|
V1.6.1 |
September 27, 2023 |
HDM2-1.24 HDM2-1.61 |
|
The version number is the latest HDM version at the time of manual release. For more information about supported versions, see the relevant interface's revision history. |
|
|
September 27, 2023 |
|
Obtain the collection information of drive Bays Obtain drive Bay information |
Added interface. |
|
V1.7 |
October 8, 2023 |
HDM2-1.24 HDM2-1.62 |
|
The version number is the latest HDM version at the time of manual release. For more information about supported versions, see the relevant interface's revision history. |
|
|
October 8, 2023 |
|
Configure the heat dissipation resource information for the specified chassis |
Added description of values of the Oem.Public.LeakStrategy field. |
|
|
October 8, 2023 |
|
Add a Kerberos user group Obtain a user group resource from a Kerberos controller Edit a user group resource in a Kerberos controller |
Deleted the "currently only supports admin users" phrase from the GroupRole field description. |
|
|
October 8, 2023 |
|
Obtain network port information |
Added fields Oem.Public.CPUId and Oem.Public.Slot. |
|
|
October 8, 2023 |
|
Obtain platform firmware resilience configuration |
Added field CPLDState. |
|
|
October 8, 2023 |
|
Added field Oem.Public.SoftwareGenerationId. |
|
|
|
October 8, 2023 |
|
Obtain power information |
Changed the field PowerControl.Oem.Public.CurrentDiskPowerWats to PowerControl.Oem.Public.CurrentDiskPowerWatts, while still supporting the original field. |
|
|
October 8, 2023 |
|
Obtain network port information Configure network port settings |
|
|
|
October 8, 2023 |
|
||
|
|
October 8, 2023 |
|
||
|
|
October 8, 2023 |
|
||
|
|
October 8, 2023 |
|
||
|
|
October 8, 2023 |
|
||
|
|
October 8, 2023 |
|
||
|
|
October 8, 2023 |
|
||
|
|
October 8, 2023 |
|
||
|
|
October 8, 2023 |
|
||
|
V1.8 |
October 20, 2023 |
HDM2-1.25 HDM2-1.63 |
||
|
|
October 20, 2023 |
|
||
|
|
October 20, 2023 |
|
||
|
V1.9 |
November 16, 2023 |
HDM2-1.65 HDM2-2.02 |
|
The version number is the latest HDM version at the time of manual release. For more information about supported versions, see the relevant interface's revision history. |
|
|
November 16, 2023 |
|
Report error alarms |
Changed the fields description of the Oem.Public.specificProblem, Oem.Public.specificProblemID, Oem.Public.EventAssertedSeverity, and Severity fields |
|
|
November 22, 2023 |
|
Obtain network port information |
The field descriptions of Ipv4Addresses.AddressOrigin and Ipv6Addresses.AddressOrigin are changed from protocol type to address obtaining method. |
|
V1.10 |
November 24, 2023 |
HDM2-1.66 HDM2-2.03 |
|
The version number is the latest HDM version at the time of manual release. For more information about supported versions, see the relevant interface's revision history. |
|
|
November 24, 2023 |
|
Obtain information about CPU historical usage rate resource Obtain information about memory historical usage rate resource |
Deleted memory historical usage rate information in CUPS when FIST SMS was absent. |
|
|
November 30, 2023 |
|
Obtain service information Configure service settings Obtain detailed session information for a specified service Delete session information for the specified service |
Added support of G6 AMD products for iHDT. |
|
|
November 30, 2023 |
|
Use the restart service. |
Added interface. |
|
|
December 01, 2023 |
|
Obtain service information |
Added an executable operation, restart service. |
|
|
December 01, 2023 |
|
Add a user account Edit user account settings |
Changed the length of the value for the UserName field from 16 characters to 32 characters. |
|
|
December 02, 2023 |
|
Obtain processor information |
Added Intel On Demand information. |
|
|
December 02, 2023 |
|
Upload and write the Intel On Demand License activation file Export a CPU status report |
Added interface. |
|
|
December 15, 2023 |
|
Obtain physical drive information |
Added the Oem.Public. IsNVMeM2 field and the description about NVMe display for outsourced MARVELL controller configuration. |
|
|
December 15, 2023 |
|
Obtain storage controller information |
Added description about interface rates of Marvell vendor in the StorageControllers.Oem.Public.ChipManufacturer field. Added description for interface rates of outsourced Marvell controllers in the StorageControllers.Oem.Public.SpeedGTps and StorageControllers.SpeedGbps fields. |
|
|
December 15, 2023 |
|
Obtain network adapter information |
Added the Oem.Public.MCTPEnabled field. |
|
V1.10.1 |
2023-12-18 |
HDM2-1.68 HDM2-2.04 |
|
The version number is the latest HDM version at the time of manual release. For more information about supported versions, see the relevant interface's revision history. |
|
|
2024-01-03 |
|
Obtain intelligent monitoring service information Configure intelligent monitoring service information Obtain intelligent monitoring memory resource information |
Added the description that AMD server models do not support fields related to intelligent memory repair. Deleted other fields and retain only the MRT value for the memory repair description field. |
|
|
2024-01-03 |
|
Involves about 60 operational interfaces |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node to the response body. |
|
|
2024-01-05 |
|
Obtain physical drive information |
Added the MediaErrCount and PredictiveFailureCount fields |
|
|
2024-01-08 |
|
Obtain performance advisor recommendation information |
Changed the support state of the NUMAUsageLevel and RecommendedSettings fields to not supported. |
|
|
2024-01-10 |
|
Obtain PCIe module information |
Added the PCIE_AUX value to the Oem.Public.PCIeCardType field. |
|
|
2024-01-10 |
|
Restart CPLD |
Modified the interface description to illustrate the supported CPLD types. |
|
|
2024-01-10 |
|
Obtain power information |
Added the PowerControl.Oem.Public.OtherComponentsPowerWatts field. |
|
|
2024-01-10 |
|
Obtain module information |
Added the Oem.Public.BackPlane.DrivesCount, Oem.Public.BackPlane.PortCount, and Oem.Public.BackPlane.Type fields. |
|
|
2024-01-10 |
|
Obtain PCIe function information |
Added the Oem.Public.BDF and Oem.Public. RootBDF fields. |
|
|
2024-01-10 |
|
Export the BIOS, BMC, and RAID controller settings |
Added the Oem.Public.ExportPasswordEnabled field. |
|
|
2024-01-10 |
|
Create a Redfish session |
Deleted the ChangeDefaultPasswordEnabled field and added the DefaultPasswordModifyPolicy field. |
|
|
2024-01-10 |
|
Obtain user account information Add a user account Edit user account settings |
Added the Oem.Public.DefaultPasswordModifyPolicy field. |
|
V1.10.2 |
2024-02-07 |
HDM2-1.68 HDM2-2.05 |
|
The version number is the latest HDM version at the time of manual release. For more information about supported versions, see the relevant interface's revision history. |
|
|
2024-01-20 |
|
Obtain manager resource information |
Added the DiagnosticService field. |
|
|
2024-01-20 |
|
Obtain manager resource information |
Added the Oem.Public.IsSupportSimulator field. |
|
|
2024-01-22 |
|
Obtain PCIe function information |
Added the Oem.Public.SlotMapping field. |
|
|
2024-01-23 |
|
Obtain logical drive information |
Added the RebuildProgress field. |
|
|
2024-01-28 |
|
Edit manager resource information |
Added the UUID field. |
|
|
2024-02-03 |
|
Obtain system diagnosis information Configure system diagnosis settings |
Added interface. |
|
|
2024-02-03 |
|
Obtain event log entry resource information |
Added the EventType field. |
|
|
2024-02-05 |
|
Configure SNMP settings |
Added the SnmpTrapNotification object. |
|
|
2024-02-06 |
|
Obtain NTP information |
Added the MinPollingInterval and MaxPollingInterval fields. |
|
V1.10.3 |
2024-03-17 |
HDM2-1.69 HDM2-2.05 HDM3-1.06 |
|
The version number is the latest HDM version at the time of manual release. For more information about supported versions, see the relevant interface's revision history. |
|
|
2024-03-17 |
HDM3-1.06 |
|
Released for HDM3. API support depends on HDM3. The applicable products are listed. |
|
V1.11 |
2024-03-19 |
HDM2-1.69 HDM2-2.06 |
|
The version number is the latest HDM version at the time of manual release. For more information about supported versions, see the relevant interface's revision history. |
|
|
2024-03-19 |
|
Obtain thermal properties |
Revised the output description for blade server models to exclude redundancy information, the health state field, and fan resource status. |
|
|
2024-03-19 |
|
Configure drive alarm threshold settings |
Added the Life.MajorAlarmLimit field. |
|
|
2024-03-20 |
|
Obtain logical drive information |
Added the Oem.Public. RebuildProgress field. |
|
|
2024-03-21 |
|
Obtain physical drive information |
Updated the description for the MediaErrCount and PredictiveFailureCount fields. |
|
|
2024-03-21 |
|
Obtain server information Modify chassis-related resources |
Added the Oem.Public.SlotPowerSupply object. |
|
|
2024-03-21 |
|
Obtain thermal properties |
Added the FanSummary.MaxRotorCountSupported and FanSummary.RotorCount fields. |
|
|
2024-03-21 |
|
Obtain power information |
Added the PowerSupplies.Oem.Public.PowerInputWatts field. |
|
|
2024-03-21 |
|
Obtain PCIe module information |
Added the CardManufacturer and CardModel fields. |
|
|
2024-03-21 |
|
Obtain storage controller information |
Added the StorageControllers.CardManufacturer and StorageControllers.CardModel fields. |
|
|
2024-03-21 |
|
Obtain system resource information |
Added the Oem.Public.ConfigurationModel field. |
|
V1.12 |
2024-04-22 |
HDM2-1.70 HDM2-2.07 HDM3-1.08 |
|
The version number is the latest HDM version at the time of manual release. For more information about supported versions, see the relevant interface's revision history. |
|
|
|
|
Obtain power information |
Added the PowerControl.Oem.Public. SuggestedActivePowerCount field. |
|
V1.13 |
2024-05-18 |
HDM2-1.71 HDM2-2.08 HDM3-1.09 |
|
The version number is the latest HDM version at the time of manual release. For more information about supported versions, see the relevant interface's revision history. |
|
|
|
|
Create a logical drive |
Added support for LSI 9660 storage controllers and the strip size description for LSI 9660 storage controllers. |
|
|
|
|
Obtain processor information |
Added the Oem.Public.ChipId field. |
|
|
|
|
Configure virtual media settings |
Added support for http and https in the Media.ShareType and Oem.Public.ShareType fields. |
|
|
|
|
Connect to virtual media |
Added support for http and https for connecting to virtual media. |
|
V1.14 |
2024-07-23 |
HDM2-1.73 HDM2-2.10 HDM3-1.14 |
|
The version number is the latest HDM version at the time of manual release. For more information about supported versions, see the relevant interface's revision history. |
|
|
|
|
Obtain manager resource information |
Added the Manager.NodeSwitch, Oem.Public.CurrentNodeId, and Oem.Public.MasterNodeId fields. |
|
|
|
|
Perform node control on a multi-node device |
Added interface. |
|
V1.15 |
2024-07-25 |
HDM2-1.73 HDM2-2.11 HDM3-1.15 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
|
|
HDM3 |
Obtain manager resource information |
HDM3 does not support wireless resource information. |
|
|
|
HDM3 |
Obtain wireless information |
HDM3 does not support wireless resource information. |
|
|
|
HDM3 |
Edit wireless settings |
HDM3 does not support wireless resource information. |
|
|
|
HDM3 |
Edit logical drive properties |
Added the Oem.Public.BootEnable field. |
|
|
|
HDM3 |
Set a BIOS password |
The PowerOn option was added to the UserName field. |
|
|
|
HDM3 |
Configure specified event log service resource settings |
When the HostName is set, the HostNameSetupMode field is set to Manual by default. |
|
|
|
HDM3 |
Obtain attributes of the specified physical drive |
Added description in the change record to indicate that HDM3 supports the mediaerr count and predictive failure count fields. |
|
|
|
HDM3 |
Obtain system resource information |
The Phytium platform does not support the Legacy mode. |
|
|
|
HDM3 |
Configure system resource properties |
The Phytium platform does not support the Legacy mode. |
|
|
|
HDM3 |
Obtain server information by its chassis resource ID |
Added the Oem.Public.IdleDriveSlots object. |
|
|
|
HDM3 |
Obtain idle slot collection information |
Added the interface. |
|
|
|
HDM3 |
Obtain information about the specified idle slot |
Added the interface. |
|
|
|
HDM3 |
Set the UID LED state of the idle slot |
Added the interface. |
|
|
|
HDM3 |
Obtain storage controller information |
Added the Oem.Public.IdleDriveSlots object. |
|
V1.16 |
2024-08-19 |
HDM2-1.73 HDM2-2.11 HDM3-1.16 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
|
|
HDM2 |
Obtain intelligent monitoring service information |
Added the MemoryPageOfflineState, MemoryPageOfflineSizeKB, and MemoryLevel fields. |
|
|
|
HDM2 |
Configure intelligent monitoring service information |
Added the MemoryPageOfflineState, MemoryPageOfflineSizeKB, and MemoryLevel fields. |
|
|
|
HDM3 |
Configure SNMP settings |
Added the SnmpTrapNotification object. |
|
|
|
HDM3 |
Obtain logical drive information |
Added the Oem.Public.RebuildProgress field to display the rebuild progress of logical drives. |
|
|
|
HDM3 |
Obtain PCIe function information |
Added the Oem.Public.BDF and Oem.Public.RootBDF fields and synchronized them to HDM3. |
|
|
|
HDM2 |
Obtain physical drive information |
Added the PMR_Failed option to the Oem.Public.FirmwareStatus field for NVMe drives. |
|
|
|
HDM3 |
Obtain virtual media information |
Added the Connected.Oem.Public.ImageType and NotConnected.Oem.Public.ImageType fields. |
|
|
|
HDM2 |
Obtain service information Configure service settings Obtain manager resource information Edit manager resource information Obtain the list of services that can create sessions |
Deleted the Telnet service field. |
|
|
|
HDM3 |
Obtain service information Configure service settings Obtain manager resource information Edit manager resource information Obtain the list of services that can create sessions |
Deleted the Telnet service field. |
|
|
|
HDM2 |
Configure virtual media settings |
Refreshed the command format example. |
|
|
|
HDM2 |
Obtain physical drive information |
Modified the description of the Failed option in the Oem.Public.FirmwareStatus field. |
|
|
|
HDM2 |
Obtain performance advisor recommendation information |
Added the OneWeekInterval field. |
|
V1.17 |
2024-09-11 |
HDM2-1.73 HDM2-2.12 HDM3-1.17 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
|
|
HDM2 |
Obtain storage controller information |
Added the StorageControllers.Oem.Public.PSOCFirmwareVersion field. |
|
|
|
HDM2 |
Obtain thermal properties |
Revised the output description for blade server models to exclude redundancy information, the health state field, and fan resource status. |
|
|
|
HDM2 |
Obtain physical drive information |
Added the physical drive states supported by the 9300 controller to the Oem.Public.FirmwareStatus field. |
|
|
|
HDM2 |
Obtain logical drive information |
Added the RebuildProgress, VolumeRaidLevel, and RedundantType fields. |
|
|
|
HDM3 |
Connect to virtual media |
Added the Oem.Public.ImageType field. |
|
|
|
HDM3 |
Stop virtual media mounting |
Added the interface. |
|
|
|
HDM3 |
Obtain virtual media collection information |
Added the VirtualMedia.StopMount field. |
|
V1.18 |
2024-09-20 |
HDM2-1.75 HDM2-2.12 HDM3-1.18 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
|
|
HDM2 |
Obtain logical drive information |
Added description for LSI controllers in the RebuildProgress field. |
|
|
|
HDM2 |
Obtain thermal properties |
Modify blade model output instructions, hide redundant information and health status fields, and output fan management resource status. More versions are supported simultaneously. |
|
V1.19 |
2024-10-17 |
HDM2-1.76 HDM2-2.13 HDM3-1.18 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
|
|
|
Create a Redfish session |
Edited the value for the Id field. |
|
|
|
|
Obtain session information |
Edited the value for the Id field. |
|
V1.20 |
2024-10-28 |
HDM2-1.76 HDM2-2.13 HDM3-1.19 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
|
|
|
Obtain KVM information |
Revised the description for the response fields. |
|
|
|
|
Obtain screen snapshots |
Change the blue screen description to screen description. |
|
|
|
|
Delete screen snapshots |
Changed the interface name. Revised the description for the FileName field. |
|
|
|
|
Manually take screen snapshots |
Added the interface. |
|
|
|
|
Create a logical drive |
Changed the stripe size, capacity description, physical drive cache policy, and initialization type for 3SNIC storage controller. |
|
|
|
|
Obtain the system software inventory information |
Added the OSHostName field. |
|
|
|
|
Obtain logical drive information |
Edited the description for the VolumeRaidLevel field. |
|
|
|
|
Create a logical drive |
Changed the value for the NumDrivePerSpan field. |
|
V1.21 |
2024-11-05 |
HDM2-1.77 HDM2-2.14 HDM3-1.20 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
Obtain thermal properties |
Updated the response example |
|||
|
Obtain processor information |
Added the Oem.Public.MaxSpeed field. |
|||
|
Configure network port settings |
Edited the field description |
|||
|
Obtain the detailed progress of configuration clearance |
Edited the description for the ClearStatus field. |
|||
|
V1.22 |
2024-11-26 |
HDM2-1.77 HDM2-2.15 HDM3-1.21 HDM3-2.01 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
Obtain GPU information |
Added the GPU.PowerCapacityWatts field. |
|||
|
|
|
|
Obtain processor information |
Added the TDPWatts field. |
|
|
|
|
Obtain logical drive information |
Edited the description for the VolumeRaidLevel field. |
|
V1.23 |
2024-12-16 |
HDM2-1.78 HDM2-2.15 HDM3-1.21 HDM3-2.01 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
|
|
|
Obtain network port information |
Added the Oem.Public.DNS.IPv4DNS.DNSAutoReg and Oem.Public.DNS.IPv6DNS.DNSAutoReg fields. |
|
|
|
|
Configure network port settings |
Added the Oem.Public.DNS.IPv4DNS. DNSAutoReg and Oem.Public.DNS.IPv6DNS. DNSAutoReg fields. These fields are available only when the DNS mode is set to manual. |
|
V1.24 |
2024-12-24 |
HDM2-1.78 HDM2-2.16 HDM3-1.23 HDM3-2.02 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
|
|
|
Configure SMTP settings |
Added the description for the ServerPort and TLSEnabled fields. |
|
|
|
|
Obtain module information |
Added the TopoType field. |
|
V1.25 |
2025-01-14 |
HDM2-1.79 HDM2-2.16 HDM3-1.24 HDM3-2.02 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
|
|
|
Configure network port settings |
Added the remarks. |
|
|
|
|
Obtain manager resource information |
Added the Oem.Public.BiosCurrentRunningPartition field. |
|
|
|
|
Update firmware |
Added the Oem.Public.BiosFlash field in the request body. |
|
V1.26 |
2025-01-24 |
HDM2-1.80 HDM2-2.17 HDM3-1.24 HDM3-2.03 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
|
|
|
Configure SMTP settings |
Revised the change history. |
|
|
|
|
Obtain shared network port information |
Deleted the LinkStatus field in response field description. |
|
|
|
|
Obtain module information |
Revised the example. |
|
|
|
|
Obtain module information |
Revised the change history. |
|
|
|
|
Configure network port information |
Added the remarks. |
|
|
|
|
Export the BIOS, BMC, and RAID controller settings Create a Redfish session Obtain user account information Add a user account Edit user account settings |
Revised the change history. |
|
|
|
|
Obtain network adapter information |
Added the NPARPort field. |
|
|
|
|
Obtain module information |
Added the Retimer field. |
|
|
|
|
Obtain thermal properties |
Revised the change history. |
|
|
|
|
Create a Redfish session |
Revised the request. |
|
|
|
|
Configure SMTP settings |
Added the description for the SenderUserName field. |
|
|
|
|
Configure virtual media settings |
Added the description for the Media.UserName field. |
|
|
|
|
Configure SMTP settings |
Added the description for the read-only community and write/read community. |
|
V1.27 |
2025-02-19 |
HDM2-1.80 HDM2-2.17 HDM3-1.25 HDM3-2.04 |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
|
|
|
Create a logical drive |
Added description for the stripe size value. |
|
|
|
|
Configure SMTP settings |
Revised the version in the change history. |
|
|
|
|
Obtain thermal properties |
Revised the change history. |
|
V1.2x |
2025-03-14 |
HDM2-1.8x HDM2-2.1x HDM3-1.2x HDM3-2.0x |
|
The version number is the latest HDM version at the time of release. For more information about the versions supported by a product, see the change history for the target interface and "Applicable products" in Redfish API conventions. |
|
|
|
|
Obtain system resource information |
Added the Oem.Public.PUID field. |
Description for special field values
Operations on public fixed resources
Obtain Redfish version information
Obtain root service information
Obtain metadata document information
Obtain Schema collection information
Obtain the registry address for a single Schema file
Obtain message registry collection information
Obtain message registry information
Obtain OData service document information
Operations on chassis resources
Obtain the chassis resource ID of the server
Obtain server information by its chassis resource ID
Modify chassis-related resources
Obtain physical drive collection information
Obtain physical drive information
Obtain available logical disks when creating a hot spare drive on specified physical drive
Obtain idle slot collection information
Obtain information about the specified idle slot
Set the UID LED state of the idle slot
Obtain the collection information of drive Bays
Configure the heat dissipation resource information for the specified chassis
Obtain air inlet temperature history resource information
Obtain power recovery policy information
Obtain information about CPU power saving
Configure CPU power saving settings
Obtain information about historical power resource
Obtain sensor type collection information
Obtain information of sensor list for a specified type
Obtain historical information about a single sensor resource
Recalculate highest historical temperature information for sensor
Obtain module collection information
Obtain PCIe module collection information
Obtain PCIe module information
Obtain PCIe function information
Obtain network adapter collection information
Obtain network adapter information
Obtain network port collection information
Obtain network port information
Configure network port settings
Obtain drive alarm threshold information
Configure drive alarm threshold settings
Operations on system resources
Obtain system collection information
Obtain system resource information
Configure system resource properties
Obtain information about boot self-test code collection resource
Obtain information about specified boot self-test code
Obtain processor collection information
Set alarm threshold for processor usage
Obtain memory collection information
Obtain storage controller collection information
Obtain storage controller information
Modify storage controller information
Clear Foreign status of physical drives in specified storage controller
Clear all configurations for a specified storage controller
Obtain logical drive collection information
Obtain logical drive information
Obtain BIOS setting collection information
Obtain pending BIOS setting information
Restore the default BIOS settings
Obtain BIOS detailed setting rules information
Obtain event log service collection information
Obtain event log service resource information
Configure specified event log service resource settings
Obtain event log entry collection information
Obtain event log entry resource information
Export event log entry information
Clear event log entry information
Obtain information about security control panel
Set security control panel information
Obtain information about network interface collection resource
Obtain information of the specified network interface resource
Obtain network port collection information
Download clear configuration reports
Obtain the detailed progress of configuration clearance
Obtain the system software inventory information
Clear inactive BIOS configurations
Obtain host status migration information
Obtain information about host resource monitoring
Configure host resource monitoring information settings
Obtain information about CPU historical usage rate resource
Obtain information about memory historical usage rate resource
Obtain information about GPU historical usage rate resource
Obtain information about network bandwidth historical send/receive speed resource
Obtain information about disk historical usage rate resource
Obtain information about disk IO performance historical data
Obtain information about disk SVCTM historical data
Obtain information about NFS server read/write rate historical data
Obtain information about NFS client read/write rate historical data
Obtain information about system load historical data
Obtain performance advisor recommendation information
Upload and write the Intel On Demand License activation file
Operations on manager resources
Obtain manager collection information
Obtain manager resource information
Edit manager resource information
Obtain information for SMTP trap testing
Import the syslog root certificate
Import a private key certificate
Obtain the list of services that can create sessions
Obtain detailed session information for a specified service
Delete session information for the specified service
Obtain energy-saving service information
Configure energy-saving service settings
Obtain network port collection information
Obtain shared network port information
Configure shared network port settings
Obtain network port information
Configure network port settings
Obtain virtual media collection information
Obtain virtual media information
Obtain virtual media connection status
Obtain virtual media configuration
Configure virtual media settings
Obtain all operation log collection information
Obtain log service collection information
Obtain log service information
Obtain log entry collection information
Export operation log information
Clear operation log information
Collect SDS log entry information
Obtain serial port collection information
Obtain serial port information
Obtain LLDP service information
Import the BIOS, BMC, and RAID controller settings
Export the BIOS, BMC, and RAID controller settings
Obtain trusted password module status configuration
Obtain firewall configuration information
Delete firewall configuration rule
Obtain server security service information
View SSL certificate resource information
Obtain login security information feature
Set login security information feature
Obtain platform firmware resilience configuration
Configure platform firmware resilience settings
Obtain serial port redirection settings
Set serial port redirection settings
Obtain advanced video playback configuration
Set advanced video playback configuration
Unified management: Obtain managed device collection resources
Unified management: Add managed device resources
Unified management: Delete managed device resources
Unified management: Host power operation
Obtain service USB drive resource information
Set service USB drive resource information
Obtain security dashboard information
Set security dashboard information
Obtain system lock resource information
Modify system lock resource information
Obtain intelligent monitoring service information
Configure intelligent monitoring service information
Obtain intelligent monitoring drive resource information
Obtain intelligent monitoring information of a drive
Obtain intelligent monitoring memory resource information
Obtain configuration information about fast OS installation
Create a fast OS installation configuration service
Obtain system diagnosis information
Configure system diagnosis settings
Perform node control on a multi-node device
Manually take screen snapshots
Operations on account service resources
Obtain account service information
Obtain user account collection information
Obtain user account information
Obtain role collection information
Obtain the LDAP service resource
Edit the LDAP service resource
Obtain LDAP domain controller collection resource
Obtain the user collection resource in an LDAP domain
Obtain a single user resource in an LDAP domain
Edit an LDAP domain user group resource
Delete a user group resource in an LDAP domain
Obtain the AD service resource
Obtain AD domain controller collection resource
Obtain the user collection resource in an AD domain
Obtain a single user resource in an AD domain
Edit a user group resource in an AD domain
Delete a user group resource in an AD domain
Obtain user certificate management service information
Set certificate management service information
Obtain user root certificate list
Obtain information of a specific root certificate
Import a root certificate file
Delete a root certificate file
Obtain the client certificate list bound to a root certificate
Import a client certificate file
Obtain information of a client certificate
Obtain the user list bindable to a client certificate
Bind a user to a client certificate
Unbind a client certificate from a user
Obtain SSH public key list information
Obtain information of an SSH public key
Obtain the list of SSH public key-bindable users
Bind an SSH public key to a user
Unbind an SSH public key from a user
Import a weak password dictionary
Export a weak password dictionary
Obtain the Kerberos service resource
Edit the Kerberos service resource
Obtain the Kerberos collection resource
Obtain the user group collection resource in a Kerberos controller
Edit the user group collection resource in a Kerberos controller
Obtain a user group resource from a Kerberos controller
Edit a user group resource in a Kerberos controller
Delete a Kerberos user group resource
Operations on session service resources
Obtain session collection information
Obtain Redfish session information
Operations on update service resources
Obtain update service information
Configure update service information
Obtain firmware inventory collection information
Obtain firmware inventory information
Delete an image in an image pool
Obtain firmware inventory information
Obtain information of a firmware inventory
Obtain firmware package collection information
Operations on task service resources
Obtain task service information
Obtain task collection information
Obtain server scheduled task list information
Obtain information of a server scheduled task
Operations on event service resources
Obtain event collection information
Obtain event subscription collection information
Obtain event subscription information
Simulate reporting test events
Operations on license service resources
Obtain license service information
Obtain license resource collection information
Obtain information of a license resource
Install the license activation file
Uninstall the license activation file
Use Postman to obtain information about Redfish root service resources
Perform filtering and pagination ($skip, $top)
Obtain the list of fields ($select)
Introduction
Redfish® is an open industry standard defined by DMTF to provide simple and secure management of modern scalable hardware for converged, hybrid IT and software-defined data centers. It is replacing IPMI as the next-generation server management protocol.
Redfish provides HTTP- and HTTPS-based RESTful APIs for device management. Each HTTP or HTTPS operation submits a resource request or retrieves a resource response encoded in UTF-8 in JSON format.
Hardware device management (HDM) is an H3C-proprietary remote server management system. It supports managing servers through Redfish to streamline server configuration, monitoring, and remote control.
Prerequisites
This document is applicable only to H3C server models.
This document was created based on Redfish version 1.15.1 and Schema version 2020.3.
Redfish API conventions
HTTPS methods and URI format
An API operation contains an HTTPS method and a URI path. The available HTTPS methods include:
· GET—Retrieves data from the server.
· POST—Creates a resource or invokes an action.
· PATCH—Updates or modifies an existing resource.
· DELETE—Removes a resource.
The URI path uses the https://device_ip/redfish/v1/path format, where:
· https://device_ip—Specifies the URI address. The device_ip argument represents the HDM management IP address of the server to access.
· /redfish/v1/—Specifies Redfish service and version. This document was created based on Redfish v1.
· /path—Specifies the resource ID.
OData properties
The response displays resource information by using OData properties as shown in Table 1.
Table 1 Available OData properties
|
OData property |
Description |
|
@odata.context |
Specifies the context URL. |
|
@odata.id |
Specifies the unique identifier of the resource. |
|
@odata.type |
Specifies the type of a resource, an absolute URL. |
Status codes
|
Status code |
Description |
|
200 OK |
The request was successfully completed. |
|
201 Created |
A request that created a new resource completed successfully. |
|
202 Accepted |
The request has been accepted for processing, but the processing has not been completed. |
|
204 No Content |
The request succeeded, but no content is being returned in the body of the response. |
|
400 Bad Request |
The request parameter could not be processed because it contains missing or invalid information. An extended error shall be returned in the response. |
|
401 Unauthorized |
The authentication credentials included with this request are missing or invalid. (User privileges) |
|
403 Forbidden |
The server recognized the credentials in the request, but those credentials do not possess authorization to perform this request. (API privileges) |
|
404 Not Found |
The request specified a URI of a resource that does not exist. |
|
405 Method Not Allowed |
The HTTP verb specified in the request is not supported for this request URI. |
|
409 Conflict |
A creation or update request could not be completed, because it would cause a conflict in the current state of the resources supported by the platform. |
|
412 Precondition Failed |
The precondition (such as If-Match headers) check failed. |
|
428 Precondition Missed |
The precondition was missing. |
|
The server encountered an unexpected condition that prevented it from fulfilling the request. For example, a timeout error occurrred. |
|
|
501 Not Implemented |
The server does not (currently) support the functionality required to fulfill the request. |
|
503 Service Unavailable |
The server is temporarily overloaded and is unable to process the request. |
|
507 Insufficient Storage |
The server cannot store content necessary to complete the request. |
Field status
|
Field |
Data type |
Value |
|
Status.State |
String |
Device enabling status. Supported options: · Absent—The device does not exist or has not been detected. · Enabled. · UnavailableOffline—The device has resources, but the resources are not available. For example: ¡ The system cannot obtain the out-of-band information about a present storage controller. ¡ The system cannot obtain storage controller information about a present drive. ¡ The storage overall status is powered off.) · Disabled—The device is faulty or disabled. For example the memory is disabled. · Starting—The BIOS is being initialized. · StandbyOffline—The device is present, but requires external activation. |
|
Status.Health |
String |
Health status. Supported options: · OK—The device is in normal state. · Warning—A minor alarm occurred on the device. · Critical—A major or critical alarm occurred on the device. This field indicates the health status of the device only when the device is enabled. If the device enabling status is disabled or absent, this field is fixed to OK. |
|
Status.HealthRollup |
String |
HealthRollup status. Supported options: · OK—The device is in normal state. · Warning—A minor alarm occurred on the device. · Critical—A major or critical alarm occurred on the device. This field indicates the health status of the device only when the device is enabled. If the device enabling status is disabled or absent, this field is fixed to OK. |
|
Status.Oem.Public.Severity |
String |
Custom health status levels. Supported options: · Informational—The device is in normal state. · Minor—A minor alarm occurred on the device. · Major—A major alarm occurred on the device. · Critical—A critical alarm occurred on the device. |
API privilege modules
HDM 2.xx.xx provides group-based API access control. The APIs are assigned to groups, with each group called an API privilege module. You can assign API privileges to user roles on a per-module basis.
Table 2 API privilege modules
|
Module |
API privileges |
|
ConfigureUsers |
Includes local user configuration, LDAP user configuration, AD user configuration, OTP authentication, certificate authentication, SSH key management, license management, secure erasure, configuration import and export, and unified control. |
|
ConfigureComponents |
Includes asset tag configuration, network configuration, LLDP configuration, wireless management, NTP configuration, SNMP configuration, alarm configuration (SMTP, trap, and syslog), event log policy settings, operation log clearing, video playback, and security bezel configuration. |
|
OemKvm |
Includes storage management, system resource monitoring settings, BIOS settings, KVM (excluding power control and image mounting), H5 KVM (excluding power control and image mounting), VNC password management, system boot options, UID LED control, SOL serial settings, and MCA policy access. |
|
OemVmm |
Includes virtual media configuration, KVM image mounting, and H5 KVM image mounting. |
|
OemSecurityMgmt |
Includes service configuration, firewall, SSL certificate, PFR firmware protection, and login security information configuration. |
|
OemPowerControl |
Includes power supply management, NMI control, physical power button control, fan configuration, and intelligent energy-saving. |
|
OemDiagnosis |
Includes clearing event logs, package management, firmware updates, firmware library management, scheduled task management, restoring HDM configuration, restarting HDM, restarting CPLD, and service USB drive settings. |
|
ConfigureSelf |
Includes configuring user passwords (for local users only). |
|
Login |
Includes viewing typical HDM information, excluding event logs, operation logs, or SDS log download. Only the Administrator role can view information of other users. |
|
OemSystemAudit |
Includes the operation permissions to view or save event logs, operation logs, and one-click collection and download of SDS logs. |
|
ConfigureManager |
(Not supported.) Includes configuring manager resources. |
Table 3 User role privilege modules
|
Module |
Description |
|
Administrator |
Login ConfigureSelf ConfigureUsers ConfigureComponents OemKvm OemVmm OemSecurityMgmt OemPowerControl OemDiagnosis OemSystemAudit |
|
Operator |
Login ConfigureSelf ConfigureComponents OemKvm OemVmm OemSecurityMgmt OemPowerControl OemSystemAudit |
|
User |
Login ConfigureSelf |
|
NoAccess |
No access privilege. This indicates that users cannot access or view specific content, files, or systems. |
|
CustomRole1 |
Login All privileges can be configured except ConfigureUsers. |
|
CustomRole2 |
Login All privileges can be configured except ConfigureUsers. |
|
CustomRole3 |
Login All privileges can be configured except ConfigureUsers. |
|
CustomRole4 |
Login All privileges can be configured except ConfigureUsers. |
|
CustomRole5 |
Login All privileges can be configured except ConfigureUsers. |
Resource description
|
Resources |
Description |
|
Chassis |
Used to manage physical drives, power supplies, fans, UID LED, PCIe modules, and network adapters. |
|
Systems |
Used to manage components such as processors, memory, storage controllers, logical drives, and GPUs, and resources such as BIOS, KVM, and event log. |
|
Managers |
Used to manage BMC network settings (NTP, SNMP, LLDP, and syslog for example), security settings (certificate and services), operation log, and virtual media. |
|
AccountService |
Used to manage BMC users. |
|
SessionService |
Used to manage BMC sessions. |
|
UpdateService |
Used to manage firmware update for BMC. |
|
TaskService |
Used to manage BMC tasks. |
|
EventService |
Used to manage alarm event report for BMC. |
Description for special field values
The following special field values are supported in responses:
· ""—Indicates that the value has been successfully obtained and the content is an empty string, which is also displayed normally on the Web interface.
· N/A—Not available, which indicates that the field is retrievable, but currently unavailable. The Web interface displays N/A normally.
· NULL—Indicates that the field is not supported. The Web interface does not display the field content or the field name.
· 0xFFFFFFFF—Indicates that the value should have been obtained but was not obtained. The Web interface displays N/A and Redfish displays 4294967295 (=0xFFFFFFFF).
Field values N/A (for the string type) and 0xFFFFFFFF (for the integer type) are used for retrievable fields that cannot be retrieved due to an exception:
· An API error occurred, but the Redfish API still needs to display the field content.
· Values agreed upon with the back end to represent exceptions.
For features that are disabled, Redfish API will use the values returned by the back end. For example, when IPv6 is disabled, Redfish API will return an empty string for the subnet mask and 0 for the subnet prefix length.
Applicable products
This document is applicable to all H3C server models. For more information about the applicable products, see H3C Servers HDM2 User Guide.
The Redfish commands for HDM3 are developed based on HDM2-1.65. If no additional revision records are described, the Redfish features after this HDM2 version is not supported by default or is not yet developed in HDM3. Make sure you are aware of the command instructions in subsequent new versions.
Others
The following conventions are used in Redfish API:
· Oem.Public.CompletionCode: Indicates the CC value returned by this interface.
· Oem.Public.Description: Indicates the description of the interface execution result. This field is fixed to Success by default.
· RSAEncryptionEnabled: Indicates that the Web interface uses RSA encryption and the value does not need to be displayed when obtained.
· Members@odata.nextLink: Indicates the link to the next page when the number of collection resource members exceeds 100 and pagination is required.
· The time format is 2019-02-14T20:21:36+08:00.
· The time zone supports only whole hour or half-hour increments.
· "Content":
¡ File transfer protocols—SFTP, HTTPS, HTTP, NFS, CIFS, and TFTP.
¡ The operation paths do not support Chinese characters.
¡ The field length cannot exceed 1024 characters. Chinese characters are not supported and the following special characters are supported: @!$^&()_+.;[]{}-=~`
¡ Only /tmp/web/ is supported locally.
¡ The maximum total length of the directory and file name for the TFTP protocol is 240 characters.
Recommended API tools
Use either of the following API tools to make API calls:
· (Recommended) Postman.
To download Postman, access https://www.getpostman.com/downloads/.
· HttpRequester for Firefox.
Install the httprequester-2.2-fx.xpi plugin in the Firefox browser. Make sure the browser version is earlier than 56.0b3 (64-bit).
API operations
Operations on public fixed resources
Obtain Redfish version information
Description
Obtain Redfish version information from the server.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish
Request header:
N/A
Request body:
N/A
Parameters
|
Parameter |
Description |
Value |
|
device_ip |
IP address for logging in to the device. |
IPv4 or IPv6 address. |
Examples
Method and URL:
GET https://192.168.18.18/redfish
Request header:
N/A
Request body:
N/A
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"v1": "/redfish/v1/"
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
v1 |
String |
Redfish version information. |
The server returns status code 200 for a successful operation.
Obtain root service information
Description
Obtain root service information from the server.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1
Request header:
N/A
Request body:
N/A
Parameters
|
Parameter |
Description |
Value |
|
device_ip |
IP address for logging in to the device. |
IPv4 or IPv6 address. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1
Request header:
N/A
Request body:
N/A
Response:
{
"@odata.id": "/redfish/v1",
"@odata.type": "#ServiceRoot.v1_9_0.ServiceRoot",
"AccountService": {
"@odata.id": "/redfish/v1/AccountService"
},
"Chassis": {
"@odata.id": "/redfish/v1/Chassis"
},
"EventService": {
"@odata.id": "/redfish/v1/EventService"
},
"Id": "RootService",
"JsonSchemas": {
"@odata.id": "/redfish/v1/JsonSchemas"
},
"LicenseService": {
"@odata.id": "/redfish/v1/LicenseService"
},
"Links": {
"Sessions": {
"@odata.id": "/redfish/v1/SessionService/Sessions"
}
},
"Managers": {
"@odata.id": "/redfish/v1/Managers"
},
"Name": "Root Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"HostName": "HDM222235A022B2B22",
"Manufacturer": "H3C",
"Model": "RS32M2C9S",
"SerialNumber": "222235A022B2B22",
"SoftwareGenerationId":"2"
}
},
"ProtocolFeaturesSupported": {
"DeepOperations": {
"DeepPATCH": false,
"DeepPOST": false
},
"ExcerptQuery": false,
"ExpandQuery": {
"ExpandAll": true,
"Levels": true,
"Links": true,
"MaxLevels": 5,
"NoLinks": true
},
"FilterQuery": false,
"OnlyMemberQuery": false,
"SelectQuery": true
},
"RedfishVersion": "1.15.1",
"Registries": {
"@odata.id": "/redfish/v1/Registries"
},
"SessionService": {
"@odata.id": "/redfish/v1/SessionService"
},
"Systems": {
"@odata.id": "/redfish/v1/Systems"
},
"Tasks": {
"@odata.id": "/redfish/v1/TaskService"
},
"UUID": "36538512-d02a-1000-02f2-aabbccd24718",
"UpdateService": {
"@odata.id": "/redfish/v1/UpdateService"
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the root service resource model. |
|
@odata.id |
String |
Link to the root service resource. |
|
@odata.type |
String |
Type of the root service resource. |
|
Id |
String |
ID of the root service resource. |
|
Name |
String |
Name of the root service resource. |
|
RedfishVersion |
String |
Redfish version. |
|
UUID |
String |
Universally unique identifier (UUID) of the device. |
|
AccountService |
Object |
Account service resource. |
|
Chassis |
Object |
Chassis information resource. |
|
EventService |
Object |
Event service resource. |
|
LicenseService |
Object |
License service resource. |
|
Links |
Links to resources. |
|
|
Sessions |
Object |
Session collection resource. |
|
Managers |
Object |
Manager collection resource. |
|
Registries |
Object |
Message registry collection resource. |
|
SessionService |
Object |
Session service collection resource. |
|
Systems |
Object |
System collection resource. |
|
Tasks |
Object |
Task collection resource. |
|
UpdateService |
Object |
Update service collection resource. |
|
JsonSchemas |
Object |
Json-Schema file collection resource. |
|
Oem.Public.HostName |
String |
Host name of a system resource. |
|
Oem.Public.Manufacturer |
String |
Manufacturer. |
|
Oem.Public.Model |
String |
Model. |
|
Oem.Public.SerialNumber |
String |
Product serial number |
|
Oem.Public.SoftwareGenerationId |
String |
BMC software generation information |
|
@odata.id |
String |
Link to a resource. |
|
ProtocolFeaturesSupported |
Object |
Protocol extension resources. |
|
ProtocolFeaturesSupported.DeepOperations |
Object |
Deep operations supported by the protocol. |
|
ProtocolFeaturesSupported.DeepOperations.DeepPATCH |
Boolean |
Whether the protocol supports deep PATCH operations. |
|
ProtocolFeaturesSupported.DeepOperations.DeepPOST |
Boolean |
Whether the protocol supports deep POST operations. |
|
ProtocolFeaturesSupported.ExcerptQuery |
Boolean |
Whether the excerpt query parameter is supported. |
|
ProtocolFeaturesSupported.ExpandQuery |
Object |
Contains information about the protocol using the $expand query parameter. |
|
ProtocolFeaturesSupported.ExpandQuery.ExpandAll |
Boolean |
Whether asterisks (*) are supported for the $expand query parameter. |
|
ProtocolFeaturesSupported.ExpandQuery.Levels |
Boolean |
Whether the $levels query parameter is supported for expand query. |
|
ProtocolFeaturesSupported.ExpandQuery.Links |
Boolean |
Whether tilde signs (~) are supported for the $expand query parameter. |
|
ProtocolFeaturesSupported.ExpandQuery.MaxLevels |
Integer |
Maximum supported $levels parameter for $expand. |
|
ProtocolFeaturesSupported.ExpandQuery.NoLinks |
Boolean |
Whether dots (.) are supported for the $expand query parameter. |
|
ProtocolFeaturesSupported.FilterQuery |
Boolean |
Whether the filter query feature is supported. |
|
ProtocolFeaturesSupported.OnlyMemberQuery |
Boolean |
Whether the only query feature is supported. |
|
ProtocolFeaturesSupported.SelectQuery |
Boolean |
Whether the select query feature is supported. |
Change history
|
Version |
Change description |
|
HDM2-1.61 |
Added the Oem.Public.SoftwareGenerationId field. |
|
HDM2-1.55 |
Added the LicenseService object. |
Obtain metadata document information
Description
Obtain information about all metadata documents from the server.
Privilege module
Login
Request
Method and URL:
GET https://device_ip//redfish/v1/$metadata
Request header:
N/A
Request body:
N/A
Parameters
|
Parameter |
Description |
Value |
|
device_ip |
IP address for logging in to the device. |
IPv4 or IPv6 address. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/$metadata
Request header:
Content-Type:application/json
Request body:
N/A
Response:
<?xml version="1.0" encoding="UTF-8"?>
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
<edmx:Reference Uri="/redfish/v1/schema/AccountService_v1.xml">
<edmx:Include Namespace="AccountService"/>
<edmx:Include Namespace="AccountService.v1_0_0"/>
<edmx:Include Namespace="AccountService.v1_0_2"/>
<edmx:Include Namespace="AccountService.v1_0_3"/>
<edmx:Include Namespace="AccountService.v1_0_4"/>
<edmx:Include Namespace="AccountService.v1_0_5"/>
<edmx:Include Namespace="AccountService.v1_0_6"/>
<edmx:Include Namespace="AccountService.v1_0_7"/>
<edmx:Include Namespace="AccountService.v1_0_8"/>
<edmx:Include Namespace="AccountService.v1_0_9"/>
<edmx:Include Namespace="AccountService.v1_0_10"/>
<edmx:Include Namespace="AccountService.v1_0_11"/>
......
<edmx:Reference Uri="/redfish/v1/schema/VLanNetworkInterface_v1.xml">
<edmx:Include Namespace="VLanNetworkInterface"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_0_0"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_0_1"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_0_2"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_0_3"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_0_4"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_0_5"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_0_6"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_0_7"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_0_8"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_0_9"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_1_0"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_1_1"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_1_2"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_1_3"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_1_4"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_1_5"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_2_0"/>
<edmx:Include Namespace="VLanNetworkInterface.v1_3_0"/>
</edmx:Reference>
<edmx:Reference Uri="/redfish/v1/schema/VLanNetworkInterfaceCollection_v1.xml">
<edmx:Include Namespace="VLanNetworkInterfaceCollection"/>
</edmx:Reference>
<edmx:DataServices>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Service">
<EntityContainer Name="Service" Extends="ServiceRoot.v1_0_0.ServiceContainer"/>
</Schema>
</edmx:DataServices>
<edmx:Reference Uri="/redfish/v1/schema/OemManager_v1.xml">
<edmx:Include Namespace="OemManager"/>
</edmx:Reference>
<edmx:Reference Uri="/redfish/v1/schema/OemComputerSystem_v1.xml">
<edmx:Include Namespace="OemComputerSystem"/>
</edmx:Reference>
<edmx:Reference Uri="/redfish/v1/schema/OemVirtualMedia_v1.xml">
<edmx:Include Namespace="OemVirtualMedia"/>
<edmx:Include Namespace="OemVirtualMedia.v1_0_0"/>
</edmx:Reference>
<edmx:Reference Uri="/redfish/v1/schema/OemAccountService_v1.xml">
<edmx:Include Namespace="OemAccountService"/>
<edmx:Include Namespace="OemAccountService.v1_0_0"/>
</edmx:Reference>
<edmx:Reference Uri="/redfish/v1/schema/OemSession_v1.xml">
<edmx:Include Namespace="OemSession"/>
<edmx:Include Namespace="OemSession.v1_0_0"/>
</edmx:Reference>
</edmx:Edmx>
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
Obtain Schema collection information
Description
Obtain information about Schemas of all resources from the server.
Privilege module
Login
Request
Method and URL:
GET https://device_ip//redfish/v1/JsonSchemas
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/JsonSchemas
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.id": "/redfish/v1/JsonSchemas",
"@odata.context": "/redfish/v1/$metadata#JsonSchemaFileCollection.JsonSchemaFileCollection",
"@odata.type": "#JsonSchemaFileCollection.JsonSchemaFileCollection",
"Name": "JsonSchemaFile Collection",
"Description": "Collection of JsonSchemaFiles",
"Members@odata.count": 58,
"Members": [
{
"@odata.id": "/redfish/v1/JsonSchemas/AccountService"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/ActionInfo"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Assembly"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/AttributeRegistry"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Bios"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Certificate"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/CertificateLocations"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/CertificateService"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Chassis"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/ComputerSystem"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Drive"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/EthernetInterface"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Event"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/EventDestination"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/EventService"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/IPAddresses"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/JsonSchemaFile"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/LogEntry"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/LogService"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Manager"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/ManagerAccount"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/ManagerNetworkProtocol"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Memory"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Message"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/MessageRegistry"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/MessageRegistryFile"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/MetricDefinition"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/MetricReport"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/MetricReportDefinition"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/OperatingConfig"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/PCIeDevice"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/PCIeFunction"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Power"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Privileges"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Processor"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Resource"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Role"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Sensor"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/ServiceRoot"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Session"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/SessionService"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Settings"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/SoftwareInventory"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Storage"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/StorageController"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Task"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/TaskService"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/TelemetryService"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Thermal"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/Triggers"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/UpdateService"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/VLanNetworkInterface"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/VirtualMedia"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/odata"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/redfish-error"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/redfish-payload-annotations"
},
{
"@odata.id": "/redfish/v1/JsonSchemas/redfish-schema"
}
]
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the Schema collection resource model. |
|
@odata.id |
String |
Link to the Schema collection resource. |
|
Name |
String |
Name of the Schema collection resource. |
|
Description |
String |
Description of the Schema resource. |
|
@odata.type |
String |
Type of the Schema collection resource. |
|
Members@odata.count |
Integer |
Number of Schema resources. |
|
Members |
List of Schema resources. |
|
|
@odata.id |
String |
Link to a Schema resource. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.57 |
Deleted the path to access the Redundant resource node in Members. |
|
HDM-1.30.09 |
Added the redfish/v1/JSONSchemas interface. |
Obtain the registry address for a single Schema file
Description
Obtain the registry address for a single Schema file from the server.
Privilege module
Login
Request
Method and URL:
GET https://device_ip//redfish/v1/JsonSchemas/schema_name
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. |
|
schema_name |
Access ID of the Schemas resource node. |
You can obtain the ID by obtaining the Schema file of all current resources on the server. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/JsonSchemas/Chassis
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#JsonSchemaFile.JsonSchemaFile",
"@odata.id": "/redfish/v1/JsonSchemas/Chassis",
"@odata.type": "#JsonSchemaFile.v1_0_2.JsonSchemaFile",
"Name": "Chassis Schema File",
"Schema": "#Chassis.Chassis",
"Description": "Chassis Schema File Location",
"Id": "Chassis",
"Languages": [
"en"
],
"Languages@odata.count": 1,
"Location": [
{
"Language": "en",
"PublicationUri": "http://redfish.dmtf.org/schemas/v1/Chassis.json",
"Uri": "/redfish/v1/JsonSchemas/Chassis/Chassis.json"
}
],
"Location@odata.count": 1
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description information for the registry resource model. |
|
@odata.id |
String |
Link to registry resource nodes. |
|
@odata.type |
String |
Type of the registry resource. |
|
Id |
String |
ID of the registry resource. |
|
Name |
String |
Name of the registry resource. |
|
Description |
String |
Description of the registry resource. |
|
Schema |
String |
Name of the registry file. |
|
Languages |
String |
Language set. |
|
Languages@odata.count |
Integer |
Number of language sets. |
|
Location |
Object array |
|
|
Language |
String |
Encoding language of Schema file. |
|
Uri |
String |
Local accessible URI linked to the Schema. |
|
PublicationUri |
String |
Public accessible URI linked to Schema. |
|
Location@odata.count |
Integer |
Number of location groups. |
Obtain message registry collection information
Description
Obtain information about all message registries from the server.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Registries
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/Registries
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Registries",
"@odata.id": "/redfish/v1/Registries",
"@odata.type": "#MessageRegistryFileCollection.MessageRegistryFileCollection",
"Description": "Collection of MessageRegistryFiles",
"Members": [
{
"@odata.id": "/redfish/v1/Registries/Base"
},
{
"@odata.id": "/redfish/v1/Registries/TaskEvent"
},
{
"@odata.id": "/redfish/v1/Registries/ResourceEvent"
},
{
"@odata.id": "/redfish/v1/Registries/OpenBMC"
}
],
"Members@odata.count": 4,
"Name": "MessageRegistryFile Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the message registry collection resource model. |
|
@odata.id |
String |
Link to the message registry collection resource. |
|
Name |
String |
Name of the message registry collection resource. |
|
@odata.type |
String |
Type of the message registry collection resource. |
|
Members@odata.count |
Integer |
Number of message registry resources. |
|
Members |
List of message registry resources. |
|
|
@odata.id |
String |
Link to a message registry resource. |
The server returns status code 200 for a successful operation.
Obtain message registry information
Description
Obtain information about a specific message registry from the server.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Registries/registries_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. |
|
registries_id |
Extended resource ID. |
You can obtain the resource IDs by obtaining all registry resources. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/Registries/Base
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Registries/Members/$entity",
"@odata.id": "/redfish/v1/Registries/Base",
"@odata.type": "#MessageRegistryFile.v1_1_0.MessageRegistryFile",
"Description": "DMTF Base Message Registry File Location",
"Id": "Base",
"Languages": [
"en"
],
"Languages@odata.count": 1,
"Location": [
{
"Language": "en",
"PublicationUri": "https://redfish.dmtf.org/registries/Base.1.8.1.json",
"Uri": "/redfish/v1/Registries/Base/Base"
}
],
"Location@odata.count": 1,
"Name": "Base Message Registry File",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"Registry": "Base.1.8.1"
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the message registry model. |
|
@odata.id |
String |
Link to the message registry resource. |
|
Id |
String |
ID of the message registry resource. |
|
Name |
String |
Name of the message registry resource. |
|
@odata.type |
String |
Type of the message registry resource. |
|
Description |
String |
Description of the message registry resource. |
|
Languages |
Integer |
Language codes for the registries available. |
|
Registry |
String |
Name of the message registry, primary or secondary version of the registry. |
|
Location@odata.count |
Integer |
Number of location groups. |
|
Location |
Array |
|
|
Language |
String |
Language code for the file the registry is in. |
|
Uri |
String |
Link to the locally available URI for the registry. |
|
PublicationUri |
String |
Link to publicly accessible URI for Schema. |
The server returns status code 200 for a successful operation.
Obtain OData service document information
Description
Obtain information about the OData service document from the server.
Privilege module
Login
Request
Method and URL:
GET https://device_ip//redfish/v1/odata
Request header:
N/A
Request body:
N/A
Parameters
|
Parameter |
Description |
Value |
|
device_ip |
IP address for logging in to the device. |
IPv4 or IPv6 address. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/odata
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata",
"value": [
{
"kind": "Singleton",
"name": "$metadata",
"url": "/redfish/v1/$metadata"
},
{
"kind": "Singleton",
"name": "odata",
"url": "/redfish/v1/odata"
},
{
"kind": "Singleton",
"name": "JsonSchemas",
"url": "/redfish/v1/JsonSchemas"
},
{
"kind": "Singleton",
"name": "Service",
"url": "/redfish/v1/"
},
{
"kind": "Singleton",
"name": "ServiceRoot",
"url": "/redfish/v1/ServiceRoot"
},
{
"kind": "Singleton",
"name": "Systems",
"url": "/redfish/v1/Systems"
},
{
"kind": "Singleton",
"name": "Chassis",
"url": "/redfish/v1/Chassis"
},
{
"kind": "Singleton",
"name": "Managers",
"url": "/redfish/v1/Managers"
},
{
"kind": "Singleton",
"name": "SessionService",
"url": "/redfish/v1/SessionService"
},
{
"kind": "Singleton",
"name": "AccountService",
"url": "/redfish/v1/AccountService"
},
{
"kind": "Singleton",
"name": "UpdateService",
"url": "/redfish/v1/UpdateService"
}
]
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the OData service document resource model. |
|
value |
List of OData service document resources. |
|
|
name |
String |
Name of an OData service document resource. |
|
kind |
String |
Type of an OData service document resource. |
|
url |
String |
Link to an OData service document resource. |
The server returns status code 200 for a successful operation.
Operations on chassis resources
Obtain the chassis resource ID of the server
Description
Obtain the chassis ID of the server. This operation returns information about only one server chassis, because HDM manages only the server on which it runs.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Chassis
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/Chassis
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#ChassisCollection.ChassisCollection",
"@odata.id": "/redfish/v1/Chassis",
"@odata.type": "#ChassisCollection.ChassisCollection",
"Members": [
{
"@odata.id": "/redfish/v1/Chassis/1"
}
],
"Members@odata.count": 1,
"Name": "Chassis Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
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
Login
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",
"@odata.id": "/redfish/v1/Chassis/1",
"@odata.type": "#Chassis.v1_14_0.Chassis",
"AssetTag": "",
"BoardsSummary": {
"Count": 4,
"MaxCountSupported": null,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
"ChassisType": "Rack Mount Chassis",
"Description": "Computer System Chassis",
"Drives": {
"@odata.id": "/redfish/v1/Chassis/1/Drives"
},
"Id": "1",
"IndicatorLED": "Off",
"IndicatorLED@Redfish.AllowableValues": [
"Lit",
"Blinking",
"Off"
],
"InletHistoryTemperature": {
"@odata.id": "/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature"
},
"Links": {
"ComputerSystems": [
{
"@odata.id": "/redfish/v1/Systems/1"
}
],
"ManagedBy": [
{
"@odata.id": "/redfish/v1/Managers/1"
}
],
"PCIeDevices": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3"
}
]
},
"Manufacturer": "New H3C Technologies Co., Ltd.",
"Model": "R4900_G6",
"Name": "Computer System Chassis",
"NetworkAdapters": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters"
},
"Oem": {
"Public": {
"Boards": {
"@odata.id": "/redfish/v1/Chassis/1/Boards"
},
"CPUEnergyEfficiency": {
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/CPUEnergyEfficiency"
},
"CompletionCode": 0,
"Description": "Success",
"DeviceMaxNum": {
"CPUNum": 2,
"DiskNum": 25,
"FanNum": 4,
"LiquidCoolerNum": 1,
"LogicalDriveNum": 1,
"MemoryNum": 32,
"MezzCardNum": null,
"PCIeNum": 5,
"PowerSupplyNum": 2,
"SDCardNum": null,
"SDContollerNum": null,
"StorageCardNum": 4
},
"IdleDriveSlots": {
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots"
},
"MCAPolicy": "Restart",
"Mainboard": {
"BoardName": "111",
"ChassisPartNumber": "0235AQ7",
"Manufacturer": "H3C",
"PartNumber": "0302A5B8",
"SerialNumber": "210231A8L0H199BI"
},
"PowerOnSettings": {
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/PowerOnSettings"
},
"SlotPowerSupply": [
{
"PowerState": "Off",
"SlotNumber": "2"
},
{
"PowerState": "Off",
"SlotNumber": "3"
},
{
"PowerState": "Off",
"SlotNumber": "5"
}
]
}
},
"PCIeSummary": {
"Count": 1,
"MaxCountSupported": 5,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
"PSUSummary": {
"Count": 1,
"MaxCountSupported": 2,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
"PartNumber": "1234",
"Power": {
"@odata.id": "/redfish/v1/Chassis/1/Power"
},
"PowerState": "On",
"SKU": "",
"Sensors": {
"@odata.id": "/redfish/v1/Chassis/1/Sensors"
},
"SerialNumber": "123",
"Status": {
"Health": "Critical",
"HealthRollup": "Critical",
"Oem": {
"Public": {
"Severity": "Major"
}
},
"State": "Enabled"
},
"TemperatureSummary": {
"Count": null,
"MaxCountSupported": 28,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"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 chassis resource. |
|
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. |
|
IndicatorLED@Redfish.AllowableValues |
Array |
Available UID LED status. Supported options: · Lit—The LED is steady on. · Blinking—The LED is flashing. · Off—The LED is off. |
|
BoardsSummary/PCIeSummary/ PSUSummary/TemperatureSummary |
Module summary information The X18000 model does not support the PSUSummary module. |
|
|
Count |
Integer |
Current quantity. |
|
MaxCountSupported |
Integer |
Maximum supported quantity in the chassis. |
|
Status |
Object |
Summary resource status. Includes: · Health—Summary resource health status. · State—Summary resource enabling status. · HealthRollup—Overall health status, which is consistent with Health. · Oem.Public.FaultDescription—Overall fault description. · Oem.Public.Severity—Custom health status. The overall fault description is related to component overall faults, which is independent from individual component fault information. |
|
Drives |
Object |
Drive information resource. |
|
InletHistoryTemperature |
Object |
Air inlet historical temperature resource. |
|
Links |
Links to service resources. |
|
|
Links ComputerSystems |
Array |
Computer system resource. |
|
Links ManagedBy |
Array |
System manager resource. |
|
Links.PCIeDevices |
Array |
PCIe device 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. |
|
NetworkAdaptersPartNumber |
Object |
Network adapter resource. |
|
SKU |
String |
SKU code. |
|
SerialNumber |
String |
Serial number. |
|
PartNumber |
String |
Part number. |
|
Sensors |
Object |
Sensor resource. |
|
PowerOnSettings |
Object |
Power recovery policy resource. |
|
Status |
Object |
Resource states: · Health—Whether the resource is healthy. · State—Whether the resource has been enabled. · HealthRollup—Overall health status. · Oem.Public.Severity—Custom health status. |
|
Oem.Public |
Custom attribute. |
|
|
Oem.Public.Boards@odata.id |
Object |
Expander module resource. |
|
Oem.Public.CPUEnergyEfficiency |
Object |
CPU power-saving resource. |
|
Oem.Public.DeviceMaxNum.CPUNum |
Integer |
Maximum number of processors in the chassis. |
|
Oem.Public.DeviceMaxNum.FanNum |
Integer |
Maximum number of fan modules 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.LiquidCoolerNum |
Integer |
Maximum number of liquid-cooled devices. |
|
Oem.Public.DeviceMaxNum.LogicalDriveNum |
Integer |
Maximum number of logical drives in the chassis. |
|
Oem.Public.DeviceMaxNum.MezzCardNum |
Integer |
Maximum number of Mezz cards in the chassis. |
|
Oem.Public.DeviceMaxNum.SDCardNum |
Integer |
Maximum number of SD cards in the chassis. |
|
Oem.Public.DeviceMaxNum.SDContollerNum |
Integer |
Maximum number of SD controllers in the chassis. |
|
Oem.Public.DeviceMaxNum.StorageCardNum |
Integer |
Maximum number of storage controllers in the chassis. |
|
Oem.Public.IdleDriveSlots |
Object |
Empty slots. |
|
Oem.Public.MCAPolicy |
String |
· Restart—Restart the host upon the occurrence of an MCA failure. · NoAction—Do not restart the host when MCA failures occur. |
|
Oem.Public.SlotPowerSupply |
Object |
Power status and slot number for intelligent network adapters that are powered on by slot. |
|
Oem.Public.SlotPowerSupply.PowerState |
String |
Power status. |
|
Oem.Public.SlotPowerSupply.SlotNumber |
String |
Slot number. |
|
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.ChassisPartNumber |
String |
· For all servers except for the R6900 and R8900: Chassis domain part number of the system board. · For the R6900 and R8900: Product name of the midplane. |
|
Oem.Public.Mainboard.Manufacturer |
String |
· For all servers except for the R6900 and R8900: Manufacturer of the system board. · For the R6900 and R8900: Product name of the midplane. |
|
Oem.Public.Mainboard.PartNumber |
String |
· For all servers except for the R6900 and R8900: Part number 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 |
|
HDM3-1.15 |
Added object Oem.Public.IdleDriveSlots. |
|
HDM2-2.04 |
Added object Oem.Public.SlotPowerSupply and updated the description for the Oem.Public.DeviceMaxNum.FanNum field. |
|
HDM2-1.54 |
Added the LiquidCoolerNum field. |
Modify chassis-related resources
Description
Set the UID LED on the server, and configure the MCA policy.
Privilege module
OemKvm
Locking type of the associated system
BMC configuration locking (only applicable when you set MCA)
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,
"Oem":{
"Public":{
"MCAPolicy":policy
"SlotPowerSupply": [
{
"PowerState": "Off",
"SlotNumber": "2"
},
{
"PowerState": "Off",
"SlotNumber": "3"
},
{
"PowerState": "Off",
"SlotNumber": "5"
}
]
}
}
}
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. |
|
Oem.Public.MCAPolicy |
String. |
Supported options: · Restart—Auto restart. · NoAction—No auto restart. |
|
Oem.Public.SlotPowerSupply |
Object |
Power status and slot number for intelligent network adapters that are powered on by slot. |
|
Oem.Public.SlotPowerSupply.PowerState |
String |
Power status. |
|
Oem.Public.SlotPowerSupply.SlotNumber |
String |
Slot number. |
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:
{
"IndicatorLED":"Lit",
"Oem":{
"Public":{
"MCAPolicy":"Restart",
"SlotPowerSupply": [
{
"PowerState": "Off",
"SlotNumber": "2"
},
{
"PowerState": "Off",
"SlotNumber": "3"
},
{
"PowerState": "Off",
"SlotNumber": "5"
}
]
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Chassis.Chassis",
"@odata.id": "/redfish/v1/Chassis/1",
"@odata.type": "#Chassis.v1_14_0.Chassis",
"AssetTag": "",
"BoardsSummary": {
"Count": 4,
"MaxCountSupported": null,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
"ChassisType": "Rack Mount Chassis",
"Description": "Computer System Chassis",
"Drives": {
"@odata.id": "/redfish/v1/Chassis/1/Drives"
},
"Id": "1",
"IndicatorLED": "Lit",
"IndicatorLED@Redfish.AllowableValues": [
"Lit",
"Blinking",
"Off"
],
"InletHistoryTemperature": {
"@odata.id": "/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature"
},
"Links": {
"ComputerSystems": [
{
"@odata.id": "/redfish/v1/Systems/1"
}
],
"ManagedBy": [
{
"@odata.id": "/redfish/v1/Managers/1"
}
],
"PCIeDevices": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3"
}
]
},
"Manufacturer": "New H3C Technologies Co., Ltd.",
"Model": "R4900_G6",
"Name": "Computer System Chassis",
"NetworkAdapters": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters"
},
"Oem": {
"Public": {
"Boards": {
"@odata.id": "/redfish/v1/Chassis/1/Boards"
},
"CPUEnergyEfficiency": {
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/CPUEnergyEfficiency"
},
"CompletionCode": 0,
"Description": "Success",
"DeviceMaxNum": {
"CPUNum": 2,
"DiskNum": 25,
"FanNum": 4,
"LiquidCoolerNum": 1,
"LogicalDriveNum": 1,
"MemoryNum": 32,
"MezzCardNum": null,
"PCIeNum": 5,
"PowerSupplyNum": 2,
"SDCardNum": null,
"SDContollerNum": null,
"StorageCardNum": 4
},
"MCAPolicy": "Restart",
"Mainboard": {
"BoardName": "111",
"ChassisPartNumber": "0235AQ7",
"Manufacturer": "H3C",
"PartNumber": "0302A5B8",
"SerialNumber": "210231A8L0H199BI"
},
"PowerOnSettings": {
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/PowerOnSettings"
},
"SlotPowerSupply": [
{
"PowerState": "Off",
"SlotNumber": "2"
},
{
"PowerState": "Off",
"SlotNumber": "3"
},
{
"PowerState": "Off",
"SlotNumber": "5"
}
]
}
},
"PCIeSummary": {
"Count": 1,
"MaxCountSupported": 5,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
"PSUSummary": {
"Count": 1,
"MaxCountSupported": 2,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
"PartNumber": "1234",
"Power": {
"@odata.id": "/redfish/v1/Chassis/1/Power"
},
"PowerState": "On",
"SKU": "",
"Sensors": {
"@odata.id": "/redfish/v1/Chassis/1/Sensors"
},
"SerialNumber": "123",
"Status": {
"Health": "Critical",
"HealthRollup": "Critical",
"Oem": {
"Public": {
"Severity": "Major"
}
},
"State": "Enabled"
},
"TemperatureSummary": {
"Count": null,
"MaxCountSupported": 28,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"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 |
|
HDM2-2.04 |
Added object Oem.Public.SlotPowerSupply. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain physical drive collection information
Description
Obtain information about all physical drives from the server. Physical drives include NVMe drives and HDDs.
Privilege module
Login
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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
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": "#DriveCollection.DriveCollection",
"AlarmThreshold": {
"@odata.id": "/redfish/v1/Chassis/1/Drives/AlarmThreshold"
},
"Members": [
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront2"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"
}
],
"Members@odata.count": 3,
"Name": "Drives Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
AlarmThreshold |
Object |
Obtain the storage medium alarm threshold. |
|
Members |
Array |
Links to physical drive resources. |
|
Members@odata.count |
Integer |
Number of physical drives. |
|
Name |
String |
Name of the physical drive collection resource. |
Obtain physical drive information
Description
Obtain information about a specific physical drive from the server.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Chassis/chassis_id/Drives/driver_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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
driver_id |
ID of the physical drive resource. |
You can obtain available physical drive resource IDs from physical drive collection information. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Examples
# 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/DiskFront3
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/DiskFront3",
"@odata.type":"#Drive.v1_11_0.Drive",
"CapableSpeedGbs":12,
"CapacityBytes":599584145408,
"HotspareType":"Dedicated",
"Id":"DiskFront3",
"IndicatorLED":"Lit",
"Links":{
"Volumes":[
]
},
"Location":[
{
"Info":"Front3",
"InfoFormat":"DeviceName"
}
],
"Manufacturer":"SEAGATE",
"MediaErrCount": null,
"MediaType":"HDD",
"Model":"ST600MP0005",
"Name":"DiskFront3",
"NegotiatedSpeedGbs":12,
"Oem":{
"Public":{
"CapableSpeedGTs":null,
"CapacityGB":"600GB",
"CompletionCode":0,
"ConnectionID":156,
"Description":"Success",
"DriveNumberInBios":"3",
"DriveNumberInOS":"3",
"EEPROMPage1":null,
"FirmwareStatus":"HotSpare",
"ForeignState":false,
"HoursOfPoweredUp":null,
"IsNVMeM2": false,
"NegotiatedSpeedGTs":null,
"OwnerNode":null,
"Panel":"Front3",
"PowerState":null,
"PredictedMediaLifeLeftDays": null,
"RawCapacity":"600GB",
"RebuildProgress":null,
"SASAddress":[
"5764824129363309997",
"0000000000000000000"
],
"SASSmartInformation":null,
"SATASmartInformation ":[
{
"AttributeName":"RawReadErrorRate",
"ID":1,
"Thresh":44,
"Value":82,
"Worst":63,
"RawValue":100
}
],
"SpareforLogicalDrives":[
{
"@odata.id":"/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0"
}
],
"SupportedConfigurationOperation":[
"ClearHotSpare"
],
"SystemDiskNumber":null,
"TemperatureCelsius":46,
"TriMode":false,
"PatrolState":"DoneOrNotPatrolled",
"RebuildState":"DoneOrNotRebuilt"
}
},
"PredictedMediaLifeLeftPercent":null,
"PredictiveFailureCount":null,
"Protocol":" SATA",
"Revision":"N003",
"SerialNumber":"S7M12N93",
"Status":{
"Health":"OK",
"Oem":{
"Public":{
"FaultDescription":"",
"Severity":"Informational"
}
},
"State":"Enabled"
},
"StatusIndicator":"Hotspare"
}
Response code: 200
# 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",
"CapableSpeedGbs":12,
"CapacityBytes":599584145408,
"HotspareType":"None",
"Id":"DiskFront0",
"IndicatorLED":"Lit",
"Links":{
"Volumes":[
{
"@odata.id":"/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive239"
}
]
},
"Location":[
{
"Info":"Front0",
"InfoFormat":"DeviceName"
}
],
"Manufacturer":"HGST",
"MediaErrCount": null,
"MediaType":"HDD",
"Model":"HUC101860CS4200",
"Name":"DiskFront0",
"NegotiatedSpeedGbs":12,
"Oem":{
"Public":{
"CapableSpeedGTs":null,
"CapacityGB":"600GB",
"CompletionCode":0,
"ConnectionID":155,
"Description":"Success",
"DriveNumberInBios":"0",
"DriveNumberInOS":"0",
"EEPROMPage1":null,
"FirmwareStatus":"Online",
"ForeignState":false,
"HoursOfPoweredUp":null,
"IsNVMeM2": false,
"NegotiatedSpeedGTs":null,
"OwnerNode":null,
"OwnerVolume":{
"Name":"",
"RaidControllerID":0,
"Status":{
"Health":"OK",
"State":"Enabled"
},
"VolumeRaidLevel":"RAID0",
"element_num":1
},
"Panel":"Front0",
"PowerState":null,
"PredictedMediaLifeLeftDays": null,
"RawCapacity":"600GB",
"RebuildProgress":null,
"SASAddress":[
"5764832511393723981",
"0000000000000000000"
],
"SASSmartInformation":{
"AccumulatedLoadUnloadCycles":52,
"AccumulatedStartStopCycles":36,
"CycleCountOverDeviceLifetime":50000,
"DiskTemperatureCelsius":36,
"DiskTripTemperatureCelsius":65,
"ElementsInGrownDefectList":0,
"LoadUnloadCountOverDeviceLifetime":600000,
"WeekAndYearOfManufacture":"In week 44 Of Year 2022"
},
"SATASmartInformation":null,
"SpareforLogicalDrives":[
],
"SupportedConfigurationOperation":[
],
"SystemDiskNumber":null,
"TemperatureCelsius":36,
"TriMode":false,
"PatrolState":"DoneOrNotPatrolled",
"RebuildState":"DoneOrNotRebuilt"
}
},
"PredictedMediaLifeLeftPercent":null,
"PredictiveFailureCount":null,
"Protocol":" SAS",
"Revision":"AD02",
"SerialNumber":"03H3MEHA",
"Status":{
"Health":"OK",
"Oem":{
"Public":{
"FaultDescription":"",
"Severity":"Informational"
}
},
"State":"Enabled"
},
"StatusIndicator":"OK"
}
Response code: 200
# Obtain information about an NVMe drive.
Method and URL:
GET http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront9
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/DiskFront9",
"@odata.type":"#Drive.v1_11_0.Drive",
"CapableSpeedGbs":null,
"CapacityBytes":299439751168,
"Id":"DiskFront9",
"IndicatorLED":"Off",
"Location":[
{
"Info":"Front Slot 9",
"InfoFormat":"DeviceName"
}
],
"Manufacturer":"Intel",
"MediaErrCount": null,
"MediaType":"SSD",
"Model":"SSDPE2MX450G7",
"Name":"P3520",
"NegotiatedSpeedGbs":null,
"Oem":{
"Public":{
"CapableSpeedGTs":8,
"CapacityGB":null,
"CompletionCode":0,
"Description":"Success",
"DriveNumberInBios":"109",
"DriveNumberInOS":"109",
"EEPROMPage1":null,
"FirmwareStatus":"Normal",
"IsNVMeM2": false,
"NegotiatedSpeedGTs":8,
"OwnerNode":null,
"Panel":"Front Slot 9",
"PowerState":null,
"PredictedMediaLifeLeftDays": 4294967295,
"RawCapacity":null,
"SASSmartInformation":null,
"SATASmartInformation ":null,
"SystemDiskNumber":null,
"TemperatureCelsius":34,
"TriMode":false
}
},
"PredictedMediaLifeLeftPercent":95,
"PredictiveFailureCount":null,
"Protocol":"PCIe",
"Revision":"MDV10253",
"SerialNumber":"",
"Status":{
"Health":"OK",
"Oem":{
"Public":{
"FaultDescription":"",
"Severity":"Informational"
}
},
"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. |
|
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. |
|
IndicatorLED |
String |
LED status of the specified driver. Supported options: · Lit—Steady on. · Off—Off. |
|
HotspareType |
String |
Hot spare status of the specified driver. Supported options: · None—No hot spare configured. · Global—Global hot spare. · Dedicated—Local hot spare. · AutoReplace—Roaming hot spare. |
|
Model |
String |
Drive model. |
|
Name |
String |
Name of the physical drive. |
|
NegotiatedSpeedGbs |
Integer |
Negotiated speed of the drive interface, in Gbps. This field is unavailable for NVMe drives. |
|
CapableSpeedGbs |
Integer |
Maximum speed of the drive interface, in Gbps. This field is unavailable for NVMe drives. |
|
Protocol |
String |
Protocol used by the drive: · SAS. · SATA. · PCIe. |
|
MediaErrCount |
Integer |
Number of media errors This field is not supported by NVMe drives and LSI HBA, PMC, or Marvell cards. |
|
PredictiveFailureCount |
Integer |
Number of predicted failures. This field is supported by physical drives attached to the LSI controllers and LSI HBA 9540 controllers. |
|
Oem.Public.CapacityGB |
String |
Capacity of the physical drive, in GB. This field is not supported by physical drives attached to the LSI controllers and LSI HBA 9540 controllers. |
|
Oem.Public.RawCapacity |
String |
Capacity of the physical drive. This field is not supported for NVMe drives, but is supported for NVMe M.2 drive in Trimode or outsourced Marvell controller configuration. |
|
Oem.Public.CapableSpeedGTs |
Integer |
Maximum speed of the drive interface, in GTs. This field is only available for NVMe drives and not available for NVMe M.2 drive in outsourced Marvell controller configuration. |
|
Oem.Public.NegotiatedSpeedGTs |
Integer |
Negotiated speed of the drive interface, in GTs. This field is only available for NVMe drives and not available for NVMe M.2 drive in outsourced Marvell controller configuration. |
|
Oem.Public.DriveNumberInBios |
String |
Drive number in the BIOS. For NVMe, when NVMe M.2 drives are installed in non-Trimode or non-outsourced Marvell controller configuration, this field displays the PCIe slot number. |
|
Oem.Public.DriveNumberInOS |
String |
Drive number in OS. For NVMe, when NVMe M.2 drives are installed in non-Trimode or non-outsourced Marvell controller configuration, this field displays the PCIe slot number. |
|
Oem.Public.SystemDiskNumber |
String |
System drive 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. ¡ UnconfiguredBad. ¡ Failed. ¡ PFA. · States supported for an LSI controller other than the LSI-9300: ¡ Ready. ¡ UnconfiguredGood. ¡ UnconfiguredBad. ¡ HotSpare. ¡ Offline. ¡ Failed. ¡ Rebuilding. ¡ Optimal. ¡ Online. ¡ JBOD. ¡ Unknown. ¡ PFA. ¡ Copyback. · States supported for an PMC controller: ¡ Offline. ¡ Failed. ¡ PFA. ¡ Raw. ¡ Hotspare. ¡ Ready. ¡ Optimal. ¡ Unsupported. ¡ Unknown. · States supported for a self-developed Marvell controller: ¡ Unconfigured. ¡ Configured. ¡ PFA. · States supported for an outsourced Marvell controller: ¡ Idle. ¡ Assigned. ¡ PFA. ¡ Failed. · States supported for a 3SNIC controller: ¡ Online. ¡ Offline. ¡ Fault. ¡ Ucfggood. ¡ Ucfgfault—Uncorrectable error. ¡ Spare. ¡ Foreign. ¡ Diagnosing. ¡ Reconstructing. ¡ Copybacking. ¡ Cfgincompat—Drive configuration incompatible. ¡ PFA. · States supported for an NVMe drive: ¡ Spare_below. ¡ Temp_Anomaly. ¡ Subsys_Degraded. ¡ Read_only. ¡ Cache_Failed. ¡ PMR_Failed. ¡ Normal. ¡ Abnormal. ¡ Predict_Fail. |
|
Oem.Public.Panel |
String |
Location information.. |
|
Oem.Public.ConnectionID |
Integer |
Physical drive connection ID. This field is unavailable for NVMe drives but is available for NVMe drives in Trimode configuration. |
|
Oem.Public.PowerState |
String |
Power status of the physical drive. · On. · Off. This field is only supported for X18000G6. |
|
Oem.Public.SASSmartInformation |
Object |
SAS interface SMART information. |
|
SASSmartInformation. AccumulatedLoadUnloadCycles |
Integer |
Total drive load-unload count. |
|
SASSmartInformation. AccumulatedStartStopCycles |
Integer |
Total drive start-stop count. |
|
SASSmartInformation. CycleCountOverDeviceLifetime |
Integer |
Drive allowable start-stop count within its lifespan. |
|
SASSmartInformation. DiskTemperatureCelsius |
Integer |
Current drive temperature. |
|
SASSmartInformation. DiskTripTemperatureCelsius |
Integer |
Drive temperature upper limit. |
|
SASSmartInformation. ElementsInGrownDefectList |
Integer |
Elements in the growth list |
|
SASSmartInformation. LoadUnloadCountOverDeviceLifetime |
Integer |
Number of Load-Unloads during device lifetime. |
|
SASSmartInformation. WeekAndYearOfManufacture |
String |
Manufacturing date. |
|
Oem.Public.SATASmartInformation |
Object |
SATA interface SMART information. |
|
AttributeName |
String |
SMART attribute name. |
|
ID |
Integer |
SMART attribute ID. |
|
Thresh |
Integer |
SMART attribute threshold. |
|
Value |
Integer |
SMART attribute current value. |
|
Worst |
Integer |
SMART attribute worst value. |
|
RawValue |
Integer |
SMART attribute raw value. |
|
Oem.Public.TemperatureCelsius |
String |
Drive temperature in Celsius. |
|
Oem.Public.TriMode |
Boolean |
Whether the physical drive is in Trimode configuration. |
|
PredictedMediaLifeLeftPercent |
Integer |
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. |
|
Status.State.Oem.Public.Severity |
String |
Custom health status. |
|
Status.State.Oem.Public.FaultDescription |
String |
Fault description information. |
|
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. |
|
Oem.Public.ForeignState |
Boolean |
Physical drive foreign state. |
|
Oem.Public.OwnerNode |
String |
Hard drive node information. This field displays null if the drive does not have a node. |
|
Oem.Public.SpareforLogicalDrives |
Integer |
List of logical drives belonging to local hot spare. |
|
SupportedConfigurationOperation |
Integer |
Supported operations list. Supported options: · MakeUnconfiguredBad · MakeUnconfiguredGood · MakeJBOD · AssignGlobalHotSpareDrive · AssignDedicatedHotSpareDrive · AssignAutoReplaceHotSpareDrive · ClearHotSpare This field is for reference only and does not guarantee successful execution. |
|
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. The address is invalid when all field values are 0. NVMe M.2 drives do not support SAS addresses. |
|
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, in percentage. |
|
Oem.Public.PredictedMediaLifeLeftDays |
Integer |
Specified drive predicted remaining lifespan in days. This field is only available for NVMe drives but is not available for NVMe M.2 drives in Trimode or outsourced Marvell controller configuration. |
|
Oem.Public.EEPROMPage1 |
String |
EEPROM data of the Page switched to VPD on the NVMe drive. This field is only supported on the X18000G6 for the P6530RT0192M00 and P6530RT0384M00 E1.SPB6530 drives. |
|
Oem.Public.IsNVMeM2 |
Boolean |
NVMe M.2 driver identifier. |
Change history
|
Version |
Change description |
|
HDM3-1.15 |
Added physical drive states in the Oem.Public.FirmwareStatus field for 3SNIC controllers. |
|
HDM2-2.10 |
Added physical drive states in the Oem.Public.FirmwareStatus field for the 9300 module. |
|
HDM2-2.12 |
Modified the Failed option for the Oem.Public.FirmwareStatus field. |
|
HDM2-2.12 |
Added the PMR_Failed option to the Oem.Public.FirmwareStatus field for NVMe drives. |
|
HDM3-1.14 |
Added the MediaErrCount and PredictiveFailureCount fields. |
|
HDM2-2.04 |
Added the MediaErrCount and PredictiveFailureCount fields. |
|
HDM2-2.03 |
Added the Oem.Public.IsNVMeM2 field and the description about NVMe display for outsourced MARVELL controller configuration. |
|
HDM2-1.60 |
Added the Oem.Public.EEPROMPage1 field and the Unsupported state for physical drives managed by a PMC storage controller. |
|
HDM2-1.59 |
Added the Oem.Public.PowerState field. |
|
HDM2-1.58 |
Added the Oem.Public.TriMode field and deleted the NVME option from the Protocol field. |
|
HDM2-1.58 |
Added the Predict_Fail option to the Oem.Public.FirmwareStatus field. |
|
HDM2-1.56 |
Adjusted the field options of the Oem.Public.FirmwareStatus field for physical drives of the Marvell module: Changed the Ready option to Unconfigured and the Online option to Configured. |
|
HDM2-1.54 |
· Added the RawCapacity field. · Added the RawValue field for Smart information of SATA drives for specific fields. |
|
HDM2-1.53 |
Added description of the NVMe drives in Trimode configuration for specific fields. |
Obtain available logical disks when creating a hot spare drive on specified physical drive
Description
Obtain the list of available logical drives when creating a hot spare drive for a specified physical drive.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Chassis/chassis_id/Drives/driver_id/Oem/Public/OptionalLogicalDrivesforHotspare
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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
driver_id |
ID of the physical drive. |
You can obtain available physical drive resource IDs from physical drive collection information. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Usage guidelines
· Local Hot Spare—Add ?$filter=Type eq 2 to the URL to obtain the list of available logical drives for creating a local hot spare.
· Roaming Hot Spare—Add ?$filter=Type eq 3 to the URL to obtain the list of available logical drives for creating a roaming hot spare.
· Default—Without adding any parameter, the list of available logical drives for creating a local hot spare is returned.
Examples
Method and URL:
GET http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront1/Oem/Public/ OptionalLogicalDrivesforHotspare
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#OptionalLogicalDrivesforHotspare.OptionalLogicalDrivesforHotspare(*)",
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1/Oem/Public/OptionalLogicalDrivesforHotspare",
"@odata.type": "#OptionalLogicalDrivesforHotspareColletion.OptionalLogicalDrivesforHotspareCollection",
"Members": [
{
"@odata.id":"/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0"
}
],
"Members@odata.count": 1,
"Name": "OptionalLogicalDrivesforHotspare Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description information for the available logical drives resource model when creating a hot spare for a specified physical drive. |
|
@odata.id |
String |
Link to the available logical drives resource when creating a hot spare for a specified physical drive. |
|
@odata.type |
String |
Type of the available logical drives resource Link to the available logical drives resource when creating a hot spare for a specified physical drive. |
|
Members |
Array |
Link to the available logical drives. |
|
Members@odata.count |
Integer |
Number of available logical drives. |
|
Name |
String |
Name of the logical drives resource. |
Set the physical drive state
Description
Set the state of a physical drive.
Privilege module
OemKvm and OemDiagnosis
Note that setting the LED state belongs to OemDiagnosis, and setting hot spare, physical drive status, and power-on/off status of physical drives belongs to OemKvm.
Locking type of the associated system
Hardware configuration lock
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Drives/driver_id
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
// Set the status of the locator LED:
{
"IndicatorLED": ledstate
}
// Set or cancel the global hot spare disk:
{
"HotspareType": hotsparetype
}
// Set the local hot spare disk or roaming hot spare disk:
{
"HotspareType": "Dedicated",
"Oem":{
"Public":{
"SpareforLogicalDrives":[
{
"@odata.id": volumepath
}
]
}
}
}
// Set the disk status:
{
"Oem":{
"Public":{
"FirmwareStatus":diskstate
}
}
}
// Set the drive power status.
{
"Oem":{
"Public":{
"PowerState":powerstate
}
}
}
Parameters
|
Parameter |
Description |
Value |
|
device_ip |
IP address for logging in to the device. |
IPv4 or IPv6 address. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
driver_id |
ID of the physical drive resource. |
You can obtain available physical drive resource IDs from physical drive 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. |
|
Oem.Public.FirmwareStatus |
String |
Drive state. Supported options: · UnconfiguredGood. · UnconfiguredBad. · JBOD. NOTE: The switchover between the Unconfigured_Bad state and the JBOD state is not allowed. |
|
HotspareType |
Drive hot spare status. |
Supported options: · None—No hot spare configured. · Global—Global hot spare. · Dedicated—Dedicated hot spare. · AutoReplace—Roaming hot spare. LSI controllers support global and dedicated hot spares, and PMC controllers support dedicated and roaming hot spares. |
|
SpareforLogicalDrives |
List of logical drives for which the local/roaming hot spare belongs. |
Array. |
|
@odata.id |
Link to the associated logical drive is provided when the drive is set as a local/roaming hot spare. |
You can obtain the list of optional logical drives available for creating a hot spare drive for a specific physical drive. For example: /redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0. This field is only available for hot spare disk settings in the target logical drive. |
|
IndicatorLED |
String |
Locator LED status. Supported options: · Off—Off. · Lit—Steady on. |
|
Oem.Public.PowerState |
String |
Power status of the physical drive. · On. · Off. This field is only supported for X18000G6. |
Usage guidelines
When setting the location indicator light status, the privilege is for maintenance. When setting the hot spare and physical drive status, it is for remote control.
Examples
# Turn on the location LED for the slot containing the specified drive.
Method and URL:
PATCH //192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront3
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"IndicatorLED": "Lit"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3",
"@odata.type": "#Drive.v1_11_0.Drive",
"CapableSpeedGbs": 12,
"CapacityBytes": 599584145408,
"HotspareType": "None",
"Id": "DiskFront3",
"IndicatorLED": "Lit",
"Links": {
"Volumes": []
},
"Location": [
{
"Info": "Front3",
"InfoFormat": "DeviceName"
}
],
"Manufacturer": "SEAGATE",
"MediaErrCount": null,
"MediaType": "HDD",
"Model": "ST600MP0005",
"Name": "DiskFront3",
"NegotiatedSpeedGbs": 12,
"Oem": {
"Public": {
"CapacityGB":"600GB",
"CapableSpeedGTs": null,
"CapacityGB":"600GB",
"CompletionCode": 0,
"ConnectionID": 156,
"Description": "Success",
"DriveNumberInBios": "3",
"DriveNumberInOS": "3",
"EEPROMPage1":null,
"FirmwareStatus": "Online",
"ForeignState": false,
"HoursOfPoweredUp": null,
"IsNVMeM2": false,
"NegotiatedSpeedGTs": null,
"OwnerNode": null,
"Panel": "Front3",
"PowerState":null,
"RawCapacity":"600GB",
"RebuildProgress": null,
"PredictedMediaLifeLeftDays": null,
"SASAddress": [
"5764824129363309997",
"0000000000000000000"
],
"SASSmartInformation": {
"AccumulatedLoadUnloadCycles": 52,
"AccumulatedStartStopCycles": 36,
"CycleCountOverDeviceLifetime": 50000,
"DiskTemperatureCelsius": 46,
"DiskTripTemperatureCelsius": 65,
"ElementsInGrownDefectList": 0,
"LoadUnloadCountOverDeviceLifetime": 600000,
"WeekAndYearOfManufacture": "In week 44 Of Year 2022"
},
"SATASmartInformation": null,
"SpareforLogicalDrives": [],
"SupportedConfigurationOperation": [],
"SystemDiskNumber":null,
"TemperatureCelsius": 46,
"TriMode":false,
"PatrolState": "DoneOrNotPatrolled",
"RebuildState": "DoneOrNotRebuilt"
}
},
"PredictedMediaLifeLeftPercent": null,
"PredictiveFailureCount":null,
"Protocol": " SAS",
"Revision": "N003",
"SerialNumber": "S7M12N93",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"StatusIndicator": "OK"
}
Response code: 200
# Modify the status of a physical 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:
{
"Oem":{
"Public":{
"FirmwareStatus": "UnconfiguredGood"
}
}
}
Response:
{
"@odata.context":"/redfish/v1/$metadata#Drive.Drive(*)",
"@odata.id":"/redfish/v1/Chassis/1/Drives/DiskFront3",
"@odata.type":"#Drive.v1_4_0.Drive",
"CapableSpeedGbs":12,
"CapacityBytes":599584145408,
"HotspareType":"None",
"Id":"DiskFront3",
"IndicatorLED":"Lit",
"Links":{
"Volumes":[
]
},
"Location":[
{
"Info":"Front3",
"InfoFormat":"DeviceName"
}
],
"Manufacturer":"SEAGATE",
"MediaErrCount": null,
"MediaType":"HDD",
"Model":"ST600MP0005",
"Name":"DiskFront3",
"NegotiatedSpeedGbs":12,
"Oem":{
"Public":{
"CapableSpeedGTs":null,
"CapacityGB":"600GB",
"CompletionCode":0,
"ConnectionID":156,
"Description":"Success",
"DriveNumberInBios":"3",
"DriveNumberInOS":"3",
"EEPROMPage1":null,
"FirmwareStatus":"UnconfiguredGood",
"ForeignState":false,
"HoursOfPoweredUp":null,
"IsNVMeM2": false,
"NegotiatedSpeedGTs":null,
"OwnerNode":null,
"Panel":"Front3",
"PowerState":null,
"PredictedMediaLifeLeftDays": null,
"RawCapacity":"600GB",
"RebuildProgress":null,
"SASAddress":[
"5764824129363309997",
"0000000000000000000"
],
"SASSmartInformation":{
"AccumulatedLoadUnloadCycles":52,
"AccumulatedStartStopCycles":36,
"CycleCountOverDeviceLifetime":50000,
"DiskTemperatureCelsius":46,
"DiskTripTemperatureCelsius":65,
"ElementsInGrownDefectList":0,
"LoadUnloadCountOverDeviceLifetime":600000,
"WeekAndYearOfManufacture":"In week 44 Of Year 2022"
},
"SATASmartInformation":null,
"SpareforLogicalDrives":[
],
"SupportedConfigurationOperation":[
"MakeUnconfiguredBad",
"MakeJBOD",
"AssignGlobalHotSpareDrive",
"AssignDedicatedHotSpareDrive"
],
"SystemDiskNumber":null,
"TemperatureCelsius":46,
"TriMode":false,
"PatrolState":"DoneOrNotPatrolled",
"RebuildState":"DoneOrNotRebuilt"
}
},
"PredictedMediaLifeLeftPercent":null,
"PredictiveFailureCount":null,
"Protocol":" SAS",
"Revision":"N003",
"SerialNumber":"S7M12N93",
"Status":{
"Health":"OK",
"Oem":{
"Public":{
"FaultDescription":"",
"Severity":"Informational"
}
},
"State":"Enabled"
},
"StatusIndicator":"OK"
}
Response code: 200
# Set a dedicated hot spare.
Method and URL:
PATCH http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront2
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/Volumes/LogicalDrive239"
}
]
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront2",
"@odata.type": "#Drive.v1_11_0.Drive",
"CapableSpeedGbs": 6.0,
"CapacityBytes": 1919816826880,
"HotspareType": "None",
"Id": "DiskFront2",
"IndicatorLED": "Off",
"Links": {
"Volumes": []
},
"Location": [
{
"Info": "Front2",
"InfoFormat": "DeviceName"
}
],
"Manufacturer": "Seagate",
"MediaErrCount": null,
"MediaType": "SSD",
"Model": "XA1920LE10063",
"Name": "DiskFront2",
"NegotiatedSpeedGbs": 6.0,
"Oem": {
"Public": {
"CapableSpeedGTs": null,
"CapacityGB":"1920GB",
"CapacityGB": "1.92TB",
"CompletionCode": 0,
"ConnectionID": 34,
"Description": "Success",
"DriveNumberInBios": "2",
"DriveNumberInOS": "2",
"EEPROMPage1":null,
"FirmwareStatus": "UnconfiguredGood",
"ForeignState": false,
"HoursOfPoweredUp": 880,
"IsNVMeM2": false,
"NegotiatedSpeedGTs": null,
"OwnerNode": null,
"Panel": "Front2",
"PatrolState": "DoneOrNotPatrolled",
"PowerState":null,
"PredictedMediaLifeLeftDays": null,
"RawCapacity":"1.92TB",
"RebuildProgress": null,
"RebuildState": "DoneOrNotRebuilt",
"SASAddress": [
"300062B20EC1FB02",
"0000000000000000"
],
"SASSmartInformation": null,
"SATASmartInformation": [
{
"AttributeName": "N/A",
"ID": 1,
"Thresh": 0,
"Value": 100,
"Worst": 100
},
...
{
"AttributeName": "N/A",
"ID": 243,
"Thresh": 0,
"Value": 37,
"Worst": 23
}
],
"SpareforLogicalDrives": [],
"SupportedConfigurationOperation": [
"MakeUnconfiguredBad",
"MakeJBOD",
"AssignGlobalHotSpareDrive",
"AssignDedicatedHotSpareDrive"
],
"SystemDiskNumber":null,
"TemperatureCelsius": 33,
"TriMode":false
}
},
"PredictedMediaLifeLeftPercent": 100,
"PredictiveFailureCount":null,
"Protocol": "SATA",
"Revision": "00ZU",
"SerialNumber": "HKS015WZ",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"StatusIndicator": "OK"
}
Response code: 200
# Set the power status of the physical drive.
Method and URL:
PATCH http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront10
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Oem": {
"Public": {
"PowerState": "On"
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",
"@odata.id":"/redfish/v1/Chassis/1/Drives/DiskFront10",
"@odata.type":"#Drive.v1_11_0.Drive",
"CapableSpeedGbs": null,
"CapacityBytes": 1920000000000,
"Id": "DiskFront10",
"IndicatorLED": "Lit",
"Location": [
{
"Info": "Front Slot 10",
"InfoFormat": "DeviceName"
}
],
"Manufacturer": "Samsung",
"MediaErrCount": null,
"MediaType": "SSD",
"Model": "MZTL21T9HCJR-00A07",
"Name": "PM9A3",
"NegotiatedSpeedGbs": null,
"Oem": {
"Public": {
"CapableSpeedGTs": 16,
"CapacityGB": null,
"CompletionCode": 0,
"Description": "Success",
"DriveNumberInBios": "110",
"DriveNumberInOS": "110",
"EEPROMPage1":null,
"FirmwareStatus": "Normal",
"IsNVMeM2": false,
"NegotiatedSpeedGTs": 16,
"OwnerNode": null,
"Panel": "Front Slot 10",
"PowerState": "On",
"PredictedMediaLifeLeftDays": 4294967295,
"RawCapacity": null,
"SASSmartInformation": null,
"SATASmartInformation":null,
"SystemDiskNumber": null,
"TemperatureCelsius": 37,
"TriMode": false
}
},
"PredictedMediaLifeLeftPercent": 100,
"PredictiveFailureCount":null,
"Protocol": "PCIe",
"Revision": "GDC6102Q",
"SerialNumber":"S6RCNG0T100136",
"Status": {
"Health":"OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State":"Enabled"
}
}
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 |
|
HDM2-1.59 |
Added the Oem.Public.PowerState field. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain idle slot collection information
Description
Obtain idle slot collection information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/IdleDriveSlots
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. |
|
chassis_id |
ID of the chassis resource. |
This field is 1 for all current models. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Examples
Method and URL:
GET https://172.16.20.162/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#IdleDriveSlotsCollection.IdleDriveSlotsCollection(*)",
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots",
"@odata.type": "#IdleDriveSlotsCollection.IdleDriveSlotsCollection ",
"Members": [
{
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front2"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front3"
}
],
"Members@odata.count": 3,
"Name": "Idle Drive Slots Collection ",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the idle slot collection resource model. |
|
@odata.id |
String |
Link to the collection information of idle slot resources. |
|
@odata.type |
String |
Type of the collection information of idle slot resources. |
|
Members |
Array |
Link to the idle slot resource. |
|
Members@odata.count |
Integer |
Number of idle slots. |
|
Name |
String |
Name of the idle slot resource. |
Change history
|
Version |
Change description |
|
HDM3-1.15 |
Added the interface. |
Obtain information about the specified idle slot
Description
Obtain information about the specified idle slot.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/IdleDriveSlots/IdleDriveSlots_id
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Parameters
|
Parameter |
Description |
Value |
|
device_ip |
Device IP address. |
IPv4 or IPv6 address. |
|
chassis_id |
Chassis resource ID. |
This field is 1 for all current models. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Examples
Method and URL:
GET https://172.16.20.162/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#IdleDriveSlot.IdleDriveSlot(*)",
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front1",
"@odata.type": "#IdleDriveSlot.v1_0_0.IdleDriveSlot",
"Id":"Front1",
"IndicatorLED":"Lit",
"Name": "Front1",
"DrivesSizeSupported": "2.5in",
"Module": "4UniBay",
"InterfaceSupported": "SATA/SAS/U.2(NVMe)",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the idle slot collection resource model. |
|
@odata.id |
String |
Link to the collection information of idle slot resources. |
|
@odata.type |
String |
Type of the collection information of idle slot resources. |
|
Name |
String |
Name of the idle slot resource. |
|
IndicatorLED |
String |
UID LED state of the idle slot. · Off. · Lit. |
|
DrivesSizeSupported |
String |
Drive size supported by the idle slot. · 2.5in · 3.5in · 7.5mm · 9.5mm · 80mm · 110mm · 80mm/110mm |
|
Module |
String |
Name of the module connected to the idle slot. |
|
InterfaceSupported |
String |
Drive interface supported by the idle slot. · SATA/SAS · SATA/SAS/U.2(NVMe) · M.2(SATA) · M.2(NVMe) · E1.S · E3.S |
Change history
|
Version |
Change description |
|
HDM3-1.15 |
Added the interface. |
Set the UID LED state of the idle slot
Description
Set the UID LED state of the idle slot.
Privilege module
OemDiagnosis
Locking type of the associated system
Hardware configuration locking
Request
PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/IdleDriveSlots/IdleDriveSlots_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. |
|
chassis_id |
ID of the chassis resource. |
This field is 1 for all current models. |
|
IdleDriveSlots_id |
ID of the idle slot. |
You can obtain the ID from the idle slot collection information. |
|
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. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
|
IndicatorLED |
String |
UID LED state: · Off. · Lit. |
Examples
Method and URL:
PATCH
https://172.16.20.162/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"IndicatorLED": "Lit"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#IdleDriveSlot.IdleDriveSlot(*)",
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front1",
"@odata.type": "#IdleDriveSlot.v1_0_0.IdleDriveSlot",
"Id":"Front1",
"IndicatorLED":"Lit",
"Name": "Front1",
"DrivesSizeSupported": "2.5in",
"Module": 4UniBay,
"InterfaceSupported": "SATA/SAS/U.2(NVMe)",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain idle slot collection information."
Change history
|
Version |
Change description |
|
HDM3-1.15 |
Added the interface. |
Obtain the collection information of drive Bays
Description
Obtain the collection information of drive Bays.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/DriveBays
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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Examples
Method and URL:
GET https://172.16.20.162/redfish/v1/Chassis/1/Oem/Public/DriveBays
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context":"/redfish/v1/$metadata#DriveBaysCollection.DriveBaysCollection(*)",
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/DriveBays",
"@odata.type": "#DriveBaysCollection.DriveBaysCollection",
"Members": [
{
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/DriveBays/Bay5"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/DriveBays/Bay14"
}
],
"Members@odata.count": 2,
"Name": "DriveBays Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the drive Bay collection information. |
|
@odata.id |
String |
Link to the drive Bay collection information. |
|
@odata.type |
String |
Type of the drive Bay collection information. |
|
Members |
Array |
Link to the drive Bay collection information. |
|
Integer |
Number of the drive Bay collections. |
|
|
Name |
String |
Name of the drive Bay collection information. |
Change history
|
Version |
Change description |
|
HDM2-1.59 |
Added the redfish/v1/Chassis/1/Oem/Public/DriveBays interface. |
Obtain drive Bay information
Description
Obtain information about a specific drive Bay from the server.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/DriveBays/bay_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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
bay_id |
ID of the drive Bay. |
You can obtain the drive Bay ID from the collection information of drive Bays. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Examples
Method and URL:
GET https://172.16.20.162/redfish/v1/Chassis/1/Oem/Public/DriveBays/Bay5
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#DriveBay.DriveBay(*)",
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/DriveBays/Bay5",
"@odata.type": "#DriveBay.v1_0_0.DriveBay",
"DrivesCount": "3",
"DrivesMaxTemperatureCelsius": "36",
"Id": "Bay5",
"Name": "DriveBay Instance",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SlotNumber": "5",
"Status": {
"Health": "Critical",
"Oem": {
"Public": {
"FaultDescription": "[Bay5_Status]Drive Fault",
"Severity": "Major"
}
},
"State": "Enabled"
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the drive Bay information model. |
|
@odata.id |
String |
Link to the drive Bay information resource. |
|
@odata.type |
String |
Type of the drive Bay information resource. |
|
Id |
String |
ID of the DriveBay. |
|
Name |
String |
Name of the DriveBay resource. |
|
DrivesCount |
Integer |
Number of drives connected to the DriveBay. |
|
DrivesMaxTemperatureCelsius |
Integer |
Highest temperature of the drives connected to the DriveBay. |
|
Status.Health |
String |
Health status of the DriveBay. |
|
Status.State |
String |
Enable status of the DriveBay. |
|
Status.State.Oem.Public.Severity |
String |
Custom health status of the DriveBay. |
|
Status.State.Oem.Public.FaultDescription |
String |
Failure description information of the DriveBay. |
Change history
|
Version |
Change description |
|
HDM2-1.59 |
Added the redfish/v1/Chassis/1/Oem/Public/DriveBays/bay_id interface. |
Obtain thermal properties
Description
Obtain information about thermal properties from the server.
Privilege module
Login
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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
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/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",
"@odata.id": "/redfish/v1/Chassis/1/Thermal",
"@odata.type": "#Thermal.v1_6_3.Thermal",
"FanSummary": {
"Count": 4,
"MaxCountSupported": 4,
"MaxRotorCountSupported": 16,
"Redundancy": [
{
"Name": "FAN_Redundant",
"Status": {
"Health": "OK",
"State": "Enabled"
}
}
],
"RotorCount": 16,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
"Fans": [
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/0",
"MaxReadingRange": 17300,
"MemberId": "0",
"MinReadingRange": 0,
"Name": "Fan1",
"Oem": {
"Public": {
"Position": "(up_front)",
"SlotNumber": 1,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/1",
"MaxReadingRange": 17300,
"MemberId": "1",
"MinReadingRange": 0,
"Name": "Fan1",
"Oem": {
"Public": {
"Position": "(up_rear)",
"SlotNumber": 1,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/2",
"MaxReadingRange": 17300,
"MemberId": "2",
"MinReadingRange": 0,
"Name": "Fan1",
"Oem": {
"Public": {
"Position": "(down_front)",
"SlotNumber": 2,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/3",
"MaxReadingRange": 17300,
"MemberId": "3",
"MinReadingRange": 0,
"Name": "Fan1",
"Oem": {
"Public": {
"Position": "(down_rear)",
"SlotNumber": 2,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/4",
"MaxReadingRange": 17300,
"MemberId": "4",
"MinReadingRange": 0,
"Name": "Fan2",
"Oem": {
"Public": {
"Position": "(up_front)",
"SlotNumber": 3,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/5",
"MaxReadingRange": 17300,
"MemberId": "5",
"MinReadingRange": 0,
"Name": "Fan2",
"Oem": {
"Public": {
"Position": "(up_rear)",
"SlotNumber": 3,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/6",
"MaxReadingRange": 17300,
"MemberId": "6",
"MinReadingRange": 0,
"Name": "Fan2",
"Oem": {
"Public": {
"Position": "(down_front)",
"SlotNumber": 4,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/7",
"MaxReadingRange": 17300,
"MemberId": "7",
"MinReadingRange": 0,
"Name": "Fan2",
"Oem": {
"Public": {
"Position": "(down_rear)",
"SlotNumber": 4,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/8",
"MaxReadingRange": 17300,
"MemberId": "8",
"MinReadingRange": 0,
"Name": "Fan3",
"Oem": {
"Public": {
"Position": "(up_front)",
"SlotNumber": 5,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/9",
"MaxReadingRange": 17300,
"MemberId": "9",
"MinReadingRange": 0,
"Name": "Fan3",
"Oem": {
"Public": {
"Position": "(up_rear)",
"SlotNumber": 5,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/10",
"MaxReadingRange": 17300,
"MemberId": "10",
"MinReadingRange": 0,
"Name": "Fan3",
"Oem": {
"Public": {
"Position": "(down_front)",
"SlotNumber": 6,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/11",
"MaxReadingRange": 17300,
"MemberId": "11",
"MinReadingRange": 0,
"Name": "Fan3",
"Oem": {
"Public": {
"Position": "(down_rear)",
"SlotNumber": 6,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/12",
"MaxReadingRange": 17300,
"MemberId": "12",
"MinReadingRange": 0,
"Name": "Fan4",
"Oem": {
"Public": {
"Position": "(up_front)",
"SlotNumber": 7,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/13",
"MaxReadingRange": 17300,
"MemberId": "13",
"MinReadingRange": 0,
"Name": "Fan4",
"Oem": {
"Public": {
"Position": "(up_rear)",
"SlotNumber": 7,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/14",
"MaxReadingRange": 17300,
"MemberId": "14",
"MinReadingRange": 0,
"Name": "Fan4",
"Oem": {
"Public": {
"Position": "(down_front)",
"SlotNumber": 8,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/15",
"MaxReadingRange": 17300,
"MemberId": "15",
"MinReadingRange": 0,
"Name": "Fan4",
"Oem": {
"Public": {
"Position": "(down_rear)",
"SlotNumber": 8,
"SpeedRatio": 0
}
},
"PartNumber": "8056",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
}
],
"Id": "Thermal",
"InletHistoryTemperature": {
"@odata.id": "/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature"
},
"Name": "Thermal",
"Oem": {
"Public": {
"CompletionCode": 0,
"CoolingMedium": "AirCooled",
"Description": "Success",
"FanSpeedAdjustmentMode": "Silent",
"LeakStrategy": "N/A",
"LiquidCoolers": [],
"LiquidSummary": {
"Count": 0,
"FaultDescription": "",
"MaxCountSupported": 0,
"Severity": "Informational"
}
}
},
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"Temperatures": [
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/0",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "0",
"Name": "Inlet_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 7,
"OceanTemperatureYCoordinate": 0,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16184
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber":
1,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": 42.0,
"UpperThresholdFatal": 55.0,
"UpperThresholdNonCritical": 40.0
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/1",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "1",
"Name": "CPU1_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 11,
"OceanTemperatureYCoordinate": 8,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16128
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 7,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": null
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/2",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "2",
"Name": "CPU2_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 4,
"OceanTemperatureYCoordinate": 8,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16128
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 8,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": null
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/3",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "3",
"Name": "CPU1_DTS",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 15,
"OceanTemperatureYCoordinate": 15,
"OceanTemperatureZCoordinate": 0,
"ThresholdMask": 16136
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 9,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": -1.0
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/4",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "4",
"Name": "CPU2_DTS",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 15,
"OceanTemperatureYCoordinate": 15,
"OceanTemperatureZCoordinate": 0,
"ThresholdMask": 16136
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 10,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": -1.0
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/5",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "5",
"Name": "CPU1_VR_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 12,
"OceanTemperatureYCoordinate": 10,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16152
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 11,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": 111.0,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": 106.0
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/6",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "6",
"Name": "CPU2_VR_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 3,
"OceanTemperatureYCoordinate": 10,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16152
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 12,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": 111.0,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": 106.0
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/7",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "7",
"Name": "PSU1_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 14,
"OceanTemperatureYCoordinate": 12,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16128
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 77,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": null
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/8",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "8",
"Name": "PSU2_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 11,
"OceanTemperatureYCoordinate": 12,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16128
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 78,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": null
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/9",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "9",
"Name": "PSU3_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 4,
"OceanTemperatureYCoordinate": 12,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16128
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 79,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": null
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/10",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "10",
"Name": "PSU4_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 1,
"OceanTemperatureYCoordinate": 12,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16128
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 80,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": null
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/11",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "11",
"Name": "Front_NVMe_Max",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 8,
"OceanTemperatureYCoordinate": 1,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16136
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 21,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": 70.0
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/12",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "12",
"Name": "Front_HD_Max",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 7,
"OceanTemperatureYCoordinate": 1,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16136
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 20,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": 60.0
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/13",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "13",
"Name": "M.2_Max",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 8,
"OceanTemperatureYCoordinate": 12,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16136
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 24,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": 70.0
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/14",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "14",
"Name": "CPU1_DIMM_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 13,
"OceanTemperatureYCoordinate": 8,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16152
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 16,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": 95.0,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": 87.0
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/15",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "15",
"Name": "CPU2_DIMM_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 6,
"OceanTemperatureYCoordinate": 8,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16152
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 17,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": 95.0,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": 87.0
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/16",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "16",
"Name": "M.2_Zone",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 7,
"OceanTemperatureYCoordinate": 13,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16128
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 5,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": null
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/17",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "17",
"Name": "Busbar1_Zone",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 13,
"OceanTemperatureYCoordinate": 11,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16128
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 85,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": null
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/18",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "18",
"Name": "Busbar2_Zone",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 2,
"OceanTemperatureYCoordinate": 11,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16128
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 86,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": null
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/19",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "19",
"Name": "Switch1_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 13,
"OceanTemperatureYCoordinate": 12,
"OceanTemperatureZCoordinate": 2,
"ThresholdMask": 16152
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 13,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": 112.0,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": 107.0
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/20",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "20",
"Name": "Switch2_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 2,
"OceanTemperatureYCoordinate": 12,
"OceanTemperatureZCoordinate": 2,
"ThresholdMask": 16152
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 14,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": 112.0,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": 107.0
},
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/21",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "21",
"Name": "Outlet_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 8,
"OceanTemperatureYCoordinate": 15,
"OceanTemperatureZCoordinate": 1,
"ThresholdMask": 16128
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 3,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": null,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": null
}
]
}
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. |
|
InletHistoryTemperature |
Object |
Obtain information about the air inlet temperature history 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. |
|
FanSummary.Count |
Integer |
Current number of installed fan modules. |
|
FanSummary.MaxCountSupported |
Integer |
Maximum supported number of fan modules. |
|
FanSummary.MaxRotorCountSupported |
Integer |
Maximum supported number of fan rotors. |
|
FanSummary.RotorCount |
Integer |
Current number of present fan rotors. |
|
FanSummary.Redundancy |
Object |
Fan redundancy information. This field is null for blade servers. |
|
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. |
|
FanSummary.Status |
Object |
Overall fan status information. Supported options: · HealthRollup—Overall health status. · Health—Health status. · State—Enabling status.. · Severity—Custom health status. · FaultDescription—Overall fault description. The overall fault description is associated with the overall fault of the component and is independent of the fault information of individual components. The blade servers can display only the State field normally and displays null for all other fields. |
|
Status |
Object |
Overall state information of the heat dissipation module. Supported options: · HealthRollup—Overall health state of the heat dissipation module (same as the Health). · Health—Health state of the heat dissipation module. · State—Enabling status of the heat dissipation module. · Severity—Custom health state. · FaultDescription—Overall fault description. Overall fault description refers to the general failure of the associated components, which is independent of individual component failure information. The blade servers can display only the State field normally and displays null for all other fields. |
|
Fans |
Fan information. |
|
|
@odata.id |
String |
Link to a thermal resource. |
|
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. |
|
PartNumber |
String |
Part number. |
|
ReadingUnits |
String |
Unit of fan speed read by the fan sensor, in RPM. |
|
Status |
Object |
Resource status: · Health—Health status. · State—Enabling status. · Severity—Custom health status. · FaultDescription—Overall fault description. The blade servers can display only the State field normally and displays null for all other fields. |
|
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. |
|
Temperatures |
Temperature sensor properties. |
|
|
@odata.id |
String |
Link to a temperature sensor resource. |
|
MemberId |
String |
Temperature sensor ID. |
|
Name |
String |
Temperature sensor name. |
|
LowerThresholdCritical |
Integer |
Lower major alarm threshold of the temperature sensor. |
|
LowerThresholdFatal |
Integer |
Lower critical alarm threshold of the temperature sensor. |
|
LowerThresholdNonCritical |
Integer |
Lower minor alarm threshold of the temperature sensor. |
|
UpperThresholdCritical |
Integer |
Upper major alarm threshold of the temperature sensor. |
|
UpperThresholdFatal |
Integer |
Upper critical alarm threshold of the temperature sensor. |
|
UpperThresholdNonCritical |
Integer |
Upper minor alarm threshold of the temperature sensor. |
|
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. · Severity—Custom health state. |
|
Oem.Public.OceanTemperatureXCoordinateUpperThresholdCritical |
Integer |
X-coordinate of ocean temperature. |
|
Oem.Public.OceanTemperatureYCoordinateUpperThresholdFatal |
Integer |
Y-coordinate of ocean temperature. |
|
Oem.Public.OceanTemperatureZCoordinate |
Integer |
Z-coordinate of ocean temperature. |
|
Oem.Public.ThresholdMaskUpperThresholdNonCritical |
Integer |
Mask for temperature sensor thresholds. |
|
Oem.Public.CoolingMedium |
String |
Cooling medium. Supported options: · AirCooled · LiquidCooled · AirAndLiquidCooled |
|
Oem.Public.LeakStrategy |
String |
Action to take upon liquid leakage on liquid-cooled servers. Supported options: · AutoPowerOff. · ManualPowerOff. |
|
Oem.Public.LiquidSummary.Count |
Integer |
Number of present liquid-cooled devices. |
|
Oem.Public.LiquidSummary.MaxCountSupported |
Integer |
Maximum number of supported liquid-cooled devices. |
|
Oem.Public.LiquidSummary.FaultDescription |
String |
Overall fault description for liquid-cooled devices. |
|
Oem.Public.LiquidSummary.Severity |
String |
Overall health status of liquid-cooled devices. |
|
Oem.Public.LiquidCoolers.Status.Health |
String |
Health status of a single liquid-cooled device. |
|
Oem.Public.LiquidCoolers.Status.State |
String |
Enabling status of a single liquid-cooled device. |
|
Oem.Public.LiquidCoolers.MemberId |
String |
Liquid-cooled device ID. |
|
Oem.Public.LiquidCoolers.Name |
String |
Liquid-cooled device name. |
|
Oem.Public.LiquidCoolers.Severity |
String |
Custom health status of a single liquid-cooled device. |
|
Oem.Public.LiquidCoolers.FaultDescription |
String |
Fault description of a single liquid-cooled device. |
Change history
|
Version |
Change description |
|
HDM3-1.20 HDM2-2.14 HDM2-1.79 |
Updated the response example. |
|
HDM2-1.72 HDM2-2.05 |
Revised the output description for blade server models to exclude redundancy information, the health state field, and fan resource status. |
|
HDM2-2.04 HDM2-1.79 |
Added the FanSummary.MaxRotorCountSupported and FanSummary.RotorCount fields and updated the description for the FanSummary.Count and FanSummary.MaxCountSupported fields |
|
HDM2-1.57 |
Changed the return value for sensor threshold unavailability from 4294967295 to null. |
|
HDM2-1.56 |
Changed the fan redundancy sensor name from FAN_Redundancy to FAN_Redundant in the example. |
|
HDM2-1.54 |
Edited the overall state information for heat dissipation module in the Status field. Added the CoolingMedium and LeakStrategy fields, object FanSummary.Status and the corresponding fields, object LiquidSummary and the corresponding fields, and object LiquidCoolers and the corresponding fields. |
Configure the heat dissipation resource information for the specified chassis
Description
Configure the heat dissipation resource information for the specified chassis.
Privilege module
OemPowerControl
Locking type of the associated system
BMC configuration locking
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
"LeakStrategy": leakstrategy
}
}
}
Parameters
|
Parameter |
Description |
Value |
|
device_ip |
IP address for logging in to the device. |
IPv4 or IPv6 address. |
|
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. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
|
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. |
|
Oem.Public.LeakStrategy |
Action to take on a liquid-cooled server upon liquid leakage. · AutoPowerOff · ManualPowerOff |
String. |
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,
"LeakStrategy":"ManualPowerOff"
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Thermal.Thermal",
"@odata.id": "/redfish/v1/Chassis/1/Thermal",
"@odata.type": "#Thermal.v1_6_3.Thermal",
"FanSummary": {
"Count": 4,
"MaxCountSupported": 4,
"MaxRotorCountSupported": 8,
"Redundancy": [
{
"Name": "FAN_Redundant",
"Status": {
"Health": "OK",
"State": "Enabled"
}
}
],
"RotorCount": 0,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
"Fans": [
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/0",
"MaxReadingRange": 15000,
"MemberId": "0",
"MinReadingRange": 0,
"Name": "Fan1",
"Oem": {
"Public": {
"Position": "chassis",
"SlotNumber": 1,
"SpeedRatio": 0
}
},
"PartNumber": "8038",
"Reading": 0,
"ReadingUnits": "RPM",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
…
],
"Id": "Thermal",
"InletHistoryTemperature": {
"@odata.id": "/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature"
},
"Name": "Thermal",
"Oem": {
"Public": {
"CompletionCode": 0,
"CoolingMedium": "AirAndLiquidCooled",
"Description": "Success",
"FanSpeedAdjustmentMode": "Silent",
"LeakStrategy": "ManualPowerOff",
"LiquidCoolers": [
{
"FaultDescription": "",
"MemberId": 0,
"Name": "CPU Liquid Cooler1",
"Severity": "Informational",
"Status": {
"Health": "OK",
"State": "Enabled"
}
}
],
"LiquidSummary": {
"Count": 1,
"FaultDescription": "",
"MaxCountSupported": 1,
"Severity": "Informational"
}
}
},
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"Temperatures": [
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/0",
"LowerThresholdCritical": null,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MemberId": "0",
"Name": "Inlet_Temp",
"Oem": {
"Public": {
"OceanTemperatureXCoordinate": 8,
"OceanTemperatureYCoordinate": 0,
"OceanTemperatureZCoordinate": 0,
"ThresholdMask": 16152
}
},
"PhysicalContext": "Room",
"ReadingCelsius": 4294967295,
"SensorNumber": 1,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Disabled"
},
"UpperThresholdCritical": 52.0,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": 50.0
},
...
]
}
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 |
|
HDM2-1.62 |
Added description of the Oem.Public.LeakStrategy field. |
|
HDM2-1.56 |
Changed the fan redundancy sensor name from FAN_Redundancy to FAN_Redundant in the example. |
|
HDM2-1.54 |
Changed the title name from Set the fan speed mode to Configure the heat dissipation resource information for the specified chassis. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
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
Login
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://192.168.18.18/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#InletHistoryTemperature.InletHistoryTemperature",
"@odata.id": "/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature",
"@odata.type": "#InletHistoryTemperature.v1_0_0.InletHistoryTemperature",
"Description": "Air Inlet Historical Temperature",
"HistoricalInletTemp": [
{
"Description": "Normal",
"avg": 50,
"max": 50,
"min": 50,
"time": "2021-12-15T10:47:49+08:00"
},
{
"Description": "Unavailable",
"avg": null,
"max": null,
"min": null,
"time": "2021-12-15T11:33:28+08:00"
},
{
"Description": null,
"avg": null,
"max": null,
"min": null,
"time": "2021-12-15T11:38:28+08:00"
},
...
],
"Id": "InletHistoryTemperature",
"Name": "InletHistoryTemperature",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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 air inlet temperature history resource. |
|
Id |
String |
ID of the air inlet temperature history resource. |
|
Name |
String |
Name of the air inlet temperature history resource. |
|
HistoricalInletTemp.avg |
Integer |
Average temperature. |
|
HistoricalInletTemp.max |
Integer |
Maximum temperature. |
|
HistoricalInletTemp.min |
Integer |
Minimum temperature. |
|
HistoricalInletTemp.time |
String |
Sample time. Format example: 2021-12-15T11:33:28+08:00. |
|
HistoricalInletTemp. Description |
String |
Description of sampling point data. Supported options: · Normal—Normal. · Unavailable—Sensor unavailable. · null—Not sampled. |
Obtain power information
Description
Obtain power information from the server.
Privilege module
Login
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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
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/Chassis/1/Power
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Power.Power(PowerControl,Voltages,Id,Name,PowerSupplies)",
"@odata.id": "/redfish/v1/Chassis/1/Power",
"@odata.type": "#Power.v1_7_0.Power",
"AllPowerStatus": {
"Oem": {
"Public": {
"HostPowerStatus": "On",
"JBODPowerStatus": null,
"JBOGPowerStatus": null,
"OverallPowerStatus": "On",
"SmartNICPowerStatus": null
}
}
},
"Id": "Power",
"Name": "Power",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"StandbyPowerMonitoringEnabled": true
}
},
"PowerHistoryData": {
"@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData"
},
"PowerControl": [
{
"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerControl/1",
"MaxNum": 2,
"MemberId": 1,
"Name": "System Power Control 1",
"Oem": {
"Public": {
"CurrentBoardPowerWatts": 466,
"CurrentCPUPowerWatts": 214,
"CurrentDiskPowerWatts":29,
"CurrentDiskPowerWats": 29,
"CurrentFanPowerWatts": 144,
"CurrentGPUPowerWatts": null,
"CurrentMemoryPowerWatts": 0,
"MinActivePowerCount":[1],
"PowerGroupCount": 1,
"SuggestedActivePowerCount": 2,
"OtherComponentsPowerWatts": null
}
},
"PowerAlarmInfo": {
"MaxPowerAlarm": 10000,
"Multiple": 4,
"PowerAlarmEnabled": false,
"PowerAlarmThreshold": 10000
},
"PowerConsumedWatts": 467,
"PowerLimit": {
"CorrectionInMs": 1000,
"LimitException": "NoAction",
"LimitInWatts": null,
"PowerLimitEnable":false
},
"PowerMetrics": {
"MaxConsumedWatts": 10000,
"MinConsumedWatts": 150
},
"Status": {
"Health": "Ok",
"State": "Enabled"
}
}
],
"PowerManagementEnabled": true,
"PowerSupplies": [
{
"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/2",
"FirmwareVersion": "1M.0009.0024.002",
"LineInputVoltage": 232,
"LineInputVoltageType": "ACandDCWideRange",
"Manufacturer": "FSP-GROUP",
"MemberId": "2",
"Model": "PSR800-12A",
"Name": "PSU2",
"Oem": {
"Public": {
"ActiveStandby": "Active",
"ActiveStandbySupported": true,
"InputAmperage": 2.058,
"LineInputCurrent": 2.058,
"LineInputVoltageType": "AC",
"ManufactureDate":"2023-05-31",
"PowerCurrentWatts": 467,
"PowerGroupId": "1",
"PowerID": "2",
"PowerInputWatts": 156,
"PowerMaxWatts": 800,
"PowerOutputVoltage": 12.1,
"PowerOutputWatts": 442,
"ReadingAmperes": 36.375,
"SlotNumber": 2
}
},
"PartNumber": null,
"PowerCapacityWatts": 800,
"PowerSupplyType": "ACorDC",
"Redundancy": [],
"SerialNumber": "8588859",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
...
],
"Redundancy": [
{
"@odata.id": "/redfish/v1/Chassis/1/Power#/Redundancy/1",
"@odata.type": "#Redundancy.v1_4_1.Redundancy",
"MaxNumSupported": 2,
"MemberId": "1",
"MinNumNeeded": 1,
"Mode": "Sharing",
"Name": "PowerSupply Redundancy Group 1",
"RedundancySet": [
{
"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupply/2"
}
],
"RedundancySet@odata.count": 1,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
...
],
"Voltages": [
{
"LowerThresholdCritical": 10.752,
"LowerThresholdFatal": null,
"LowerThresholdNonCritical": null,
"MaxReadingRange": 255,
"MinReadingRange": 0,
"Name": "SYS_12V",
"ReadingVolts": 11.968,
"SensorNumber": 94,
"Status": {
"Health": "OK",
"State": "Enabled"
},
"UpperThresholdCritical": 13.184,
"UpperThresholdFatal": null,
"UpperThresholdNonCritical": null
},
...
]
}
Response code: 200
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. |
|
Id |
String |
ID of power supply resource. |
|
Name |
String |
Name for power supply resource. |
|
PowerManagementEnabled |
Boolean |
Whether power management is supported. |
|
PowerHistoryData |
Object |
Link to historical power resource information. |
|
Oem.Public.StandbyPowerMonitoringEnabled |
Boolean |
Enabling status.of cold standby power inspection |
|
Redundancy |
List of power supply redundancy groups. |
|
|
Redundancy.@odata.id |
Integer |
Link to power supply redundancy group. |
|
Redundancy.@odata.type |
Integer |
Resource type of power supply redundancy group. |
|
Redundancy.MemberId |
String |
ID of power supply redundancy group. |
|
Redundancy.Name |
String |
Name of power supply redundancy group. |
|
Redundancy.MaxNumSupported |
Integer |
Maximum number of power supplies supported in this redundancy group. |
|
Redundancy.MinNumNeeded |
Integer |
Minimum number of power supplies supported in this redundancy group. |
|
Redundancy.RedundancySet |
Object |
List of power modules included in the specified power supply redundancy group, including: · @odata.id—Link to the specified power module. |
|
Redundancy.Mode |
String |
Power supply redundancy group mode. Supported options: · Sharing—Load balancing. · Failover—Primary/backup mode. |
|
Redundancy.Status.Health |
String |
Health status of power supply redundancy group. |
|
Redundancy.Status.State |
String |
Enabling status of power supply redundancy group. |
|
Redundancy.Status.Oem.Public.Severity |
String |
Custom health status of power supply redundancy group. |
|
Redundancy.Status.Oem.Public.FaultDescription |
String |
Fault description information of power supply redundancy group. The overall fault information of the power group is associated with the overall component, independent of the fault information of a single component. |
|
PowerControl |
Power control information. |
|
|
PowerControl.PowerAlarmInfo.PowerAlarmEnabled |
Boolean |
Enabling status of total power alarm. |
|
PowerControl.PowerAlarmInfo.PowerAlarmThreshold |
Integer |
Threshold of total power alarm. |
|
PowerControl.PowerAlarmInfo.Multiple |
Integer |
Multiplier. |
|
PowerControl.PowerAlarmInfo.MaxPowerAlarm |
Integer |
Maximum value of total power alarm. |
|
PowerControl.MaxNum |
Integer |
Maximum number of power supplies. This field is unavailable for X18000. |
|
PowerControl.PowerConsumedWatts |
Integer |
Current power of power supply. |
|
PowerControl.@odata.id |
String |
Link to power control attributes. |
|
PowerControl.MemberId |
Integer |
ID of power control attributes. |
|
PowerControl.Name |
String |
Name of power control attributes. |
|
PowerControl.PowerMetrics.MaxConsumedWatts |
Integer |
Maximum power consumption. |
|
PowerControl.PowerMetrics.MinConsumedWatts |
Integer |
Minimum power consumption. |
|
PowerControl.PowerLimit.CorrectionInMs |
Integer |
Power correction time (in milliseconds). |
|
PowerControl.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. |
|
PowerControl.PowerLimit.LimitInWatts |
Integer or null |
Power cap value. This field displays null if power capping is disabled. For G6 5500 AMD/Intel models, this field indicates the power cap for the CPU node. For other models, it indicates the power cap for the board. |
|
PowerControl.PowerLimit.PowerLimitEnable |
Boolean |
Power cap enabling state. This field displays the CPU node power cap value for the G6 R5500 AMD/Intel models. For the other models, this field displays the system board power cap value. |
|
PowerControl.Status.Health |
String |
Power control health status. |
|
PowerControl.Status.State |
String |
Power control enabling status. |
|
PowerControl.Oem.Public.PowerGroupCount |
Integer |
Number of supported power supply units for the current model. This field is unavailable for X18000. |
|
PowerControl.Oem.Public.CurrentCPUPowerWatts |
Integer |
Current CPU power. |
|
PowerControl.Oem.Public.CurrentMemoryPowerWatts |
Integer |
Current memory power. |
|
PowerControl.Oem.Public.CurrentFanPowerWatts |
Integer |
Current fan power. This field is unavailable for X18000. |
|
PowerControl.Oem.Public.CurrentBoardPowerWatts |
Integer |
Total power consumption of the board. For G6 5500 AMD/Intel models, this field indicates the power consumption of the CPU node. |
|
PowerControl.Oem.Public.CurrentGPUPowerWatts |
Integer |
Total power consumption of the GPU node. This field is available for G6 5500 AMD/Intel models. |
|
PowerControl.Oem.Public.OtherComponentsPowerWatts |
Integer |
Total power consumption of components, excluding CPUs and GPUs. This field is supported by G6 5500 AMD/Intel models. |
|
PowerControl.Oem.Public.CurrentDiskPowerWatts |
Integer |
Current drive power. This field is unavailable for X18000. The CurrentDiskPowerWats field still exists, which has the same usage as this field and is reserved to maintain field compatibility. |
|
PowerControl.Oem.Public.MinActivePowerCount |
Array |
Minimum number of primary power supplies supported by each power supply group. |
|
PowerControl.Oem.Public.SuggestedActivePowerCount |
Integer |
Recommended number of primary power supplies. This field is available only for the R4500G6. |
|
PowerSupplies |
Power supply information. This field is unavailable for X18000. |
|
|
PowerSupplies.FirmwareVersion |
String |
Firmware version. |
|
PowerSupplies.LineInputVoltage |
Integer |
Input voltage. |
|
PowerSupplies.LineInputVoltageType |
String |
Input voltage type. Supported option is ACandDCWideRange. |
|
PowerSupplies.Manufacturer |
String |
Manufacturer of the power supply. |
|
PowerSupplies.Model |
String |
Model of the power supply. |
|
PowerSupplies.Name |
String |
Name of the power supply. |
|
PowerSupplies.PowerCapacityWatts |
Integer |
Power capacity of the power supply. |
|
PowerSupplies.Oem.Pubilc.PowerID |
String |
ID of the power supply. |
|
PowerSupplies.Oem.Pubilc.ActiveStandby |
String |
Active/standby state. |
|
PowerSupplies.Oem.Pubilc.PowerCurrentWatts |
Integer |
Current input power of the power supply. |
|
PowerSupplies.Oem.Pubilc.InputAmperage |
Integer |
Input electrical current of the power supply. |
|
PowerSupplies.Oem.Pubilc.ReadingAmperes |
Integer |
Current reading of the electrical current sensor. |
|
PowerSupplies.Oem.Public.SlotNumber |
Integer |
Slot number of the power supply. |
|
PowerSupplies.Oem.Public.LineInputCurrent |
Integer |
Input current of the power supply. |
|
PowerSupplies.Oem.Public.LineInputVoltageType |
String |
Custom input voltage types for the power module: · AC. · HVDC. · LVDC. · No input. |
|
PowerSupplies.Oem.Public. PowerOutputVoltage |
Integer |
Output voltage of the power module. |
|
Oem.Public.PowerOutputWatts |
Integer |
Output power of the power supply. |
|
PowerSupplies.Oem.Public.PowerMaxWatts |
Integer |
Maximum power of the power supply. |
|
PowerSupplies.Oem.Public.PowerInputWatts |
Integer |
Power input of the power supply. |
|
PowerSupplies.Oem.Public. ActiveStandbySupported |
Boolean |
Power cold backup is supported. |
|
PowerSupplies.Oem.Public.PowerGroupId |
String |
Power supply group to which it belongs. |
|
PowerSupplies.Oem.Public.ManufactureDate |
String |
Manufacturer date of the power supply. |
|
PowerSupplies.Redundancy |
Array |
List of power redundancy groups to which the power module actually belongs. Supported options: · @odata.id—Link to the power redundancy group. |
|
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. |
|
Status.Oem.Public.Severity |
String |
Custom power status. |
|
Status.Oem.Public. FaultDescription |
String |
Description of the power failure. |
|
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. |
|
LowerThresholdFatal |
Integer or string |
Lower critical alarm threshold. |
|
LowerThresholdNonCritical |
Integer or string |
Lower minor alarm threshold. |
|
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. · 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 |
Upper major alarm threshold. |
|
UpperThresholdFatal |
Integer |
Upper critical alarm threshold. |
|
UpperThresholdNonCritical |
Integer |
Upper minor alarm threshold. |
|
AllPowerStatus |
Power status information. |
|
|
Oem.Public.HostPowerStatus |
String |
On and Off. |
|
Oem.Public.JBODPowerStatus |
String |
|
|
Oem.Public.JBOGPowerStatus |
String |
This field is fixed as null. |
|
Oem.Public.OverallPowerStatus |
String |
On and Off. |
|
Oem.Public.SmartNICPowerStatus |
String |
Primary power supply status of the intelligent network adapter. In the current software version, this field displays null. |
Change history
|
Version |
Change description |
|
HDM2-2.07 |
Added the PowerControl.Oem.Public. SuggestedActivePowerCount field. |
|
HDM2-2.04 |
Added the PowerSupplies.Oem.Public.PowerInputWatts field. |
|
HDM2-1.61 |
Changed the PowerControl.Oem.Public.CurrentDiskPowerWats field to PowerControl.Oem.Public.CurrentDiskPowerWatts, while the original field is still supported. |
|
HDM2-1.58 |
Added the PowerControl.Oem.Public.MinActivePowerCount field. |
|
HDM2-1.57 |
Added the PowerSupplies.Oem.Public.ManufactureDate field. Changed the return value for sensor threshold unavailability from 4294967295 to null. |
|
HDM2-1.56 |
Added the PowerControl.PowerLimit.PowerLimitEnable field. |
|
HDM2-1.55 |
Added the PowerControl.Oem.Public.OtherComponentsPowerWatts 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
OemPowerControl
Locking type of the associated system
BMC configuration locking
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": {
"PowerGroupId":power_group_id,
"PowerID":power_id,
"ActiveStandby":active_standby
}
}
},
{
"Oem": {
"Public": {
"PowerGroupId":power_group_id,
"PowerID":power_id,
"ActiveStandby":active_standby
}
}
}
]
}
Request body 2:
// Configure power capping state and power capping for the board or CPU node:
{
"PowerControl":[
{
"PowerLimit":{
"LimitInWatts":limit_value,
"LimitException":limit_exception
}
}
]
}
Request body 3:
// Configure the total power, including alarm status and alarm threshold:
{
"PowerControl":[
{
"PowerAlarmInfo":{
"PowerAlarmEnabled":enabled,
"PowerAlarmThreshold":threshold_value
}
}
]
}
Request body 4:
// Configure the inspection status of the cold backup power supply:
{
"Oem":{
"Public":{
"StandbyPowerMonitoringEnabled":enabled
}
}
}
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.PowerGroupId |
Power supply group ID. |
String. |
|
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. For G6 5500 AMD/Intel models, this field indicates the CPU node power limit. For the other models, it indicates the board power limit. |
|
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. For G6 5500 AMD/Intel models, this field indicates the action to take when CPU node power capping fails. For the other models, it indicates the action to take when board power capping fails. |
|
PowerControl.PowerAlarmInfo.PowerAlarmEnabled |
Total power alarm enabling status. |
Boolean. |
|
PowerControl.PowerAlarmInfo.PowerAlarmThreshold |
Total power alarm threshold. |
Integer. |
|
Oem.Public.StandbyPowerMonitoringEnabled |
Cold backup power supply inspection status. |
Boolean. |
Examples
# Perform a power supply active/standby switchover.
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:
{
"PowerControl": [
{
"Oem": {
"Public": {
"PowerGroupId":"1",
"PowerID":1,
"ActiveStandby":"Active"
}
}
},
{
"Oem": {
"Public": {
"PowerGroupId":"1",
"PowerID":2,
"ActiveStandby":"Standby"
}
}
}
]
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Power.Power(PowerControl,Voltages,Id,Name,PowerSupplies)",
"@odata.id": "/redfish/v1/Chassis/1/Power",
"@odata.type": "#Power.v1_7_0.Power",
...
"Id": "Power",
"Name": "Power",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"StandbyPowerMonitoringEnabled":true
}
},
"PowerHistoryData": {
"@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData"
},
"PowerControl": [
...
],
"PowerManagementEnabled": true,
"PowerSupplies": [
{
"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/1",
"FirmwareVersion": "1M.0009.0024.002",
"LineInputVoltage": 236,
"LineInputVoltageType": "ACandDCWideRange",
"Manufacturer": "FSP-GROUP",
"MemberId": "1",
"Model": "PSR800-12A",
"Name": "PSU1",
"Oem": {
"Public": {
"ActiveStandby": "Active",
"ActiveStandbySupported": true,
"InputAmperage": 566,
"LineInputCurrent": 566,
"LineInputVoltageType": "AC",
"ManufactureDate": "2023-05-31",
"PowerCurrentWatts": 111,
"PowerGroupId": "1",
"PowerID": "1",
"PowerInputWatts": 156,
"PowerMaxWatts": 800,
"PowerOutputVoltage": 12.1,
"PowerOutputWatts": 99,
"ReadingAmperes": 7929,
"SlotNumber": 1
}
},
"PartNumber": "9PA8001704 S7181402841",
"PowerCapacityWatts": 800,
"PowerSupplyType": "ACorDC",
"Redundancy": [
{
"@odata.id": "/redfish/v1/Chassis/1/Power#/Redundancy/1"
}
],
"SerialNumber": "210213A05PH175000850",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/2",
"FirmwareVersion": "1M.0009.0024.002",
"LineInputVoltage": 231,
"LineInputVoltageType": "ACandDCWideRange",
"Manufacturer": "FSP-GROUP",
"MemberId": "2",
"Model": "PSR800-12A",
"Name": "PSU2",
"Oem": {
"Public": {
"ActiveStandby": "Standby",
"ActiveStandbySupported": true,
"InputAmperage": 628,
"LineInputCurrent": 628,
"LineInputVoltageType": "AC",
"ManufactureDate":"2023-05-31",
"PowerCurrentWatts": 122,
"PowerGroupId": "1",
"PowerID": "2",
"PowerInputWatts": 156,
"PowerMaxWatts": 800,
"PowerOutputVoltage": 12.2,
"PowerOutputWatts": 107,
"ReadingAmperes": 8796,
"SlotNumber": 2
}
},
"PartNumber": "9PA8001704 S6361201074",
"PowerCapacityWatts": 800,
"PowerSupplyType": "ACorDC",
"Redundancy": [
{
"@odata.id": "/redfish/v1/Chassis/1/Power#/Redundancy/1"
}
],
"SerialNumber": "",
"Status": {
"Health": "Critical",
"Oem": {
"Public": {
"FaultDescription": "[PowerSupply]Power Supply Failure detected",
"Severity": "Major"
}
},
"State": "Enabled"
}
}
],
"Redundancy": [
...
],
"Voltages": [
...
]
}
Response code: 200
# Configure power capping state.
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:
{
"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",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"StandbyPowerMonitoringEnabled":true
}
},
"PowerHistoryData": {
"@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData"
},
"PowerControl": [
{
"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerControl/1",
"MaxNum": 4,
"MemberId": 1,
"Name": "System Power Control 1",
"Oem": {
"Public": {
"CurrentBoardPowerWatts": 0,
"CurrentCPUPowerWatts": 0,
"CurrentDiskPowerWatts":0,
"CurrentDiskPowerWats": 0,
"CurrentFanPowerWatts": 0,
"CurrentGPUPowerWatts": 0,
"CurrentMemoryPowerWatts": 0,
"PowerGroupCount": 1,
"OtherComponentsPowerWatts": null
}
},
"PowerAlarmInfo": {
"MaxPowerAlarm": 10000,
"Multiple": 1,
"PowerAlarmEnabled": false,
"PowerAlarmThreshold": 1500
},
"PowerConsumedWatts": 0,
"PowerLimit": {
"CorrectionInMs": 1000,
"LimitException": "NoAction",
"LimitInWatts": 766,
"PowerLimitEnable":true
},
"PowerMetrics": {
"MaxConsumedWatts": 10000,
"MinConsumedWatts": 150
},
"Status": {
"Health": "Ok",
"State": "Enabled"
}
}
],
"PowerManagementEnabled": true,
"PowerSupplies": [
...
],
"Redundancy": [
...
],
"Voltages": [
...
]
}
Response code: 200
# Configure the threshold for total power alarm.
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:
{
"PowerControl": [
{
"PowerAlarmInfo": {
"PowerAlarmEnabled":true,
"PowerAlarmThreshold":1000
}
}
]
}
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",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"StandbyPowerMonitoringEnabled":true
}
},
"PowerHistoryData": {
"@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData"
},
"PowerControl": [
{
"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerControl/1",
"MaxNum": 4,
"MemberId": 1,
"Name": "System Power Control 1",
"Oem": {
"Public": {
"CurrentBoardPowerWatts": 0,
"CurrentCPUPowerWatts": 0,
"CurrentDiskPowerWatts":0,
"CurrentDiskPowerWats": 0,
"CurrentFanPowerWatts": 0,
"CurrentGPUPowerWatts": 0,
"CurrentMemoryPowerWatts": 0,
"PowerGroupCount": 1,
"OtherComponentsPowerWatts": null
}
},
"PowerAlarmInfo": {
"MaxPowerAlarm": 2550,
"Multiple": 10,
"PowerAlarmEnabled": true,
"PowerAlarmThreshold": 1000
},
"PowerConsumedWatts": 0,
"PowerLimit": {
"CorrectionInMs": 1000,
"LimitException": "NoAction",
"LimitInWatts": 766,
"PowerLimitEnable":true
},
"PowerMetrics": {
"MaxConsumedWatts": 10000,
"MinConsumedWatts": 150
},
"Status": {
"Health": "Ok",
"State": "Enabled"
}
}
],
"PowerManagementEnabled": true,
"PowerSupplies": [
...
],
"Redundancy": [
...
],
"Voltages": [
...
]
}
Response code: 200
# Configure the inspection status of the cold backup power supply.
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:
{
"Oem":{
"Public":{
"StandbyPowerMonitoringEnabled":true
}
}
}
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",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"StandbyPowerMonitoringEnabled":true
}
},
"PowerHistoryData": {
"@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData"
},
"PowerControl": [
{
"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerControl/1",
"MaxNum": 4,
"MemberId": 1,
"Name": "System Power Control 1",
"Oem": {
"Public": {
"CurrentBoardPowerWatts": 0,
"CurrentCPUPowerWatts": 0,
"CurrentDiskPowerWatts":0,
"CurrentDiskPowerWats": 0,
"CurrentFanPowerWatts": 0,
"CurrentGPUPowerWatts": 0,
"CurrentMemoryPowerWatts": 0,
"PowerGroupCount": 1,
"OtherComponentsPowerWatts": null
}
},
"PowerAlarmInfo": {
"MaxPowerAlarm": 2550,
"Multiple": 10,
"PowerAlarmEnabled": true,
"PowerAlarmThreshold": 1000
},
"PowerConsumedWatts": 0,
"PowerLimit": {
"CorrectionInMs": 1000,
"LimitException": "NoAction",
"LimitInWatts": null,
"PowerLimitEnable":false
},
"PowerMetrics": {
"MaxConsumedWatts": 10000,
"MinConsumedWatts": 150
},
"Status": {
"Health": "Ok",
"State": "Enabled"
}
}
],
"PowerManagementEnabled": true,
"PowerSupplies": [
...
],
"Redundancy": [
...
],
"Voltages": [
...
]
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 |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain power recovery policy information
Description
Obtain the resource for power recovery policy information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/PowerOnSettings
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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Examples
Method and URL:
GET http://192.168.18.18/redfish/v1/Chassis/1/Oem/Public/PowerOnSettings
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#PowerDefaultSettings",
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/PowerOnSettings",
"@odata.type": "#PowerOnSettings.v1_0_0.PowerOnSettings",
"Description": "Power On Settings",
"Id": "PowerOnSettings",
"MaxRandomDelaySeconds": 120,
"Name": "PowerOnSettings",
"Oem": {
"Public": {
"BackPlane":null,
"CompletionCode": 0,
"Description": "Success"
}
},
"PowerOnStrategy": "RestorePreviousState",
"PowerRestoreDelayMode": "FixedDelay",
"PowerRestoreDelaySeconds": 0
}
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. |
|
Id |
String |
ID of the system resource. |
|
Name |
String |
Name of the system resource. |
|
PowerOnStrategy |
String |
Power recovery configuration command. Supported options: · TurnOn—Keep power on. · RestorePreviousState—Restore to previous state. · StayOff—Keep power off. |
|
PowerRestoreDelaySeconds |
Integer |
Delay time. |
|
PowerRestoreDelayMode |
String |
Type of delay. · FixedDelay—Fixed delay time. · RandomDelay—Random delay time. |
|
MaxRandomDelaySeconds |
Integer |
Maximum time for random delay setting. |
Set power recovery policy
Description
Set the resource for power recovery policy information.
Privilege module
OemPowerControl
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/PowerOnSettings
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"PowerOnStrategy": power_on_strategy,
"PowerRestoreDelayMode": delay_mode,
"PowerRestoreDelaySeconds": delay_seconds
}
Parameters
|
Parameter |
Description |
Value |
|
device_ip |
IP address for logging in to the device. |
IPv4 or IPv6 address. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
|
PowerOnStrategy |
Power recovery configuration command. |
String. Supported options: · TurnOn—Keep power on. · RestorePreviousState—Restore to previous state. · StayOff—Keep power off. |
|
PowerRestoreDelaySeconds |
Delay time. |
Integer. |
|
PowerRestoreDelayMode |
Type of delay. |
String. Supported options: · FixedDelay—Fixed delay time. · RandomDelay—Random delay time. |
Examples
Method and URL:
PATCH http://192.168.18.18/redfish/v1/Chassis/1/Oem/Public/PowerOnSettings
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"PowerOnStrategy": "TurnOn",
"PowerRestoreDelayMode": "RandomDelay",
"PowerRestoreDelaySeconds": 120
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#PowerDefaultSettings",
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/PowerOnSettings",
"@odata.type": "#PowerOnSettings.v1_0_0.PowerOnSettings",
"Description": "Power On Settings",
"Id": "PowerOnSettings",
"MaxRandomDelaySeconds": 120,
"Name": "PowerOnSettings",
"Oem": {
"Public": {
"BackPlane":null,
"CompletionCode": 0,
"Description": "Success"
}
},
"PowerOnStrategy": "TurnOn",
"PowerRestoreDelayMode": "RandomDelay",
"PowerRestoreDelaySeconds": 120
}
Response code: 200
Response field description
For information about the response fields, see "Obtain power recovery policy information."
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain information about CPU power saving
Description
Obtain information about power saving for the CPU.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/CPUEnergyEfficiency
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/Oem/Public/CPUEnergyEfficiency
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#CPUEnergyEfficiency.CPUEnergyEfficiency/$entity",
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/CPUEnergyEfficiency",
"@odata.type": "#CPUEnergyEfficiency.v1_0_0.CPUEnergyEfficiency",
"CPUPowerAdjustment": {
"CPUPLimit": 13,
"CPUPState": 0
},
"Description": "Get processors energy efficiency",
"Id": "CPUEnergyEfficiency",
"Name": "CPUEnergyEfficiency",
"Oem": {
"Public": {
"BackPlane":null,
"CompletionCode": 0,
"Description": "Success"
}
},
"CPUPStateValid": false,
"ProcessorEPPProfile": "Balanced"
}
The BIOS offers four CPU power efficiency strategies, while Redfish provides only three. Only three corresponding strategies are available on the webpage.
Including:
· Performance in BIOS is obtained as Performance in Redfish and displayed as Performance on the page.
· Balanced Power in BIOS is obtained as Balanced in Redfish and displayed as Balanced on the page.
· Balanced Performance in BIOS is obtained as Balanced in Redfish and displayed as Balanced on the page.
· Power in BIOS is obtained as Power in Redfish and displayed as Power on the page.
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the system CPU power saving information resource. |
|
@odata.id |
String |
Link to the system CPU power saving information resource. |
|
@odata.type |
String |
Type of CPU power saving information. |
|
Id |
String |
ID of the CPU power saving information resource. |
|
Name |
String |
Name of the CPU power saving information resource. |
|
ProcessorEPPProfile |
String |
CPU power efficiency policy selection. Supported options: · Performance. · Balanced. · Power. |
|
Description |
String |
Description of CPU power saving information resource: |
|
CPUPLimit |
Integer |
Maximum P-State adjustment level supported by the current platform. |
|
CPUPState |
Integer |
Current P-State level. |
|
CPUPStateValid |
Boolean |
Validity of the P-State level value. |
Configure CPU power saving settings
Description
Configure information about CPU power saving.
Privilege module
OemPowerControl
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Oem/Public/CPUEnergyEfficiency
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"CPUPowerAdjustment": {
"CPUPState": 0
},
"ProcessorEPPProfile": "Power"
}
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. |
|
ProcessorEPPProfile |
CPU power efficiency policy selection. |
String. Supported options: · Performance. · Balanced. · Power. |
|
CPUPState |
Current P-State level. |
Integer. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Chassis/1/Oem/Public/CPUEnergyEfficiency
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
"CPUPowerAdjustment": {
"CPUPState": 0
},
"ProcessorEPPProfile": "Power"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#CPUEnergyEfficiency.CPUEnergyEfficiency/$entity",
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/CPUEnergyEfficiency",
"@odata.type": "#CPUEnergyEfficiency.v1_0_0.CPUEnergyEfficiency",
"CPUPowerAdjustment": {
"CPUPLimit": 0,
"CPUPState": 0
},
"Description": "Get processors energy efficiency",
"Id": "CPUEnergyEfficiency",
"Name": "CPUEnergyEfficiency",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"CPUPStateValid": true,
"ProcessorEPPProfile": "Power"
}
Response code: 200
Response field description
For information about the response fields, see "Obtain information about CPU power saving."
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain information about historical power resource
Description
Obtain information about historical power resource.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Chassis/chassis_id/Power/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#PowerHistoryData.PowerHistoryData",
"@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData",
"@odata.type": "#PowerHistoryData.v1_0_0.PowerHistoryData",
"Description": "Historical Power",
"HistoricalCPU": [
{
"Description": "Normal",
"avg": 65,
"max": 65,
"min": 65,
"time": "2017-01-15T10:03:18+08:00"
},
{
"Description": "Normal",
"avg": 468,
"max": 468,
"min": 468,
"time": "2022-10-27T17:11:12+08:00"
},
...
],
"Id": "PowerHistoryData",
"Name": "PowerHistoryData",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the historical power resource model. |
|
@odata.id |
String |
Link to the historical power resource. |
|
@odata.type |
String |
Type of the historical power resource. |
|
Id |
String |
ID of the historical power resource. |
|
Name |
String |
Name of the historical power resource. |
|
Description |
String |
Description of the historical power resource. |
|
HistoricalCPU.avg |
Integer |
Average power value. |
|
HistoricalCPU.max |
Integer |
Maximum power value. |
|
HistoricalCPU.min |
Integer |
Minimum power value. Type of delay. · FixedDelay—Fixed delay time. · RandomDelay—Random delay time. |
|
HistoricalCPU.time |
String |
Sampling time, example format: 2021-12-15T11:33:28+08:00 |
|
HistoricalCPU.Description |
String or null |
Description of the sampling point data. · Normal. · Unavailable. · Null. |
Obtain sensor type collection information
Description
Obtain the list information about sensor types.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Chassis/chassis_id/Sensors
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/Sensors
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Sensors.Sensors",
"@odata.id": "/redfish/v1/Chassis/1/Sensors",
"@odata.type": "#SensorsCollection.SensorsCollection",
"Description": "Sensors Collection",
"Members": [
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Voltage"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Current"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Power"
}
],
"Members@odata.count": 4,
"Name": "Sensors Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the sensor list model. |
|
@odata.id |
String |
Link to the sensor list resource. |
|
@odata.type |
String |
Type of the sensor list resource. |
|
Name |
String |
Name of the sensor list resource. |
|
Description |
String |
Description of the sensor list resource. |
|
Members |
Array |
Link where the sensor member is located. |
|
Members@odata.count |
Integer |
Number of sensor types. |
Obtain information of sensor list for a specified type
Description
Obtain the information of the sensor list for a specified type.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Chassis/chassis_id/Sensors/Oem/Public/sensors_type
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. |
|
sensors_ type |
Sensors type |
You can obtain available sensor types from the collection information of sensor types. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Sensors.Sensors",
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature",
"@odata.type": "#SensorsCollection.SensorsCollection",
"Description": "Temperature Sensor Collection",
"Members": [
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/Inlet_Temp"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_Temp"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU2_Temp"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_DTS"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU2_DTS"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_VR_Temp"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU2_VR_Temp"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/PCH_Temp"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/PSU1_Temp"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/PSU2_Temp"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_DIMM_Temp"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU2_DIMM_Temp"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_PMem_Temp"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU2_PMem_Temp"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/Busbar_Zone"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/Outlet_Temp"
}
],
"Members@odata.count": 16,
"Name": "Temperature Sensor Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the sensor list model. |
|
@odata.id |
String |
Link to the sensor list resource. |
|
Name |
String |
Name of the sensor list resource. |
|
@odata.type |
String |
Type of the sensor list resource. |
|
Description |
String |
Description of the sensor list resource. |
|
Members |
Array |
Link where the sensor member of is located. |
|
Members@odata.count |
Integer |
Number of sensor types of a specific type. |
Obtain historical information about a single sensor resource
Description
Obtain historical information about a single sensor resource.
Privilege module
Login
Request
Method and URL:
GET
https://device_ip/redfish/v1/Chassis/chassis_id/Sensors/Oem/Public/sensors_type/sensors_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. |
|
sensors_ type |
Sensors type |
You can obtain available sensor types from the sensor types collection. |
|
sensors_id |
Sensor ID. |
You can obtain available sensor IDs from the specified list of sensor types. |
Examples
Method and URL:
GET https://192.168.1.18/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_Temp
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Sensors_Temperature.Sensors_Temperature",
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/CPU1_Temp",
"@odata.type": "#SensorsInstance.v1_0_0.SensorsInstance",
"Actions": {
"#Sensors.ResetStatistics": {
"target": "/redfish/v1/Chassis/1/Sensors/Actions/Oem/Public/Temperature/CPU1_Temp/Sensors.ResetStatistics"
}
},
"Description": "Temperature Sensor Instance",
"HistoricalHigh": 87,
"HistoryData": [
{
"Average": null,
"Description": "Unavailable",
"Maximum": null,
"Minimum": null,
"Time": "2017-01-15T11:40:07+08:00"
},
...
{
"Average": 46,
"Description": "Normal",
"Maximum": 48,
"Minimum": 46,
"Time": "2017-01-15T12:56:07+08:00"
},
...
{
"Average": null,
"Description": null,
"Maximum": null,
"Minimum": null,
"Time": "2017-01-15T14:27:20+08:00"
},
...
],
"LastDay": {
"Average": 84,
"Maximum": 87,
"Minimum": 45
},
"LastWeek": {
"Average": 84,
"Maximum": 87,
"Minimum": 42
},
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SpecifiedTime": {
"Average": 4294967295,
"EndTime": null,
"MaxEndTime": "2017-01-15T11:44:19+08:00",
"Maximum": 4294967295,
"MinStartTime": "2017-01-15T11:40:07+08:00",
"Minimum": 4294967295,
"StartTime": null
},
"StartTime": "1970-01-01T08:00:00+08:00",
"TimeStamp": "2017-01-15T12:33:54+08:00"
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of a single sensor resource model. |
|
@odata.id |
String |
Link to a single sensor resource |
|
@odata.type |
String |
Type of a single sensor resource. |
|
Actions |
The actions that can be performed on the Sensors resource. |
|
|
#Sensors.ResetStatistics |
Object |
Link to the recalculate operation. |
|
Description |
String |
Description of a single sensor resource. |
|
HistoricalHigh |
Integer |
Maximum of historical value. |
|
TimeStamp |
String |
Maximum time of historical value. |
|
StartTime |
String |
Start time of the statistical calculation. |
|
LastDay |
Object |
The sensor information of the most recent day. |
|
LastWeek |
Object |
The sensor information of the most recent week. |
|
SpecifiedTime |
Object |
Sensor information for a specified time period. |
|
Average |
Integer |
Average value. |
|
Maximum |
Integer |
Maximum value. |
|
Minimum |
Integer |
Minimum value. |
|
SpecifiedTime.StartTime |
String |
Start time for statistical calculation of sensor data for a specified time period. |
|
SpecifiedTime.EndTime |
String |
End time for statistical calculation of sensor data for a specified time period. |
|
SpecifiedTime.MinStartTime |
String |
The earliest time you can start statistical calculation for the specified time period. |
|
SpecifiedTime.MaxEndTime |
String |
The latest time by which you must complete statistical calculation for the specified time period. |
|
HistoryData.Description |
String or null |
Description of the sampling point data. · Normal. · Unavailable. · Null. |
|
HistoryData |
Array |
Historical data. |
|
Time |
String |
Sampling time. |
Recalculate highest historical temperature information for sensor
Description
Recalculate the highest historical temperature information for the specified sensor.
Privilege module
OemDiagnosis
Request
Method and URL:
POST
https://device_ip/redfish/v1/Chassis/chassis_id/Sensors/Actions/Oem/Public/sensors_type/sensors_id/Sensors.ResetStatistics
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
// Recalculate highest historical temperature information based on current time:
{
}
// Calculate highest historical temperature information for a specified time period:
{
"SpecifiedTime": {
"StartTime": "2019-02-14T20:21:36+08:00",
"EndTime": "2019-03-14T20:21:36+08:00"
}
}
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. |
|
sensors_ type |
Sensors type |
Obtained information on a collection of sensor types by querying. |
|
sensors_id |
Sensor ID. |
Obtained information on a specified list of sensor types by querying. |
|
SpecifiedTime.StartTime |
Start time for the specified time period. |
Redfish standard format. For example: 2019-02-14T20:21:36+08:00. |
|
SpecifiedTime.EndTime |
End time for the specified time period. |
Redfish standard format. For example: 2019-02-14T20:21:36+08:00. Start and end times must be specified together, otherwise the historical temperature information will be recalculated based on the current time. |
Examples
# Recalculate the highest historical temperature information based on the current time.
Method and URL:
POST https://192.168.1.18/redfish/v1/Chassis/1/Sensors/Actions/Oem/Public/Temperature/TEST2_Threshold/Sensors.ResetStatistics
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Sensors_Temperature.Sensors_Temperature",
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/TEST2_Threshold",
"@odata.type": "#SensorsInstance.v1_0_0.SensorsInstance",
"Description": "Temperature Instance",
"HistoricalHigh": 100,
"HistoryData": [
{
"Average": null,
"Description": "Unavailable",
"Maximum": null,
"Minimum": null,
"Time": "2017-01-15T15:36:59+08:00"
},
...
{
"Average": 46,
"Description": "Normal",
"Maximum": 48,
"Minimum": 46,
"Time": "2017-01-15T18:04:23+08:00"
},
...
{
"Average": null,
"Description": null,
"Maximum": null,
"Minimum": null,
"Time": "2017-01-15T20:21:41+08:00"
},
...
],
"LastDay": {
"Average": 50,
"Maximum": 100,
"Minimum": 0
},
"LastWeek": {
"Average": 50,
"Maximum": 100,
"Minimum": 0
},
"SpecifiedTime": null,
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"StartTime": "1970-01-01T08:00:00+08:00",
"TimeStamp": "2017-01-15T14:03:56+08:00"
}
Response code: 200
# Calculate the highest historical temperature information for the specified time period.
Method and URL:
POST https://192.168.1.18/redfish/v1/Chassis/1/Sensors/Actions/Oem/Public/Temperature/TEST2_Threshold/Sensors.ResetStatistics
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"SpecifiedTime": {
"StartTime": "2019-02-14T20:21:36+08:00",
"EndTime": "2019-03-14T20:21:36+08:00"
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Sensors_Temperature.Sensors_Temperature",
"@odata.id": "/redfish/v1/Chassis/1/Sensors/Oem/Public/Temperature/TEST2_Threshold",
"@odata.type": "#SensorsInstance.v1_0_0.SensorsInstance",
"Description": "Temperature Instance",
"HistoricalHigh": 100.0,
"HistoryData": [
{
"Average": null,
"Description": "Unavailable",
"Maximum": null,
"Minimum": null,
"Time": "2017-01-15T15:36:59+08:00"
},
...
{
"Average": 46,
"Description": "Normal",
"Maximum": 48,
"Minimum": 46,
"Time": "2017-01-15T18:04:23+08:00"
},
...
{
"Average": null,
"Description": null,
"Maximum": null,
"Minimum": null,
"Time": "2017-01-15T20:21:41+08:00"
},
...
],
"LastDay": {
"Average": 50.75,
"Maximum": 100.0,
"Minimum": 0.0
},
"LastWeek": {
"Average": 50.75,
"Maximum": 100.0,
"Minimum": 0.0
},
"SpecifiedTime": {
"Average": 50.75,
"Maximum": 100.0,
"Minimum": 0.0
"StartTime": "2019-02-14T20:21:36+08:00",
"EndTime": "2019-03-14T20:21:36+08:00"
},
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"StartTime": "1970-01-01T08:00:00+08:00",
"TimeStamp": "2017-01-15T14:03:56+08:00"
}
Response code: 200
Response field description
For information about the response fields, see "Obtain historical information about a single sensor resource."
The server returns status code 200 for a successful operation.
Obtain module collection information
Description
Obtain information about all modules in the server.
Privilege module
Login
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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Examples
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/Boards
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
"@odata.context": "/redfish/v1/$metadata#BoardsCollection.BoardsCollection",
"@odata.id": "/redfish/v1/Chassis/1/Boards/",
"@odata.type": "#BoardsCollection.BoardsCollection",
"Members": [
{
"@odata.id": "/redfish/v1/Chassis/1/Boards/Motherboard"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Boards/DSDCard"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Boards/LiquidCooler"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Boards/BMCCard"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Boards/Other"
}
],
"Members@odata.count": 5,
"Name": "Boards Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
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. |
|
Members@odata.count |
Integer |
Number of modules installed on the server. |
Obtain module information
Description
Obtain information about a specific module from the server.
Privilege module
Login
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. |
|
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. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Examples
# Obtain the module information for the Motherboard.
Method and URL:
GET https://192.168.46.246/redfish/v1/Chassis/1/Boards/Motherboard
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#BoardsInstance.BoardsInstance",
"@odata.id": "/redfish/v1/Chassis/1/Boards/Motherboard",
"@odata.type": "#Boards.v1_0_0.Boards",
"BoardId": null,
"DeviceId": null,
"Id": "Motherboard",
"ManufactureDate": "2017-01-10T05:14:00+08:00",
"Manufacturer": "N/A",
"Model": "RS33M2C9S",
"Name": "Motherboard",
"Oem": {
"Public": {
"BMCCard": null,
"CPLDVersion": "V001AD",
"CPLD1Version": "V001AD",
"CPLD2Version": "V001AC",
"CompletionCode": 0,
"Description": "Success",
"DeviceType": "MainBoard",
"ExpandedBoard": null,
"MainBoard": null,
"PCBVersion": "VER.B",
"Retimer": null,
"SCPLDVersion": "V001AC",
"SubDeviceType": null,
"TopoType": null,
"iFIST": null
}
},
"PartNumber": "0231A111",
"ProductName": "RS33M2C9S",
"SerialNumber": "210231A1110000000001",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"Version": ""
}
Response code: 200
# Obtain the module information for Riser2.
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/Boards/Riser2
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#BoardsInstance.BoardsInstance",
"@odata.id": "/redfish/v1/Chassis/1/Boards/Riser2",
"@odata.type": "#Boards.v1_0_0.Boards",
"BoardId": null,
"DeviceId": null,
"Id": "Riser2",
"ManufactureDate": "2017-06-20T23:46:00+08:00",
"Manufacturer": "H3C",
"Model": "RS32B12L",
"Name": "Riser2",
"Oem": {
"Public": {
"BMCCard": null,
"CPLD1Version": null,
"CPLD2Version": null,
"CPLDVersion": null,
"CompletionCode": 0,
"Description": "Success",
"DeviceType": "PCIeConventor",
"ExpandedBoard": null,
"MainBoard": null,
"PCBVersion": "VER.A",
"Retimer": null,
"SCPLDVersion": null,
"SubDeviceType": "Riser",
"TopoType": null,
"iFIST": null
}
},
"PartNumber": "0302A2N3",
"ProductName": "RS32B12L",
"SerialNumber": "02A2N31234567890",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"Version": ""
}
Response code: 200
# Obtain the BMC card information.
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/Boards/BMCCard
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#BoardsInstance.BoardsInstance",
"@odata.id": "/redfish/v1/Chassis/1/Boards/BMCCard",
"@odata.type": "#Boards.v1_0_0.Boards",
"BoardId": null,
"DeviceId": null,
"Id": "BMCCard",
"ManufactureDate": "2017-06-20T23:46:00+08:00",
"Manufacturer": "H3C",
"Model": "RS32B12L",
"Name": "BMCCard",
"Oem": {
"Public": {
"BMCCard": {
"BackUpMode": "Golden Image",
"ChipManufacture":"ASPEED",
"ChipModel":"AST2600"
"ECCCount": 0,
"ImageState": "Normal",
"ProcessStartupResult": "Successful",
"RAMState": "Normal",
"SDCardState": "Enabled",
"UECCCount": 0,
"VARMSizeMB": 64
},
"CPLD1Version": "V001A5",
"CPLD2Version": null,
"CPLDVersion": "V001A5",
"CompletionCode": 0,
"Description": "Success",
"DeviceType": "BMCCard",
"ExpandedBoard": null,
"MainBoard": null,
"PCBVersion": "",
"Retimer": null,
"SCPLDVersion": null,
"SubDeviceType": null,
"TopoType": null,
"iFIST": {
"SDCardSizeGB": null,
"SDCardState": "Absent",
"Version": null,
"iFISTState": "Absent"
}
}
},
"PartNumber": "0302A2N3",
"ProductName": "RS32B12L",
"SerialNumber": "210231A8L0H199BING",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"Version": ""
}
Response code: 200
# Obtain the FrontBackplane1 information.
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/Boards/FrontBackplane1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#BoardsInstance.BoardsInstance",
"@odata.id": "/redfish/v1/Chassis/1/Boards/FrontBackplane1",
"@odata.type": "#Boards.v1_0_0.Boards",
"BoardId": null,
"DeviceId": null,
"Id": "FrontBackplane1",
"ManufactureDate": "2023-01-16T17:12:00+08:00",
"Manufacturer": "N/A",
"Model": "RS36B08SUF",
"Name": "FrontBackplane1",
"Oem": {
"Public": {
"BMCCard": null,
"BackPlane": {
"DrivesCount": 1,
"PortCount": 8,
"Type": "Unibay"
},
"CPLD1Version": "V004",
"CPLD2Version": null,
"CPLDVersion": "V004",
"CompletionCode": 0,
"Description": "Success",
"DeviceType": "BackPlane",
"ExpandedBoard": null,
"MainBoard": null,
"PCBVersion": "VER.B",
"Retimer": null,
"SCPLDVersion": null,
"SubDeviceType": null,
"TopoType": null,
"iFIST": null
}
},
"PartNumber": "9803A077",
"ProductName": "RS36B08SUF",
"SerialNumber": "219803A0776231V00008",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"Version": ""
}
Response code: 200
# Obtain the GPU board information.
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/Boards/GPUBoard
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#BoardsInstance.BoardsInstance",
"@odata.id": "/redfish/v1/Chassis/1/Boards/GPUBoard",
"@odata.type": "#Boards.v1_0_0.Boards",
"BoardId": null,
"DeviceId": null,
"Id": "GPUBoard",
"ManufactureDate": "",
"Manufacturer": "",
"Model": "",
"Name": "GPUBoard",
"Oem": {
"Public": {
"BMCCard": null,
"BackPlane": null,
"CPLD1Version": null,
"CPLD2Version": null,
"CPLDVersion": null,
"CompletionCode": 0,
"Description": "Success",
"DeviceType": "BoardAdapter",
"ExpandedBoard": null,
"MainBoard": null,
"PCBVersion": "VER.A",
"Retimer": null,
"SCPLDVersion": null,
"SubDeviceType": "GPUAdapter",
"TopoType": "Switch_X32",
"iFIST": null
}
},
"PartNumber": "",
"ProductName": "",
"SerialNumber": "",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"Version": ""
}
Response code: 200
# Obtain the Retimer information.
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/Boards/Retimer1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
"@odata.context": "/redfish/v1/$metadata#BoardsInstance.BoardsInstance",
"@odata.id": "/redfish/v1/Chassis/1/Boards/Retimer1",
"@odata.type": "#Boards.v1_0_0.Boards",
"BoardId": null,
"DeviceId": null,
"Id": "Retimer1",
"ManufactureDate": null,
"Manufacturer": null,
"Model": null,
"Name": "Retimer1",
"Oem": {
"Public": {
"BMCCard": null,
"BackPlane": null,
"CPLD1Version": null,
"CPLD2Version": null,
"CPLDVersion": null,
"CompletionCode": 0,
"Description": "Success",
"DeviceType": "BoardAdapter",
"ExpandedBoard": null,
"MainBoard": null,
"PCBVersion": null,
"Retimer": {
"CurrentFirmwareVersion": "0x689A000"
},
"SCPLDVersion": null,
"SubDeviceType": "Retimer",
"TopoType": null,
"iFIST": null
}
},
"PartNumber": null,
"ProductName": null,
"SerialNumber": null,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"Version": null
}
Response code: 200
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 |
String |
Date of manufacture. |
|
Manufacturer |
String |
Manufacturer. |
|
PartNumber |
String |
Part number. |
|
ProductName |
String |
Product name. |
|
SerialNumber |
String |
Serial number. |
|
Model |
String |
Model. |
|
Status.Health |
String |
Health status of the module. |
|
Status.State |
String |
Enabling status of the module. |
|
Status.Oem.Public. Severity |
String |
Custom health status for the module. |
|
Status.Oem.Public. FaultDescription |
String |
Fault description information for the module. |
|
Version |
String |
Privilege module version. |
|
Name |
String |
Privilege module resource name. |
|
Oem.Public.DeviceType |
String |
Type of the primary module. Supported options: · MainBoard—Mainboard. · CalculationModule—computing node. · CPUBoard—CPU daughter board. · BackPlane—Hard drive backplane. · PDB—Power board. · MDB—Mid-plane backplane. · Expander—Expansion board. · PCIeConventor—PCIe adapter card. · DiagPanel—Diagnostic panel. · GPUPanel—GPU panel. · SecurityBezel—Security panel. · BMCCard—Management module. · BoardAdapter—Adapter module. · Other—Other components. |
|
Oem.Public.SubDeviceType |
String |
Type of the secondary module. Supported options: · SASSwitch—SAS expansion board. · PCIeSwitch—PCIe expansion board. · Retimer—Retimer card. · Redriver—Redriver card. · Riser—Riser card. · M2Conventor—M.2 adapter card. · OPCconventor—OCP adapter card. · LOMConventor—LOM adapter card. · MEZZConventor—Mezzanine adapter card. · HotPlugRiser— Hot-pluggable riser. · ClockCard—Clock card. · DeltaNextBoard—GPU module (delta-next module). |
|
Oem.Public.CPLDVersion |
String |
Single-board CPLD version. |
|
Oem.Public.Retimer.CurrentFirmwareVersion |
String |
Current firmware version of the Retimer card. |
|
Oem.Public.PCBVersion |
String |
PCB version. |
|
Oem.Public.SCPLDVersion |
String |
SCPLD version information, such as auxiliary CPLD for the mainboard or backplane. |
|
Oem.Public.CPLD1Version |
String |
CPLD 1 version, same as the CPLD version. |
|
Oem.Public.CPLD2Version |
String |
CPLD 2 version, same as the SCPLD version. |
|
Oem.Public.TopoType |
String |
GPU topology type. |
|
Oem.Public.ExpandedBoard.CurrentFirmwareVersion |
String |
Current firmware version of the module chip. |
|
Oem.Public.ExpandedBoard.CurrentConfigurationVersion |
String |
Current configuration file version of the module chip. |
|
Oem.Public.ExpandedBoard.BootloaderVersion |
String |
Module chip bootloader version. |
|
Oem.Public.ExpandedBoard.EEPROMVersion |
String |
Module chip EEPROM version. |
|
Oem.Public.MainBoard.PFRCPLDVersion |
String |
Mainboard PFRCPLD version. |
|
Oem.Public.BackPlane.DrivesCount |
Integer |
Number of backplane drives in place. |
|
Oem.Public.BackPlane.PortCount |
Integer |
Number of backplane ports. |
|
Oem.Public.BackPlane.Type |
String |
Backplane type. |
|
Oem.Public.BMCCard.BackUpMode |
String |
Backup plan. |
|
Oem.Public.BMCCard.ChipManufacture |
String |
BMC chip manufacturer. |
|
Oem.Public.BMCCard.ChipModel |
String |
BMC chip model. |
|
Oem.Public.BMCCard.SDCardState |
String |
SD card status. Absent/Enabled/PartLose/AccessFailed Not present/Normal/Partition lost/Access failed. |
|
Oem.Public.BMCCard.ECCCount |
Integer |
BMC card memory ECC count during abnormal state. |
|
Oem.Public.BMCCard.UECCCount |
Integer |
BMC card memory UECC count during abnormal state. |
|
Oem.Public.BMCCard.RAMState |
String |
BMC card memory status: Normal or Error. |
|
Oem.Public.BMCCard.VARMSizeMB |
Integer |
Video memory size, in MB. |
|
Oem.Public.BMCCard.ProcessStartupResult |
String |
Whether the key process started successfully. Supported options: · Successful. · Failed. |
|
Oem.Public.BMCCard.ImageState |
String |
Image status. Supported options: · Normal. · Error. |
|
Oem.Public.iFIST.iFISTState |
String |
IFIST status. Supported options: · Absent. · Enabled. |
|
Oem.Public.iFIST.SDCardState |
String |
Status of the iFIST SD card. Supported options: · Absent. · Enabled. |
|
Oem.Public.iFIST.SDCardSizeGB |
Integer |
Capacity of the iFIST SD card. |
|
Oem.Public.iFIST.Version |
String |
Information of the iFIST version. |
Change history
|
Version |
Change description |
|
HDM2-2.17 |
Added the Oem.Public.Retimer.CurrentFirmwareVersion field. |
|
HDM2-2.16 HDM2-1.79 HDM3-2.03 |
Added the Oem.Public.TopoType field. |
|
HDM2-2.04 |
Added the Oem.Public.BackPlane.DrivesCount, Oem.Public.BackPlane.PortCount, and Oem.Public.BackPlane.Type fields. |
|
HDM2-1.58 |
Added the Oem.Public.BMCCard.ChipManufacture and Oem.Public.BMCCard.ChipModel fields. |
|
HDM2-1.55 |
· Added the BoardAdapter option to the DeviceType field. · Added the DeltaNextBoard option to the SubDeviceType field. |
|
HDM2-1.54 |
· Changed Baseboard to Motherboard in the example. · Deleted the SMC option from the Oem.Public.DeviceType field. · Modified the description of the BMCCard option in the Oem.Public.DeviceType to management module. · Added the Oem.Public.CPLD1Version and Oem.Public.CPLD2Version fields. |
Obtain PCIe module collection information
Description
Obtain information about all PCIe modules in the server.
Privilege module
Login
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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Examples
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/PCIeDevices
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
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/3"
}
],
"Members@odata.count": 1,
"Name": "PCIeDevices Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
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. |
|
Members@odata.count |
Integer |
Number of PCIe modules. |
|
Name |
String |
Name of the PCIe module collection resource. |
Obtain PCIe module information
Description
Obtain information about a specific PCIe module from the server.
Privilege module
Login
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. |
|
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. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Examples
# For PCIe modules other than GPU modules:
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/PCIeDevices/23
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/23",
"@odata.type": "#PCIeDevice.v1_5_0.PCIeDevice",
"CardManufacturer": null,
"CardModel": null,
"Description": "OCP-1",
"FirmwareVersion": "N/A",
"Id": "PCIeCard23",
"Links": {
"Chassis": [
{
"@odata.id": "/redfish/v1/Chassis/1"
}
],
"PCIeFunctions": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/23/Functions/1"
}
]
},
"Manufacturer": "H3C",
"Model": "NIC-ETH640F-3S-2P",
"Name": "NIC-ETH640F-3S-2P",
"Oem": {
"Public": {
"ChipManufacturer": "Mellanox",
"ChipModel": "ConnectX-4",
"CompletionCode": 0,
"Description": "Success",
"DeviceLocator": "PCIe Card23",
"PCIeCardType": "NIC",
"Position": 23,
"SlotNumber": 23
}
},
"PCIeInterface": {
"LanesInUse": 8,
"MaxLanes": 8
},
"PartNumber": "0302A2N4",
"SerialNumber": "222235A022B2B221A",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
}
Response code: 200
# For GPU modules:
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/PCIeDevices/5
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/5",
"@odata.type": "#PCIeDevice.v1_2_0.PCIeDevice",
"CardManufacturer": null,
"CardModel": null,
"Description": "",
"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": {
"ChipManufacturer": "NVIDIA",
"ChipModel": "",
"CompletionCode": 0,
"Description": "Success",
"DeviceLocator": "PCIe Card5",
"DriverVersion": "N/A",
"ECCEnable": 1,
"GCUVoltage": 0.75,
"GPUDeviceError": 16384,
"GPUMemoryError": 16384,
"HBMVoltage": 1.25,
"MemorySizeMiB": 16384,
"PCIeBusError": 16384,
"PCIeCardType": "GPU",
"Position": 5,
"PowerCapacityWatts": 70,
"PowerWatts": 70,
"ProductDate": "20240517",
"SlotMapping":"OAM2",
"SlotNumber": 5
}
},
"PCIeInterface": {
"LanesInUse": 16,
"MaxLanes": null
},
"PartNumber": "0302A2N9",
"SerialNumber": "0323617020478",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
}
Response code: 200
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. |
|
CardManufacturer |
String |
Manufacturer of the PCIe module resource. |
|
CardModel |
String |
Device model of the PCIe module resource. |
|
Description |
String |
Description of the PCIe module. |
|
FirmwareVersion |
String |
Firmware version of the PCIe module. |
|
Id |
String |
ID of the PCIe module resource. |
|
Links.Chassis |
Array |
Link to a chassis resource. |
|
Links.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. |
|
SerialNumber |
String |
PCIe module serial number. |
|
PartNumber |
String |
PCIe module part number. |
|
Oem.Public.ChipManufacturer |
String |
PCIe module chip manufacturer. |
|
Oem.Public.ChipModel |
String |
PCIe module chip model. |
|
Oem.Public.DeviceLocator |
String |
PCIe module silkscreen. |
|
Oem.Public.PCIeCardType |
String |
Type of the PCIe module. Supported options: · GPU. · FPGA. · NIC. · RAID. · SAS. · FC. · IB. · OEM. · QAT. · SWITCH. · PCIE_AUX. |
|
Oem.Public.Position |
Integer |
PCIe module container. |
|
Oem.Public.SlotNumber |
Integer |
Slot number of 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. |
|
Oem.Public.PowerWatts |
Integer |
Current power of the specified PCIe module. (GPU) 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 PCIe modules. (GPU) |
|
Oem.Public.MemorySizeMiB |
Integer |
Video memory capacity of the specified PCIe module. (GPU) |
|
Oem.Public.SlotMapping |
String |
Slot mapping (GPU) with the actual physical slot of a PCIe device. |
|
Oem.Public.DriverVersion |
String |
Driver version (only supported by the Enflame S60 GPU). |
|
Oem.Public.ECCEnable |
String |
Enabling status of ECC (only supported by the Enflame S60 GPU). |
|
Oem.Public.GCUVoltage |
Value |
GCU voltage (only supported by the Enflame S60 GPU). The unit is V. |
|
Oem.Public.HBMVoltage |
Value |
HBM voltage (only supported by the Enflame S60 GPU). The unit is V. |
|
Oem.Public.GPUDeviceError |
Value |
GPU device error (only supported by the Enflame S60 GPU). Values include: · 0: Represents healthy. · 16384: Represents that a recoverable error has occurred on the acceleration module. · 32768: Represents that a non-recoverable error has occurred on the acceleration module peripheral. |
|
Oem.Public.PCIeBusError |
Integer |
PCIe error (only supported by the Enflame S60 GPU). Values include: · 0: Represents healthy. · 16384: Represents that a recoverable error has occurred on the acceleration module peripheral. · 32768: Represents that a non-recoverable error has occurred on the acceleration module. |
|
Oem.Public.GPUMemoryError |
Integer |
GPU memory error (only supported by the Enflame S60 GPU). Values include: · 0: Represents healthy. · 16384: Represents that a recoverable error has occurred on the acceleration module VRAM. · 32768: Represents that a non-recoverable error has occurred on the acceleration module VRAM. |
|
Oem.Public.ProductDate |
String |
Product production date (only supported by the Enflame S60 GPU). Values include: |
|
Status.Health |
String |
PCIe module resource health status rated power. |
|
Status.State |
String |
PCIe module resource enabled state video memory. |
|
Status.Oem.Public.Severity |
String |
Custom health status serial number for PCIe module resources. |
|
Status.Oem.Public.FaultDescription |
String |
Fault description information for PCIe module resources. |
Change history
|
Version |
Change description |
|
HDM2-2.10 |
Added the Oem.Public.DriverVersion, Oem.Public.ECCEnable, Oem.Public.GCUVoltage, Oem.Public.HBMVoltage, Oem.Public.GPUDeviceError, Oem.Public.PCIeBusError, Oem.Public.GPUMemoryError, and Oem.Public.ProductDate fields. |
|
HDM2-2.04 |
Added the CardManufacturer and CardModel fields. |
|
HDM2-2.04 |
Added the Oem.Public.SlotMapping field. |
|
HDM2-2.04 |
Added the PCIE_AUX option to the Oem.Public.PCIeCardType field. |
|
HDM2-1.53 |
Modified description of the FirmwareVersion field. |
Obtain PCIe function information
Description
Obtain information about the function of a specific PCIe module from the server.
Privilege module
Login
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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
pciedevices_id |
ID of the PCIe module. |
You can obtain available PCIe module IDs from PCIe module collection information. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Examples
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/PCIeDevices/23/Functions/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#PCIeDevicesFunctionsInstance.PCIeDevicesFunctionsInstance",
"@odata.id": "/redfish/v1/Chassis/23/PCIeDevices/23/Functions/1",
"@odata.type": "#PCIeFunction.v1_3_0.PCIeFunction",
"DeviceId": "0x1015",
"Id": "1",
"Manufacturer": "H3C",
"Name": "Function1",
"Oem": {
"Public": {
"BDF": null,
"BusNumber": "0x16",
"CPUId": "1",
"CompletionCode": 0,
"Datawidth": "x8",
"Description": "Success",
"DeviceClass": "SignalProcessingController",
"DeviceNumber": "0",
"FunctionNumber": "0",
"MaxDatawidth": "x16",
"MaxSpeed": "8.0GT/s",
"MezzSlot": null,
"MaxProtocol": "Gen 3",
"Negotiatedspeed": "8.0GT/s",
"Protocol": "Gen 3",
"RiserId": "N/A",
"LinkWidthAbility":"x16"
"RootBDF": null
}
},
"PartNumber": "0302A2N4",
"ProductName": "NIC-ETH640F-3S-2P",
"SerialNumber": "222235A022B2B221A",
"Status": {
"Health": "OK",
"State": "Enabled"
},
"SubsystemId": "0x1083",
"SubsystemVendorId": "0x193D",
"VendorId": "0x15B3"
}
Response code: 200
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.BDF |
String |
Device resource attributes. |
|
Oem.Public.RootBDF |
String |
Port resource attributes. |
|
Oem.Public.Datawidth |
String |
Negotiated link width. |
|
Oem.Public.MaxDatawidth |
String |
Maximum bandwidth. |
|
Oem.Public.MaxSpeed |
String |
Maximum speed. |
|
Oem.Public.LinkWidthAbility |
String |
Maximum bandwidth. |
|
Oem.Public.Negotiatedspeed |
String |
Negotiated speed. |
|
Oem.Public.Protocol |
String |
Negotiated protocol. |
|
Oem.Public.Slot |
String |
PCIe slot number. |
|
Oem.Public.RiserId |
String |
Riser number. |
|
Oem.Public.CPUId |
String |
Associated CPU. |
|
Oem.Public.MezzSlot |
String |
Mezz slot. |
|
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.MaxProtocol |
String |
Highest PCIe protocol. |
|
Name |
String |
PCIe function resource name. |
Change history
|
Version |
Change description |
|
HDM3-1.14 |
Added the Oem.Public.BDF and Oem.Public.RootBDF fields and synchronized them to HDM3. |
|
HDM2-2.04 |
Added the Oem.Public.BDF and Oem.Public. RootBDF fields. |
Obtain network adapter collection information
Description
Obtain information about all network adapters in the server.
Privilege module
Login
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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
TOKEN |
Authentication token. |
The token is generated when a session is created by using /redfish/v1/SessionService/Sessions. |
Examples
Method and URL:
GET http://172.16.13.176/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/PCIeSlot1"
}
],
"Members@odata.count": 1,
"Name": "NetworkAdapter Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
Integer |
Number of installed network adapters. |
|
Name |
String |
Name of the network adapter resource. |
Obtain network adapter information
Description
Obtain information about a specific network adapter from the server.
Privilege module
Login
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
# Obtain information for the specified NIC controller.
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16
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/PCIeSlot16",
"@odata.type": "#NetworkAdapter.v1_5_0.NetworkAdapter",
"Controllers": [
{
"ControllerCapabilities": {
"NetworkPortCount": 2
},
"FirmwarePackageVersion": "2.0",
"Links": {
"NetworkPorts": [
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16/NetworkPorts/1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16/NetworkPorts/2"
}
],
"NetworkPorts@odata.count": 2,
"PCIeDevices": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/16"
}
],
"PCIeDevices@odata.count": 1
}
}
],
"Id": "PCIeSlot16",
"Manufacturer": "Intel",
"Model": "NIC-ETH660F-3S-2P",
"Name": "PCIeSlot16",
"NetworkPorts": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16/NetworkPorts"
},
"Oem": {
"Public": {
"CapableSpeedGbs": "25",
"CardManufacturer": "H3C",
"CardMode": "NPAR",
"CardModel": "2*25GE",
"ChipModel": "E810",
"CompletionCode": 0,
"Configuration":{
"CardTypeCode": "0302A5FQ",
"DataOrigin": 2,
"EffectiveLink": 0,
"MultifunctionMode": "NPAR",
"NPARLink": 44000,
"NPARPort": [],
"PortsConfig": [
{
"16GFECConfig": "Disabled",
"ConnectionType": "Switch",
"PFsInfo": [
{
"FCoEFipMACAddress": "14:58:D0:D3:00:02",
"ISCSIAddress": "00:0a:f7:10:d8:71",
"PermanentAddress": "14:58:D0:D3:00:02",
"Protocol": "ETHERNET",
"WWNN": ":14:58:D0:D3:00:02",
"WWPN": ":14:58:D0:D3:00:02"
}
],
"PortId": "0"
},
……
]
},
"Description": "Success",
"DeviceLocator": "PCIe Card16",
"FirmwareVersion": "2.0",
"MCTPEnabled":false,
"MezzSlot":"Mezz2",
"NetworkTechnology": [
"Ethernet"
],
"OCPFan": {
"Status": {
"Health": "Critical",
"Oem": {
"Public": {
"FaultDescription": "[PCIe_Card16]Fault Status asserted:---fan error in slot 16",
"Severity": "Major"
}
},
"State": "Absent"
}
},
"PartNumber": "0302A5L9",
"Position": "PCIe-16",
"RootBDF": "0000:15:01.0",
"SerialNumber": "02A5L902110M000G",
"SlotNumber": 16,
"TemperatureCelsius": 41
}
},
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
}
Response code: 200
# Obtain information for the specified FC controller.
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response 2:
{
"@odata.context": "/redfish/v1/$metadata",
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6",
"@odata.type": "#NetworkAdapter.v1_5_0.NetworkAdapter",
"Controllers": [
{
"ControllerCapabilities": {
"NetworkPortCount": 2
},
"FirmwarePackageVersion": "12.8.351.47",
"Links": {
"NetworkPorts": [
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/2"
}
],
"NetworkPorts@odata.count": 2,
"PCIeDevices": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/6"
}
],
"PCIeDevices@odata.count": 1
}
}
],
"Id": "PCIeSlot6",
"Manufacturer": "Emulex",
"Model": "FC-HBA-LPe35002-LP-32Gb-2P",
"Name": "PCIeSlot6",
"NetworkPorts": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts"
},
"Oem": {
"Public": {
"CapableSpeedGbs": "32",
"CardManufacturer": "Emulex",
"CardMode": null,
"CardModel": "2*32GE",
"ChipModel": "XE601",
"CompletionCode": 0,
"Configuration":{
"CardTypeCode": "0302A5FQ",
"DataOrigin": 2,
"EffectiveLink": 0,
"MultifunctionMode": "NPAR",
"NPARLink": 44000,
"NPARPort": [],
"PortsConfig": [
{
"16GFECConfig": "Disabled",
"ConnectionType": "Switch",
"PFsInfo": [
{
"FCoEFipMACAddress": "14:58:D0:D3:00:02",
"ISCSIAddress": "00:0a:f7:10:d8:71",
"PermanentAddress": "14:58:D0:D3:00:02",
"Protocol": "ETHERNET",
"WWNN": ":14:58:D0:D3:00:02",
"WWPN": ":14:58:D0:D3:00:02"
}
],
"PortId": "0"
},
……
]
},
"Description": "Success",
"DeviceLocator": "PCIe Card6",
"FirmwareVersion": "12.8.351.47",
"MCTPEnabled":false,
"MezzSlot":"Mezz2",
"NetworkTechnology": [
"FC"
],
"PartNumber": null,
"Position": "PCIe6",
"ProductCode": "FC HBA",
"RootBDF": null,
"SerialNumber": null,
"SlotNumber": 6,
"TemperatureCelsius": 41
}
},
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Disabled"
}
}
Response code: 200
# Obtain information for the specified eth682i controller.
Method and URL:
GET http://172.16.13.176/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response 3:
{
"@odata.context": "/redfish/v1/$metadata",
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6",
"@odata.type": "#NetworkAdapter.v1_5_0.NetworkAdapter",
"Controllers": [
{
"ControllerCapabilities": {
"NetworkPortCount": 2
},
"FirmwarePackageVersion": "12.8.351.47",
"Links": {
"NetworkPorts": [
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/2"
}
],
"NetworkPorts@odata.count": 2,
"PCIeDevices": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/6"
}
],
"PCIeDevices@odata.count": 1
}
}
],
"Id": "PCIeSlot5",
"Manufacturer": "QLogic",
"Model": "NIC-ETH682i-Mb-2*25G",
"Name": "PCIeSlot5",
"NetworkPorts": {
"@odata.context": "/redfish/v1/$metadata#NetworkPortCollection.NetworkPortCollection(*)",
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot5/NetworkPorts",
"@odata.type": "#NetworkPortCollection.NetworkPortCollection",
"Members": [
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot5/NetworkPorts/1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot5/NetworkPorts/2"
}
],
"Members@odata.count": 2,
"Name": "Network Port Collection"
},
"Oem": {
"Public": {
"CapableSpeedGbs": "25",
"CardManufacturer": "H3C",
"CardMode": "Single",
"CardModel": "2*25GE",
"ChipModel": "QL41401 A2",
"Configuration": {
"CardTypeCode": "0302A5K7",
"DataOrigin": 3,
"EffectiveLink": 65535,
"MultifunctionMode": "QINQ_NPAR",
"NPARLink": 0,
"NPARPort": [
{
"Port": 0
},
{
"Port": 1
},
{
"Port": 2
},
{
"Port": 3
},
{
"Port": 4
},
{
"Port": 5
},
{
"Port": 6
},
{
"Port": 7
},
{
"Port": 8
},
{
"Port": 9
},
{
"Port": 10
},
{
"Port": 11
},
{
"Port": 12
},
{
"Port": 13
},
{
"Port": 14
},
{
"Port": 15
}
],
"PortsConfig": [
{
"16GFECConfig": null,
"ConnectionType": null,
"PFsInfo": [
{
"FCoEFipMACAddress": "AC:BD:E2:50:28:EC",
"ISCSIAddress": "AC:BD:E2:50:28:EE",
"PermanentAddress": "AC:BD:E2:50:28:EA",
"Protocol": "UNDI",
"WWNN": "10:00:AC:BD:E2:50:28:EC",
"WWPN": "20:00:AC:BD:E2:50:28:EC"
}
],
"PortId": "0"
},
{
"16GFECConfig": null,
"ConnectionType": null,
"PFsInfo": [
{
"FCoEFipMACAddress": "AC:BD:E2:50:28:ED",
"ISCSIAddress": "AC:BD:E2:50:28:EF",
"PermanentAddress": "AC:BD:E2:50:28:EB",
"Protocol": "UNDI",
"WWNN": "10:00:AC:BD:E2:50:28:ED",
"WWPN": "20:00:AC:BD:E2:50:28:ED"
}
],
"PortId": "1"
}
]
},
"DeviceLocator": "PCIe Card5",
"FirmwareVersion": "00.00.00",
"MCTPEnabled": true,
"MezzSlot": "Mezz1",
"NetworkTechnology": [
"Ethernet"
],
"OCPFan": null,
"PartNumber": "N/A",
"Position": "PCIe-5",
"RootBDF": "0000:48:01.0",
"SerialNumber": "N/A",
"SlotNumber": 5,
"TemperatureCelsius": 57.0
}
},
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"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. |
|
CardManufacturer |
String |
Manufacturer of the network adapter. |
|
CardMode |
String |
Mode of the network adapter. |
|
CardModel |
String |
Interface type on the network adapter. |
|
ChipModel |
String |
Chip model. |
|
Configuration |
Object |
Mezzanine card information. |
|
Configuration.CardTypeCode |
String |
Mezzanine card type. |
|
Configuration.DataOrigin |
Integer |
Data source: · EEPROM · OM |
|
Configuration.EffectiveLink |
Integer |
Port connection effective status, with the value in the range of 0 to 65535. Each bit represents a port, and the connection status corresponds to bit 1. |
|
Configuration.MultifunctionMode |
String |
Port multifunction mode: · SF · NPAR · Default · QINQ_NPAR · QINQ_Default |
|
Configuration.NPARLink |
Integer |
Port connection status with the value in the range of 0 to 65535 when NPAR is enabled. |
|
Configuration.NPARPort |
Array |
List of available ports when NPAR is enabled. |
|
Configuration.PortsConfig |
Array |
Port configuration information. |
|
Configuration.PortsConfig.16GFECConfig |
String |
Enabling status of current 16G FEC configuration: · Enabled · Disabled |
|
Configuration.PortsConfig.ConnectionType |
String |
Port connection type: · Switch · PTM_32G · PTM_16G |
|
Configuration.PortsConfig.PFsInfo |
Array |
Port physical feature information. |
|
Configuration.PortsConfig.PFsInfo.FCoEFipMACAddress |
String |
FCoE MAC address. |
|
Configuration.PortsConfig.PFsInfo.ISCSIAddress |
String |
ISCSI address. |
|
Configuration.PortsConfig.PFsInfo.PermanentAddress |
String |
Fixed address. |
|
Configuration.PortsConfig.PFsInfo.Protocol |
String |
Protocol name. |
|
Configuration.PortsConfig.PFsInfo.WWNN |
String |
Node WWN. |
|
Configuration.PortsConfig.PFsInfo.WWPN |
String |
Port WWN. |
|
Configuration.PortsConfig.PortId |
String |
Port ID. |
|
MezzSlot |
String |
Mezzanine slot number. |
|
DeviceLocator |
String |
Network adapter silk-screen information. |
|
FirmwareVersion |
String |
Firmware version. |
|
MCTPEnabled |
Boolean |
MCTP enabling status. |
|
OCPFan |
Object |
OCP fan information. This field is unavailable for FC HBA cards. |
|
OCPFan.Status |
Object |
Specify OCP fan status, including: · Health—OCP fan health status. · State—OCP fan enable status. · Severity—Custom health status. · FaultDescription— Fault description information. When the OCP fan enable status is Absent, it indicates the OCP fan is missing and will trigger a severe alarm (Critical/Major). |
|
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. |
|
Position |
String |
Network adapter location, for example, mLOM, sLOM, and Embedded. |
|
SerialNumber |
String |
Serial number. |
|
PartNumber |
String |
Part number. |
|
Model |
String |
Device model. |
|
SlotNumber |
Integer |
Slot number of the network adapter. |
|
TemperatureCelsius |
Integer |
Current temperature. |
|
RootBDF |
String |
Root port BDF of the network adapter. |
|
ProductCode |
String |
Product Code This field is available for FC HBA cards. |
|
PCIeDevices@odata.count |
Integer |
Number of related PCIe module for network adapter. |
|
NetworkPorts@odata.count |
Integer |
Number of related network ports for network adapter. |
|
Controllers |
Network adapter properties. |
|
|
ControllerCapabilities |
Network adapter controller capability information. |
|
|
Links |
Single object of the network adapter. |
|
|
NetworkPorts |
Collection of network port objects for the network adapter. |
|
|
PCIeDevices |
Collection of PCIe objects for the network adapter. |
|
|
FirmwarePackageVersion |
String |
Version of the firmware package. |
|
Status.Health |
String |
Health status of the network adapter. |
|
Status.State |
String |
Enabling status of network adapters. |
|
Status.Oem.Public.Severity |
String |
Custom health status. |
|
Status.Oem.Public.FaultDescription |
String |
Fault description information. |
Change history
|
Version |
Change description |
|
HDM2-1.79 HDM2-2.17 |
Added the Configuration.NPARPort field. |
|
HDM2-2.03 |
Added the Oem.Public.MCTPEnabled field. |
|
HDM2-1.59 |
Added Mezzanine related fields. |
|
HDM2-1.59 |
Added the Oem.Public.CardMode field. |
Obtain network port collection information
Description
Obtain information about all network ports from the server.
Privilege module
Login
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:
GET http://172.16.13.176/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#NetworkPortCollection.NetworkPortCollection(*)",
"@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"
}
],
"Members@odata.count": 2,
"Name": "Network Port Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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 single network port. |
|
Members@odata.count |
Integer |
Number of network ports. |
Obtain network port information
Description
Obtain information about a specific network port from the server.
Privilege module
Login
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
# Obtain port information for the specified NIC controller.
Method and URL:
GET https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16/NetworkPorts/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json n
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#NetworkPort.NetworkPort",
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot16/NetworkPorts/1",
"@odata.type": "#NetworkPort.v1_3_0.NetworkPort",
"AssociatedNetworkAddresses": [
"78:AA:82:CB:11:18"
],
"CurrentLinkSpeedMbps": null,
"Id": "1",
"LinkStatus": "Down",
"Name": "1",
"Oem": {
"Public": {
"AutoNeg": true,
"BDF": "0000:16:00.0",
"CompletionCode": 0,
"CPUId":"CPU2",
"Description": "Success",
"FatherPortNum": "1",
"FullDuplex": false,
"LldpService": {
"LldpCurrentState": "N/A",
"LldpEnabled": null,
"WorkMode": ""
},
"PortMaxSpeed": "25000Mb/s",
"PortType": "OpticalPort",
"Slot": "Slot24"
}
},
"PhysicalPortNumber": "1"
}
Response code: 200
# Obtain port information for the specified FC controller.
Method and URL:
GET https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot1/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/PCIeSlot1/NetworkPorts/1",
"@odata.type": "#NetworkPort.v1_2_5.NetworkPort",
"AssociatedNetworkAddresses": [],
"CurrentLinkSpeedMbps": 0,
"Id": "1",
"LinkStatus": "N/A",
"Name": "1",
"Oem": {
"Public": {
"AutoNeg": null,
"BDF": "0000:49:00.0",
"CompletionCode": 0,
"CPUId": null,
"Description": "Success",
"FatherPortNum": null,
"FullDuplex": null,
"LldpService": {
"LldpCurrentState":null,
"LldpEnabled": null,
"WorkMode": null
},
"PortMaxSpeed": "16000Mb/s",
"PortType": "ElectricalPort",
"Slot": null
}
},
"PhysicalPortNumber": "1"
}
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 |
Supported options: · NIC—MAC addresses of the network port. · FC—First is WWPN, second is WWNN. |
|
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 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 Mb/s. |
|
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. |
|
CPUId |
String |
CPU to which the network port belongs. Only supported by NIC card. |
|
Slot |
String |
Slot to which the network port belongs. Only supported by NIC card. |
|
AutoNeg |
Boolean |
Autonegotiation of the network port. Supported options: · true. · false. |
|
FatherPortNum |
String |
Father port number of the specified port. |
|
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 enabling 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. |
|
LldpService.LldpCurrentState |
String |
LLDP status. Supported options: · Enabled—On. · Disabled—Off. |
Change history
|
Version |
Change description |
|
HDM3-1.20 |
Edited the description for the LinkStatus field. |
|
HDM2-1.61 |
Added the Oem.Public.CPUId and Oem.Public.Slot field. |
|
HDM2-1.59 |
Added the Oem.Public.FatherPortNum field. |
Configure network port settings
Description
Configure a network port on the server.
|
|
NOTE: This feature is not available for FC controllers. |
Privilege module
ConfigureComponents
Locking type of the associated system
BMC configuration locking
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": lldp_enabled
}
}
}
}
Parameters
|
Parameter |
Description |
Value |
|
device_ip |
IP address for logging in to the device. |
IPv4 or IPv6 address. |
|
networkadapters_id |
ID of the network adapter |
You can obtain available network adapter resource IDs from network adapter collection information. |
|
networkport_id |
ID of the single network port resource |
You can obtain available network port resource IDs from network port collection information. |
|
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 enabling status of the network port. Supported options: · true. · false. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot17/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/PCIeSlot17/NetworkPorts/1",
"@odata.type":"#NetworkPort.v1_3_0.NetworkPort",
"AssociatedNetworkAddresses":[
"B8:59:9F:FB:44:32"
],
"CurrentLinkSpeedMbps":10000,
"Id":"1",
"LinkStatus":"Up",
"Name":"1",
"Oem":{
"Public":{
"AutoNeg":true,
"BDF":"0000:81:00.0",
"CompletionCode":0,
"CPUId":"CPU2",
"Description":"Success",
"FatherPortNum": "1",
"FullDuplex":true,
"LldpService":{
"LldpCurrentState":"Disabled",
"LldpEnabled":true,
"WorkMode":""
},
"PortMaxSpeed":"25000Mb/s",
"PortType":"OpticalPort",
"Slot": "Slot24"
}
},
"PhysicalPortNumber":"1"
}
Response code: 200
Response field description
For information about the response fields, see "Obtain network port information."
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain drive alarm threshold information
Description
Obtain information about alarm thresholds of drives in the server.
Privilege module
Login
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": 24810,
"EnableFlag": false
"MajorAlarmLimit": 95
},
"Life": {
"AlarmLimit": 95,
"EnableFlag": false
},
"MediaError": {
"MediaErrorCnt": 24810,
"MediaErrorEnableFlag": false
},
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"PredFail": {
"PredFailCnt": 24810,
"PredFailEnableFlag": false
},
"RevBlock": {
"AlarmLimit": 10,
"EnableFlag": false
},
"UNC": {
"AlarmLimit": 240,
"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. Enabled by default with AlarmLimit as 90 and MajorAlarmLimit as 95. |
|
|
AlarmLimit |
Integer |
Remaining drive life that can trigger a minor alarm. Value range: 0 to 100 in percent. |
|
EnableFlag |
Boolean |
Enabling status of drive life alarming. Supported options: · true—Enabled. · false—Disabled. |
|
MajorAlarmLimit |
Integer |
Remaining drive life that can trigger a major alarm. Value range: 0 to 100 in percent. |
|
MediaError |
Media error alarming. This feature is available only for HDDs and SSDs. |
|
|
MediaErrorCnt |
Integer |
Number of media errors that can trigger an alarm. Value range: 0 to 65535. |
|
MediaErrorEnableFlag |
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. |
|
|
PredFailCnt |
Integer |
Number of predictive failures that can trigger an alarm. Value range: 0 to 255. |
|
PredFailEnableFlag |
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 using the SATA protocol. |
|
|
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 |
|
HDM2-1.69 HDM2-2.06 |
Added the Life.MajorAlarmLimit field to indicate the major alarm threshold for drive life. |
Configure drive alarm threshold settings
Description
Configure the alarm threshold settings for drives.
Privilege module
OemKvm
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Drives/AlarmThreshold
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"BadTrack": {
"AlarmLimit": Limit,
"EnableFlag": Flag
"MajorAlarmLimit":Limit
},
"Life": {
"AlarmLimit": 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. |
|
chassis_id |
ID of the chassis resource. |
Only value 1 is supported. |
|
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. |
|
|
BadTrack.AlarmLimit |
Number of bad sectors that can trigger an alarm. |
Integer. Value range: 0 to 65535. |
|
BadTrack.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. Enabled by default with AlarmLimit as 90 and MajorAlarmLimit as 95. |
|
|
Life.AlarmLimit |
Remaining drive life that can trigger a minor alarm. |
Integer. Value range: 0 to 100 in percent. |
|
Life.EnableFlag |
Enable or disable remaining drive life alarming. |
Boolean. Supported options: · true—Enable. · false—Disable. |
|
Life.MajorAlarmLimit |
Remaining drive life that can trigger a major alarm. |
Integer Value range: 0 to 100 in percent. |
|
MediaError |
Media error alarming. This feature is available only for HDDs and SSDs. |
|
|
MediaError.MediaErrorCnt |
Number of media errors that can trigger an alarm. |
Integer. Value range: 0 to 65535. |
|
MediaError.MediaErrorEnableFlag |
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. |
|
|
PredFail.PredFailCnt |
Number of predictive failures that can trigger an alarm. |
Integer. Value range: 0 to 255. |
|
PredFail.PredFailEnableFlagEnableFlag |
Enable or disable predictive failure alarming. |
Boolean. Supported options: · true—Enable. · false—Disable. |
|
RevBlock |
Reserved block alarming. This feature is available only for SSDs. |
|
|
RevBlock.AlarmLimit |
Number of reserved blocks that can trigger an alarm. |
Integer. Value range: 0 to 100. |
|
RevBlock.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 using the SATA protocol. |
|
|
UNC.AlarmLimit |
Number of uncorrectable errors that can trigger an alarm. |
Integer. Value range: 0 to 255. |
|
UNC.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,
"EnableFlag": true
"MajorAlarmLimit": 95
},
"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,
"EnableFlag": true
"MajorAlarmLimit": 95
},
"MediaError": {
"MediaErrorCnt": 32767,
"MediaErrorEnableFlag": true
},
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"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 |
|
HDM2-1.69 HDM2-2.06 |
Added the Life.MajorAlarmLimit field to indicate the major alarm threshold for drive life. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Operations on system resources
Obtain system collection information
Description
Obtain information about all system resources from the server.
Privilege module
Login
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#Systems",
"@odata.id": "/redfish/v1/Systems",
"@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",
"Description": "A collection of ComputerSystem resource instances",
"Members": [
{
"@odata.id": "/redfish/v1/Systems/1"
}
],
"Members@odata.count": 1,
"Name": "Computer System Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Description |
String |
Description of the system collection resource. |
|
Members@odata.count |
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
Login
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_13_0.ComputerSystem",
"Actions": {
"#ComputerSystem.Reset": {
"ResetType@Redfish.AllowableValues": [
"ForceOff",
"ForcePowerCycle",
"ForceRestart",
"GracefulShutdown",
"Nmi",
"On"
],
"target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset"
},
"Oem": {
"Public": {
"#ComputerSystem.ClearConfiguration": {
"SecureErase@Redfish.AllowableValues": [
"BIOS",
"Storage",
"BMC"
],
"target": "/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ClearConfiguration"
},
"#ComputerSystem.ResetCPLD": {
"ResetType@Redfish.AllowableValues": [
"ForceRestart"
],
"target": "/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.ResetCPLD"
},
"#Systems.ExportReport": {
"@Redfish.AllowableValues": [
""
],
"target": "/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ExportReport"
}
}
}
},
"AssetTag": "test_123",
"Bios": {
"@odata.id": "/redfish/v1/Systems/1/Bios"
},
"BiosVersion": "6.00.01",
"Boot": {
"BootSourceOverrideEnabled": "Once",
"BootSourceOverrideEnabled@Redfish.AllowableValues": [
"Continuous",
"Once"
],
"BootSourceOverrideMode": "None",
"BootSourceOverrideMode@Redfish.AllowableValues": [
"Legacy",
"None",
"UEFI"
],
"BootSourceOverrideTarget": "None",
"BootSourceOverrideTarget@Redfish.AllowableValues": [
"BiosSetup",
"Cd",
"Hdd",
"None",
"Pxe"
]
},
"ChassisPartNumber": "0235AQ7",
},
"Description": "System 1",
"Healthstate": {
"OverallHealth": "Critical",
"board": "OK",
"fans": "OK",
"memory": "OK",
"pcie": "OK",
"power": "Critical",
"processor": "OK",
"storage": "OK",
"temperature": "OK"
},
"HostName": "HDM",
"Id": "1",
"IndicatorLED": "Off",
"Links": {
"Chassis": [
{
"@odata.id": "/redfish/v1/Chassis/1"
}
],
"ManagedBy": [
{
"@odata.id": "/redfish/v1/Managers/1"
}
],
"PCIeDevices": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/6"
},
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/7"
}
],
"PCIeFunctions": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/6/Functions/1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/7/Functions/1"
}
]
},
"LogServices": {
"@odata.id": "/redfish/v1/Systems/1/LogServices"
},
"MaintenanceSerialNumber": "",
"Manufacturer": "H3C",
"Memory": {
"@odata.id": "/redfish/v1/Systems/1/Memory"
},
"MemorySummary": {
"Count": 1,
"MaxCountSupported": 32,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"TotalSystemMemoryGiB": 32
},
"Model": "RS33M2C9S",
"Name": "Computer System",
"NetworkInterfaces": {
"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"
},
"Oem": {
"Public": {
"AlarmEventSummary": {
"CriticalAlarmCount": 0,
"MajorAlarmCount": 2,
"MinorAlarmCount": null
},
"BiosVendor": "AMI",
"ClearConfigurationProgress": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/ClearConfigurationProgress"
},
"CompletionCode": 0,
"ComputeModuleMaxCount": 1,
"ConfigurationModel":null,
"Description": "Success",
"FirmwareInformation": {
"BiosFirmwareBuildDate": "2022-10-13T12:12:52+08:00",
"BiosInternalFirmwareVersion": "V100R001B01D001_DEBUG",
"MEFirmwareVersion": "6.0.3.176"
},
"GPU": {
"@odata.id": "/redfish/v1/Systems/1/GPU"
},
"HostNameSetupMode": "Auto",
"HostStatus": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/HostStatus"
},
"IndependentPowerSupply": false,
"NodeType":null,
"POSTRoutines": {
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines"
},
"PUID": "R3950-G7-ABCD",
"PanelPowerButtonEnabled": true,
"PowerOnStrategy": "RestorePreviousState",
"PresentComputeModules": [
"CM1"
],
"SecurityBezel": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/SecurityBezel"
},
"SoftwareList": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/SoftwareList"
}
"BootSmallOption":{
"CD/DVD": {
…
},
"Hard Disk": {
"BootSmallOption1": "UEFI:KingstonDataTraveler 2.0PMAP, Partition 4,0x0002",
…
},
"Network": {
…
},
"Other Device": {
…
}
}
}
},
"PartNumber": "",
"PowerState": "On",
"ProcessorSummary": {
"Count": 1,
"MaxCountSupported": 2,
"Model": "Intel(R) Xeon(R) Platinum 8450H",
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"TotalCores": 28,
"TotalThreads": 56
},
"Processors": {
"@odata.id": "/redfish/v1/Systems/1/Processors"
},
"SerialNumber": "",
"Status": {
"Health": "Critical",
"HealthRollup": "Critical",
"Oem": {
"Public": {
"Severity": "Major"
}
},
"State": "Enabled"
},
"Storage": {
"@odata.id": "/redfish/v1/Systems/1/Storages"
},
"StorageControllerSummary": {
"LogicalDriveCount": 0,
"PhysicalDriveCount": 0,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Absent"
},
"StorageControllerCount": 0
},
"SystemType": "Physical",
"UUID": "98e83cd0-7a2c-1000-02ff-aabbccd24718",
"Uptime_hours": "7",
"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. |
|
ResetType@Redfish.AllowableValues |
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. |
|
Actions.Oem.Public |
Custom Actions executable operations. |
|
|
ComputerSystem.ClearConfiguration |
Object |
Clear configuration operation. |
|
SecureErase@Redfish.AllowableValues |
Array |
Allowed types for clearing configuration. Supported options: · BIOS. · Storage. · BMC. |
|
target |
String |
Link to the clear configuration operation. |
|
ComputerSystem.DownloadReport |
Object |
Operation of the download clear configuration report. |
|
DownloadReport@Redfish.AllowableValues |
Array |
Allowed types for clearing configuration are only displayed as "". |
|
target |
String |
Link to download clear report operation. |
|
ComputerSystem.ResetCPLD |
Object |
Restart CPLD operation. |
|
ResetType@Redfish.AllowableValues |
Array |
Restart CPLD parameters include: ForceRestart. |
|
target |
String |
Link to restart CPLD operation. |
|
AssetTag |
String |
Asset tag of the system resource. Value range: 1 to 48. |
|
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. |
|
BootSourceOverrideEnabled@Redfish.AllowableValues |
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. The Phytium platform does not support the Legacy mode. |
|
BootSourceOverrideMode@Redfish.AllowableValues |
Array |
Available boot modes. Supported options: · None. · Legacy—Legacy mode. · UEFI—UEFI mode. The Phytium platform does not support the Legacy mode. |
|
BootSourceOverrideTarget |
String |
Current boot device. Supported options: · None. · Hdd. · Pxe. · BiosSetup. · Cd. |
|
BootSourceOverrideTarget@Redfish.AllowableValues |
Array |
Available boot devices. Supported options: · None. · Hdd. · Pxe. · BiosSetup. · Cd. |
|
ChassisPartNumber |
String |
Part number of the system board chassis domain. R6900 and R8900 are the names of mid planes. |
|
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. |
|
PCIeDevices |
Object array |
Link to PCIe resource node. |
|
PCIeFunctions |
Object array |
Link to PCIe function resource node. |
|
LogServices |
Object |
Link to the log service collection resource. |
|
MaintenanceSerialNumber |
String |
Maintenance serial number. |
|
Manufacturer |
String |
Manufacturer. |
|
Memory |
Object |
Link to a memory resource. |
|
MemorySummary/StorageControllerSummary/ProcessorSummary |
Module summary information. |
|
|
Count |
Integer |
Current numbers. |
|
MaxCountSupported |
Integer |
Maximum supported numbers. |
|
Status |
Object |
Summary resource status. Supported options: · Health—Summary resource health status. · State—Summary resource enabling status. · HealthRollup—Overall health status. · Oem.Public.FaultDescription—Overall fault description. · Oem.Public.Severity—Custom health status. The overall fault description is related to the overall component fault, independent of individual component fault information. |
|
MemorySummary.TotalSystemMemoryGiB |
Integer |
Capacity of the total memory. |
|
StorageControllerSummary.StorageControllerCount |
Integer |
Number of storage controllers. |
|
StorageControllerSummary.LogicalDriveCount |
Integer |
Number of logical drives. |
|
StorageControllerSummary.PhysicalDriveCount |
Integer |
Number of physical drives. |
|
ProcessorSummary.TotalCores |
Integer |
Total CPU cores in the system. |
|
ProcessorSummary.TotalThreads |
Integer |
Total CPU threads in the system. |
|
ProcessorSummary.Model |
String |
First CPU model in the system. |
|
SerialNumber |
String |
Product serial number. |
|
Status |
Object |
Status of the system resource. Supported options: · Health—Health status. · State—Enabling status. |
|
Storage |
Object |
Link to a storage resource node. |
|
Processors |
Object |
Link to a processor resource node. |
|
Model |
String |
Product model. |
|
Name |
String |
System resource name. |
|
NetworkInterfaces |
Object |
Link to a network interface resource. |
|
PartNumber |
String |
Product part number. |
|
PowerState |
String |
Power state. Supported options: · On. · Off. |
|
Oem.Public |
Custom attributes. |
|
|
AlarmEventSummary |
Object |
Alarm summary information. |
|
CriticalAlarmCount |
Integer |
Number of fatal alarms. |
|
MajorAlarmCount |
Integer |
Number of critical alarms.. |
|
MinorAlarmCount |
Integer |
Number of minor alarms. |
|
Oem.Public.BiosVendor |
String |
Software vendor of the system resource BIOS. |
|
Oem.Public.PanelPowerButtonEnabled |
Boolean |
Ear-mounted power button enabled. |
|
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.PUID |
String |
Product usage ID. |
|
Oem.Public.ClearConfigurationProgress |
Object |
Obtain detailed progress of configuration clearance. |
|
Oem.Public.FirmwareInformation.MEFirmwareVersion |
String |
ME version information |
|
Oem.Public.FirmwareInformation.BiosFirmwareBuildDate |
String |
BIOS firmware build time. N/A indicates a failure to obtain this field. |
|
Oem.Public.FirmwareInformation.BiosInternalFirmwareVersion |
String |
BIOS firmware version. |
|
Oem.Public.GPU |
Object |
Link to the CPU resource. |
|
Oem.Public.HostNameSetupMode |
String |
Hostname setting mode. Supported options: · Auto—Automatic mode. · Manual—Manual mode. |
|
Oem.Public.HostStatus |
Object |
Obtain host status migration link. |
|
Oem.Public.IndependentPowerSupply |
Boolean |
Whether independent power supply is supported for the standard PCIe slot. |
|
Oem.Public.POSTRoutines |
Object |
Link to the power-on self-test code processor resource node. |
|
Oem.Public.SecurityBezel |
Object |
Link to the security panel. |
|
Oem.Public.SoftwareList |
Object |
Link to the system software list. |
|
Oem.Public.ComputeModuleMaxCount |
Integer |
Maximum node count supported by current model. |
|
Oem.Public.PresentComputeModules |
Array |
Current compute storage resource node. |
|
String |
Product package information. |
|
|
Oem.Public.BootSmallOption |
Object |
BIOS minimal boot option. |
|
BootSmallOptionX |
String |
Name of the minimal boot option, where X represents the sequence starting from 1. |
|
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. Value range: 1 to 48. |
Change history
|
Version |
Change description |
|
HDM3-2.04 |
Added the Oem.Public.PUID field. |
|
HDM3-1.07 |
The Phytium platform does not support the Legacy mode. |
|
HDM2-2.04 |
Added the Oem.Public.ConfigurationModel field. |
|
HDM2-1.58 |
Added the BIOS minimal boot option. |
|
HDM2-1.57 |
Added the Oem.Public.NodeType field. |
|
HDM2-1.52 |
Added the ChassisPartNumber field. |
Configure system resource properties
Description
Configure the properties of a specific system resource.
Privilege module
OemKvm, ConfigureComponents, and OemPowerControl
Locking type of the associated system
BIOS configuration locking (only applicable when configuring BIOS-related properties), BMC configuration locking (not applicable when configuring BIOS-related properties)
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
},
"Oem": {
"Public": {
"PanelPowerButtonEnabled": true,
"HostNameSetupMode": "Manual",
"BootSmallOption": {
"CD/DVD": {
…
},
"Hard Disk": {
"BootSmallOption1":"UEFI: KingstonDataTraveler 2.0PMAP, Partition 4,0x0002",
…
},
"Network": {
…
},
"Other Device": {
…
}
}
}
}
}
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. |
Length of the field string. · Mobile CID—1 to 48. · Mainline—1 to 63. |
|
Boot.BootSourceOverrideMode |
Next boot mode. |
Supported options: · None. · Legacy—Legacy mode. · UEFI—UEFI mode. The Phytium platform does not support the Legacy 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. |
|
Oem.Public.PanelPowerButtonEnabled |
Boolean. |
Ear-mounted power button enablement. |
|
Oem.Public.HostNameSetupMode |
Hostname setup mode. |
Supported options: · Auto—Automatic mode. · Manual—Manual mode. |
|
Oem.Public.BootSmallOption |
Object |
BIOS minimal boot option. |
|
BootSmallOptionX |
String |
Name of the minimal boot option, where X represents the sequence starting from 1. |
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.
When only the HostName is set, the HostNameSetupMode field is set to Manual by default.
When BMC configuration is locked, parameters within the Boot structure cannot be mixed with other parameters for deployment.
Examples
Method and URL:
PATCH 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"
},
"Oem": {
"Public": {
"HostNameSetupMode": "Manual",
"BootSmallOption": {
"CD/DVD": {},
"Hard Disk": {
"BootSmallOption1":"UEFI: KingstonDataTraveler 2.0PMAP, Partition 4,0x0002"
},
"Network": {},
"Other Device": {}
}
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem(*)",
"@odata.id": "/redfish/v1/Systems/1",
"@odata.type": "#ComputerSystem.v1_13_0.ComputerSystem",
"Actions": {
"#ComputerSystem.Reset": {
"ResetType@Redfish.AllowableValues": [
"ForceOff",
"ForcePowerCycle",
"ForceRestart",
"GracefulShutdown",
"Nmi",
"On"
],
"target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset"
},
"Oem": {
"Public": {
"#ComputerSystem.ClearConfiguration": {
"SecureErase@Redfish.AllowableValues": [
"BIOS",
"Storage",
"BMC"
],
"target": "/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ClearConfiguration"
},
"#ComputerSystem.ResetCPLD": {
"ResetType@Redfish.AllowableValues": [
"ForceRestart"
],
"target": "/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.ResetCPLD"
},
"#Systems.ExportReport": {
"@Redfish.AllowableValues": [
""
],
"target": "/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ExportReport"
}
}
}
},
"AssetTag": "test_123",
"Bios": {
"@odata.id": "/redfish/v1/Systems/1/Bios"
},
"BiosVersion": "6.00",
"Boot": {
"BootSourceOverrideEnabled": "Once",
"BootSourceOverrideEnabled@Redfish.AllowableValues": [
"Continuous",
"Once"
],
"BootSourceOverrideMode": "UEFI",
"BootSourceOverrideMode@Redfish.AllowableValues": [
"Legacy",
"None",
"UEFI"
],
"BootSourceOverrideTarget": "Pxe",
"BootSourceOverrideTarget@Redfish.AllowableValues": [
"BiosSetup",
"Cd",
"Hdd",
"None",
"Pxe"
]
},
},
"ChassisPartNumber": "0235AQ7",
"Description": "System 1",
"Healthstate": {
"OverallHealth": "Critical",
"board": "OK",
"fans": "OK",
"memory": "OK",
"pcie": "OK",
"power": "Critical",
"processor": "OK",
"storage": "OK",
"temperature": "OK"
},
"HostName": "HDM12315555777745557765",
"Id": "1",
"IndicatorLED": "Lit",
"Links": {
"Chassis": [
{
"@odata.id": "/redfish/v1/Chassis/1"
}
],
"ManagedBy": [
{
"@odata.id": "/redfish/v1/Managers/1"
}
],
"PCIeDevices": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/16"
}
],
"PCIeFunctions": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/16/Functions/1"
}
]
},
"LogServices": {
"@odata.id": "/redfish/v1/Systems/1/LogServices"
},
"MaintenanceSerialNumber": "",
"Manufacturer": "H3C",
"Memory": {
"@odata.id": "/redfish/v1/Systems/1/Memory"
},
"MemorySummary": {
"Count": 1,
"MaxCountSupported": 32,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"TotalSystemMemoryGiB": 32
},
"Model": "RS33M2C9S",
"Name": "Computer System",
"NetworkInterfaces": {
"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"
},
"Oem": {
"Public": {
"AlarmEventSummary": {
"CriticalAlarmCount": 0,
"MajorAlarmCount": 1,
"MinorAlarmCount": null
},
"BiosVendor": "AMI",
"ClearConfigurationProgress": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/ClearConfigurationProgress"
},
"CompletionCode": 0,
"ComputeModuleMaxCount": 1,
"ConfigurationModel":null,
"Description": "Success",
"FirmwareInformation": {
"BiosInternalFirmwareVersion": "V100R001B06BBIT05",
"MEFirmwareVersion": "6.0.3.159"
},
"GPU": {
"@odata.id": "/redfish/v1/Systems/1/GPU"
},
"HostNameSetupMode": "Manual",
"IndependentPowerSupply": false,
"NodeType":null,
"POSTRoutines": {
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines"
},
"PanelPowerButtonEnabled": true,
"PowerOnStrategy": "RestorePreviousState",
"PresentComputeModules": [
"CM1"
],
"SecurityBezel": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/SecurityBezel"
},
"SoftwareList": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/SoftwareList"
}
"BootSmallOption": {
"CD/DVD": {},
"Hard Disk": {
"BootSmallOption1":"UEFI: KingstonDataTraveler 2.0PMAP, Partition 4,0x0002"
},
"Network": {},
"Other Device": {}
}
}
},
"PartNumber": "",
"PowerState": "Off",
"ProcessorSummary": {
"Count": 1,
"MaxCountSupported": 2,
"Model": "Genuine Intel(R) CPU 0000%@",
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"TotalCores": 48,
"TotalThreads": 96
},
"Processors": {
"@odata.id": "/redfish/v1/Systems/1/Processors"
},
"SerialNumber": "",
"Status": {
"Health": "Critical",
"HealthRollup": "Critical",
"Oem": {
"Public": {
"Severity": "Major"
}
},
"State": "Enabled"
},
"Storage": {
"@odata.id": "/redfish/v1/Systems/1/Storages"
},
"StorageControllerSummary": {
"LogicalDriveCount": 0,
"PhysicalDriveCount": 0,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Absent"
},
"StorageControllerCount": 0
},
"SystemType": "Physical",
"UUID": "ff777238-ec31-1000-03f2-aabbccd24718",
"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 |
|
HDM3-1.07 |
The Phytium platform does not support the Legacy mode. |
|
HDM3-1.12 |
When the HostName is set, the HostNameSetupMode field is set to Manual by default. |
|
HDM2-1.58 |
Added the BIOS minimal boot option. |
|
HDM2-1.52 |
Added the locking type of the associated system. |
|
HDM2-1.16 |
Added the redfish/v1/Systems/system_id interface. Added Usage guidelines in the Description. If you are setting HostName, also set the HostNameSetupMode field to Manual. At the same time, changed the HostNameSetupMode field in the Examples to Manual. |
Obtain boot self-test order
Description
Obtain the boot self-test order.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Bios/Oem/Public/POSTRoutines
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/Oem/Public/POSTRoutines
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#POSTRoutines.POSTRoutines",
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines",
"@odata.type": "#POSTRoutines.v1_0_0.POSTRoutines",
"Description": "A Collection of POST routines.",
"Entries": {
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries"
},
"Name": "POST Routines Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"POSTState": "Post To Setup"
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description for boot self-test order collection model. |
|
@odata.id |
String |
Link to boot self-test order collection. |
|
@odata.type |
String |
Resource type of boot self-test order collection. |
|
Description |
String |
Interface function description. |
|
Entries |
Object |
Boot self-test order resource list. |
|
Name |
String |
Name of boot self-test order collection resource. |
|
POSTState |
String |
POSTState description. |
Obtain information about boot self-test code collection resource
Description
Obtain information about boot self-test code collection resource.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Bios/Oem/Public/POSTRoutines/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. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#POSTRoutinesEntryCollection.POSTRoutinesEntryCollection",
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries",
"@odata.type": "#POSTRoutinesCollection.POSTRoutinesEntryCollection",
"Description": "A Collection of Entry routines.",
"Members": [
{
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/1"
},
{
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/2"
},
{
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/3"
},
{
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/4"
},
{
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/5"
},
…
{
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/315"
},
{
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/316"
}
],
"Members@odata.count": 316,
"Members@odata.nextLink": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries?$skip=100&$top=100",
"Name": "POST Routines Entries Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description for boot self-test collection resource information model |
|
@odata.id |
String |
Link to boot self-test collection resource information. |
|
@odata.type |
String |
Type of boot self-test collection resource information. |
|
Members |
Array |
Information list of the boot self-test code collection resource. |
|
Description |
String |
Description of boot self-test collection resource. |
|
Members@odata.count |
Integer |
Number of boot self-test collection resource information. |
|
Name |
String |
Name of boot self-test collection resource information. |
|
Members@odata.nextLink |
String |
Link to the boot self-test code collection resource on multiple pages. |
Obtain information about specified boot self-test code
Description
Obtain information of the specified boot self-test order.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Bios/Oem/Public/POSTRoutines/Entries/entries_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. |
|
entries_id |
ID of the boot self-test code collection resource. |
You can obtain available IDs from the boot self-test collection resource information. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#POSTRoutinesInstance.POSTRoutinesInstance",
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/POSTRoutines/Entries/3",
"@odata.type": "#POSTRoutinesInstance.v1_0_0.POSTRoutinesInstance",
"Description": "Bios POST Routines Information",
"Id": "3",
"Name": "Bios POST Routines Information",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"POSTCode": "0x0002",
"POSTCodeDescription": "MICROCODE Initialization",
"TimeStamp": "2019-02-18T17:51:02+08:00"
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description for boot self-test code resource model. |
|
@odata.id |
String |
Link to boot self-test code resource. |
|
@odata.type |
String |
Type of boot self-test code information. |
|
Id |
String |
ID of the boot self-test code resource. |
|
Name |
String |
Name of the boot self-test code resource. |
|
Description |
String |
Description of the boot self-test code resource. |
|
POSTCodeDescription |
String |
Detailed description of current boot self-test stage. |
|
POSTCode |
String |
Current boot self-test code. |
|
TimeStamp |
String |
Timestamp. |
Perform a power operation
Description
Perform a system power reset operation (power-on, forced power-off, graceful power-off, or forced restart).
Privilege module
OemPowerControl
Locking type of the associated system
Power control locking
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. · PowerCycle—Forced power-cycle. This action has the same effect as ForcePowerCycle. |
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:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.56 |
Added the PowerCycle field. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Restart CPLD
Description
This feature allows for the CPLD firmware to be restarted after an upgrade or if anomalies occur, without the need to power off the server.
For information about CPLD types that support restarting, see H3C Servers HDM2 User Guide.
Privilege module
OemDiagnosis
Request
Method and URL:
POST https://device_ip/redfish/v1/Systems/system_id/Actions/Oem/Public/ComputerSystem.ResetCPLD
Request header:
X-Auth-Token:TOKEN
Content-Type:application/jso
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. |
|
system_id |
ID of the system resource. |
Only value 1 is supported. |
|
ResetType |
ForceRestart: Restart CPLD. |
String. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Systems/1/Actions/Oem/Public/ComputerSystem.ResetCPLD
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"ResetType":"ForceRestart"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended action for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
· Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. · Changed the interface description. |
Obtain processor collection information
Description
Obtain information about all processors from the server.
Privilege module
Login
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:
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/Processors
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
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"
}
],
"Members@odata.count": 2,
"Name": "Processors Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"CpuUsageRatePercent": 60,
"Description": "Success",
"UsageAlarmThreshold": 75
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the processor collection resource model. |
|
@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. |
|
Members@odata.count |
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. |
|
Oem.Public. UsageAlarmThreshold |
Integer |
CPU usage alarm threshold. Value range: 0 to 100. This field displays null if the usage failed to be obtained. |
Set alarm threshold for processor usage
Description
Set the alarm threshold for processor usage.
Privilege module
OemKvm
Request
Method and URL:
PATCH 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. |
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#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"
}
],
"Members@odata.count": 2,
"Name": "Processors Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"CpuUsageRatePercent": 60,
"Description": "Success",
"UsageAlarmThreshold": 75
}
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain processor collection information."
Obtain processor information
Description
Obtain information about a specific processor from the server.
Privilege module
Login
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
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. |
|
cpu_id |
ID of the processor resource. |
You can obtain available processor IDs from processor collection resource information. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/Systems/1/Processors/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response 1:
{
"@odata.context": "/redfish/v1/$metadata#Processor.Processor(*)",
"@odata.id": "/redfish/v1/Systems/1/Processors/1",
"@odata.type": "#Processor.v1_10_0.Processor",
"ChopType": "",
"Id": "1",
"InstructionSet": "x86-64",
"Manufacturer": "Intel(R) Corporation",
"MaxSpeedMHz": 4000,
"Model": "Genuine Intel(R) CPU 0000%@",
"Name": "CPU1",
"Actions": {
"Oem": {
"Public":{
"#Processor.LicenseUpload": {
"target":"/redfish/v1/Systems/1/Processors/1/Actions/Oem/Public/Processor.LicenseUpload"
},
"#Processor.StateReportExport": {
"target":"/redfish/v1/Systems/1/Processors/1/Actions/Oem/Public/Processor.StateReportExport"
}
}
}
},
"Oem": {
"Public": {
"64BitSupported": true,
"CompletionCode": 0,
"Description": "Success",
"FrequencyMHz": 1500,
"ChipId": null,
"CoreEnabledCount": 32,
"L1CacheKiB": 3840,
"L2CacheKiB": 34304,
"L3CacheKiB": 34208,
"MaxSpeed": null,
"SerialNumber": "07-9A-3E-43-60-E1-C5-50",
"Temperature": 4294967295,
"ThermalDesignPower":null,
"ThreadEnabledCount": 32,
"Capability": :[
{
"Name": "CSS4",
"State": "Enabled"
},
{
"Name": "AMS4",
"State": "Disabled"
},
{
"Name": "AMS1",
"State": "Disabled"
},
{
"Name": "CSS2",
"State": "Disabled"
},
{
"Name": "SGX512",
"State": "Enabled"
}
]
}
},
"Ppin": "07-9A-3E-43-60-E1-C5-50",
"ProcessorArchitecture": "x86",
"ProcessorId": {
"IdentificationRegisters": "F3-06-08-00-FF-FB-EB-BF",
"Step": ""
},
"ProcessorType": "CPU",
"Socket": 1,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"TDPWatts":null,
"TotalCores": 48,
"TotalThreads": 96
}
Response code: 200
Response 2 (Phytium):
{
"@odata.context": "/redfish/v1/$metadata#Processor.Processor(*)",
"@odata.id": "/redfish/v1/Systems/1/Processors/1",
"@odata.type": "#Processor.v1_10_0.Processor",
"ChopType": "",
"Id": "1",
"InstructionSet": "Aarch64",
"Manufacturer": "Phytium",
"MaxSpeedMHz": 2100,
"Model": "S5000C-64",
"Name": "CPU1",
"Oem": {
"Public": {
"64BitSupported": true,
"ChipId": "KPA5691504160000",
"CompletionCode": 0,
"CoreEnabledCount": null,
"Description": "Success",
"FrequencyMHz": 2100,
"L1CacheKiB": 4096,
"L2CacheKiB": 32768,
"L3CacheKiB": 32768,
"MaxSpeed": null,
"SerialNumber": "KPA5691504160000",
"Temperature": 4294967295,
"ThermalDesignPower": null
"ThreadEnabledCount": null,
}
},
"Ppin": null,
"ProcessorArchitecture": "ARMv8",
"ProcessorId": {
"IdentificationRegisters": "20-86-0F-70-00-00-00-00",
"Step": ""
},
"ProcessorType": "CPU",
"Socket": 1,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"TDPWatts":null,
"TotalCores": 64,
"TotalThreads": 64
}
Response code: 200
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. |
|
Actions |
Actions allowed by Redfish that can be perform on specific CPU resources. |
|
|
Actions.Oem.Public |
Custom actions that can be performed. |
|
|
#Processor.LicenseUpload |
Object |
Upload operation of the Intel On Demand License activation file. |
|
target |
String |
Operation path for uploading the Intel On Demand License activation file. |
|
#Processor.StateReportExport |
Object |
Export operation of the CPU status report. |
|
target |
String |
Path for exporting the CPU status report. |
|
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. |
|
TDPWatts |
Integer |
Power consumption of CPU thermal design. |
|
TotalCores |
Integer |
Total number of cores in the processor. |
|
TotalThreads |
Integer |
Maximum number of threads supported by the processor. |
|
ChopType |
String |
Architecture type. |
|
Oem.Public.ChipId |
String |
CPU identifier, available only for the Phytium CPU platform. |
|
Oem.Public.CoreEnabledCount |
Integer |
Actual number of CPU cores. |
|
Oem.Public.ThreadEnabledCount |
Integer |
Actual number of CPU threads. |
|
Oem.Public.L1CacheKiB |
Integer |
L1 cache size. |
|
Oem.Public.L2CacheKiB |
Integer |
L2 cache size. |
|
Oem.Public.L3CacheKiB |
Integer |
L3 cache size. |
|
Oem.Public.MaxSpeed |
String |
Maximum PCIe speed. |
|
Oem.Public.SerialNumber |
String |
Serial number of the processor. |
|
Oem.Public.Temperature |
Integer |
Processor temperature. |
|
Oem.Public.ThermalDesignPower |
Integer |
Power consumption of CPU thermal design. |
|
Oem.Public.FrequencyMHz |
Integer |
Base frequency of the processor. |
|
Oem.Public.64BitSupported |
Boolean |
Whether it supports 64-bit. |
|
Oem.Public.Capability |
Array |
Intel On Demand feature and status for a specific CPU. |
|
Oem.Public.Capability.Name |
String |
Intel On Demand features supported on a specific CPU: · CSS4 · AMS4 · AMS1 · CSS2 · SGX512 |
|
Oem.Public.Capability.State |
String |
Enabling status of Intel On Demand on a specific CPU: · Enabled. · Disabled. |
|
Ppin |
String |
Protected Processor Inventory Number (PPIN). |
|
ProcessorArchitecture |
String |
Architecture of the processor. |
|
ProcessorId |
Object |
ID of the processor. |
|
Step |
String |
Step frequency. |
Change history
|
Version |
Change description |
|
HDM2-2.15 |
Added the TDPWatts field. |
|
HDM3-1.19 |
Added the Oem.Public.MaxSpeed field. |
|
HDM3-1.18 |
Added the Oem.Public.CoreEnabledCount and Oem.Public.ThreadEnabledCount fields. |
|
HDM3-1.09 |
Added the Oem.Public.ChipId field. |
|
HDM2-2.03 |
Changed the Actions field to Actions.Oem.Public. |
|
HDM2-2.02 |
Added Intel On Demand information. |
|
HDM2-1.57 |
Added the Oem.Public.ThermalDesignPower field. |
Obtain memory collection information
Description
Obtain information about all memory modules from the server.
Privilege module
Login
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. |
|
system_id |
ID of the system resource. |
Only value 1 is supported. |
|
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/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",
"Description": "A Collection of memory resource instances.",
"Members": [
{
"@odata.id": "/redfish/v1/Systems/1/Memory/DIMM110"
},
{
"@odata.id": "/redfish/v1/Systems/1/Memory/DIMM210"
}
],
"Members@odata.count": 2,
"Name": "Memory Module Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"PowerWatts": 0,
"RASConfig": {
"ADDDCSparing": "Disabled",
"ECC": "Enabled",
"MirrorMode": "Partial Mirror Mode",
"PatrolScrub": "Enable at End of POST",
"SDDC": 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. |
|
Description |
String |
Description of the interface. |
|
Members |
Array |
List of memory resources. |
|
Members@odata.count |
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. |
|
RASConfig |
Object |
RAS configuration information. |
|
ADDDCSparing |
String |
ADDDCSparing status. Supported options: · Enabled. · Disabled. |
|
ECC |
String |
ECC status. Supported options: · Enabled. · Disabled. |
|
MirrorMode |
String |
MirrorMode status. Supported options: · Partial Mirror Mode. · Full Mirror Mode. · Disabled. |
|
PatrolScrub |
String |
PatrolScrub status. Supported options: · Enabled. · Disabled. · Enable at End of POST. |
|
SDDC |
String |
SDDC status. Supported options: · Enabled. · Disabled. |
Obtain memory information
Description
Obtain information about a specific memory module from the server.
Privilege module
Login
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#Systems/Members/1/Memory/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/Memory/DIMM110",
"@odata.type": "#Memory.v1_10_0.Memory",
"AllowedSpeedsMHz": [
4800
],
"BaseModuleType": "RDIMM",
"BusWidthBits": 80,
"CapacityMiB": 32768,
"DCPMMType": null,
"DataWidthBits": 64,
"DeviceLocator": "CPU1_CH1_D0",
"ErrorCorrection": "NoECC",
"FirmwareRevision": null,
"Id": "DIMM110",
"IsRankSpareEnabled": false,
"IsSpareDeviceEnabled": false,
"Manufacturer": "Micron",
"MemoryDeviceType": "DDR5",
"MemoryLocation": {
"Channel": 1,
"Controller": 0,
"Slot": 0,
"Socket": 1
},
"Name": "DIMM110",
"Oem": {
"Public": {
"AccumulatedPowerOnHours": null,
"Authenticity": "Normal",
"CapacityGiB":32,
"CompletionCode": 0,
"ControllerTemperatureCelsius": null,
"Description": "Success",
"DisabledCausation": null,
"MediumTemperatureCelsius": null,
"Model": "MTC20F1045S1RC48BAX",
"Technology": "RDIMM",
"VDDQVolt": "1.1V",
"OperatingSpeedMegaTransfersPerSecond": 4800,
"AllowedSpeedsMegaTransfersPerSecond": [
4800
]
}
},
"OperatingSpeedMhz": 4800,
"PartNumber": "MTC20F1045S1RC48BAX",
"PersistentRegionSizeLimitMiB": null,
"PowerManagementPolicy": {
"PolicyEnabled": false
},
"RankCount": 1,
"RemainingServiceLifePercent": null,
"SecurityCapabilities": {
"PassphraseCapable": false
},
"SerialNumber": "2B6BAE3E",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"VolatileRegionSizeLimitMiB": null
}
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. |
|
ErrorCorrection |
String |
Error correction method. Supported options: · MultiBitECC. · NoECC. · SingleBitECC. · AddressParity. |
|
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. |
|
Oem.Public.MediumTemperatureCelsius |
Integer |
Memory medium temperature. |
|
Oem.Public.ControllerTemperatureCelsius |
Integer |
Memory controller temperature. |
|
Oem.Public.AccumulatedPowerOnHours |
Integer |
Cumulative power-on time (Hour). |
|
Oem.Public.OperatingSpeedMegaTransfersPerSecond |
Integer |
Current operating speed of the specified memory module. |
|
Oem.Public.AllowedSpeedsMegaTransfersPerSecond |
Integer |
Maximum memory speed. |
|
Oem.Public.DisabledCausation |
String |
Description of memory disable reasons. |
|
Oem.Public.CapacityGiB |
Integer |
Memory capacity, in GiB. |
|
Name |
String |
Name of the memory module. |
|
OperatingSpeedMhz |
Integer |
Current operating speed of the memory module. |
|
AllowedSpeedsMHz |
Array |
Maximum memory speed. |
|
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. Supported options: · Enabled. · Disabled. · Absent. |
|
Status.State |
String |
Enabling status of the memory module. |
|
Status.Oem.Public.FaultDescription |
String |
Fault description of specified memory module. |
|
Status.Oem.Public.Severity |
String |
Custom health status of specified memory module. |
|
Manufacturer |
String |
Manufacturer name of the specified memory module. |
|
FirmwareRevision |
String |
Memory firmware version. |
|
VolatileRegionSizeLimitMiB |
Integer |
Volatile capacity of specified memory module (MiB). |
|
PersistentRegionSizeLimitMiB |
Integer |
Persistent capacity of specified memory module (MiB). |
|
RemainingServiceLifePercent |
Integer |
Remaining lifespan of specified memory module. |
|
DCPMMType |
String |
Operating mode: · Memory Mode—Memory mode. · APP Direct Mode—Application direct access mode. · Mixed Mode—Mixed mode. |
|
DataWidthBits |
Integer |
Memory data width. |
|
BusWidthBits |
Integer |
Memory bus width. |
Change history
|
Version |
Change description |
|
HDM2-1.57 |
Added the Oem.Public.CapacityGiB field. |
Obtain storage controller collection information
Description
Obtain information about all storage controllers from the server.
Privilege module
Login
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": [],
"Members@odata.count": 0,
"Name": "Storage Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"Status": {
"Health": "OK",
"State": "Starting"
}
}
}
}
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. |
|
Members@odata.count |
Integer |
Number of storage controller resources. |
|
Name |
String |
Name of the storage controller resource list. |
|
Oem.Public.Status.State |
String |
Overall storage controller status. Supported options: · Starting—BIOS initializing. · Disabled—Faulty or disabled. · UnavailableOffline—Server powered off. · Enabled—Normal. · Absent—Absent. · UnKnow—Unknown status. |
|
Oem.Public.Status.Health |
String |
Health status of the overall storage controller. |
Obtain storage controller information
Description
Obtain information about a specific storage controller from the server.
Privilege module
Login
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_9_0.Storage",
"Actions": {
"Oem": {
"Public": {
"#Storage.ClearConfiguration": {
"target": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearConfiguration"
},
"#Storage.ClearForeignConfiguration": {
"target": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearForeignConfiguration"
}
}
}
},
"Drives": [
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront5"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront6"
}
],
"Drives@odata.count": 3,
"Id": "RAIDStorage0",
"Name": "RAIDStorage0",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
"IdleDriveSlots": [
{
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front2"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Oem/Public/IdleDriveSlots/Front6"
}
],
"IdleDriveSlots @odata.count": 3
}
},
"StorageControllers": [
{
"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0#/StorageControllers/0",
"AssetTag": "RAID-LSI-9560-LP-16i-8GB",
"CardManufacturer": "Broadcom",
"CardModel": "HBA-LSI-9500-LP-8i",
"FirmwareVersion": "5.160.02-3415",
"Manufacturer": "Broadcom",
"MemberId": "0",
"Model": "RAID-LSI-9560-LP-16i-8GB",
"Name": "RAID-LSI-9560-LP-16i-8GB",
"Oem": {
"Public": {
"AssociatedCard": {
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/5"
},
"BBUstate": "Miss",
"CapacitancePercent": null,
"CapacitanceStatus": {
"FaultDescription": "",
"Health": "OK",
"Severity": "Informational",
"State": "Absent"
},
"ChipManufacturer": "Broadcom",
"ChipModel": "LSI3916",
"ConfigurationVersion": "5.1600.00-0393",
"CopyBackState": true,
"DDRECCCount": 0,
"ExternalPortCount":null,
"FaultforLogicalDrives": [],
"FlashState": "Miss",
"InternalPortCount":16,
"JBODState": null,
"MaintainPDFailHistory": true,
"MaxStripeSizeBytes": 1048576,
"MemorySizeMiB": 8192,
"MinStripeSizeBytes": 65536,
"Mode": "RAID",
"PackageVersion": "52.16.0-3803",
"PSOCFirmwareVersion":"0x000C",
"SASAddress": "500062B208620140",
"SmarterCopyBackState": false,
"SpeedGTps": null
"SupportedConfigurationOperation": [
"ClearForeignConfiguration",
"ClearConfiguration",
"ModifyProperty",
"ManageVolumes",
"ModifyMode",
"ConfigureAccessPolicy",
"ConfigureWritePolicy",
"ConfigureReadPolicy",
"ConfigureDriveCachePolicy"
],
"SupportedRAIDLevels": [
"RAID0",
"RAID1",
"RAID5",
"RAID6",
"RAID10",
"RAID50",
"RAID60"
],
"SupportedRAIDMode": [
"RAID",
"JBOD"
],
"SupportedStripSize": [
"64KB",
"128KB",
"256KB",
"512KB",
"1MB"
],
"TemperatureCelsius": 48
}
},
"SerialNumber": "SKB3980100",
"SpeedGbps": 12,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"SupportedDeviceProtocols": [
"SAS/SATA"
]
}
],
"StorageControllers@odata.count": 1,
"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. |
|
Actions.Oem.Public |
Custom actions. |
|
|
Storage.ClearConfiguration |
Object |
Action for clearing all the configuration for the specified RAID controller. |
|
target |
String |
Action path for clearing all configurations on the specified RAID controller. |
|
Storage.ClearForeignConfiguration |
Object |
Action for clearing the physical drive Foreign state for the specified RAID controller. |
|
target |
String |
Action path for clearing the physical drive Foreign state for the specified RAID controller. |
|
Drives |
Array |
List of physical drive resources. |
|
Drives@odata.count |
Integer |
Number of physical drive resources. |
|
Id |
String |
ID of the storage controller resource. |
|
Name |
String |
Name of the storage controller resource. |
|
Oem.Public |
Custom properties. |
|
|
Oem.Public.IdleDriveSlotsStorageControllers.@odata.id |
Array |
Link to the resource of an empty slot. |
|
StorageControllers.Model |
String |
Model of the storage controller. |
|
StorageControllers.AssetTag |
String |
Asset tag of the storage controller. |
|
StorageControllers.CardManufacturer |
String |
Manufacturer of the storage controller. |
|
StorageControllers.CardModel |
String |
Storage controller model. |
|
StorageControllers.FirmwareVersion |
String |
Firmware version of the storage controller. |
|
StorageControllers.Manufacturer |
String |
Manufacturer of the storage controller. |
|
StorageControllers.MemberId |
String |
ID of the storage controller resource. |
|
StorageControllers.Name |
String |
Name of the storage controller. |
|
StorageControllers.Oem.Public.BBUstate |
String |
Supercapacitor status. Supported options: · N/A. · Learn. · LearnFail. · Over_temp. · Failed. · Fatal. · ChargeCompleted. · Charging. · Miss. · Present—This field is supported only by 3SNIC controllers. |
|
StorageControllers.Oem.Public.CapacitanceStatus |
Object |
Status of the storage controller capacitor (BBU). Supported options: · Health—Capacitor health status. · State—Capacitor enable status. · Severity—Custom health status. · FaultDescription—Fault description information. |
|
StorageControllers.Oem.Public.CapacitancePercent |
String |
Percentage of the supercapacitor charge. |
|
StorageControllers.Oem.Public.ChipModel |
String |
Chip model. |
|
StorageControllers.Oem.Public.ChipManufacturer |
String |
Chip manufacturer. Supported options: · Broadcom—LSI storage controller. · Microchip—PMC storage controller. · Marvell—Self-developed and outsourced Marvell controller. · 3SNIC—3SNIC controller. |
|
StorageControllers.Oem.Public.ConfigurationVersion |
String |
Controller card configuration version. |
|
StorageControllers.Oem.Public.CopyBackState |
Boolean |
Copyback status. |
|
StorageControllers.Oem.Public.DDRECCCount |
Integer |
Storage controller memory correctable error count. |
|
StorageControllers.Oem.Public.FlashState |
String |
Flash card status. Supported options: · Initializing. · Normal. · Miss. · Failed. · Warning. · Unknown. · N/A. |
|
StorageControllers.Oem.Public.FaultforLogicalDrives |
Array |
Current storage controller faulty logical drive list. |
|
StorageControllers.Oem.Public.JBODState |
Boolean |
JBOD status. |
|
StorageControllers.Oem.Public.MaintainPDFailHistory |
Boolean |
Storage drive fault record feature enable status. |
|
StorageControllers.Oem.Public.MinStripeSizeBytes |
Integer |
Controller supports minimum stripe value. |
|
StorageControllers.Oem.Public.MaxStripeSizeBytes |
Integer |
Controller supports maximum stripe value. |
|
StorageControllers.Oem.Public.MemorySizeMiB |
Integer |
Cache size the storage controller, in MiB. |
|
StorageControllers.Oem.Public.Mode |
String |
Mode of the storage controller. Supported options: · Non-RAID. · RAID. · HBA. · Mixed. · JBOD. · SimpleVolume. · AutoVolume. |
|
StorageControllers.Oem.Public.PackageVersion |
String |
PackageVersion of the LSI storage controller. |
|
StorageControllers.Oem.Public.PSOCFirmwareVersion |
String |
PSOC firmware version. |
|
StorageControllers.Oem.Public.SASAddress |
String |
Address of the storage controller. This field displays null if no address is obtained. |
|
StorageControllers.Oem.Public.SmarterCopyBackState |
Boolean |
SMART error copyback status. |
|
StorageControllers.Oem.Public. SupportedConfigurationOperation |
Array |
Capabilities of the specified storage controller. |
|
StorageControllers.Oem.Public.SupportedRAIDLevels |
Array |
Supported storage controller levels. |
|
StorageControllers.Oem.Public.SupportedStripSize |
Array |
Supported stripe sizes |
|
StorageControllers.Oem.Public.SupportedRAIDMode |
Array |
Current supported storage controller mode. |
|
StorageControllers.Oem.Public.TemperatureCelsius |
Array |
Current temperature. |
|
StorageControllers.Oem.Public.AssociatedCard |
Object |
Link to the associated storage controller. |
|
StorageControllers.Oem.Public.SpeedGTps |
Integer |
Interface speed This field is available only for a self-developed Marvell 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. This field is available only for non-Marvell storage controller. An outsourced Marvell storage controller does not support displaying interface rates. |
|
StorageControllers.SupportedDeviceProtocols |
Integer |
Supported protocols by the storage controller. |
|
StorageControllers@odata.count |
Integer |
Number of drivers managed by the storage controller. |
|
Volumes |
Object |
List of logical drives. |
|
StorageControllers. Status |
Object |
Storage controller status. Supported options: · Health—Storage controller health status. · State—Storage controller enable status. · Severity—Custom health status. · FaultDescription—Fault description information. |
|
StorageControllers.Oem.Public.InternalPortCount |
Integer |
Number of internal ports. |
|
StorageControllers.Oem.Public.ExternalPortCount |
Integer |
Number of external ports. |
Change history
|
Version |
Change description |
|
HDM2-2.10 |
Added the StorageControllers.Oem.Public.PSOCFirmwareVersion field. |
|
HDM3-1.15 |
Added custom properties. Added the Present state option to the StorageControllers.Oem.Public.BBUstate field and added the 3SNIC chip vendor to the StorageControllers.Oem.Public.ChipManufacturer field. |
|
HDM2-2.04 |
Added the StorageControllers.CardManufacturer and StorageControllers.CardModel fields. |
|
HDM2-2.03 |
Added description for interface rates of outsourced Marvell controllers in the StorageControllers.Oem.Public.SpeedGTps and StorageControllers.SpeedGbps fields. |
|
Added description about interface rates of Marvell vendor in the StorageControllers.Oem.Public.ChipManufacturer field. |
|
|
HDM2-1.57 |
Added the StorageControllers.Oem.Public.InternalPortCount and StorageControllers.Oem.Public.ExternalPortCount fields. |
|
HDM2-1.55 |
Added the Storage.ClearConfiguration and Storage.ClearForeignConfiguration fields for the Actions object. |
|
HDM2-1.14 |
Added the StorageControllers.Oem.Public.SupportedRAIDMode field. |
Modify storage controller information
Description
Modify information about a specific storage controller from the server.
Privilege module
OemKvm
Locking type of the associated system
Hardware configuration locking
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
Request body:
{
"StorageControllers":[
{
"Oem":{
"Public":{
"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 resource. |
You can obtain available storage controller IDs from storage controller collection resource information. |
|
CopyBackState |
Only LSI cards support Copyback enable status. |
Supported options: · true. · false. |
|
SmarterCopyBackState |
Only LSI cards support SMART error copyback enable status. |
Supported options: · true. · false. |
|
JBODState |
Only LSI cards support JBOD enable status. |
Supported options: · true. · false. |
|
Mode |
Storage controller mode. |
Supported options: · RAID. · HBA. · Mixed. · JBOD. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"StorageControllers":[
{
"Oem":{
"Public":{
"CopyBackState":true,
"SmarterCopyBackState":false,
"Mode":"RAID"
}
}
}
]
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Storage.Storage(*)",
"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0",
"@odata.type": "#Storage.v1_9_0.Storage",
"Actions": {
"Oem": {
"Public": {
"#Storage.ClearConfiguration": {
"target": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearConfiguration"
},
"#Storage.ClearForeignConfiguration": {
"target": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearForeignConfiguration"
}
}
}
},
"Drives": [
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront2"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront4"
}
],
"Drives@odata.count": 4,
"Id": "RAIDStorage0",
"Name": "RAIDStorage0",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"StorageControllers": [
{
"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0#/StorageControllers/0",
"AssetTag": "RAID-LSI-9560-LP-16i-8GB",
"CardManufacturer": "Broadcom",
"CardModel": "HBA-LSI-9500-LP-8i",
"FirmwareVersion": "5.150.02-3377",
"Manufacturer": "H3C",
"MemberId": "0",
"Model": "RAID-LSI-9560-LP-16i-8GB",
"Name": "RAID-LSI-9560-LP-16i-8GB",
"Oem": {
"Public": {
"AssociatedCard": {
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3"
},
"BBUstate": "Miss",
"CapacitancePercent": null,
"CapacitanceStatus": {
"FaultDescription": "",
"Health": "OK",
"Severity": "Informational",
"State": "Absent"
},
"ChipManufacturer": "Broadcom",
"ChipModel": "LSI3108",
"ConfigurationVersion": "5.1500.00-0399",
"CopyBackState": true,
"DDRECCCount": 0,
"ExternalPortCount":null,
"FlashState": "Miss",
"InternalPortCount":16,
"FaultforLogicalDrives": [
{
"@odata.id":
"/redfish/v1/Chassis/1/Storages/RAIDStorage0/Volumes/LogicalDrive1"
},
{
"@odata.id":
"/redfish/v1/Chassis/1/Storages/RAIDStorage0/Volumes/LogicalDrive2"
}
],
"JBODState": null,
"MaintainPDFailHistory": true,
"MaxStripeSizeBytes": 1048576,
"MemorySizeMiB": 8192,
"MinStripeSizeBytes": 65536,
"Mode": "RAID",
"PackageVersion": "52.15.0-3720",
"SASAddress": "500062B202508300",
"SmarterCopyBackState": false,
"SpeedGTps": null
"SupportedConfigurationOperation": [
"ClearForeignConfiguration",
"ClearConfiguration",
"ModifyProperty",
"ManageVolumes",
"ModifyMode",
"ConfigureAccessPolicy",
"ConfigureWritePolicy",
"ConfigureReadPolicy",
"ConfigureDriveCachePolicy"
],
"SupportedRAIDLevels": [
"RAID0",
"RAID1",
"RAID5",
"RAID6",
"RAID10",
"RAID50",
"RAID60"
],
"SupportedRAIDMode": [
"RAID",
"JBOD"
],
"SupportedStripSize": [
"64KB",
"128KB",
"256KB",
"512KB",
"1MB"
],
"TemperatureCelsius": 52
}
},
"SerialNumber": "SK00977218",
"SpeedGbps": 12,
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
},
"SupportedDeviceProtocols": [
"SAS"
]
}
],
"StorageControllers@odata.count": 1,
"Volumes": {
"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes"
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain storage controller information."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Clear Foreign status of physical drives in specified storage controller
Description
Clear Foreign status of physical drives in specified storage controller.
Privilege module
OemKvm
Locking type of the associated system
Hardware configuration locking
Request
Method and URL:
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 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:
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:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Clear all configurations for a specified storage controller
Description
Clear the default configuration for the specified storage controller.
Privilege module
OemKvm
Locking type of the associated system
Hardware configuration locking
Request
Method and URL:
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 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:
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:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain logical drive collection information
Description
Obtain information about all logical drives from the server.
Privilege module
Login
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/LogicalDrive239"
}
],
"Members@odata.count": 1,
"Name": "Volume Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
Integer |
Number of logical drive resources. |
|
Name |
String |
Name of the logical drive collection resource. |
Create a logical drive
Description
Create a logical drive on the server.
Privilege module
OemKvm
Locking type of the associated system
Hardware configuration locking
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:
// Create a logical drive with ConnectionID:
{
"Oem": {
"Public":{
"Name":name,
"InitState": initstate,
"StripSize":stripsize,
"Level": raid_level,
"SpanNum": spanname,
"NumDrivePerSpan": num_drives,
"DefaultReadPolicy": read_policy,
"DefaultWritePolicy": write_policy,
"DefaultCachePolicy": cache_policy,
"DriveCache": drive_cache_policy,
"AccessPolicy": access_policy,
"Size": size,
"SizeUnit": unit,
"AccelerationMethod": acceleration,
"PhysicalDiskList": [
{
"group_id":group_id,
"id":connnection_id
},
...
]
}
}
}
// Create a logical drive with LocationInfo:
{
"Oem": {
"Public":{
"Name":name,
"InitState": initstate,
"StripSize":stripsize,
"Level": raid_level,
"SpanNum": spanname,
"NumDrivePerSpan": num_drives,
"DefaultReadPolicy": read_policy,
"DefaultWritePolicy": write_policy,
"DefaultCachePolicy": cache_policy,
"DriveCache": drive_cache_policy,
"AccessPolicy": access_policy,
"Size": size,
"SizeUnit": unit,
"AccelerationMethod": acceleration,
"PhysicalDiskList": [
{
"group_id":group_id,
"LocationInfo":location_info
},
...
]
}
}
}
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 |
Object |
Custom attributes, this feature need to be compatible with B05 without Public situations. |
|
Name |
Name of the logical drive. |
String |
|
InitState |
(Optional.) Initialization type. |
For LSI storage controllers, supported options include: · No. · Fast. · Full. For PMC storage controllers, supported options include: · Default. · RapidParity. If you do not specify an option for this field, the default is to not perform initialization. For 3SNIC storage controllers, supported options include: · Fast. · Background—RAID 0 does not support this type. · Front. The fast type is used by default. |
|
StripSize |
Stripe size. |
· Available sizes for the LSI 9540 storage controller: 64KB. · Available sizes for the LSI 9560 storage controllers: ¡ 64KB. ¡ 128KB. ¡ 256KB. ¡ 512KB. ¡ 1MB. · Available sizes for the LSI 9660 storage controller: 64KB and 256KB. · Available sizes for the P9560 storage controller: ¡ 64KB. ¡ 128KB. ¡ 256KB. ¡ 512KB. ¡ 1MB. · Available sizes for the H460 3254 storage controller: ¡ 64KB. ¡ 128KB. ¡ 256KB. ¡ 512KB. ¡ 1MB. · Available sizes for the PMC P460 storage controller: ¡ 16KB. ¡ 32KB. ¡ 64KB. ¡ 128KB. ¡ 256KB. ¡ 512KB. ¡ 1MB. · Available sizes for the 3SNIC storage controller: ¡ 32KB. ¡ 64KB. ¡ 128KB. ¡ 256KB. ¡ 512KB. ¡ 1MB. · For support of other storage controllers, see the actual specifications. You can obtain supported stripe sizes through HDM or BIOS. |
|
Level |
RAID level. |
Supported options: · RAID 0. · RAID 1. · RAID 5. · RAID 6. · RAID 00—This option is not available for PMC or 3SNIC storage controllers. · RAID 10. · RAID 50. · RAID 60. · RAID 1 ADM—This level supports only three disks. · RAID 10 ADM. For the 3SNIC 3S580, 3S585, and 3S590, supported options include: · RAID0. · RAID1. · RAID5. · RAID6. · RAID10. · RAID50. · RAID60. For the 3SNIC 3S520 and 3S530, supported options include: · RAID0. · RAID1. · RAID10. |
|
SpanNum |
Number of spans. |
Integer. If not specified, this field is fixed to 0. 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. For 3SNIC storage controllers: · For RAID levels 0, 1, 5, and 6, only 1 is available. · For RAID levels 10, 50, and 60, the value must be greater than 1. · For RAID level 50, the value must be 2, 3, 4, or 5. · For RAID level 60, the value must be 2, 3, or 4. |
|
NumDrivePerSpan |
Number of physical drives per span. |
Integer. If not specified, this field is fixed to 0. 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 and less than the number of installed physical drives. · For RAID 5 and RAID 6, the value must be greater than 2 and less than the number of installed physical drives. · 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, 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 RAID 60, the value must be greater than 3 and the total number of physical drives in all spans cannot be greater than the number of installed physical drives. For PMC storage controllers: · 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 2 and less than the number of installed physical drives. · For RAID 5, the value must be greater than 2 and less than the number of installed physical drives. · For RAID 6, the value must be greater than 3 and less than the number of installed physical drives. · For RAID 10, the value must be an even number greater than 3 and less than the number of installed physical drives. · For RAID 50, the value must be greater than 2, a multiple of 3, and the total number of physical drives in all spans cannot be greater than the number of installed physical drives. · For RAID 60, the value must be greater than 3, a multiple of and the total number of physical drives in all spans cannot be greater than the number of installed physical drives · For RAID 1ADM, the value must be 3 and less than the number of installed physical drives. · For RAID 10ADM, the value must be greater than 5, a multiple of 6, and less than the number of installed physical drives. For 3SNIC storage controllers: · For RAID 0, the value must be greater than 0 and less than the number of installed physical drives. · For RAID 1, the value can only be 2. · For RAID 5, the value must be greater than 2 and less than the number of installed physical drives. · For RAID 6, the value must be greater than 3 and less than the number of installed physical drives. · For RAID 10, the value must be an even number greater than 0, and the value multiplied by the number of spans must be less than the number of installed physical drives. · For RAID 50, the value must be greater than 2, and the value multiplied by the number of spans must be less than the number of installed physical drives. · For RAID 60, the value must be greater than 3, and the value multiplied by the number of spans must be less than the number of installed physical drives. |
|
DefaultWritePolicy |
Default write policy. |
Supported options: · Write Through. · Write Back. · Always Write Back. This field is not available for PMC or 3SNIC storage controllers. Optional field. If not specified, the default is WriteBack. |
|
DefaultReadPolicy |
Default read policy. |
Supported options: · NoReadAhead. · ReadAhead. This field is not available for PMC or 3SNIC storage controllers. Optional field. If not specified, the default is ReadAhead. |
|
WritePolicy |
Write policy. |
Supported options: · Write Back. · Write Through. · Write Back Enforce. This field is available only for 3SNIC storage controllers. Optional field. If not specified, the default is Write Though. |
|
ReadPolicy |
Read policy. |
Supported options: · No Ahead. · Ahead. This field is available only for 3SNIC storage controllers. Optional field. If not specified, the default is No Ahead. |
|
DefaultCachePolicy |
Cache policy. |
Supports only DirectIO. This field is not available for PMC or 3SNIC storage controllers. Optional field. If not specified, the default is DirectIO. |
|
DriveCache |
Drive cache policy. |
For 3SNIC controllers, supported options include: · Off. · On. · Default. For other controllers, supported options include: · Unchanged. · Enable. · Disable. This field is not available for PMC storage controllers. Optional field. If not specified, the default is Unchanged. For the 3SNIC storage controller, the default is Default. |
|
AccessPolicy |
Access policy. |
Supported options: · Read/Write. · Read only. · Blocked. This field is not available for PMC or 3SNIC storage controllers. Optional field. If not specified, the default is Read/Write. |
|
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: · MiB. · GiB. · TiB. The minimum capacity of a LSI storage controller is 100 MiB. The minimum capacity of a PMC storage controller is 1 GiB. The capacity of a 3SNIC storage controller is greater than 0 MiB. |
|
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. · Optional field, if not specified, the default is ControllerCache. |
|
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 or 3SNIC storage controllers. If this field is specified, it will not take effect. 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. |
|
LocationInfo |
Physical drive silk screen. |
Physical drive silk screen can be obtained by querying the specified drive information. Users can create only through index or silk screen; if both are specified, silk screen takes priority. |
Usage guidelines
This feature is supported on the following storage controllers:
· The 9560, 9540, and 9660 LSI storage controllers.
· The H460, 3254, and P460 PMC storage controllers whose firmware supports MCTP.
· The 3s520, 3S585, and 3S590 3SNIC storage controllers.
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": {
"Public": {
"Name":"LogicalDisk0",
"InitState": "No",
"StripSize":"64KB",
"Level":"RAID0",
"SpanNum": 1,
"NumDrivePerSpan": 1,
"DefaultReadPolicy": "Read Ahead",
"DefaultWritePolicy": "Write Through",
"DefaultCachePolicy": "Direct",
"DriveCache": "Disable",
"AccessPolicy": "Blocked",
"Size": 199,
"SizeUnit": "GiB",
"PhysicalDiskList": [
{
"group_id":0,
"id":11
}
]
}
}
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
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": {
"Public": {
"Name":"LogicalDisk1",
"StripSize":"32KB",
"Level":"RAID0",
"SpanNum": 0,
"NumDrivePerSpan": 1,
"Size": 199,
"SizeUnit": "GiB",
"AccelerationMethod":"None",
"PhysicalDiskList": [
{
"LocationInfo":"DiskFront1"
}
]
}
}
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
# Create a RAID50 logical drive using 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": {
"Public": {
"Name":"LogicalDisk1",
"StripSize":"32KB",
"Level":"RAID50",
"SpanNum": 2,
"NumDrivePerSpan": 3,
"Size": 0,
"SizeUnit": "GiB",
"AccelerationMethod":"None",
"PhysicalDiskList": [
{
"LocationInfo":"DiskFront1"
},
{
"LocationInfo":"DiskFront2"
},
{
"LocationInfo":"DiskFront3"
},
{
"LocationInfo":"DiskFront4"
},
{
"LocationInfo":"DiskFront5"
},
{
"LocationInfo":"DiskFront6"
}
]
}
}
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Messgae.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM3-1.20 |
Changed the value for the NumDrivePerSpan field. |
|
HDM3-1.15 |
Changed the stripe size, capacity description, physical drive cache policy, and initialization type for 3SNIC storage controller. |
|
HDM3-1.15 |
Added description for 3SNIC controllers to the InitState, StripSize, Level, SpanNum, NumDrivePerSpan, DefaultWritePolicy, DefaultReadPolicy, DefaultCachePolicy, DriveCache, AccessPolicy, SizeUnit, and group_id fields. Added the WritePolicy and ReadPolicy fields. |
|
HDM2-2.08 |
Added support for LSI 9660 storage controllers and the strip size description for LSI 9660 storage controllers. |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
|
HDM2-1.15 |
Changed stripe size field description. More storage controllers are supported, depending on actual specification scans. You can obtain supported stripe sizes through HDM/BIOS.. |
|
HDM2-1.14 |
Changed stripe size field description. Added support for 16/32KB stripe sizes on P460 storage controllers. |
|
HDM2-1.14 |
Changed supported card description and stripe size field description. |
Delete a logical drive
Description
Delete a specific logical drive from the server.
Privilege module
OemKvm
Locking type of the associated system
Hardware configuration locking
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:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Messgae.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain logical drive information
Description
Obtain information about a specific logical drive from the server.
Privilege module
Login
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
# For LSI storage controllers:
Method and URL:
GET https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive239
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",
"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive239",
"@odata.type": "#Volume.v1_5_0.Volume",
"CapacityBytes": 600127266816,
"Encrypted": false,
"Id": "LogicalDrive239",
"Links": {
"Drives": [
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront4"
}
],
"Drives@odata.count": 1
},
"Name": "",
"Oem": {
"Public": {
"AccessPolicy": "Blocked",
"BGIEnable": true,
"BootEnable": false,
"CompletionCode": 0,
"ConsistencyCheck": false,
"CurrentCachePolicy": "DirectIO",
"CurrentReadPolicy": "ReadAhead",
"CurrentWritePolicy": "WriteThrough",
"DefaultCachePolicy": "DirectIO",
"DefaultReadPolicy": "ReadAhead",
"DefaultWritePolicy": "WriteThrough",
"Description": "Success",
"DriveCache": "Disabled",
"FirmwareStatus": "Optimal",
"NumDrivePerSpan": 1,
"OptimumIOSizeBytes": 65536,
"RaidControllerID": 0,
"ReadPolicy": "ReadAhead",
"RebuildProgress":"2",
"SSDCachecadeVolume": null,
"SSDCachingEnable": null,
"SpanNumber": 1,
"VolumeRaidLevel": "RAID0",
"WritePolicy": "WriteThrough"
}
},
"RedundantType": "NonRedundant",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
}
Response code: 200
# For PMC storage controllers:
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:
{
"@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": 53686272000,
"Encrypted": false,
"Id": "LogicalDrive0",
"Links": {
"Drives": [
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront2"
},
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"
}
],
"Drives@odata.count": 2
},
"Name": "flapper2",
"Oem": {
"Public": {
"AccelerationMethod": "None",
"BootEnable": false,
"CompletionCode": 0,
"Description": "Success",
"FirmwareStatus": "Optimal",
"OptimumIOSizeBytes": 32768,
"RaidControllerID": 0,
"RebuildProgress":"2",
"SSDCachecadeVolume": null,
"SSDCachingEnable": null,
"SpanNumber": 1,
"NumDrivePerSpan":2,
"VolumeRaidLevel": "RAID1"
}
},
"RedundantType": "Mirrored ",
"Status": {
"Health": "",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
}
Response code: 200
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 |
Array |
Links to member drives of the logical drive. |
|
Links.Drives@odata.count |
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. · ReadOnly. · Blocked. This field is not available for PMC or 3SNIC storage controllers or outsourced Marvell storage controllers. |
|
BootEnable |
Boolean |
Whether the logical drive is a boot device. |
|
DriveCache |
String |
Cache policy of physical drives in the logical drive. For 3SNIC controllers, supported options include: · On. · Off. · Default. For other controllers, supported options include: · Unchanged. · Enable. · Disable. This field is not available for PMC storage controllers or outsourced Marvell storage controllers. |
|
DefaultCachePolicy |
String |
Cache policy. Supported options: · DirectIO. · CachedIO. This field is not available for PMC or 3SNIC storage controllers or outsourced Marvell storage controllers. This field is available for Original IOPolicy. |
|
CurrentCachePolicy |
String |
Cache policy. Supported options: · DirectIO. · CachedIO. This field is not available for PMC or 3SNIC storage controllers or outsourced Marvell 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. |
|
CurrentReadPolicy |
String |
Current read policy of the logical drive. For 3SNIC controllers, supported options include: · No Ahead. · Ahead. For other controllers, supported options include: · NoReadAhead. · Read Ahead. This field is not available for PMC storage controllers or outsourced Marvell storage controllers. |
|
ReadPolicy |
String |
Read policy of the logical drive. For 3SNIC controllers, supported options include: · No Ahead. · Ahead. For other controllers, supported options include: · NoReadAhead. · Read Ahead. This field is not available for PMC storage controllers or outsourced Marvell storage controllers. |
|
RebuildProgress |
String |
Rebuild progress of the logical drive in percentage. This field is not available for LSI 9500\9300\9311 storage controllers or Marvell storage controllers. |
|
DefaultReadPolicy |
String |
Default read policy of the logical drive. Supported options: · NoReadAhead. · Read Ahead. This field is not available for PMC or 3SNIC storage controllers or outsourced Marvell storage controllers. |
|
SpanNumber |
Integer |
Number of spans contained in the logical drive. |
|
VolumeRaidLevel |
String |
· RAID levels supported by the LSI storage controller: ¡ RAID0. ¡ RAID00. ¡ RAID1. ¡ RAID5. ¡ RAID6. ¡ RAID10. ¡ RAID50. ¡ RAID60. · RAID levels supported by the PMC storage controller: ¡ RAID0. ¡ RAID1. ¡ RAID5. ¡ RAID6. ¡ RAID10. ¡ RAID50. ¡ RAID60. ¡ RAID1(ADM). ¡ RAID10(ADM). · RAID levels supported by outsourced Marvell controllers: ¡ RAID0. ¡ RAID1. ¡ JBOD. · RAID levels supported by the 3SNIC storage controller: ¡ RAID0. ¡ RAID1. ¡ RAID5. ¡ RAID6. ¡ RAID10. ¡ RAID50. ¡ RAID60. · RAID levels supported by the P9560 storage controller: ¡ RAID0. ¡ RAID00. ¡ RAID1. ¡ RAID5. ¡ RAID6. ¡ RAID10. ¡ RAID50. ¡ RAID60. · RAID levels supported by the Marvell controllers: ¡ RAID0. ¡ RAID1. |
|
DefaultWritePolicy |
String |
Default write policy of the logical drive. Supported options: · WriteThrough. · Write Back. · AlwaysWriteBack. This field is not available for PMC or 3SNIC storage controllers or outsourced Marvell storage controllers. |
|
CurrentWritePolicy |
String |
Current write policy of the logical drive. For 3SNIC controllers, supported options include: · Write Back. · Write Through. · Write Back Enforce. For other controllers, supported options include: · WriteThrough. · Write Back. · AlwaysWriteBack. This field is not available for PMC storage controllers or outsourced Marvell storage controllers. |
|
WritePolicy |
String |
Current write policy of the logical drive. For 3SNIC controllers, supported options include: · Write Back. · Write Through. · Write Back Enforce. For other controllers, supported options include: · WriteThrough. · Write Back. · AlwaysWriteBack. This field is not available for PMC storage controllers or outsourced Marvell storage controllers. |
|
FirmwareStatus |
String |
Logical drive status. For PMC storage controllers: · Optimal. · Creating. · Scrubbing. · Zeroing. · Rebuilding. · Morphing. · Verifying. · Copying. · Suboptimal. · Degraded. · Offline"No. · Fast. · Full. For LSI storage controllers: · Optimal. · Offline. · Degraded. · Rebuilding. · UnknownDefault. For self-developed Marvell storage controllers: · Foreign. · Functional. · Offline. · Degraded. · Rebuilding. For outsourced Marvell storage controllers: · Functional. · Offline. · Degraded. For 3SNIC storage controllers: · Normal. · Fault. · Degrade. · Deleting. · Delete_fail. · Formatting. · Initializing. · Initialize_fail. · Not_Formatted. · Sanitizing. · Write_protect. |
|
OptimumIOSizeBytes |
Integer |
Strip size. Supported options vary by storage controller models. · 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. · For 3SNIC storage controllers: ¡ 32768—32 KB. ¡ 65536—64 KB. ¡ 131072—128 KB. ¡ 262144—256 KB. ¡ 524288—512 KB. ¡ 1048576—1 MB. |
|
AccelerationMethod |
String |
Acceleration policy, this field is available only for PMC storage controllers. Supported options: · ControllerCache. · None. · IOBypass (only for SSD). · MaxCache. |
|
BGIEnable |
Boolean |
Enabling status of background initialization. |
|
SSDCachecadeVolume |
Boolean |
Whether the logical drive is a CacheCade logical drive. |
|
ConsistencyCheck |
Boolean |
Enabling status of consistency check. |
|
SSDCachingEnable |
Boolean |
Whether a CacheCade logical drive can be used. |
|
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 and RAID 1E) · StripedWithParity (RAID 5 and RAID6). · SpannedMirrors (RAID 10). · SpannedStripesWithParity (RAID50 and RAID 60). · Unknown. |
|
Status.Health |
String |
Health status of the logical drive. |
|
Status.State |
String |
Enabling status of the logical drive. |
|
Status.Oem.Public.Severity |
String |
Custom health status. |
|
Status.Oem.Public.FaultDescription |
String |
Fault description information. |
Change history
|
Version |
Change description |
|
HDM3-1.21 |
Edited the description for the VolumeRaidLevel field. |
|
HDM3-1.20 |
Edited the description for the VolumeRaidLevel field. |
|
HDM3-1.15 |
Added description for 3SNIC controllers to the AccessPolicy, DriveCache, DefaultCachePolicy, CurrentCachePolicy, CurrentReadPolicy, ReadPolicy, DefaultReadPolicy, VolumeRaidLevel, DefaultWritePolicy, CurrentWritePolicy, WritePolicy, FirmwareStatus, and OptimumIOSizeBytes fields. |
|
HDM2-2.10 |
Added description for RebuildProgress, VolumeRaidLevel, and RedundantType. Added description for LSI storage controllers in the RebuildProgress field. |
|
HDM3-1.15 |
Added the Oem.Public.RebuildProgress field and synchronized it to HDM3. |
|
HDM2-2.05 |
Added the Oem.Public. RebuildProgress field. |
|
HDM2-2.03 |
Added description about outsourced Marvell storage controller in related fields. |
|
HDM2-1.56 |
Changed the Optimal option to Functional in the Oem.Public.FirmwareStatus field for logical drives of the Marvell module. |
Edit logical drive properties
Description
Edit properties of the specified logical drive.
Privilege module
OemKvm
Locking type of the associated system
Hardware configuration locking
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":{
"BootEnable":boot_enable,
"DefaultWritePolicy": write_policy,
"DefaultReadPolicy": read_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. |
|
BootEnable |
Boolean |
Whether the logical drive is a boot drive. This field is not available when the PMC storage controller is in the PBSI channel. |
|
DefaultWritePolicy |
Default write policy. |
Default write policy of the logical drive. Supported options: · WriteThrough. · WriteBack. · AlwaysWriteBack. This field is not available for PMC storage controllers. |
|
DefaultReadPolicy |
Default read policy. |
Default read policy of the logical drive. Supported options: · NoReadAhead. · ReadAhead. This field is not available for PMC storage controllers. |
|
AccessPolicy |
String. |
Access policy of the logical drive. Supported options: · Read/Write. · ReadOnly. · Blocked. This field is not available for PMC storage controllers. |
|
DriveCache |
String. |
Physical drive cache policy. Supported options: · Physical disk cache policy. · Enable. · 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/LogicalDrive239
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Oem":{
"Public":{
"BootEnable":false,
"DefaultWritePolicy": "WriteThrough",
"DefaultReadPolicy": "ReadAhead",
"AccessPolicy":"Blocked",
"DriveCache":"Disabled"
}
}
}
Response:
For LSI storage controllers:
{
"@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",
"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive239",
"@odata.type": "#Volume.v1_5_0.Volume",
"CapacityBytes": 600127266816,
"Encrypted": false,
"Id": "LogicalDrive239",
"Links": {
"Drives": [
{
"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront4"
}
],
"Drives@odata.count": 1
},
"Name": "",
"Oem": {
"Public": {
"AccessPolicy": "Blocked",
"BGIEnable": true,
"BootEnable": false,
"CompletionCode": 0,
"ConsistencyCheck": false,
"CurrentCachePolicy": "DirectIO",
"CurrentReadPolicy": "ReadAhead",
"CurrentWritePolicy": "WriteThrough",
"DefaultCachePolicy": "DirectIO",
"DefaultReadPolicy": "ReadAhead",
"DefaultWritePolicy": "WriteThrough",
"Description": "Success",
"DriveCache": "Disabled",
"FirmwareStatus": "Optimal",
"NumDrivePerSpan": 1,
"OptimumIOSizeBytes": 65536,
"RaidControllerID": 0,
"ReadPolicy": "ReadAhead",
"RebuildProgress":"2",
"SSDCachecadeVolume": null,
"SSDCachingEnable": null,
"SpanNumber": 1,
"VolumeRaidLevel": "RAID0",
"WritePolicy": "WriteThrough"
}
},
"RedundantType": "NonRedundant",
"Status": {
"Health": "OK",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
},
"State": "Enabled"
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain logical drive information."
Change history
|
Version |
Change description |
|
HDM3-1.14 |
Added the Oem.Public.BootEnable field. |
|
HDM2-2.06 |
Added the Oem.Public.BootEnable field. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain BIOS setting collection information
Description
Obtain information about the BIOS setting collection from the server.
Privilege module
Login
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
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_1_2.Settings",
"SettingsObject": {
"@odata.id": "/redfish/v1/Systems/1/Bios/Settings"
}
},
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/Bios/$entity",
"@odata.id": "/redfish/v1/Systems/1/Bios",
"@odata.type": "#Bios.v1_1_2.Bios",
"Actions": {
"#Bios.ChangePassword": {
"target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ChangePassword"
},
"#Bios.ResetBios": {
"ResetType@Redfish.AllowableValues": [
"Reset"
],
"target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ResetBios"
},
"#Settings.Revoke": {
"target": "/redfish/v1/Systems/1/Bios/Settings/Actions/Oem/Public/Settings.Revoke"
}
},
"AttributeRegistry": "BiosAttributeRegistry",
"Attributes": null,
"BiosRegistry": {
"@odata.id": "/redfish/v1/Systems/1/Bios/BiosRegistry"
},
"BscBootInfo": null,
"Description": "BIOS Configuration Current Settings",
"Id": "Bios",
"Name": "BIOS Configuration Current Settings",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
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. |
|
ResetType@Redfish.AllowableValues |
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. |
|
Settings.Revoke |
Object |
Clear inactive BIOS settings. |
|
target |
String |
Clear link to the inactive BIOS. |
|
Attributes |
Object |
For more information about configurable BIOS settings, see the BIOS user guides on the official website: · Intel platform—H3C Server Eagle Stream Platform BIOS User Guide. · AMD platform—H3C Server AMD EPYC Series Genoa Processor BIOS User Guide. |
|
BscBootInfo.CurrentBootMode |
String |
Current system boot mode. |
|
BscBootInfo.CurrentFirstBootDevice |
String |
First boot device in the system. |
|
BiosRegistry |
Object |
Link to access detailed BIOS configuration rules. |
|
Description |
String |
Description of the BIOS configuration. |
|
Id |
String |
ID of the BIOS configuration. |
|
Name |
String |
Name of the BIOS configuration. |
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
Login
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#Systems/Members/1/Bios/Settings/$entity",
"@odata.id": "/redfish/v1/Systems/1/Bios/Settings",
"@odata.type": "#Bios.v1_1_2.Bios",
"AttributeRegistry": "BiosAttributeRegistryP18.5.15",
"Attributes": {
......
},
"Description": "BIOS Configuration Pending Settings",
"Id": "Settings",
"Name": "BIOS Configuration Pending Settings",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. · Intel platform—H3C Server Eagle Stream Platform BIOS User Guide. · AMD platform—H3C Server AMD EPYC Series Genoa Processor BIOS User Guide. |
|
Description |
String |
Description of the pending BIOS configuration. |
|
Id |
String |
ID of the pending BIOS configuration. |
|
Name |
String |
Name of the pending BIOS configuration. |
Configure a BIOS setting
Description
Configure a specific BIOS setting for the server.
Privilege module
OemKvm
Locking type of the associated system
BIOS configuration locking
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 the BIOS user guides on the official website: · Intel platform—H3C Server Eagle Stream Platform BIOS User Guide. · AMD platform—H3C Server AMD EPYC Series Genoa Processor BIOS User Guide. 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:ifmatch_value
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_1_1.Bios",
"AttributeRegistry": "BiosAttributeRegistryP18.5.15",
"Attributes": {
"BootOrder1": "Hard Disk",
"BootOrder2": "Network",
"BootOrder3": "CD/DVD",
"BootOrder4": "Other Device"
},
"Description": "BIOS Configuration Pending Settings",
"Id": "Settings",
"Name": "BIOS Configuration Pending Settings",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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 |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Set a BIOS password
Description
Set a BIOS password for the server.
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. If password complexity check is enabled, the BIOS performs the check.
Privilege module
OemKvm
Locking type of the associated system
BIOS configuration locking
Request
Method and URL:
POST 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. · PowerOn. |
|
Password |
Password string. |
The password must be a case-sensitive string of 8 to 20 characters and can contain the letters, digits, spaces, and the following special characters: `~!@#$%^&*()_+-=[]\{}|;':",./<>? If password complexity check is enabled in the BIOS, the password must meet the following requirements: · Contain a minimum two of the following character types: Uppercase letters, lowercase letters, and digits. · Contain a minimum of one space or special character. The interface does not perform password complexity check. After the setting, restart the BIOS and verify if the setting takes effect. |
Examples
Method and URL:
POST 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:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM3-1.14 |
Added the PowerOn option to the UserName field. |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
· Added the locking type of the associated system. · Added description for BIOS password complexity check. |
Restore the default BIOS settings
Description
Restore the default BIOS settings.
Privilege module
OemKvm
Locking type of the associated system
BIOS configuration locking
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:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain BIOS detailed setting rules information
Description
Obtain BIOS detailed setting rules information.
Privilege module
Login
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Bios/BiosRegistry
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/BiosRegistry
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AttributeRegistry.AttributeRegistry",
"@odata.id": "/redfish/v1/Systems/1/Bios/BiosRegistry",
"@odata.type": "#AttributeRegistry.v1_3_6.AttributeRegistry",
"Description": "This registry defines a representation of BIOS Attribute instances",
"Id": "BiosAttributeRegistry",
"Language": "en-US",
"Name": "BIOS Attribute Registry",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"OwningEntity": "AMI",
"RegistryEntries": {
"Attributes": [
{
"AttributeName": "SetupMode",
"DefaultValue": "Graphic",
"DisplayName": "SetupMode",
"Type": "Enumeration",
"Value": [
{
"ValueDisplayName": "Text",
"ValueName": "Text"
},
{
"ValueDisplayName": "Graphic",
"ValueName": "Graphic"
}
]
}
......
]
},
"RegistryVersion": null
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the BIOS detailed setting rules model. |
|
@odata.id |
String |
Link to the BIOS detailed setting rules. |
|
@odata.type |
String |
Type of the BIOS detailed setting rules resource. |
|
Description |
String |
Description of the BIOS detailed setting rules. |
|
Id |
String |
ID of the BIOS detailed setting rules. |
|
RegistryEntries |
Object |
BIOS setting rule entries. |
|
Attributes |
Object |
· For more information about configurable BIOS settings, see the BIOS user guides on the official website: · Intel platform—H3C Server Eagle Stream Platform BIOS User Guide. · AMD platform—H3C Server AMD EPYC Series Genoa Processor BIOS User Guide. |
|
AttributeName |
String |
BIOS attribute name. |
|
DisplayName |
String |
Display name. |
|
DefaultValue |
String |
Default settings. |
|
Value |
Object |
Value range. |
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Create a KVM resource
Description
Create a KVM resource.
Privilege module
OemKvm
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:
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:
POST https://192.168.18.18/redfish/v1/Systems/1/kvm
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response 1:
"@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/saxow7fnqUBgRa1"
},
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Example 2
Purpose:
# Use KVM resource information obtained from Redfish to log in without a password.
Method and URL:
Use the H5 KVM resource link obtained from Response 1 and log in through the browser.
https://192.168.18.18/redfish/v1/Systems/1/kvm/GlPxiEitqy7QM0D
This allows remote control of the server through H5 KVM.
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. |
Obtain event log service collection information
Description
Obtain information about all event log service resources from the server.
Privilege module
Login
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#Systems/Members/1/LogServices/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices",
"@odata.type": "#LogServiceCollection.LogServiceCollection",
"Actions": {
"Oem": {
"Public": {
"#LogServices.ExportEventLog": {
"target": "/redfish/v1/Systems/1/LogServices/Actions/Oem/Public/LogServices.ExportEventLog"
}
}
}
},
"Description": "Collection of LogServices for this Computer System",
"Members": [
{
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1"
}
],
"Members@odata.count": 1,
"Name": "System Log Services Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
|
Description |
String |
Description of the event log service collection resource. |
|
|
Members@odata.count |
Integer |
Number of event log service resources. |
|
|
Members |
List of event log service resources. |
||
|
Actions |
Executable actions for LogServices. |
||
|
Oem.Public. LogServices.ExportEventLog |
Object |
Link to export event log information. |
|
Obtain event log service resource information
Description
Obtain information about a specific event log service resource from the server.
Privilege module
Login
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#Systems/Members/1/LogServices/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1",
"@odata.type": "#LogService.v1_2_0.LogService",
"Actions": {
"#LogService.ClearLog": {
"target": "/redfish/v1/Systems/1/LogServices/Log1/Actions/LogService.ClearLog"
}
},
"DateTime": "2022-02-19T15:30:04+08:00",
"DateTimeLocalOffset": "UTC+08:00",
"Description": "System Service Log for this Computer System",
"Entries": {
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries"
},
"Id": "Log1",
"MaxNumberOfRecords": 1500,
"Name": "System Service Log",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"OverWritePolicy": "WrapsWhenFull",
"OverWritePolicy@Redfish.AllowableValues": [
"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. |
|
Description |
String |
Description of the event log service resource. |
|
MaxNumberOfRecords |
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. |
|
OverWritePolicy@Redfish.AllowableValue |
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 |
Boolean |
Enabling status of the event log service resource. Supported options: · true—Enabled. · false—Disabled. |
|
Actions.#LogService.ClearLog |
Object |
Link to clear event logs entries action. |
|
Entries |
Object |
Link to the event log collection resource. |
Configure specified event log service resource settings
Description
Configure specified event log service resource settings from the server.
Privilege module
ConfigureComponents
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"OverWritePolicy": "WrapsWhenFull"
}
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 |
Matching parameters for request message. |
Initiate a GET operation on the corresponding resource and obtain from the response header (corresponding to the "ETag" parameter). |
|
LogService_id |
ID of the log service resource. |
You can obtain available log service resource IDs from log service collection information. |
|
OverWritePolicy |
String |
Event log service resource overwrite policy. Supported options: · WrapsWhenFull. · NeverOverWrites. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"OverWritePolicy": "WrapsWhenFull"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1",
"@odata.type": "#LogService.v1_2_0.LogService",
"Actions": {
"#LogService.ClearLog": {
"target": "/redfish/v1/Systems/1/LogServices/Log1/Actions/LogService.ClearLog"
}
},
"DateTime": "2022-02-19T15:30:04+08:00",
"DateTimeLocalOffset": "UTC+08:00",
"Description": "System Service Log for this Computer System",
"Entries": {
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries"
},
"Id": "Log1",
"MaxNumberOfRecords": 1500,
"Name": "System Service Log",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"OverWritePolicy": "WrapsWhenFull",
"OverWritePolicy@Redfish.AllowableValues": [
"WrapsWhenFull",
"NeverOverWrites"
],
"ServiceEnabled": true
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain event log entry resource information."
Obtain event log entry collection information
Description
Obtain information about all event log entries of a log service from the server.
Privilege module
OemSystemAudit
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#Systems/Members/1/LogServices/Log1/Entries/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries",
"@odata.type": "#LogEntryCollection.LogEntryCollection",
"Description": "Collection of System Event Log Entries",
"Members": [
{
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/642"
},
…
{
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/543"
}
],
"Members@odata.count": 642,
"Members@odata.nextLink": "/redfish/v1/Systems/1/LogServices/Log1/Entries?$skip=100&$top=100",
"Name": "System Event Log Entries",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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#Systems/Members/1/LogServices/Log1/Entries/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries",
"@odata.type": "#LogEntryCollection.LogEntryCollection",
"Description": "Collection of System Event Log Entries",
"Members": [
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/164",
"@odata.type": "#LogEntry.v1_6_1.LogEntry",
"Created": "2022-04-11T11:56:27+08:00",
"Description": "System Event Log",
"EntryCode": "Asserted",
"EntryType": "Event",
"EventTimestamp": "2022-04-11T11:56:27+08:00",
"Id": "164",
"Level": "Info",
"Message": "Transition to Off Line",
"MessageArgs": [
1
],
"Name": "Log Entry 164",
"Oem": {
"Public": {
"EventCode": "0x04400014"
}
},
"SensorName": "FAN7_F_Status",
"SensorType": "Fan",
"Severity": "OK"
},
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/163",
"@odata.type": "#LogEntry.v1_6_1.LogEntry",
"Created": "2022-04-11T11:56:27+08:00",
"Description": "System Event Log",
"EntryCode": "Asserted",
"EntryType": "Event",
"EventTimestamp": "2022-04-11T11:56:27+08:00",
"Id": "163",
"Level": "Info",
"Message": "Transition to Off Line",
"MessageArgs": [
1
],
"Name": "Log Entry 163",
"Oem": {
"Public": {
"EventCode": "0x04400014"
}
},
"SensorName": "FAN6_F_Status",
"SensorType": "Fan",
"Severity": "OK"
},
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/162",
"@odata.type": "#LogEntry.v1_6_1.LogEntry",
"Created": "2022-04-11T11:56:27+08:00",
"Description": "System Event Log",
"EntryCode": "Asserted",
"EntryType": "Event",
"EventTimestamp": "2022-04-11T11:56:27+08:00",
"Id": "162",
"Level": "Info",
"Message": "Transition to Off Line",
"MessageArgs": [
1
],
"Name": "Log Entry 162",
"Oem": {
"Public": {
"EventCode": "0x04400014"
}
},
"SensorName": "FAN5_F_Status",
"SensorType": "Fan",
"Severity": "OK"
},
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/161",
"@odata.type": "#LogEntry.v1_6_1.LogEntry",
"Created": "2022-04-11T11:56:27+08:00",
"Description": "System Event Log",
"EntryCode": "Asserted",
"EntryType": "Event",
"EventTimestamp": "2022-04-11T11:56:27+08:00",
"Id": "161",
"Level": "Info",
"Message": "Transition to Off Line",
"MessageArgs": [
1
],
"Name": "Log Entry 161",
"Oem": {
"Public": {
"EventCode": "0x04400014"
}
},
"SensorName": "FAN4_F_Status",
"SensorType": "Fan",
"Severity": "OK"
},
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/160",
"@odata.type": "#LogEntry.v1_6_1.LogEntry",
"Created": "2022-04-11T11:56:27+08:00",
"Description": "System Event Log",
"EntryCode": "Asserted",
"EntryType": "Event",
"EventTimestamp": "2022-04-11T11:56:27+08:00",
"Id": "160",
"Level": "Info",
"Message": "Transition to Off Line",
"MessageArgs": [
1
],
"Name": "Log Entry 160",
"Oem": {
"Public": {
"EventCode": "0x04400014"
}
},
"SensorName": "FAN3_F_Status",
"SensorType": "Fan",
"Severity": "OK"
},
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/159",
"@odata.type": "#LogEntry.v1_6_1.LogEntry",
"Created": "2022-04-11T11:56:27+08:00",
"Description": "System Event Log",
"EntryCode": "Asserted",
"EntryType": "Event",
"EventTimestamp": "2022-04-11T11:56:27+08:00",
"Id": "159",
"Level": "Info",
"Message": "Transition to Off Line",
"MessageArgs": [
1
],
"Name": "Log Entry 159",
"Oem": {
"Public": {
"EventCode": "0x04400014"
}
},
"SensorName": "FAN2_F_Status",
"SensorType": "Fan",
"Severity": "OK"
},
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/158",
"@odata.type": "#LogEntry.v1_6_1.LogEntry",
"Created": "2022-04-11T11:56:27+08:00",
"Description": "System Event Log",
"EntryCode": "Asserted",
"EntryType": "Event",
"EventTimestamp": "2022-04-11T11:56:27+08:00",
"Id": "158",
"Level": "Info",
"Message": "Transition to Off Line",
"MessageArgs": [
1
],
"Name": "Log Entry 158",
"Oem": {
"Public": {
"EventCode": "0x04400014"
}
},
"SensorName": "FAN1_F_Status",
"SensorType": "Fan",
"Severity": "OK"
},
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/157",
"@odata.type": "#LogEntry.v1_6_1.LogEntry",
"Created": "2022-04-11T11:56:15+08:00",
"Description": "System Event Log",
"EntryCode": "Deasserted",
"EntryType": "Event",
"EventTimestamp": "2022-04-11T11:56:15+08:00",
"Id": "157",
"Level": "Info",
"Message": "CPU1 triggered an uncorrectable error",
"MessageArgs": [
1
],
"Name": "Log Entry 157",
"Oem": {
"Public": {
"EventCode": "0x07b201df"
}
},
"SensorName": "CPU1_Status",
"SensorType": "Processor",
"Severity": "OK"
},
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/156",
"@odata.type": "#LogEntry.v1_6_1.LogEntry",
"Created": "2022-04-11T11:56:15+08:00",
"Description": "System Event Log",
"EntryCode": "Asserted",
"EntryType": "Event",
"EventTimestamp": "2022-04-11T11:56:15+08:00",
"Id": "156",
"Level": "Info",
"Message": "LPC Reset occurred",
"MessageArgs": [
1
],
"Name": "Log Entry 156",
"Oem": {
"Public": {
"EventCode": "0x22d000de"
}
},
"SensorName": "ACPI_State",
"SensorType": "System ACPI Power State",
"Severity": "OK"
},
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/155",
"@odata.type": "#LogEntry.v1_6_1.LogEntry",
"Created": "2022-04-11T11:56:10+08:00",
"Description": "System Event Log",
"EntryCode": "Asserted",
"EntryType": "Event",
"EventTimestamp": "2022-04-11T11:56:10+08:00",
"Id": "155",
"Level": "Info",
"Message": "Initiated by hard reset",
"MessageArgs": [
1
],
"Name": "Log Entry 155",
"Oem": {
"Public": {
"EventCode": "0x1d1000de"
}
},
"SensorName": "BMC_Boot_Up",
"SensorType": "System Boot / Restart Initiated",
"Severity": "OK"
}
],
"Members@odata.count": 174,
"Members@odata.nextLink": "/redfish/v1/Systems/1/LogServices/Log1/Entries?$skip=20&$top=100",
"Name": "System Event Log Entries",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
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. |
|
Description |
String |
Description of the event log collection resource. |
|
Members@odata.count |
Integer |
Number of event log entry resources. |
|
Members@odata.nextLink |
String |
Link to an event log entry resource on multiple pages. |
|
Members |
List of event log entry resources. |
|
Obtain event log entry resource information
Description
Obtain information about a specific event log entry resource.
Privilege module
OemSystemAudit
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id/Entries/Entries_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#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1",
"@odata.type": "#LogEntry.v1_7_0.LogEntry",
"Created": "2022-02-19T11:40:55+08:00",
"Description": "System Event Log",
"EntryCode": "Asserted",
"EntryType": "Event",
"EventTimestamp": "2022-02-19T11:40:55+08:00",
"EventType": "StatusChange",
"Id": "1",
"Level": "Info",
"Message": "Dropped_below_the_lower_major_threshold",
"MessageArgs": [
1
],
"Name": "Log Entry 1",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"EventCode": "0x02200002"
}
},
"SensorName": "Voltage",
"SensorType": "Voltage",
"Severity": "OK"
}
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. |
|
EventType |
String |
Event type: · StatusChange · ResourceUpdated · ResourceAdded · ResourceRemoved · Alert |
|
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. |
|
Oem.Public.EventCode |
String |
Event code. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the EventType field. |
Export event log entry information
Description
Export the event log entry information.
Privilege module
OemSystemAudit
Request
Method and URL:
POST https://device_ip/redfish/v1/Systems/system_id/LogServices/Actions/Oem/Public/LogServices.ExportEventLog
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
// Local export:
{
"Type":"URI",
"Content": "/tmp/web/dump.csv"
}
// Remote export:
Cifs or sftp
{
"Type":"URI",
"Content": "sftp://username:password@10.10.10.191/usr/dump.tar.gz"
}
//http, tftp, nfs, or https
{
"Type":"URI",
"Content": "http://ip/filename",
"Oem": {
"Public": {
"ScriptName":"1.php"
}
}
}
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. |
|
Type |
String. |
URI |
|
Content |
Link to export configuration file. |
See "Others." |
|
Oem.Public.ScriptName |
Script name. String. |
This field is required if you use HTTP or HTTPS to export the configuration file. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Systems/1/LogServices/Actions/Oem/Public/LogServices.ExportEventLog
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Type":"URI",
"Content": "/tmp/web/dump.csv"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Clear event log entry information
Description
Delete event log entries for a specific event log service from the server.
Privilege module
OemDiagnosis
Request
Method and URL:
POST https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_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:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Obtain GPU information
Description
Obtain GPU information from the server.
Privilege module
Login
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",
"@odata.type": "#GPU.v1_0_0.GPU",
"Description": "Get GPU info for this system",
"GPUMaxNum":4,
"Healthstate":{
"OverallHealth":"OK"
},
"GPU": [
{
"FirmwareVersion": "88.00.1A.00.03",
"ID": "0x1",
"Manufacture": "NVIDIA",
"Model": "Tesla V100-PCIE-16GB",
"Name": "Tesla V100-PCIE-16GB",
"Oem": {
"Public": {
"DriverVersion": "N/A",
"ECCEnable": 1,
"GCUVoltage": 0.75,
"GPUDeviceError": 16384,
"GPUMemoryError": 16384,
"HBMVoltage": 1.25,
"PCIeBusError": 16384,
"ProductDate": "20240517"
}
},
"PartNumber": "1DB4-893-A1",
"PowerConsumedWatts": 0,
"PowerCapacityWatts": 500,
"SerialNumber": "0323617020478",
"SlotNum": 2,
"Status": {
"Health": "OK",
"State": "Enable",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
}
},
"TemperatureCelsius": 50
}
],
"Members@odata.count": 1,
"Oem":{
"Public":{
"PowerControl": [
{
"PowerLimit": {
"CorrectionInMs": 30000,
"LimitException": "NoAction",
"LimitInWatts": 2000
},
"PowerMetrics": {
"MaxConsumedWatts": 10000,
"MinConsumedWatts": 1000
}
}
],
"CompletionCode":0,
"Description":"Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the GPU resourcel model. |
|
@odata.id |
String |
Link to the GPU resource. |
|
@odata.type |
String |
Type of the GPU resources. |
|
Description |
String |
Description of the interface. |
|
GPUMaxNum |
Integer |
Maximum numbers. |
|
Healthstate.OverallHealth |
String |
Overall health status. |
|
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.Oem.Public.DriverVersion |
String |
Driver version (only supported by the Enflame S60 GPU). |
|
GPU.Oem.Public.ECCEnable |
String |
Enabling status of ECC (only supported by the Enflame S60 GPU). |
|
GPU.Oem.Public.GCUVoltage |
Value |
GCU voltage (only supported by the Enflame S60 GPU). The unit is V. |
|
GPU.Oem.Public.HBMVoltage |
Value |
HBM voltage (only supported by the Enflame S60 GPU). The unit is V. |
|
GPU.Oem.Public.GPUDeviceError |
Value |
GPU device error (only supported by the Enflame S60 GPU). Values include: · 0: Represents healthy. · 16384: Represents that a recoverable error has occurred on the acceleration module. · 32768: Represents that a non-recoverable error has occurred on the acceleration module peripheral. |
|
GPU.Oem.Public.PCIeBusError |
Value |
PCIe error (only supported by the Enflame S60 GPU). Values include: · 0: Represents healthy. · 16384: Represents that a recoverable error has occurred on the acceleration module peripheral. · 32768: Represents that a non-recoverable error has occurred on the acceleration module. |
|
GPU.Oem.Public.GPUMemoryError |
Value |
GPU memory error (only supported by the Enflame S60 GPU). Values include: · 0: Represents healthy. · 16384: Represents that a recoverable error has occurred on the acceleration module VRAM. · 32768: Represents that a non-recoverable error has occurred on the acceleration module VRAM. |
|
GPU.Oem.Public.ProductDate |
String |
Product production date (only supported by the Enflame S60 GPU). Values include: |
|
GPU.PartNumber |
String |
Part number. |
|
GPU.PowerConsumedWatts |
Integer |
Power. If this field is 0, install the GPU driver in the OS. |
|
GPU.PowerCapacityWatts |
Integer |
Rated power. |
|
GPU.SerialNumber |
String |
Serial number. |
|
GPU.SlotNum |
Integer |
Slot number. |
|
GPU.Status.Health |
String |
GPU health status. |
|
GPU.Status.State |
String |
Whether the GPU is present. |
|
GPU.Status.Oem.Public.Severity |
String |
Custom health status. |
|
GPU.Status.Oem.Public.FaultDescription |
String |
Fault description information. |
|
GPU.TemperatureCelsius |
Integer |
GPU temperature in Celsius degree. |
|
Members@odata.count |
Integer |
Number of GPUs. |
|
PowerControl.PowerLimit.CorrectionInMs |
Integer |
Correction time of GPU node power capping in ms. |
|
PowerControl.PowerLimit.LimitException |
String |
Action upon GPU node power capping failure. Options include NoAction and HardPowerOff. The HardPowerOff option is not supported by G6 servers. |
|
PowerControl.PowerLimit.LimitInWatts |
Integer |
GPU node power cap value. Null indicates power capping is disabled |
|
PowerControl.PowerLimit.PowerLimitEnable |
Boolean |
Enabling status of power capping. |
|
PowerControl.PowerMetrics.MaxConsumedWatts |
Integer |
Maximum GPU node power cap value. |
|
PowerControl.PowerMetrics.MinConsumedWatts |
Integer |
Minimum GPU node power cap value. This operation is supported only by G6 5500 AMD/Intel models. |
Change history
|
Version |
Change description |
|
HDM3-2.01 |
Added the GPU.PowerCapacityWatts field. |
|
HDM2-2.10 |
Added the GPU.Oem.Public.DriverVersion, GPU.Oem.Public.ECCEnable, GPU.Oem.Public.GCUVoltage, GPU.Oem.Public.HBMVoltage, GPU.Oem.Public.GPUDeviceError, GPU.Oem.Public.PCIeBusError, GPU.Oem.Public.GPUMemoryError, and GPU.Oem.Public.ProductDate fields. |
|
HDM2-1.58 |
Added the description, which indicates that G6 servers do not support the HardPowerOff option of the PowerControl.PowerLimit.LimitException field. |
Configure GPU information
Description
Configure GPU node power capping. This operation is supported only by G6 5500 AMD/Intel models.
Privilege module
OemKvm
Locking type of the associated system
BMC configuration locking
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":limit_watts,
"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. |
|
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. The HardPowerOff option is not supported by G6 servers. |
|
PowerControl.PowerLimit.LimitInWatts |
Power cap value. |
The power cap value range is 1000 W to 10000 W. Power capping is enabled automatically when you set a power cap value in the range of 1000 W to 10000 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",
"@odata.type": "#GPU.v1_0_0.GPU",
"Description": "Get GPU info for this system",
"GPUMaxNum":4,
"Healthstate":{
"OverallHealth":"OK"
},
"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",
"Oem": {
"Public": {
"FaultDescription": "",
"Severity": "Informational"
}
}
},
"TemperatureCelsius": 50
}
],
"Members@odata.count": 1,
"Oem":{
"Public":{
"PowerControl": [
{
"PowerLimit": {
"CorrectionInMs": 30000,
"LimitException": "NoAction",
"LimitInWatts": 2000,
"PowerLimitEnable": true
},
"PowerMetrics": {
"MaxConsumedWatts": 10000,
"MinConsumedWatts": 1000
}
}
],
"CompletionCode":0,
"Description":"Success"
}
}
}
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 |
|
HDM2-1.58 |
Added the description, which indicates that G6 servers do not support the HardPowerOff option of the PowerControl.PowerLimit.LimitException field. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain information about security control panel
Description
Obtain information about security control panel. This feature is not available for X18000 products.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/SecurityBezel
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/Oem/Public/SecurityBezel
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#SecurityBezel/$entity",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/SecurityBezel",
"@odata.type": "#SecurityBezel.v1_0_0.SecurityBezel",
"Description": "Security Bezel Control",
"Id": "SecurityBezel",
"Name": "SecurityBezel",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SecurityBezelEnabled": true,
"SecurityBezelSettings": {
"DecorativeLEDMode": {
"RelatedOemMode": {
"Color": "White",
"LEDFlashingMode": "Breathing"
},
"RelatedStatusMode": null
},
"DecorativeLEDType": "Bright",
"LogoLEDEnabled": true
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the control panel resource model. |
|
@odata.id |
String |
Link to the control panel resources. |
|
@odata.type |
String |
Type of the control panel resource. |
|
Description |
String |
Description of the control panel resource. |
|
Id |
String |
ID of the control panel resource. |
|
Name |
String |
Name of the control panel resource. |
|
SecurityBezelEnabled |
Boolean |
Security panel enabled. |
|
SecurityBezelSettings |
Object |
Panel settings. |
|
SecurityBezelSettings.DecorativeLEDType |
String |
Supported options: · Bright: Brightness. · Soft: Softness. · Off: Disabled. |
|
SecurityBezelSettings.LogoLEDEnabled |
Boolean |
Logo LED enabled status. |
|
SecurityBezelSettings.DecorativeLEDMode |
Object |
Ambient LED mode. |
|
SecurityBezelSettings.DecorativeLEDMode.RelatedStatusMode |
Object |
Ambient LED status-linked mode. |
|
SecurityBezelSettings.DecorativeLEDMode.RelatedStatusMode.RelatedHealthEnabled |
Boolean |
Health status-linked enabled status. · true—status-linked. · false—custom. |
|
SecurityBezelSettings.DecorativeLEDMode.RelatedOemMode |
Object |
Ambient LED custom mode. |
|
SecurityBezelSettings.DecorativeLEDMode.RelatedOemMode. LEDFlashingMode |
String |
Custom ambient LED effects. Supported options: · Breathing—Breathing. · Flow—Flowing. · Steady On: Always on. |
|
SecurityBezelSettings.DecorativeLEDMode.RelatedOemMode.Color |
String |
Custom LED colors. Supported options: · White—White. · Amber—Orange. · Red—Red. |
Set security control panel information
Description
Set security control panel information. This feature is not available for X18000 products.
Privilege module
ConfigureComponents
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Systems/system_id/Oem/Public/SecurityBezel
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"SecurityBezelSettings": {
"DecorativeLEDMode": {
"RelatedOemMode": {
"Color": "White",
"LEDFlashingMode": "Breathing"
},
"RelatedStatusMode": null
},
"DecorativeLEDType": "Bright",
"LogoLEDEnabled": 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. |
|
system_id |
ID of the system resource. |
Only value 1 is supported. |
|
SecurityBezelSettings |
Panel Settings. |
Object. |
|
SecurityBezelSettings.DecorativeLEDType |
Decorative LED setting types. |
String. Supported options: · Bright: · Soft. · Off. |
|
SecurityBezelSettings.LogoLEDEnabled |
Logo LED enable status. |
Boolean. |
|
SecurityBezelSettings.DecorativeLEDMode |
Ambient LED Mode. |
Object. |
|
SecurityBezelSettings.DecorativeLEDMode.RelatedStatusMode |
Ambient LED status linked mode. |
Object. |
|
SecurityBezelSettings. DecorativeLEDMode. RelatedStatusMode. RelatedHealthEnabled |
Health status linked enable status. |
Boolean. |
|
SecurityBezelSettings.DecorativeLEDMode.RelatedOemMode |
Custom Ambient LED mode. |
Object. |
|
SecurityBezelSettings.DecorativeLEDMode.RelatedOemMode.LEDFlashingMode |
Ambient LED effect. |
String. Supported options: · Breathing—Breathing. · Flow—Flowing. · Steady On—Always on. |
|
SecurityBezelSettings.DecorativeLEDMode.RelatedOemMode.Color |
Light color. |
String. Supported options: · White. · Amber. · Red. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/SecurityBezel
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"SecurityBezelSettings": {
"DecorativeLEDMode": {
"RelatedOemMode": {
"Color": "White",
"LEDFlashingMode": "Breathing"
}
},
"DecorativeLEDType": "Bright",
"LogoLEDEnabled": true
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#SecurityBezel/$entity",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/SecurityBezel",
"@odata.type": "#SecurityBezel.v1_0_0.SecurityBezel",
"Description": "Security Bezel Control",
"Id": "SecurityBezel",
"Name": "SecurityBezel",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SecurityBezelEnabled": true,
"SecurityBezelSettings": {
"DecorativeLEDMode": {
"RelatedOemMode": {
"Color": "White",
"LEDFlashingMode": "Breathing"
},
"RelatedStatusMode": null
},
"DecorativeLEDType": "Bright",
"LogoLEDEnabled": true
}
}
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 information about security control panel."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain information about network interface collection resource
Description
Obtain information about network interface collection resource.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/NetworkInterfaces
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/NetworkInterfaces
Request header:
X-Auth-Token:TOKEN
Content-Type:application/jso
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/NetworkInterfaces/$entity",
"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces",
"@odata.type": "#NetworkInterfaceCollection.NetworkInterfaceCollection",
"Members": [
{
"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/PCIeSlot3"
}
],
"Members@odata.count": 1,
"Name": "Network Interface Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of network interface resource model. |
|
@odata.id |
String |
Link to the network interface resource. |
|
@odata.type |
String |
Type of the network interface resource. |
|
Name |
String |
Name of the network interface resource. |
|
Members@odata.count |
Integer |
Number of network interface resources. |
|
Members |
List of the network interface resources. |
|
Obtain information of the specified network interface resource
Description
Obtain information of the specified network interface resource.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/NetworkInterfaces/networkinterfaces_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. |
|
networkinterfaces_id |
ID of the network interface resource. |
You can obtain network interface resource IDs from network interface collection resource. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/Systems/1/NetworkInterfaces/PCIeSlot3
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/NetworkInterfaces/Members/$entity",
"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/PCIeSlot3",
"@odata.type": "#NetworkInterface.v1_2_1.NetworkInterface",
"Id": "PCIeSlot3",
"Links": {
"NetworkAdapter": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot3"
}
},
"Name": "PCIeSlot3",
"NetworkPorts": {
"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/PCIeSlot3/NetworkPorts"
},
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of network interface resource model. |
|
@odata.id |
String |
Link to the network interface resource. |
|
@odata.type |
String |
Type of the network interface resource. |
|
Id |
String |
ID of the network interface resource. |
|
Name |
String |
Name of the network interface resource. |
|
Links.NetworkAdapter |
Object |
Link to the network adapter resource node. |
|
NetworkPorts |
Object |
Link to the network port resource node. |
Obtain network port collection information
Description
Obtain network port collection information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/NetworkInterfaces/networkinterfaces_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. |
|
system_id |
ID of the system resource. |
Only value 1 is supported. |
|
networkinterfaces_id |
ID of the network interface resource. |
You can obtain network interface resource IDs from network interface collection resource. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/Systems/1/NetworkInterfaces/PCIeSlot3/NetworkPorts
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/NetworkInterfaces/Members/mainboardNIC1/NetworkPorts/$entity",
"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/PCIeSlot3/NetworkPorts",
"@odata.type": "#NetworkPortCollection.NetworkPortCollection",
"Members": [
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot3/NetworkPorts/1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot3/NetworkPorts/2"
}
],
"Members@odata.count": 2,
"Name": "Network Port Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
String |
Current number of system resources. |
|
Name |
Integer |
Name of the system resource. |
|
Members |
List of network port resources. |
|
|
@odata.id |
String |
Link to a single network port resource node. |
Clear configuration
Description
Clear BMC, BIOS, and storage configurations.
Privilege module
ConfigureUsers
Locking type of the associated system
Hardware configuration locking (when clearing storage configuration), BIOS configuration locking (when clearing BIOS configuration), BMC configuration locking (when clearing BMC configuration)
Request
Method and URL:
POST https://device_ip/redfish/v1/Systems/system_id/Actions/Oem/Public/Systems.ClearConfiguration
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"SecureErase":[
"erase_option1",
"erase_option2",
"erase_option3"
]
}
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. |
|
SecureErase |
Array. |
Optional Fields: · BIOS. · Storage. · BMC. The Storage field is not available for X18000. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ClearConfiguration
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"SecureErase":[
"BIOS",
"Storage",
"BMC"
]
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Download clear configuration reports
Description
Download the cleared configuration report.
Privilege module
ConfigureUsers
Request
Method and URL:
POST https://device_ip/redfish/v1/Systems/system_id/Actions/Oem/Public/Systems.ExportReport
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/Actions/Oem/Public/Systems.ExportReport
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{}
Response:
{
"@odata.context": "/redfish/v1/$Systems.ClearExportReport",
"@odata.type": "#Systems.ClearExportReport",
"@odata.id": "/redfish/v1/Systems/1/Actions/Oem/Public/Systems.ExportReport",
"Description": "ClearConfigurationDownload",
"FileName":"/mnt/sdmmc0p4/secure_erase_result.csv"
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description information for server upgradable firmware collection resource model. |
|
@odata.id |
String |
Link to server upgradable firmware collection resource node. |
|
@odata.type |
String |
Type of the server upgradable firmware collection resource. |
|
FileName |
String |
Exported file link and name. |
|
Description |
String |
Description of the server upgradable firmware collection resource. |
Obtain the detailed progress of configuration clearance
Description
Obtain the detailed progress of configuration clearance.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/ClearConfigurationProgress
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/Oem/Public/ClearConfigurationProgress
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#ClearConfigurationProgress.ClearConfigurationProgress",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/ClearConfigurationProgress",
"@odata.type": "#ClearConfigurationProgress.v1_0_0.ClearConfigurationProgress",
"TotalProgress": 60,
"ClearStatus": "Waiting",
"Storage":
{
"SD":{
"Progress": 100,
"Message": ""
},
"NVDIMM":{
"Progress": 100,
"Message": ""
},
"StorageController":[
{
"Model":"RSTe&VROC",
"Slot":null,
"Mode":null,
"Drives":[
{
"DriveType": "SATA",
"MediaType": "HDD",
"Progress": 99,
"Position": "[11:0:0:0]",
"Message": ""
},
{
"DriveType": "SATA",
"MediaType": "HDD",
"Progress": 100,
"Position": "[12:0:0:0]",
"Message": ""
}
]
},
{
"Model": "P460-M2",
"Slot": "1",
"Mode": "RAID",
"Drives": [
{
"DriveType": "NVME",
"MediaType": "SSD",
"Position": "Controller:1, Channel:1, Device:1",
"Progress": 10,
"Message": ""
}
]
}
]
},
"BIOS":
{
"Progress": 10,
"Message": ""
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description for server upgradable firmware collection resource model. |
|
@odata.id |
String |
Link to the server upgradable firmware collection resource node. |
|
@odata.type |
String |
Type of the server upgradable firmware collection resource node. |
|
TotalProgress |
Integer |
Overall progress. |
|
ClearStatus |
String |
Clear status types. Supported options: · Idle. · Waiting. · In Progress. · Completed. |
|
Storage.SD.Progress |
Integer |
Clearance progress of the storage SD card. |
|
Storage.SD.Message |
String |
This field records error messages and displays empty when the error information has been successfully cleared. |
|
Storage.NVDIMM.Progress |
Integer |
· Storage NVDIMM clearance progress. |
|
Storage.NVDIMM.Message |
String |
This field records error messages for storage NVDIMM and displays empty when the error information has been successfully cleared. |
|
Storage.StorageController |
Array |
|
|
Storage.StorageController.Model |
String |
Model of the storage controller. |
|
Storage.StorageController.Slot |
Integer |
Slot number. |
|
Storage.StorageController.Mode |
String |
Mode. |
|
Storage.StorageController.Drives |
Array |
|
|
Storage.StorageController.Drives.DriveType |
String |
Type of the storage controller interface. |
|
Storage.StorageController.Drives.MediaType |
String |
Media type. Options: · SSD. · HDD. |
|
Storage.StorageController.Drives.Progress |
Integer |
Progress 0 to 100, in percent. |
|
Storage.StorageController.Drives.Position |
String |
Location information. |
|
Storage.StorageController.Drives.Message |
String |
This field records error messages and displays empty when the error information has been successfully cleared. |
|
BIOS.Progress |
Integer |
Progress 0 to 100, in percent. |
|
BIOS.Message |
String |
This field records error messages and displays empty when the error information has been successfully cleared. |
Change history
|
Version |
Change description |
|
HDM2-2.15 |
Edited the description for the ClearStatus field. |
Obtain the system software inventory information
Description
Obtain the system software inventory information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/SoftwareList
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/Oem/Public/SoftwareList
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#SoftwareList/$entity",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/SoftwareList",
"@odata.type": "#SoftwareList.v1_0_0.SoftwareList",
"AgentState": "Enabled",
"Description": "Get software list",
"Id": "SoftwareList",
"Name": "SoftwareList",
"OSHostName": "Not detected",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SoftwareInfoList": {
"Details": [
{
"Index": 0,
"Locations": "/usr/local/sbin",
"Name": "Test1",
"UpdateTimes": "2021-02-14T18:15:25+08:00",
"Version": "5.7.24"
},
……
],
"TotalNumber": 5
},
"SystemType": "Windows",
"SystemVersion": "CentOS release 6.9 (Final)",
"Version": "V001"
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description for the system software inventory resource model. |
|
@odata.id |
String |
Link to the system software inventory resource. |
|
@odata.type |
String |
Type of system software inventory resources. |
|
Id |
String |
ID of system software inventory resources. |
|
Name |
String |
Name of the system inventory resource. |
|
OSHostName |
String |
System host name. |
|
Description |
String |
Description for the system software inventory resource. |
|
SoftwareInfoList |
Object |
System software inventory details |
|
SoftwareInfoList.Details |
Array |
Details of the system software inventory. Location |
|
SoftwareInfoList.Details.Index |
Integer |
Software index. |
|
SoftwareInfoList.Details.Locations |
String |
Software Location |
|
SoftwareInfoList.Details.Name |
String |
Name of the software. |
|
SoftwareInfoList.Details.UpdateTimes |
String |
Update time of the software versions. |
|
SoftwareInfoList.Details.Version |
String |
Software version information. |
|
SoftwareInfoList.TotalNumber |
Integer |
Number of the software. |
|
SystemType |
String |
System type. |
|
SystemVersion |
String |
System version. |
|
Version |
String |
Version information. |
|
AgentState |
Boolean |
Whether FIST SMS is present. Supported options: · Enabled. · Absent. |
Change history
|
Version |
Change description |
|
HDM2-2.14 HDM2-1.17 |
Added the OSHostName field. |
Clear inactive BIOS configurations
Description
Clear inactive BIOS configuration properties.
Privilege module
OemKvm
Locking type of the associated system
BIOS configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/Systems/system_id/Bios/Settings/Actions/Oem/Public/Settings.Revoke
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/Bios/Settings/Actions/Oem/Public/Settings.Revoke
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain host status migration information
Description
Obtain host status migration information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/HostStatus
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/Oem/Public/HostStatus
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#HostStatus.HostStatus",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/HostStatus",
"@odata.type": "#HostStatus.v1_0_0.HostStatus",
"AgentState": "Absent",
"CurrentStartupRecords": {
"BIOSStage": {
"BiosVersion": "",
"ComponentIsolated": false,
"CurrentStageDurationSeconds": 0,
"DurationSeconds": 0,
"EndTime": "",
"ErrorCount": 0,
"FaultList": [],
"MEFirmwareVersion": "",
"POSTCode": "0x0000",
"POSTCodeDescription": "",
"StartTime": "",
"VersionChanged": false
},
"CurrentStage": "PowerDown",
"OSStage": {
"ErrorCount": 0,
"FaultList": [],
"ReadyTime": "",
"StartTime": "",
"UCECount": 0
},
"PowerDownStage": {
"PowerDownCause": "",
"StartTime": ""
},
"PowerUpStage": {
"DurationSeconds": 0,
"PowerUpCause": "",
"StartTime": ""
}
},
"DSDCardState": "Enabled",
"HostSummary": {
"DurationSeconds": 0,
"RunningState": "PowerOff"
},
"Id": "HostStatus",
"LastStartupRecords": {
"BIOSStage": {
"BiosVersion": "",
"ComponentIsolated": false,
"CurrentStageDurationSeconds": 0,
"DurationSeconds": 0,
"EndTime": "",
"ErrorCount": 0,
"FaultList": [],
"MEFirmwareVersion": "",
"POSTCode": "0x0000",
"POSTCodeDescription": "",
"StartTime": "",
"VersionChanged": false
},
"CurrentStage": "PowerUp",
"OSStage": {
"ErrorCount": 0,
"FaultList": [],
"ReadyTime": "",
"StartTime": "",
"UCECount": 0
},
"PowerDownStage": {
"PowerDownCause": "",
"StartTime": ""
},
"PowerUpStage": {
"DurationSeconds": 0,
"PowerUpCause": "",
"StartTime": ""
}
},
"Name": "Host Status",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SystemVersion": "Not detected",
"TPMState": "Absent",
"TPMType": null
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description information for host status resource model. |
|
@odata.id |
String |
Link to the host status resource. |
|
@odata.type |
String |
Type of host status resource. |
|
Id |
String |
ID of host status resource. |
|
Name |
String |
Name of host status resource. |
|
AgentState |
String |
Agent presence status. Supported options: · Enabled. · Absent. |
|
DSDCardState |
String |
· DSDCard presence status. · Supported options: · Enabled. · Absent. · NotSupported. |
|
TPMState |
String |
TPM status. Supported options: · Enabled. · Disabled. · Absent. · NotSupported. |
|
TPMType |
String |
Name of the trusted password module. Options: · TPM. · TCM. |
|
SystemVersion |
String |
System version. |
|
HostSummary |
Object |
Host summary information. |
|
RunningState |
String |
Current operating status. Supported options: · PowerOn. · PowerOff. |
|
DurationSeconds |
Integer |
· Duration of current status. |
|
CurrentStageDurationSeconds |
Integer |
Duration of BIOS phase. |
|
LastStartupRecords |
Object |
· Data of last boot status record. |
|
CurrentStartupRecords |
Object |
Data of current boot status record. |
|
CurrentStage |
String |
Current host migration status phase. Supported options: · PowerUp. · BIOS_Starting. · BIOS_Ending. · OS. · PowerDown. |
|
PowerUpStage |
Object |
Power-on phase status information. |
|
BIOSStage |
Object |
BIOS phase status information. |
|
OSStage |
Object |
OS phase status information. |
|
PowerDownStage |
Object |
Power-down phase. |
|
StartTime |
String |
Start time of current status. |
|
EndTime |
String |
End time of current status. |
|
PowerUpCause |
String |
Reason for power-on. |
|
PowerDownCause |
String |
Reason for power-off. |
|
VersionChanged |
Boolean |
BIOS version changed. |
|
ComponentIsolated |
Boolean |
Component isolation present. |
|
POSTCode |
String |
Current power-on self-test code. |
|
POSTCodeDescription |
String |
Description of power-on self-test code. |
|
ErrorCount |
Integer |
Number of failures. |
|
BiosVersion |
Integer |
BIOS version. |
|
MEFirmwareVersion |
Integer |
ME version. (Not supported by AMD) |
|
ReadyTime |
String |
Time for OS system readiness. |
|
UCECount |
Integer |
Number of UCEs |
|
FaultList |
Array |
List of fault logs. |
|
Id |
String |
Log ID. |
|
TimeStamp |
String |
Timestamp. |
|
EventCode |
String |
Event code. |
|
Message |
String |
Log details. |
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the NotSupported option to the DSDCardState field. |
Obtain information about host resource monitoring
Description
Obtain host resource monitoring information.
Privilege module
Login
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 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/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",
"AgentState": "Absent",
"Description": "The system performance monitoring",
"DriveHistoryUsageRate": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate"
},
"DriveIOPSHistoryData": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveIOPSHistoryData"
},
"DriveSVCTMHistoryData": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveSVCTMHistoryData"
},
"DriveUsageAlarmThreshold": 0,
"DriveUsageRateAlarmThreshold": 0,
"ExternalDevice": [
{
"FreeSpaceMB": 4868,
"Model": "Kingston_DataTraveler_2.0_C86000BDB7B8EF306A25DA0C",
"SpeedMbps": 480.0,
"TotalCapacityMB": 7792
},
{
"FreeSpaceMB": 1395,
"Model": "USB_SanDisk_3.2Gen1_010140fc9d2cd08aa332d1f13eed2cb7248bf3bfba8419ddfd79063f84b189dbe33000000000000000000000689ec8130084450091558107a22aad68",
"SpeedMbps": 480.0,
"TotalCapacityMB": 1652
}
],
"FullDuplexThroughputHistoryData": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/FullDuplexThroughputHistoryData"
},
"GPUHistoryUsageRate": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/GPUHistoryUsageRate"
},
"Id": "PerformanceMonitoring",
"MemoryHistoryUsageRate": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate"
},
"MemoryUsageAlarmThreshold": 0,
"MemoryUsageRate": 11,
"MemoryUsageRateAlarmThreshold": 0,
"NFSClientIOSpeedHistoryData": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSClientIOSpeedHistoryData"
},
"NFSServerIOSpeedHistoryData": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSServerIOSpeedHistoryData"
},
"Name": "PerformanceMonitoring",
"NetworkUsageRateAlarmThreshold": 0,
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ProcessorsHistoryUsageRate": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/ProcessorsHistoryUsageRate"
},
"ProcessorsUsageAlarmThreshold": 0,
"ProcessorsUsageRate": 0,
"ProcessorsUsageRateAlarmThreshold": 0,
"SystemLoadHistoryData": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/SystemLoadHistoryData"
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of host resource monitoring model. |
|
@odata.id |
String |
Link to host resource monitoring resources. |
|
@odata.type |
String |
Type of host resource monitoring resources. |
|
AgentState |
String |
Agent presence status. Supported options: · Enabled. · Absent. |
|
Id |
String |
Resource ID. |
|
Name |
String |
Resource name. |
|
Description |
String |
Description for interface function. |
|
ProcessorsUsageRateAlarmThreshold |
Integer |
CPU usage alarm threshold. |
|
MemoryUsageRateAlarmThreshold |
Integer |
Memory usage alarm threshold. |
|
DriveUsageRateAlarmThreshold |
Integer |
Hard drive usage alarm threshold. |
|
NetworkUsageRateAlarmThreshold |
Integer |
Network usage alarm threshold. |
|
MemoryHistoryUsageRate |
Object |
Link to memory history usage resource. |
|
ProcessorsHistoryUsageRate |
Object |
Link to CPU history usage resource. |
|
FullDuplexThroughputHistoryData |
Object |
Link to network history send/receive speed resource. |
|
GPUHistoryUsageRate |
Object |
Link to GPU history usage resource. |
|
DriveHistoryUsageRate |
Object |
Link to disk history usage resource. |
|
DriveIOPSHistoryData |
Object |
Link to disk IO performance history data. |
|
DriveSVCTMHistoryData |
Object |
Link to disk SVCTM performance history data. |
|
NFSServerIOSpeedHistoryData |
Object |
Link to NFS server read/write speed history data. |
|
NFSClientIOSpeedHistoryData |
Object |
Link to NFS client read/write speed history data. |
|
SystemLoadHistoryData |
Object |
Link to system load information history data. |
|
ExternalDevice |
Array |
External device information. |
|
Model |
String |
Device model. |
|
SpeedMbps |
Integer |
Device speed. |
|
TotalCapacityMB |
Integer |
Device total capacity. |
|
FreeSpaceMB |
Integer |
Device available capacity. |
|
MemoryUsageRate |
Integer |
Memory usage rate. |
|
ProcessorsUsageRate |
Integer |
CPU usage rate. |
|
DriveUsageAlarmThreshold |
Integer |
Drive usage alarm threshold. |
|
MemoryUsageAlarmThreshold |
Integer |
Memory usage alarm threshold. |
|
ProcessorsUsageAlarmThreshold |
Integer |
CPU usage alarm threshold. |
Change history
|
Version |
Change description |
|
HDM2-1.54 |
Added the DriveUsageAlarmThreshold, MemoryUsageAlarmThreshold, and ProcessorsUsageAlarmThreshold fields. |
|
HDM2-1.14 |
Added MemoryUsageRate and ProcessorsUsageRate fields, and included output descriptions. |
Configure host resource monitoring information settings
Description
Configure host resource monitoring information settings.
Privilege module
OemKvm
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"ProcessorsUsageAlarmThreshold": processors_usage_alarm_threshold,
"MemoryUsageAlarmThreshold": memory_usage_alarm_threshold,
"NetworkUsageAlarmThreshold": network_usage_alarm_threshold,
"DriveUsageAlarmThreshold": dirve_usage_alarm_threshold
}
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. |
|
ProcessorsUsageAlarmThreshold |
CPU usage rate alarm threshold. |
Integer. |
|
MemoryUsageAlarmThreshold |
Memory usage rate alarm threshold. |
Integer. |
|
DriveUsageAlarmThreshold |
Drive usage rate alarm threshold. |
Integer. |
|
NetworkUsageAlarmThreshold |
Network port usage rate alarm threshold. This field is not supported for configuration. |
Integer. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"ProcessorsUsageAlarmThreshold": 20,
"MemoryUsageAlarmThreshold": 10,
"DriveUsageAlarmThreshold": 20
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#PerformanceMonitoring.PerformanceMonitoring",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring",
"@odata.type": "#PerformanceMonitoring.v1_0_0.PerformanceMonitoring",
"AgentState": "Absent",
"Description": "The system performance monitoring",
"DriveHistoryUsageRate": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate"
},
"DriveIOPSHistoryData": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveIOPSHistoryData"
},
"DriveSVCTMHistoryData": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveSVCTMHistoryData"
},
"DriveUsageAlarmThreshold": 20,
"DriveUsageRateAlarmThreshold": 20,
"ExternalDevice": [
{
"FreeSpaceMB": 4868,
"Model": "Kingston_DataTraveler_2.0_C86000BDB7B8EF306A25DA0C",
"SpeedMbps": 480.0,
"TotalCapacityMB": 7792
},
{
"FreeSpaceMB": 1395,
"Model": "USB_SanDisk_3.2Gen1_010140fc9d2cd08aa332d1f13eed2cb7248bf3bfba8419ddfd79063f84b189dbe33000000000000000000000689ec8130084450091558107a22aad68",
"SpeedMbps": 480.0,
"TotalCapacityMB": 1652
}
],
"FullDuplexThroughputHistoryData": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/FullDuplexThroughputHistoryData"
},
"GPUHistoryUsageRate": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/GPUHistoryUsageRate"
},
"Id": "PerformanceMonitoring",
"MemoryHistoryUsageRate": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate"
},
"MemoryUsageAlarmThreshold": 10,
"MemoryUsageRate": 11,
"MemoryUsageRateAlarmThreshold": 10,
"NFSClientIOSpeedHistoryData": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSClientIOSpeedHistoryData"
},
"NFSServerIOSpeedHistoryData": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSServerIOSpeedHistoryData"
},
"Name": "PerformanceMonitoring",
"NetworkUsageRateAlarmThreshold": 0,
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ProcessorsHistoryUsageRate": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/ProcessorsHistoryUsageRate"
},
"ProcessorsUsageAlarmThreshold": 20,
"ProcessorsUsageRate": 0,
"ProcessorsUsageRateAlarmThreshold": 20,
"SystemLoadHistoryData": {
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/SystemLoadHistoryData"
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain information about host resource monitoring."
Change history
|
Version |
Change description |
|
HDM2-1.54 |
Added the DriveUsageAlarmThreshold, MemoryUsageAlarmThreshold, and ProcessorsUsageAlarmThreshold fields in the response. |
|
HDM2-1.14 |
Added MemoryUsageRate and ProcessorsUsageRate fields in the response. |
Obtain information about CPU historical usage rate resource
Description
Obtain information about CPU historical usage rate resource.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/ProcessorsHistoryUsageRate
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/Oem/Public/PerformanceMonitoring/ProcessorsHistoryUsageRate
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#ProcessorsHistoryUsageRate.ProcessorsHistoryUsageRate",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/ProcessorsHistoryUsageRate",
"@odata.type": "#ProcessorsHistoryUsageRate.v1_0_0.ProcessorsHistoryUsageRate",
"Description": "The historical usage rate of processors",
"HistoricalUsageRate": [
{
"Time": "2023-02-19T02:36:42+08:00",
"UsageRatePercents": 5.27
},
{
"Time": "2023-02-19T02:41:42+08:00",
"UsageRatePercents": 5.27
},
{
"Time": "2023-02-19T02:46:42+08:00",
"UsageRatePercents": 5.29
},
],
"Id": "ProcessorsHistoryUsageRate",
"Name": "Processors History Usage Rate",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description for CPU historical usage rate resource model. |
|
@odata.id |
String |
Link to CPU historical usage rate resource. |
|
@odata.type |
String |
Type of CPU historical usage rate resource. |
|
Description |
String |
Description of CPU historical usage rate resource. |
|
HistoricalUsageRate |
Array |
Historical data. |
|
UsageRatePercents |
Integer |
Usage rate upon data generation. |
|
Time |
String |
Time upon data generation. |
Obtain information about memory historical usage rate resource
Description
Obtain information about memory historical usage rate resource.
Privilege module
Login
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 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/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",
"Description": "The historical usage rate of memory",
"HistoricalUsageRate": [
{
"Time": "2023-05-24T05:55:05+08:00",
"UsageRatePercents": 9.35
},
{
"Time": "2023-05-24T06:00:05+08:00",
"UsageRatePercents": 9.36
}
...
],
"Id": "MemoryHistoryUsageRate",
"Name": "Memory History Usage Rate",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description for memory historical usage rate resource model. |
|
@odata.id |
String |
Link to memory historical usage rate resource. |
|
@odata.type |
String |
Type of memory historical usage rate resource. |
|
Description |
String |
Description of memory historical usage rate resource. |
|
Name |
String |
Name of the memory historical usage rate resource. |
|
Id |
String |
ID of the memory historical usage rate resource. |
|
HistoricalUsageRate |
Array |
Historical data. |
|
UsageRatePercents |
Integer |
Usage rate upon data generation. |
|
Time |
String |
Time upon data generation. |
Obtain information about GPU historical usage rate resource
Description
Obtain information about GPU historical usage rate resource.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/GPUHistoryUsageRate
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/Oem/Public/ PerformanceMonitoring/GPUHistoryUsageRate
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#GPUHistoryUsageRate.GPUHistoryUsageRate",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/GPUHistoryUsageRate",
"@odata.type": "#GPUHistoryUsageRate.v1_0_0.GPUHistoryUsageRate",
"Description": "The historical usage rate of GPU",
"GPUList": [
{
"HistoricalUsageRate": [
{
"Time": "2022-07-29T10:55:00--03:00",
"UsageRatePercents": 0.5
},
{
"Time": "2022-07-29T10:55:00--03:00",
"UsageRatePercents": 10.5
},
...
],
"Name": "GeForce GT 720"
}
],
"Id": "GPUHistoryUsageRate",
"Name": "GPU History Usage Rate",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description for GPU historical usage rate resource model. |
|
@odata.id |
String |
Link to GPU historical usage rate resource. |
|
@odata.type |
String |
Type of GPU historical usage rate resource. |
|
Description |
String |
Description of GPU historical usage rate resource. |
|
Name |
String |
Name of the GPU historical usage rate resource. |
|
Id |
String |
ID of the GPU historical usage rate resource. |
|
GPUList |
Array |
GPU historical data. |
|
Name |
String |
GPU name. |
|
HistoricalUsageRate |
Array |
Historical data. |
|
UsageRate |
Integer |
Usage rate upon data generation. |
|
Time |
String |
Time upon data generation. |
Obtain information about network bandwidth historical send/receive speed resource
Description
Obtain information about network bandwidth historical send/receive speed resource.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/FullDuplexThroughputHistoryData
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/Oem/Public/PerformanceMonitoring/FullDuplexThroughputHistoryData
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#FullDuplexThroughputHistoryData.FullDuplexThroughputHistoryData",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/FullDuplexThroughputHistoryData",
"@odata.type": "#FullDuplexThroughputHistoryData.v1_0_0.FullDuplexThroughputHistoryData",
"Description": "Historical data of full-duplex throughput",
"Id": "FullDuplexThroughputHistoryData",
"Name": "Full Duplex Throughput History Data",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"PortList":[
{
"HistoricalData": [
{
"ReceiveRate": 0.8,
"Time": "2021-01-26T04:49:30-03:00",
"TransmitRate": 0.9
},
{
"ReceiveRate": 0.8,
"Time": "2021-01-26T04:49:30-03:00",
"TransmitRate": 0.9
},
...
],
"PortId": "0",
"PortName": "60:DA:83:80:3F:37"
},
{
"HistoricalData": [
{
"ReceiveRate": 0.8,
"Time": "2021-01-26T04:49:30-03:00",
"TransmitRate": 0.9
},
{
"ReceiveRate": 0.8,
"Time": "2021-01-26T04:49:30-03:00",
"TransmitRate": 0.9
},
...
],
"PortId": "1",
"PortName": "60:DA:83:80:3F:38"
}
...
]
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description for network historical send/receive speed resource model. |
|
@odata.id |
String |
Link to network historical send/receive speed resource model. |
|
@odata.type |
String |
Type of network historical send/receive speed resource model. |
|
Description |
String |
Description of network historical send/receive speed resource model. |
|
PortList |
String |
List of network port information. |
|
PortName |
String |
Name of network port. |
|
PortId |
String |
ID of network port. |
|
HistoricalData |
Array |
Historical data. |
|
TransmitRate |
Integer |
Network receiving speed upon data generation, in bps. |
|
ReceiveRate |
Integer |
Network sending speed upon data generation, in bps. |
|
Time |
String |
Time upon data generation. |
Obtain information about disk historical usage rate resource
Description
Obtain information about disk historical usage rate resource.
Privilege module
Login
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 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/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",
"Description": "The historical usage rate of drive",
"HistoricalUsageRate": [
{
"Time": "2021-01-26T04:49:30-03:00",
"TotalCapacityMB": 47897200,
"UsageRatePercents": 4.04,
"UsedCapacityGB": 1934608
},
{
"Time": "2021-01-26T04:49:30-03:00",
"TotalCapacityMB": 47897200,
"UsageRatePercents": 4.04,
"UsedCapacityGB": 1934608
},
...
],
"Id": "DriveHistoryUsageRate",
"Name": "Drive History Usage Rate",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the disk historical usage rate resource model. |
|
@odata.id |
String |
Link to the disk historical usage rate resource. |
|
@odata.type |
String |
Type of the disk historical usage rate resource. |
|
Description |
String |
Description of disk historical usage rate resource. |
|
HistoricalUsageRate |
Array |
Historical data. |
|
UsageRatePercents |
Integer |
Usage rate upon data generation. |
|
TotalCapacityMB |
Integer |
Total capacity of partition upon data generation. |
|
UsedCapacityGB |
Integer |
Used capacity of partition upon data generation. |
|
Time |
String |
Time upon data generation. |
Obtain information about disk IO performance historical data
Description
Obtain information about disk IO performance historical data.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/DriveIOPSHistoryData
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/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#DriveIOPSHistoryData.DriveIOPSHistoryData",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveIOPSHistoryData",
"@odata.type": "#DriveIOPSHistoryData.v1_0_0.DriveIOPSHistoryData",
"Description": "The historical IOPS of drive",
"Id": "DriveIOPSHistoryData",
"Name": "Drive IOPS History Data",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"PartitionList": [
{
"HistoricalInputOperations": [
{
"OperationsPerSecond": 4.1,
"Time": "2021-01-26T04:49:35-03:00"
},
{
"OperationsPerSecond": 4.1,
"Time": "2021-01-26T04:49:35-03:00"
},
...
],
"HistoricalOutputOperations": [
{
"OperationsPerSecond": 3.1,
"Time": "2021-01-26T04:49:35-03:00"
},
{
"OperationsPerSecond": 3.1,
"Time": "2021-01-26T04:49:35-03:00"
},
...
],
"PartitionId": "1",
"PartitionName": "sdb"
},
…
]
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of disk IO performance resource model. |
|
@odata.id |
String |
Link to disk IO performance resource. |
|
@odata.type |
String |
Type of disk IO performance resource. |
|
Description |
String |
Description of disk IO performance resource. |
|
PartitionList |
Array |
List of disk partitions. |
|
PartitionName |
String |
Name of disk partition. |
|
PartitionId |
String |
ID of disk partition. |
|
HistoricalInputOperations |
Array |
Historical data for write operations. |
|
HistoricalOutputOperations |
Array |
Historical data for read operations. |
|
OperationsPerSecond |
Integer |
Read/Write operations per second upon data generation. |
|
Time |
String |
Time upon data generation. |
Obtain information about disk SVCTM historical data
Description
Obtain the historical data information for disk SVCTM (fast and slow disks).
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/DriveSVCTMHistoryData
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/Oem/Public/PerformanceMonitoring/DriveSVCTMHistoryData
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#DriveSVCTMHistoryData.DriveSVCTMHistoryData",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveSVCTMHistoryData",
"@odata.type": "#DriveSVCTMHistoryData.v1_0_0.DriveSVCTMHistoryData",
"Description": "The historical SVCTM of drive",
"Id": "DriveSVCTMHistoryData",
"Name": "Drive SVCTM History Data",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"PartitionList": [
{
"HistorySVCTM": [
{
"ServiceTimeMs": 0.8,
"Time": "2021-01-26T04:49:35-03:00"
},
{
"ServiceTimeMs": 0.8,
"Time": "2021-01-26T04:49:35-03:00"
},
...
],
"PartitionId": "0",
"PartitionName": "sda"
},
{
"HistorySVCTM": [
{
"ServiceTimeMs": 0.8,
"Time": "2021-01-26T04:49:35-03:00"
},
{
"ServiceTimeMs": 0.8,
"Time": "2021-01-26T04:49:35-03:00"
},
...
],
"PartitionId": "1",
"PartitionName": "sdb"
}
]
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the disk SVCTM resource model. |
|
@odata.id |
String |
Link to disk SVCTM resource. |
|
@odata.type |
String |
Type of disk SVCTM resource. |
|
Description |
String |
Description of the disk SVCTM resource. |
|
PartitionList |
Array |
List of disk partitions. |
|
PartitionName |
String |
Name of the disk partition. |
|
PartitionId |
String |
ID of the disk partition. |
|
HistorySVCTM |
Array |
Historical data for SVCTM. |
|
ServiceTimeMs |
Integer |
SVCTM value upon data generation. |
|
Time |
String |
Time upon data generation. |
Obtain information about NFS server read/write rate historical data
Description
Obtain the historical data information for NFS server read/write rates.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/NFSServerIOSpeedHistoryData
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/Oem/Public/PerformanceMonitoring/NFSServerIOSpeedHistoryData
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#NFSServerIOSpeedHistoryData.NFSServerIOSpeedHistoryData",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSServerIOSpeedHistoryData",
"@odata.type": "#NFSServerIOSpeedHistoryData.v1_0_0.NFSServerIOSpeedHistoryData",
"Description": "The historical IOSpeed of NFS Server",
"HistoricalReadOperations": [
{
"SpeedMbps": 221.1,
"Time": "2022-07-29T10:55:00-03:00"
},
{
"SpeedMbps": 221.1,
"Time": "2022-07-29T10:55:00-03:00"
},
...
],
"HistoricalWriteOperations": [
{
"SpeedMbps": 21.1,
"Time": "2022-07-29T10:55:00-03:00"
},
{
"SpeedMbps": 21.1,
"Time": "2022-07-29T10:55:00-03:00"
},
...
],
"Id": "NFSServerIOSpeedHistoryData",
"Name": "NFS Server IOSpeed History Data",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description for NFS server read/write rate resource model. |
|
@odata.id |
String |
Link to NFS server read/write rate resource. |
|
@odata.type |
String |
Type of NFS server read/write rate resource. |
|
Description |
String |
Description of NFS server read/write rate resource. |
|
HistoricalWriteOperations |
Array |
Historical data for write operations. |
|
HistoricalReadOperations |
Array |
Historical data for read operations. |
|
SpeedMbps |
Integer |
Read/Write rate in KB/s upon data generation. |
|
Time |
String |
Time upon data generation. |
Obtain information about NFS client read/write rate historical data
Description
Obtain the historical data information for NFS client read/write rates.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/NFSClientIOSpeedHistoryData
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/Oem/Public/PerformanceMonitoring/NFSClientIOSpeedHistoryData
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#NFSClientIOSpeedHistoryData.NFSClientIOSpeedHistoryData",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/NFSClientIOSpeedHistoryData",
"@odata.type": "#NFSClientIOSpeedHistoryData.v1_0_0.NFSClientIOSpeedHistoryData",
"ClientList": [
{
"HistoricalReadOperations": [
{
"SpeedMbps": 1.2,
"Time": "2022-07-29T10:55:30-03:00"
},
{
"SpeedMbps": 1.2,
"Time": "2022-07-29T10:55:30-03:00"
},
...
"Name": "/mnt/share2"
],
"HistoricalWriteOperations": [
{
"SpeedMbps": 21.1,
"Time": "2022-07-29T10:55:30-03:00"
},
{
"SpeedMbps": 21.1,
"Time": "2022-07-29T10:55:30-03:00"
},
...
],
"Name": "/mnt/share1"
},
...
],
"Description": "The historical IOSpeed of NFS Server",
"Id": "NFSClientIOSpeedHistoryData",
"Name": "NFS Client IOSpeed History Data",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of for NFS client read/write rate resource model. |
|
@odata.id |
String |
Link to NFS client read/write rate resource. |
|
@odata.type |
String |
Type of NFS client read/write rate resource. |
|
Description |
String |
Description of NFS client read/write rate resource. |
|
HistoricalReadOperations |
Array |
Historical data for read operations. |
|
HistoricalWriteOperations |
Array |
Historical data for write operations. |
|
Name |
String |
Client name. |
|
SpeedMbps |
Integer |
Read/Write rate in KB/s upon data generation. |
|
Time |
String |
Time upon data generation. |
Obtain information about system load historical data
Description
Obtain the historical data information for system load.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/SystemLoadHistoryData
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/Oem/Public/PerformanceMonitoring/SystemLoadHistoryData
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#SystemLoadHistoryData.SystemLoadHistoryData",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/SystemLoadHistoryData",
"@odata.type": "#SystemLoadHistoryData.v1_0_0.SystemLoadHistoryData",
"Description": "The historical system load",
"HistoricalSystemLoad": [
{
"LastFifteenMinutes": 0.12,
"LastFiveMinutes": 0.07,
"LastMinute": 0.07,
"Time": "2021-01-26T04:49:30-03:00"
},
{
"LastFifteenMinutes": 0.12,
"LastFiveMinutes": 0.07,
"LastMinute": 0.07,
"Time": "2021-01-26T04:49:30-03:00"
},
...
],
"Id": "SystemLoadHistoryData",
"Name": "System Load History Data",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the system load resource model. |
|
@odata.id |
String |
Link to the system load resource. |
|
@odata.type |
String |
Type of the system load resource. |
|
Description |
String |
Description of the system load resource. |
|
HistoricalSystemLoad |
Array |
Historical data. |
|
LoadRatePercents |
Integer |
Load percentage upon data generation. |
|
Time |
String |
Time upon data generation. |
|
LastMinute |
Integer |
One-minute average system load upon data generation. |
|
LastFifteenMinutes |
Integer |
Fifteen-minute average system load upon data generation. |
|
LastFiveMinutes |
Integer |
Five-minute average system load upon data generation. |
Obtain performance advisor recommendation information
Description
Obtain performance advisor recommendation information.
This resource is licensed and requires authorization through licensing before use.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/WorkloadPerformanceAdvisor
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/Oem/Public/WorkloadPerformanceAdvisor
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#WorkloadPerformanceAdvisor.WorkloadPerformanceAdvisor",
"@odata.id": "/redfish/v1/Systems/1/Oem/Public/WorkloadPerformanceAdvisor",
"@odata.type": "#WorkloadPerformanceAdvisor.v1_0_0.WorkloadPerformanceAdvisor",
"Description": "Get the workload performance advisor information",
"Id": "WorkloadPerformanceAdvisor",
"Name": "WorkloadPerformanceAdvisor",
"WorkloadProfileConfiguration": "Custom",
"TenMinutesInterval": {
"ResourceUsageLevel": {
"CPUUsageLevel": "High",
"MemoryBusUsagelevel": "Low",
"IOBusUsageLevel": "Low",
"NUMAUsageLevel": null
},
"RecommendedSettings": null
},
"OneHourInterval": {
"ResourceUsageLevel": {
"CPUUsageLevel": "High",
"MemoryBusUsagelevel": "Low",
"IOBusUsageLevel": "Low",
"NUMAUsageLevel": null
},
"RecommendedSettings": null
},
"OneDayInterval": {
"ResourceUsageLevel": {
"CPUUsageLevel": "High",
"MemoryBusUsagelevel": "Low",
"IOBusUsageLevel": "Low",
"NUMAUsageLevel": null
},
"RecommendedSettings": null
},
"OneWeekInterval": {
"ResourceUsageLevel": {
"CPUUsageLevel": "High",
"MemoryBusUsagelevel": "Low",
"IOBusUsageLevel": "Low",
"NUMAUsageLevel": null
},
"RecommendedSettings": null
}
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description information for performance advisor recommendation. |
|
@odata.id |
String |
Access directory for performance advisor recommendation information. |
|
@odata.type |
String |
Type of performance advisor recommendation information. |
|
TenMinutesInterval |
Object |
10-minute interval. |
|
OneHourInterval |
Object |
1-hour interval. |
|
OneDayInterval |
Object |
1-day (24-hour) interval. |
|
OneWeekInterval |
Object |
1-week interval. |
|
WorkloadProfileConfiguration |
String |
Recommended configuration profile for the scenario. · High Performance Compute. · Custom. Configuration profile is not recommended if this field is null. |
|
ResourceUsageLevel |
Object |
Resource usage level. This field is null if the host is powered off. |
|
CPUUsageLevel |
String |
CPU usage level. · High. · Middle. · Low. The field displays N/A if the obtained data are insufficient. |
|
MemoryBusUsagelevel |
String |
Memory bus usage level. · High. · Middle. · Low. The field displays N/A if the obtained data are insufficient. |
|
IOBusUsageLevel |
String |
IO bus usage level. · High. · Middle. · Low. The field displays N/A if the obtained data are insufficient. |
|
NUMAUsageLevel |
String |
This field is not supported in the current software version. NUMA identification level. · High. · Middle. · Low. |
|
RecommendedSettings |
Object |
This field is not supported in the current software version. Recommended settings. This field is null, which represents that no recommended setting exists. |
|
Description |
String |
Description of the performance advisor recommendation information list resource. |
|
Id |
String |
ID of the performance advisor recommendation information list resource. |
|
Name |
String |
Name of the performance advisor recommendation information list resource. |
Change history
|
Version |
Change description |
|
HDM2-2.08 |
Added the OneWeekInterval field. Added a description to the CPUUsageLevel, MemoryBusUsagelevel, and IOBusUsageLevel fields to indicate that the field displays N/A if the obtained data are insufficient. |
|
HDM2-2.04 |
Changed the support state for the NUMAUsageLevel and RecommendedSettings fields to not supported. |
|
HDM2-1.60 |
Changed the interface description from "Obtain performance advisor information" to "Obtain performance advisor recommendation information." |
|
HDM2-1.55 |
Added the redfish/v1/Systems/1/Oem/Public/WorkloadPerformanceAdvisor interface. |
Upload and write the Intel On Demand License activation file
Description
Upload and write the Intel On Demand License activation file.
Privilege module
ConfigureUsers
Request
POST https://device_ip/redfish/v1/Systems/system_id/Processors/cpu_id/Actions/Oem/Public/Processor.LicenseUpload/
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
{
"Type":"URI",
"Content": "license file path"
}
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. |
|
Type |
String |
URI |
|
Content |
Link to the license file. |
· Operation path, which does not support Chinese characters. · Up to 1024 characters. Chinese characters are not supported and the following special characters are supported: @!$^&()_+.;[]{}-=~` · Only the /tmp/web/ directory and its subdirectories are supported locally. · Remote import is supported. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Systems/1/Processors/1/Actions/Oem/Public/Processor.LicenseUpload/
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
{
"Type":"URI",
"Content": "/tmp/web/LAC-B1BFB71B8395F812-00000001-FA8BD7DA7307E6-SGX512.json"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description information for the task service for uploading and writing Intel On Demand License activation file. |
|
@odata.type |
String |
Type of the task service for uploading and writing Intel On Demand License activation file. |
|
Name |
String |
Name of the Intel On Demand License activation file. |
|
Members@odata.count |
Integer |
Number of tasks generated by uploading and writing Intel On Demand License activation file. |
|
Members |
Array |
Task link collection generated by uploading and writing Intel On Demand License activation file. |
|
@odata.id |
String |
Link to the task service for uploading and writing Intel On Demand License activation file. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the task service for uploading and writing Intel On Demand License activation file. |
The server returns status code 202 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.02 |
Added this interface. |
Export the CPU status report
Description
Export the CPU status report.
Privilege module
ConfigureUsers
Request
POST https://device_ip/redfish/v1/Systems/system_id/Processors/cpu_id/Actions/Oem/Public/Processor.StateReportExport/
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
{
"Type":"URI",
"Content": "/tmp/web/CPU1_report_20290901T164036+0800.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. |
|
Type |
String |
URI |
|
Content |
File path of the CPU status report. |
· Operation path, which does not support Chinese characters. · Up to 1024 characters. Chinese characters are not supported and the following special characters are supported: @!$^&()_+.;[]{}-=~` · Only the /tmp/web/ directory and its subdirectories are support. · Remote export is supported. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Systems/1/Processors/1/Actions/Oem/Public/Processor.StateReportExport/
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
{
"Type":"URI",
"Content": "/tmp/web/CPU1_report_20290901T164036+0800.json"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/3"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656299
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description information for the task service for exporting the CPU status report. |
|
@odata.type |
String |
Type of the task service for exporting the CPU status report. |
|
Name |
String |
Name of the CPU status report. |
|
Members@odata.count |
Integer |
Number of tasks generated by exporting the CPU status report. |
|
Members |
Array |
Task link collection generated by exporting the CPU status report. |
|
@odata.id |
String |
Link to the task service for exporting the CPU status report. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the task service for exporting the CPU status report. |
The server returns status code 202 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.02 |
Added this interface. |
Operations on manager resources
Obtain manager collection information
Description
Obtain information about all managers from the server.
Privilege module
Login
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#Managers",
"@odata.id": "/redfish/v1/Managers",
"@odata.type": "#ManagerCollection.ManagerCollection",
"Members": [
{
"@odata.id": "/redfish/v1/Managers/1"
}
],
"Members@odata.count": 1,
"Name": "Manager Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
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
Login
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_10_0.Manager",
"Actions": {
"#LogService.ClearOperationLog": {
"@Redfish.AllowableValues": [
""
],
"target": "/redfish/v1/Managers/1/LogServices/Actions/LogService.ClearOperationLog"
},
"#Manager.Reset": {
"ResetType@Redfish.AllowableValues": [
"ForceRestart"
],
"target": "/redfish/v1/Managers/1/Actions/Manager.Reset"
},
"Oem": {
"Public": {
"#Manager.Dump": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.Dump"
},
"#Manager.ExportConfiguration": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ExportConfiguration"
},
"#Manager.GeneralDownload": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralDownload"
},
"#Manager.GeneralUpload": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralUpload"
},
"#Manager.ImportConfiguration": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportConfiguration"
},
"#Manager.NodeSwitch": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.NodeSwitch"
},
"#Manager.ResetSD": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ResetSD"
},
"#Manager.RestoreFactory": {
"ConfigurationType@Redfish.AllowableValues": [
"BMC"
],
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.RestoreFactory"
}
}
}
},
"CommandShell": {
"ConnectTypesSupported": [
"SSH"
],
"MaxConcurrentSessions": 20,
"ServiceEnabled": true
},
"DateTime": "2017-04-17T08:28:22+08:00",
"DateTimeLocalOffset": "UTC+08:00",
"Description": "BMC",
"DiagnosticService": {
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService"
},
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces"
},
"FirmwareVersion": "0.00.14",
"GraphicalConsole": {
"ConnectTypesSupported": [
"KVMIP"
],
"MaxConcurrentSessions": 20,
"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": "AST2600",
"Name": "Manager",
"NetworkProtocol": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"
},
"NtpService": {
"@odata.id": "/redfish/v1/Managers/1/NtpService"
},
"Oem": {
"Public": {
"BackupFirmwareBuildDate": "",
"BackupFirmwareVersion": "",
"BiosCurrentRunningPartition": "AlternatePartition",
"CompletionCode": 0,
"CurrentNodeId": "2",
"CurrentRunningPartition": "PrimaryPartition",
"CustomizedConfigurationModel": "",
"DefaultLanguage": "CN",
"Description": "Success",
"EnclosureName":"Chassis-01",
"EnclosureNodeName": "SLOT6",
"FirewallRules": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/FirewallRules"
},
"EnergySavingService": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/EnergySavingService"
},
"FirmwareBuildDate": "2022-07-01T10:02:35+08:00",
"FirmwareVendor": "BMC",
"IntelligentMonitoringService": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService"
},
"InternalFirmwareVersion": "V100R001B01BBIT14_RELEASE",
"InternalBackupFirmwareVersion": "",
"IsSupportSimulator": false,
"JointManagement": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/JointManagement"
},
"LanguageSet": "EN, CN",
"LoginSecurityInformation": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/LoginSecurityInformation"
},
"MaintenanceFunctionEnabled": false,
"MasterNodeId": "2",
"OperationLog": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/OperationLog"
},
"PFRSettings": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/PFRSettings"
},
"RestoreFactorySupported":true,
"SOLMode": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/SOLMode"
},
"TrustedModuleConfiguration": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/TrustedModuleConfiguration"
},
"USBDeviceService": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/USBDeviceService"
},
"Wireless": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Wireless"
}
}
},
"SecurityService": {
"@odata.id": "/redfish/v1/Managers/1/SecurityService"
},
"SerialConsole": {
"ConnectTypesSupported": [
"SSH"
],
"MaxConcurrentSessions": 20,
"ServiceEnabled": true
},
"SerialInterfaces": {
"@odata.id": "/redfish/v1/Managers/1/SerialInterfaces"
},
"ServiceEntryPointUUID": "7f673460-22e7-1000-03fe-aabbccd23552",
"SmtpService": {
"@odata.id": "/redfish/v1/Managers/1/SmtpService"
},
"SnmpService": {
"@odata.id": "/redfish/v1/Managers/1/SnmpService"
},
"Status": {
"Health": "Enabled",
"State": "OK"
},
"SyslogService": {
"@odata.id": "/redfish/v1/Managers/1/SyslogService"
},
"UUID": "7f673460-22e7-1000-03fe-aabbccd23552",
"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. |
|
LogService.ClearOperationLog |
Object |
Clear operation logs. |
|
Actions.Oem.Public |
Actions specify custom executable operations for management resources. |
|
|
Manager. Dump |
Object |
One-click collection of SDS. |
|
Object |
Export BIOS, BMC, and RAID controller configuration. |
|
|
Manager.GeneralDownload |
Object |
Download BMC file. |
|
Manager.GeneralUpload |
Object |
Upload BMC file. |
|
Manager.ImportConfiguration |
Object |
Import BIOS, BMC, and RAID controller configuration. |
|
Manager.NodeSwitch |
Object |
Node control. Only the E3300 G6 supports this field. |
|
Manager.ResetSD |
Object |
Reset SD card. |
|
Manager.RestoreFactory |
Object |
Restoring BMC factory-default settings. |
|
CommandShell |
CLI console properties. |
|
|
ConnectTypesSupported |
Array |
Supported link types. Supported options: · SSH. |
|
MaxConcurrentSessions |
Integer |
Maximum number of links. |
|
ServiceEnabled |
Boolean |
Service 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. |
|
DiagnosticService |
Object |
Link to system diagnosis information. |
|
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 |
Service 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. |
|
LldpService |
Object |
Link to LLDP service resource information. |
|
ManagerType |
String |
Type of the manager resource. Supported options: · BMC. |
|
Model |
String |
Model of the manager resource. Supported options: · AST2600. |
|
Name |
String |
Name of the manager resource. |
|
NetworkProtocol |
Object |
Link to the service. |
|
NtpService |
Object |
Link to NTP information. |
|
Oem.Public.BackupFirmwareBuildDate |
String |
Build time of the backup area firmware version. |
|
Oem.Public.BackupFirmwareVersion |
String |
Backup area firmware version. |
|
Oem.Public.BiosCurrentRunningPartition |
String |
· AlternatePartition—The backup BIOS partition takes effect. · PrimaryPartition—The primary BIOS partition takes effect. |
|
Oem.Public.CurrentRunningPartition |
String |
· AlternatePartition—The backup BIOS partition takes effect. · PrimaryPartition—The primary BIOS partition takes effect. |
|
Oem.Public.CustomizedConfigurationModel |
String |
Custom configuration model. |
|
Oem.Public.CurrentNodeId |
String |
Current node ID. Only the E3300 G6 supports this field. |
|
Oem.Public.RestoreFactorySupported |
Boolean |
Support or not support factory configuration restoration. |
|
Oem.Public.DefaultLanguage |
String |
Default languages. |
|
Oem.Public.EnclosureName |
String |
Enclosure name. This field is supported on for enclosures. |
|
Oem.Public.EnclosureNodeName |
String |
Enclosure BMC node name. This field is supported on for enclosures. |
|
Oem.Public.FirewallRules |
Object |
Link to the firewall resource. |
|
Oem.Public.EnergySavingService |
Object |
Link to energy-saving service information resource. |
|
Oem.Public.FirmwareVendor |
String |
Firmware vendor of the manager resource. |
|
Oem.Public.FirmwareBuildDate |
String |
Firmware compilation time. |
|
Oem.Public.InternalFirmwareVersion |
String |
Internal firmware version. (Main partition) |
|
Oem.Public.InternalBackupFirmwareVersion |
String |
Internal firmware version. (Backup partition) |
|
Oem.Public.IsSupportSimulator |
Boolean |
Simulator tag. |
|
Oem.Public.LanguageSet |
String |
Supported languages. |
|
Oem.Public.JointManagement |
Object |
Link to the unified management resource. |
|
Oem.Public.LoginSecurityInformation |
Object |
Link to secure login information resource. |
|
Oem.Public.MaintenanceFunctionEnabled |
Boolean |
Enabling status of the maintenance switch. |
|
Oem.Public.MasterNodeId |
String |
Current node ID. Only the E3300 G6 supports this field. |
|
Oem.Public.IntelligentMonitoringService |
String |
Path to the intelligent monitoring service resource. |
|
Oem.Public.OperationLog |
Object |
Links to all operation logs list resources. |
|
Oem.Public.PFRSettings |
Object |
Link to platform firmware protection recovery (PFR) configuration. |
|
Oem.Public.SOLMode |
Object |
Link to serial port redirection configuration resource. |
|
Oem.Public.TrustedModuleConfiguration |
Object |
Link to trusted password module status configuration resource. |
|
Oem.Public.USBDeviceService |
Object |
Link to service USB drive resource. |
|
Oem.Public.Wireless |
Object |
Link to the wireless resource. This field is available only for some G5 servers. This field is not available for HDM3. |
|
SerialConsole |
Serial console properties. |
|
|
ConnectTypesSupported |
Array |
Supported link types. Supported options: · SSH. |
|
MaxConcurrentSessions |
Integer |
Maximum number of links. |
|
ServiceEnabled |
Boolean |
Service enabling status. |
|
SecurityService |
Object |
Link to secure service resource. |
|
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. |
|
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. |
Change history
|
Version |
Change description |
|
HDM3-1.06 |
Added the Oem.Public.BiosCurrentRunningPartition field. |
|
HDM3-1.16 |
Deleted the Telnet field. |
|
HDM2-2.12 |
Deleted the Telnet field. |
|
HDM3-1.16 |
HDM3 does not support Oem.Public.Wireless. |
|
HDM2-2.09 |
Added the Manager.NodeSwitch, Oem.Public.CurrentNodeId, and Oem.Public.MasterNodeId fields. |
|
HDM2-2.05 |
Added the DiagnosticService field. |
|
HDM2-2.05 |
Added the Oem.Public.IsSupportSimulator field. |
|
HDM2-2.04 |
Updated the description for the Model field. |
|
HDM2-1.59 |
Added the EnclosureName and EnclosureNodeName fields. |
|
HDM2-1.54 |
Added the IntelligentMonitoringService field. |
Edit manager resource information
Description
Edit information about a specific manager resource (time zone) for the server.
Privilege module
ConfigureComponents
Locking type of the associated system
BMC configuration locking
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": local_offset
"UUID": uuid_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. |
|
DateTimeLocalOffset |
Time zone information in a string. |
N/A. |
|
UUID |
Manager resource UUID. |
String. |
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"
"UUID":"7f673460-22e7-1000-03fe-aabbccd23552"
}
Response:
{
"@odata.context":"/redfish/v1/$metadata#Manager.Manager(*)",
"@odata.id":"/redfish/v1/Managers/1",
"@odata.type":"#Manager.v1_10_0.Manager",
"Actions":{
"#LogService.ClearOperationLog":{
"@Redfish.AllowableValues":[
""
],
"target":"/redfish/v1/Managers/1/LogServices/Actions/LogService.ClearOperationLog"
},
"#Manager.Reset":{
"ResetType@Redfish.AllowableValues":[
"ForceRestart"
],
"target":"/redfish/v1/Managers/1/Actions/Manager.Reset"
},
"Oem":{
"Public":{
"#Manager.Dump":{
"target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.Dump"
},
"#Manager.ExportConfiguration":{
"target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ExportConfiguration"
},
"#Manager.GeneralDownload":{
"target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralDownload"
},
"#Manager.GeneralUpload":{
"target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralUpload"
},
"#Manager.ImportConfiguration":{
"target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportConfiguration"
},
"#Manager.ResetSD":{
"target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ResetSD"
},
"#Manager.RestoreFactory":{
"ConfigurationType@Redfish.AllowableValues":[
"BMC"
],
"target":"/redfish/v1/Managers/1/Actions/Oem/Public/Manager.RestoreFactory"
}
}
}
},
"CommandShell":{
"ConnectTypesSupported":[
"SSH"
],
"MaxConcurrentSessions":20,
"ServiceEnabled":true
},
"DateTime":"2017-04-16T19:59:23-04:30",
"DateTimeLocalOffset":"UTC-04:30",
"Description":"BMC",
"DiagnosticService": {
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService"
},
"EthernetInterfaces":{
"@odata.id":"/redfish/v1/Managers/1/EthernetInterfaces"
},
"FirmwareVersion":"0.00.14",
"GraphicalConsole":{
"ConnectTypesSupported":[
"KVMIP"
],
"MaxConcurrentSessions":20,
"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":"AST2600",
"Name":"Manager",
"NetworkProtocol":{
"@odata.id":"/redfish/v1/Managers/1/NetworkProtocol"
},
"NtpService":{
"@odata.id":"/redfish/v1/Managers/1/NtpService"
},
"Oem":{
"Public":{
"BackupFirmwareBuildDate":"",
"BackupFirmwareVersion":"",
"CompletionCode":0,
"CurrentRunningPartition":"PrimaryPartition",
"CustomizedConfigurationModel":"",
"DefaultLanguage":"CN",
"Description":"Success",
"EnclosureName":null,
"EnclosureNodeName":null,
"FirewallRules":{
"@odata.id":"/redfish/v1/Managers/1/Oem/Public/FirewallRules"
},
"EnergySavingService":{
"@odata.id":"/redfish/v1/Managers/1/Oem/Public/EnergySavingService"
},
"FirmwareBuildDate":"2022-06-30T21:32:35-04:30",
"FirmwareVendor":"BMC",
"InternalFirmwareVersion":"V100R001B01BBIT14_RELEASE",
"InternalBackupFirmwareVersion": "",
"IsSupportSimulator": false,
"JointManagement":{
"@odata.id":"/redfish/v1/Managers/1/Oem/Public/JointManagement"
},
"LanguageSet":"EN, CN",
"LoginSecurityInformation":{
"@odata.id":"/redfish/v1/Managers/1/Oem/Public/LoginSecurityInformation"
},
"MaintenanceFunctionEnabled":false,
"OperationLog":{
"@odata.id":"/redfish/v1/Managers/1/Oem/Public/OperationLog"
},
"PFRSettings":{
"@odata.id":"/redfish/v1/Managers/1/Oem/Public/PFRSettings"
},
"RestoreFactorySupported":true,
"SOLMode":{
"@odata.id":"/redfish/v1/Managers/1/Oem/Public/SOLMode"
},
"TrustedModuleConfiguration":{
"@odata.id":"/redfish/v1/Managers/1/Oem/Public/TrustedModuleConfiguration"
},
"USBDeviceService":{
"@odata.id":"/redfish/v1/Managers/1/Oem/Public/USBDeviceService"
},
"Wireless":{
"@odata.id":"/redfish/v1/Managers/1/Oem/Public/Wireless"
}
}
},
"SecurityService":{
"@odata.id":"/redfish/v1/Managers/1/SecurityService"
},
"SerialConsole":{
"ConnectTypesSupported":[
"SSH"
],
"MaxConcurrentSessions":20,
"ServiceEnabled":true
},
"SerialInterfaces":{
"@odata.id":"/redfish/v1/Managers/1/SerialInterfaces"
},
"ServiceEntryPointUUID":"7f673460-22e7-1000-03fe-aabbccd23552",
"SmtpService":{
"@odata.id":"/redfish/v1/Managers/1/SmtpService"
},
"SnmpService":{
"@odata.id":"/redfish/v1/Managers/1/SnmpService"
},
"Status":{
"Health":"Enabled",
"State":"OK"
},
"SyslogService":{
"@odata.id":"/redfish/v1/Managers/1/SyslogService"
},
"UUID":"7f673460-22e7-1000-03fe-aabbccd23552",
"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.
For more information about the response field description, see "Obtain manager resource information."
Change history
|
Version |
Change description |
|
HDM3-1.16 |
Deleted the Telnet service field. |
|
HDM2-2.12 |
Deleted the Telnet service field. |
|
HDM2-2.05 |
Added the UUID field. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain NTP information
Description
Obtain NTP information from the server.
Privilege module
Login
Locking type of the associated system
BMC configuration locking
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",
"MaxPollingInterval": 2592000,
"MinPollingInterval": 600,
"NtpAddressOrigin": "Static",
"Oem": {
"Public": {
"CompletionCode": 0,
"DateTime": "2019-02-18T17:51:02+08:00",
"Description": "Success",
"RefreshInterval": 3600,
"SynchronousResult": "Failed",
"TertiaryNtpServer": "",
"TimeZone": "UTC+08:00"
}
},
"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 resource. |
|
MaxPollingInterval |
Integer |
Maximum polling interval, in seconds. |
|
MinPollingInterval |
Integer |
Minimum polling interval, in seconds. |
|
NtpAddressOrigin |
String |
NTP server address obtaining method. Supported options: · Static. |
|
ServiceEnabled |
Boolean |
Enabling status of the NTP service. |
|
Oem.Public.TimeZone |
String |
Time zone. For example: UTC+08:00 |
|
Oem.Public.SynchronousResult |
String |
Time synchronization result. Supported options: · Failed. · Successful. · Not Synchronized. |
|
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. |
|
Oem.Public.DateTime |
String |
Timestamp Format. For Example: 2019-02-14T20:21:36+08:00 |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the MaxPollingInterval and MinPollingInterval fields. |
Configure NTP settings
Description
Configure NTP settings from the server.
Privilege module
ConfigureComponents
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+03:00"",
"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. Format: UTC+03:00 Compatibility with the original style, UTC+3, is required. |
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": "2.cn.pool.ntp.org",
"PreferredNtpServer": "1.cn.pool.ntp.org",
"ServiceEnabled": true,
"Oem":{
"Public":{
"TimeZone":"UTC+08:00",
"TertiaryNtpServer": "192.168.1.3",
"RefreshInterval":3600
}
}
}
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",
"MaxPollingInterval": 2592000,
"MinPollingInterval": 600,
"NtpAddressOrigin": "Static",
"Oem": {
"Public": {
"CompletionCode": 0,
"DateTime": "2019-02-18T17:51:02+08:00",
"Description": "Success",
"RefreshInterval": 3600,
"SynchronousResult": "Failed",
"TertiaryNtpServer": "192.168.1.3",
"TimeZone": "UTC+08:00"
}
},
"PreferredNtpServer": "1.cn.pool.ntp.org",
"ServiceEnabled": true
}
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 NTP information."
Obtain SNMP information
Description
Obtain SNMP information from the server.
Privilege module
Login
Locking type of the associated system
BMC configuration locking
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",
"@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",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ReadOnlyCommunity": "",
"ReadWriteCommunity": null,
"SnmpTrapNotification": {
"AlarmSeverity": "Minor+Major+Critical",
"CommunityName": "public",
"Oem": {
"Public": {
"SystemContact": "",
"SystemLocation": ""
}
},
"ServiceEnabled": true,
"TrapMode": "NodeMode",
"TrapServer": [
{
"Enabled": true,
"MemberId": "1",
"TrapServerAddress": "",
"TrapServerPort": 162
},
{
"Enabled": true,
"MemberId": "2",
"TrapServerAddress": "",
"TrapServerPort": 162
},
{
"Enabled": true,
"MemberId": "3",
"TrapServerAddress": "",
"TrapServerPort": 162
},
{
"Enabled": true,
"MemberId": "4",
"TrapServerAddress": "",
"TrapServerPort": 162
},
{
"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": "HDM",
"TrapV3User": "",
"TrapVersion": "v1"
},
"SnmpV1Enabled": false,
"SnmpV2CEnabled": true,
"SnmpV3AuthProtocol": "",
"SnmpV3Enabled": true,
"SnmpV3EngineID": "80001f8880a933392964005259",
"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 |
The read-only community name must be a string of up to 32 characters and can contain the letters, digits, and the following special characters: `~!@#$%^&*()_+-=[]\{}|;':",./<>? An empty string indicates that the read-only community name has been deleted. |
|
ReadWriteCommunity |
String |
The read/write community name must be a string of up to 32 characters and can contain the letters, digits, and the following special characters: `~!@#$%^&*()_+-=[]\{}|;':",./<>? An empty string indicates that the read/write community name has been deleted. |
|
SnmpTrapNotification.CommunityName |
String |
Trap community name. |
|
SnmpTrapNotification.ServiceEnabled |
Boolean |
Enabling status of the SNMP trap service. |
|
SnmpTrapNotification.TrapMode |
String |
Trap mode. Supported options: · NodeMode. · EventMode. · EventCodeMode. |
|
SnmpTrapNotification.AlarmSeverity |
String |
Severity level. Supported options: · Critical. · 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. |
|
SnmpTrapNotification.Oem.Public.SystemLocation |
String |
SNMP Trap node location. |
|
SnmpTrapNotification.Oem.Public.SystemContact |
String |
SNMP Trap contact information. |
|
SnmpV1Enabled |
Boolean |
Enabling status of SNMPv1. |
|
SnmpV2CEnabled |
Boolean |
Enabling status of SNMPv2c. |
|
SnmpV3AuthProtocol |
String |
SNMPv3 authentication algorithm. Supported options: · sha. · md5. · sha256. · sha384. · sha512. |
|
SnmpV3Enabled |
Boolean |
Enabling status of SNMPv3. |
|
SnmpV3EngineID |
String |
ID of the SNMP engine. |
|
SnmpV3PrivProtocol |
String |
SNMPv3 encryption algorithm. Supported options: · des. · aes. · aes192. · aes256. |
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
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
ConfigureComponents
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":v1_enabled,
"SnmpV2CEnabled":v2c_enabled,
"SnmpV3Enabled":v3_enabled,
"LongPasswordEnabled":long_password_enabled,
"ReadOnlyCommunity":read_only_community,
"ReadWriteCommunity":read_write_community,
"CommunityName":community_name,
"ServiceEnabled":service_enabled,
"TrapVersion":trap_version,
"TrapV3User":user_name,
"AlarmSeverity": alarm_severity,
"TrapMode": trap_mode,
"Oem": {
"Public": {
"SystemLocation": location,
"SystemContact": contact
}
},
"TrapServer":[
{
"MemberId":"1",
"Enabled":true,
"TrapServerPort":TrapServer1_portnumber,
"TrapServerAddress": TrapServer1_address
},
...
]
}
Alternatively:
{
"SnmpV1Enabled":v1_enabled,
"SnmpV2CEnabled":v2c_enabled,
"SnmpV3Enabled":v3_enabled,
"LongPasswordEnabled":long_password_enabled,
"ReadOnlyCommunity":read_only_community,
"ReadWriteCommunity":read_write_community,
"SnmpTrapNotification": {
"AlarmSeverity": alarm_severity,
"CommunityName":community_name,
"Oem": {
"Public": {
"SystemLocation": location,
"SystemContact": contact
}
},
"ServiceEnabled":service_enabled,
"TrapMode": trap_mode,
"TrapServer":[
{
"MemberId":"1",
"Enabled":true,
"TrapServerPort":TrapServer1_portnumber,
"TrapServerAddress": TrapServer1_address
},
...
],
"TrapV3User":user_name,
"TrapVersion":trap_version
},
}
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. |
|
SnmpV3Enabled |
Enable or disable SNMPv3. |
Boolean. |
|
LongPasswordEnabled |
Enable or disable the long community string feature. |
Boolean. |
|
ReadOnlyCommunity |
Read-only community name. |
String, up to 32 characters. An empty string indicates that the read-only community has been deleted. |
|
ReadWriteCommunity |
Read/write community name. |
String, up to 32 characters. An empty string indicates that the read/write community has been deleted. |
|
SnmpTrapNotification |
SNMP trap notification properties. |
|
|
SnmpTrapNotification.CommunityName |
Trap community name. |
String, up to 31 characters. For SNMPv3 users, setting the community name is successful, but it won't take effect. |
|
SnmpTrapNotification.ServiceEnabled |
Enable or disable the SNMP trap service. |
Boolean. |
|
SnmpTrapNotification.TrapVersion |
SNMP trap version. |
String. Supported options: · v1. · v2c. · v3. When SNMPv3 is used, the CommunityName field is not required. |
|
SnmpTrapNotification.TrapV3User |
SNMPv3 user. |
String. |
|
SnmpTrapNotification.AlarmSeverity |
Severity level. |
String. Supported options: · Critical. · Major+Critical. · Minor+Major+Critical. · All. |
|
SnmpTrapNotification.TrapMode |
Trap mode. |
String. Supported options: · NodeMode. · EventMode. · EventCodeMode. |
|
SnmpTrapNotification.TrapServer |
Trap server properties. When SNMPv3 is used, you must configure the TrapV3User option. |
|
|
SnmpTrapNotification.TrapServer.MemberId |
Trap server ID. |
String. The trap server ID range is 1 to 8. |
|
SnmpTrapNotification.TrapServer.Enabled |
Enable or disable the SNMP trap server. |
Boolean. |
|
SnmpTrapNotification.TrapServer.TrapServerPort |
Trap server port number. |
Integer. |
|
SnmpTrapNotification.TrapServer.TrapServerAddress |
Trap server address. |
String. IPv4, IPv6 address, or domain name formats. |
|
SnmpTrapNotification.Oem.Public.SystemLocation |
System node location. |
String. |
|
SnmpTrapNotification.Oem.Public.SystemContact |
System contact information. |
String. |
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:
{
"ServiceEnabled":true,
"TrapVersion":"v3",
"TrapV3User":"User3",
"AlarmSeverity": "All",
"TrapMode": "NodeMode",
"Oem": {
"Public": {
"SystemLocation": "HangZhou",
"SystemContact": "www.h3c.com"
}
},
"TrapServer":[
{
"MemberId":"1",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.111"
},
{
"MemberId":"2",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.112"
},
{
"MemberId":"3",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.113"
},
{
"MemberId":"4",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.114"
},
{
"MemberId":"5",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.115"
},
{
"MemberId":"6",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.116"
},
{
"MemberId":"7",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.117"
},
{
"MemberId":"8",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.118"
}
]
}
Alternatively:
{
"SnmpTrapNotification":{
"ServiceEnabled":true,
"TrapVersion":"v3",
"TrapV3User":"User3",
"AlarmSeverity": "All",
"TrapMode": "NodeMode",
"Oem": {
"Public": {
"SystemLocation": "HangZhou",
"SystemContact": "www.h3c.com"
}
},
"TrapServer":[
{
"MemberId":"1",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.111"
},
{
"MemberId":"2",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.112"
},
{
"MemberId":"3",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.113"
},
{
"MemberId":"4",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.114"
},
{
"MemberId":"5",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.115"
},
{
"MemberId":"6",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.116"
},
{
"MemberId":"7",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.117"
},
{
"MemberId":"8",
"Enabled":true,
"TrapServerPort":162,
"TrapServerAddress": "192.168.30.118"
}
]
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#SnmpService.SnmpService",
"@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",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ReadOnlyCommunity": "",
"ReadWriteCommunity": "",
"SnmpTrapNotification": {
"AlarmSeverity": "All",
"CommunityName": "public",
"Oem": {
"Public": {
"SystemContact": "www.h3c.com",
"SystemLocation": "HangZhou"
}
},
"ServiceEnabled": true,
"TrapMode": "NodeMode",
"TrapServer": [
{
"Enabled": true,
"MemberId": "1",
"TrapServerAddress": "192.168.30.111",
"TrapServerPort": 162
},
{
"Enabled": true,
"MemberId": "2",
"TrapServerAddress": "192.168.30.112",
"TrapServerPort": 162
},
{
"Enabled": true,
"MemberId": "3",
"TrapServerAddress": "192.168.30.113",
"TrapServerPort": 162
},
{
"Enabled": true,
"MemberId": "4",
"TrapServerAddress": "192.168.30.114",
"TrapServerPort": 162
},
{
"Enabled": true,
"MemberId": "5",
"TrapServerAddress": "192.168.30.115",
"TrapServerPort": 162
},
{
"Enabled": true,
"MemberId": "6",
"TrapServerAddress": "192.168.30.116",
"TrapServerPort": 162
},
{
"Enabled": true,
"MemberId": "7",
"TrapServerAddress": "192.168.30.117",
"TrapServerPort": 162
},
{
"Enabled": true,
"MemberId": "8",
"TrapServerAddress": "192.168.30.118",
"TrapServerPort": 162
}
],
"TrapServerIdentity": "HDM123456123456123456123456123456123456123456123456123456123456",
"TrapV3User": "User3",
"TrapVersion": "v3"
},
"SnmpV1Enabled": false,
"SnmpV2CEnabled": true,
"SnmpV3AuthProtocol": "SHA",
"SnmpV3Enabled": true,
"SnmpV3EngineID": "80001f8880a933392964005259",
"SnmpV3PrivProtocol": "DES"
}
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 SNMP information."
Change history
|
Version |
Change description |
|
HDM2-2.02 HDM3-1.24 HDM3-1.17 HDM3-1.80 |
Added the SnmpTrapNotification object, which is optional. The values for the same field that are not under this object take precedence over those under this object. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Perform SNMP trap testing
Description
Perform SNMP trap testing on the server.
Privilege module
ConfigureComponents
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:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Obtain SMTP information
Description
Obtain SMTP information from the server.
Privilege module
Login
Locking type of the associated system
BMC configuration locking
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. |
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": false,
"Description": "Smtpservice Gettings",
"Id": "Smtp",
"Name": "Smtp",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"Subject": [
"ProductName",
"HostName",
"AssetTag",
"BoardSerialNumber"
]
}
},
"RecipientAddresses": [
{
"EmailAddress": "123@h3c.com",
"EmailSubject": "111",
"Enabled": true,
"MemberId": "1"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "2"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "3"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "4"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "5"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "6"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "7"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "8"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "9"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "10"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "11"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "12"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "13"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "14"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "15"
}
],
"SenderAddress": "",
"SenderPassword": null,
"SenderUserName": "",
"ServerAddress": "",
"ServerPort": 25,
"ServiceEnabled": true,
"TLSEnabled": true
}
Response code: 200
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. |
|
SenderUserName |
String |
Username of senders |
|
RecipientAddresses.EmailAddress |
String |
Recipient email address. |
|
RecipientAddresses.Enabled |
Boolean |
Enabling status of a recipient. |
|
RecipientAddresses.MemberId |
String |
ID of a recipient. |
|
RecipientAddresses.EmailSubject |
String |
Email subject. |
|
Oem.Public.Subject |
Array |
Customize email subject. Supported options: · ProductName. · HostName. · AssetTag. · BoardSerialNumber. |
The server returns status code 200 for a successful operation.
Configure SMTP settings
Description
Configure SMTP settings from the server.
Privilege module
ConfigureComponents
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":true,
"AnonymousLoginEnabled":false,
"SenderUserName":username,
"SenderPassword":password,
"SenderAddress":senderaddress,
"AlarmSeverity": AlarmSeverity_value,
"Oem": {
"Public": {
"Subject":[
"ProductName",
"AssetTag",
"BoardSerialNumber",
"HostName"
] ,
"RSAEncryptionEnabled":true
}
},
"RecipientAddresses":[
{
"MemberId":"1",
"Enabled":true,
"EmailSubject":"1",
"EmailAddress":""
}
……
]
}
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. When you enable TLS, the server port must be set to 465. |
|
TLSEnabled |
Enable or disable TLS. |
Boolean. When you enable TLS, the server port must be set to 465. |
|
AnonymousLoginEnabled |
Enable or disable anonymous login. |
Boolean. |
|
SenderUserName |
Sender username. |
The username must be a string of up to 64 characters. Only letters, digits, dots (.), hyphens (-), underscores (_), and at signs (@) are allowed. |
|
SenderPassword |
Sender password. |
String, up to 64 characters. |
|
SenderAddress |
Sender address. |
String, up to 64 characters. |
|
Oem.Public.Subject |
Array |
Customize email subject. Supported options: · ProductName. · HostName. · AssetTag. · BoardSerialNumber. |
|
Oem.Public.RSAEncryptionEnabled |
Boolean. |
Supports RSA encryption, only for setting sender's password on the web interface. |
|
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.EmailSubject |
Alarm email subject. The maximum length for this field is 32 characters. When setting the Enabled field to false, you cannot set this field. |
String. |
|
RecipientAddresses. EmailAdress |
Email Address. The maximum length for this field is 64 characters. When setting the Enabled field to false, you cannot set this field. |
String. |
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:
{
"AlarmSeverity": "Critical",
"AnonymousLoginEnabled": false,
"Description": "Smtpservice Gettings",
"Id": "Smtp",
"Name": "Smtp",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"Subject": [
"ProductName",
"AssetTag",
"BoardSerialNumber",
"HostName"
]
}
},
"RecipientAddresses": [
{
"EmailAddress": "123@h3c.com",
"EmailSubject": "111",
"Enabled": true,
"MemberId": "1"
}
],
"SenderPassword": "",
"SenderUserName": "",
"ServerAddress": "",
"ServerPort": 25,
"ServiceEnabled": true,
"TLSEnabled": true
}
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": false,
"Description": "Smtpservice Gettings",
"Id": "Smtp",
"Name": "Smtp",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"Subject": [
"ProductName",
"HostName",
"AssetTag",
"BoardSerialNumber"
]
}
},
"RecipientAddresses": [
{
"EmailAddress": "123@h3c.com",
"EmailSubject": "111",
"Enabled": true,
"MemberId": "1"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "2"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "3"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "4"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "5"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "6"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "7"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "8"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "9"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "10"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "11"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "12"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "13"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "14"
},
{
"EmailAddress": "",
"EmailSubject": "",
"Enabled": false,
"MemberId": "15"
}
],
"SenderAddress": "",
"SenderPassword": null,
"SenderUserName": "",
"ServerAddress": "",
"ServerPort": 25,
"ServiceEnabled": true,
"TLSEnabled": true
}
Response code: 200
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 |
|
HDM3-2.02 HDM3-1.24 |
Added the description to indicate that the server port must be set to 465 when you enable TLS. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Perform SMTP testing
Description
Perform SMTP testing on the server.
Privilege module
ConfigureComponents
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. |
|
manager_id |
ID of the manager resource. |
Only value 1 is supported. |
|
MemberId |
Recipient ID. |
String. |
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:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageIds |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node.. |
Obtain information for SMTP trap testing
Description
Obtain SMTP trap test result information from the server.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Managers/manager_id/SmtpService/Oem/Public/SubmitTestResult/email_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. |
|
email_id |
ID of receive alarm email address. |
N/A |
Examples
Method and URL:
GET https://device_ip/redfish/v1/Managers/1/SmtpService/Oem/Public/SubmitTestResult/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#SmtpService.TestResult",
"@odata.id":"/redfish/v1/Managers/1/SmtpService/Oem/Public/SubmitTestResult/1",
"@odata.type": "#SmtpTestResult.v1_0_0.SmtpTestResult",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SMTPTestResult":"success"
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of SMTP information resource model. |
|
@odata.id |
String |
Link to SMTP information resources. |
|
@odata.type |
String |
Type of SMTP information resources. |
|
SMTPTestResult |
String |
Whether the SMTP test is successful. Supported options: · Fail. · Success. |
The server returns status code 200 for a successful operation.
Obtain syslog information
Description
Obtain syslog information from the server.
Privilege module
Login
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": "#SyslogService.v1_0_0.SyslogService",
"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": {
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent",
"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent"
}
},
"AuthenticateMode": "TwoWay",
"CustomOptions": [
"TimeStamp",
"HostName",
"Message"
],
"Id": "SyslogService",
"MessageFormat": "Custom",
"Name": "Syslog Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"ClientCertificateInstalled": false,
"PrivateKeyCertificateInstalled": false,
"RootCertificateInstalled": false
}
},
"ServerIdentitySource": "HostName",
"ServiceEnabled": true,
"SyslogServers": [
{
"Address": "192.168.10.11",
"Enabled": true,
"LogLevel": "Critical",
"LogType": [
"OperationLog",
"SDRLog"
],
"MemberId": "1",
"Name": "Channel1",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "2",
"Name": "channel2",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "3",
"Name": "channel3",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "4",
"Name": "channel4",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "5",
"Name": "channel5",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "6",
"Name": "channel6",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "7",
"Name": "channel7",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "8",
"Name": "channel8",
"Port": 514
}
],
"TimeInterval": 60,
"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. |
|
Id |
String |
ID of the syslog information resource. |
|
Name |
String |
Name of the syslog information resource. |
|
ServiceEnabled |
Boolean |
Enabling status of the syslog service. |
|
TransmissionProtocol |
String |
Protocol used for syslog message transmission. Supported options: · UDP. · TCP. · TLS. |
|
AuthenticateMode |
String |
Authentication mode. Supported options: · OneWay. · TwoWay. |
|
ServerIdentitySource |
String |
Syslog server identifier. Supported options: · HostName. · BoardSN—SN of the system board. · ProductAssetTag. · ProductSN. |
|
TimeInterval |
Integer |
Time interval: 10 to 2,592,000. |
|
MessageFormat |
String |
Message format. Supported options: · Custom—Custom. · RFC3164—RFC3164. · RFC5424—RFC5424. |
|
CustomOptions |
Array |
Custom format. Supported options · Message. · TimeStamp. · HostName. Custom format options are only valid in Custom format. |
|
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. · SerialLog. · SDRLog. |
|
SyslogServers.LogLevel |
String |
Log level. Supported options: · Informational. · Minor. · Major. · Critical. |
|
SyslogServers.Name |
String |
Channel name. |
|
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. |
|
Oem.Public.RootCertificateInstalled |
Boolean |
Import flag of the Syslog root certificate. |
|
Oem.Public.ClientCertificateInstalled |
Boolean |
Import flag of the Syslog local certificate. |
|
Oem.Public.PrivateKeyCertificateInstalled |
Boolean |
Import flag of the Syslog private key. |
The server returns status code 200 for a successful operation.
Configure syslog settings
Description
Configure syslog settings form the server.
Privilege module
ConfigureComponents
Locking type of the associated system
BMC configuration locking
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:
{
"ServiceEnabled":true,
"ServerIdentitySource":"HostName",
"TransmissionProtocol":"UDP",
"TimeInterval":60,
"AuthenticateMode":"TwoWay",
"MessageFormat":"Custom",
"CustomOptions":[
"HostName",
"Message",
"TimeStamp"
],
"SyslogServers": [
{
"Address": "192.168.10.11",
"Enabled": true,
"LogLevel":"Critical",
"LogType": [
"OperationLog",
"SDRLog"
],
"MemberId": "1",
"Name":"Channel1",
"Port": 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. |
|
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. |
|
AuthenticateMode |
Authentication mode. |
String. Supported options: · OneWay. · TwoWay. |
|
ServerIdentitySource |
Syslog server identifier. |
String. Supported options: · HostName. · BoardSN. · ProductAssetTag. · ProductSN. |
|
TimeInterval |
Time interval. |
Integer. The time interval value range is 10 to 2,592,000. |
|
MessageFormat |
Message format. |
String. Supported options: · Custom—Custom. · RFC3164—RFC3164. · RFC5424—RFC5424. |
|
CustomOptions |
Custom format. |
Array. Supported options · Message. · TimeStamp. · HostName. Custom format options are only valid in Custom format, and Message format option is a required configuration item. |
|
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.Name |
Servers name. |
String, up to 31 characters. |
|
SyslogServers.LogType |
Log type. |
Array. Supported options: · OperationLog. · EventLog. · SecurityLog. · SerialLog. · SDRLog. |
|
SyslogServers.LogLevel |
Log level. |
String. Supported options: · Informational. · Minor. · Major. · Critical. |
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:
{
"ServiceEnabled":true,
"ServerIdentitySource":"HostName",
"TransmissionProtocol":"UDP",
"TimeInterval":60,
"AuthenticateMode":"TwoWay",
"MessageFormat":"Custom",
"CustomOptions":[
"HostName",
"Message",
"TimeStamp"
],
"SyslogServers": [
{
"Address": "192.168.10.11",
"Enabled": true,
"LogLevel":"Critical",
"LogType": [
"OperationLog",
"SDRLog"
],
"MemberId": "1",
"Name":"Channel1",
"Port": 514
},
...
]
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#SyslogService.SyslogService(*)",
"@odata.id": "/redfish/v1/Managers/1/SyslogService",
"@odata.type": "#SyslogService.v1_0_0.SyslogService",
"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": {
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent",
"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent"
}
},
"AuthenticateMode": "TwoWay",
"CustomOptions": [
"TimeStamp",
"HostName",
"Message"
],
"Id": "SyslogService",
"MessageFormat": "Custom",
"Name": "Syslog Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"ClientCertificateInstalled": false,
"PrivateKeyCertificateInstalled": false,
"RootCertificateInstalled": false
}
},
"ServerIdentitySource": "HostName",
"ServiceEnabled": true,
"SyslogServers": [
{
"Address": "192.168.10.11",
"Enabled": true,
"LogLevel": "Critical",
"LogType": [
"OperationLog",
"SDRLog"
],
"MemberId": "1",
"Name": "Channel1",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "2",
"Name": "channel2",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "3",
"Name": "channel3",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "4",
"Name": "channel4",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "5",
"Name": "channel5",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "6",
"Name": "channel6",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "7",
"Name": "channel7",
"Port": 514
},
{
"Address": "0.0.0.0",
"Enabled": false,
"LogLevel": "Informational",
"LogType": [],
"MemberId": "8",
"Name": "channel8",
"Port": 514
}
],
"TimeInterval": 60,
"TransmissionProtocol": "UDP"
}
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 syslog information."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Perform SYSLOG trap testing
Description
Perform SYSLOG trap testing on the server.
Privilege module
ConfigureComponents
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.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 |
Alarm log server ID. |
String. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"MemberId":"1"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Import the syslog root certificate
Description
Import the syslog root certificate.
Privilege module
OemSecurityMgmt
Locking type of the associated system
BMC configuration locking
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:
Local import
{
"Type":"URI",
"Content": "/tmp/web/filename"
}
Remote import
{
"Type":"URI",
"Content": "sftp://username:password@10.10.10.191/filename"
}
Text content import
{
"Type":"text",
"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. |
|
Content |
Link to import Syslog root certificate. |
See "Others." |
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:y17057@192.168.170.57/cacert.pem"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Message extended information. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Message details. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Message severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended solutions. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Import a local certificate
Description
Import a syslog local certificate.
Privilege module
OemSecurityMgmt
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
}
Local import
{
"Type":"URI",
"Content": "/tmp/web/filename"
}
Remote import
{
"Type":"URI",
"Content": "sftp://username:password@10.10.10.191/filename"
}
Text content import
{
"Type":"text",
"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. |
|
Content |
Link to import a local certificate. |
See "Others." |
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:y17057@192.168.170.57/cert.pem"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Message extended information. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Message details. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Message severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended solutions. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Import a private key certificate
Description
Import a private key certificate.
Privilege module
OemSecurityMgmt
Locking type of the associated system
BMC configuration locking
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:
· Local import:
Use this interface after transferring the file to the /tmp/web/ directory. For more information, see "Upload BMC file."
{
"Type":"URI",
"Content": "/tmp/web/filename"
}
· Remote import:
¡ CIFS or SFTP:
{
"Type":"URI",
"Content":"cifs://username:password@ip/filename"
}
¡ HTTP, TFTP, NFS, or HTTPS:
{
"Type":"URI",
"Content":"http://ip/filename"
}
The Request body is the same as the "Import a root certificate file."
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. |
|
Content |
Link to import a local certificate. |
See "Others." |
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:y17057@192.168.170.57/key.pem"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Message extended information. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Message details. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Message severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended solutions. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain service information
Description
Obtain information (including port number and enabling status) about HTTPS, IPMI, KVM, SNMP, SSDP, SSH, virtual media, ASDiHDT, and VNC services.
Privilege module
Login
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_7_0.ManagerNetworkProtocol",
"ASD": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 1,
"NonSecurePort": 6868,
"NonSecurePortEnabled": true,
"SecurePort": null,
"SecurePortEnabled": null,
"SessionCount": 0,
"SessionType": "ASD(Remote_XDP)",
"TimeOut": null
}
},
"Port": 6868,
"ProtocolEnabled": false
},
"Actions": {
"Oem": {
"Public": {
"#Manager.RestartService": {
"target": "/redfish/v1/Managers/1/NetworkProtocol/Actions/Oem/Public/Manager.RestartService"
}
}
}
},
"CD-Media": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 2,
"NonSecurePort": 5120,
"NonSecurePortEnabled": false,
"SecurePort": 5124,
"SecurePortEnabled": true,
"SessionCount": 0,
"SessionType": "CD-Media",
"TimeOut": null
}
},
"Port": 5124,
"ProtocolEnabled": true
},
"Description": "Network Protocol Details",
"FD-Media": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 1,
"NonSecurePort": 5122,
"NonSecurePortEnabled": false,
"SecurePort": 5126,
"SecurePortEnabled": true,
"SessionCount": 0,
"SessionType": "FD-Media",
"TimeOut": null
}
},
"Port": 5126,
"ProtocolEnabled": true
},
"FQDN": null,
"HD-Media": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 2,
"NonSecurePort": 5123,
"NonSecurePortEnabled": false,
"SecurePort": 5127,
"SecurePortEnabled": true,
"SessionCount": 0,
"SessionType": "HD-Media",
"TimeOut": null
}
},
"Port": 5127,
"ProtocolEnabled": true
},
"HTTP": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 20,
"NonSecurePort": 80,
"NonSecurePortEnabled": true,
"SecurePort": null,
"SecurePortEnabled": null,
"SessionCount": 0,
"SessionType": "HTTP",
"TimeOut": 30
}
},
"Port": 80,
"ProtocolEnabled": true
},
"HTTPS": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 20,
"NonSecurePort": null,
"NonSecurePortEnabled": null,
"SecurePort": 443,
"SecurePortEnabled": true,
"SessionCount": 0,
"SessionType": "HTTPS",
"TimeOut": 30
}
},
"Port": 443,
"ProtocolEnabled": true
},
"HostName": "HDM",
"IPMI": {
"Oem": {
"Public": {
"MaxSessionCountSupported": null,
"NonSecurePort": 624,
"NonSecurePortEnabled": true,
"SecurePort": 623,
"SecurePortEnabled": false,
"SessionCount": null,
"SessionType": "IPMI",
"TimeOut": null
}
},
"Port": 624,
"ProtocolEnabled": true
},
"Id": "NetworkProtocol",
"KVMIP": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 4,
"NonSecurePort": 7578,
"NonSecurePortEnabled": false,
"SecurePort": 7582,
"SecurePortEnabled": true,
"SessionCount": 0,
"SessionType": "KVM",
"TimeOut": 30
}
},
"Port": 7582,
"ProtocolEnabled": true
},
"Name": "Manager Network Protocol",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
"Sessions": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions"
}
}
},
"SNMP": {
"Oem": {
"Public": {
"MaxSessionCountSupported": null,
"NonSecurePort": 161,
"NonSecurePortEnabled": true,
"SecurePort": null,
"SecurePortEnabled": null,
"SessionCount": null,
"SessionType": "SNMP",
"TimeOut": null
}
},
"Port": 161,
"ProtocolEnabled": true
},
"SSDP": {
"Oem": {
"Public": {
"MaxSessionCountSupported": null,
"NonSecurePort": 1900,
"NonSecurePortEnabled": true,
"SecurePort": null,
"SecurePortEnabled": null,
"SessionCount": null,
"SessionType": "SSDP",
"TimeOut": null
}
},
"Port": 1900,
"ProtocolEnabled": true
},
"SSH": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 3,
"NonSecurePort": null,
"NonSecurePortEnabled": null,
"SecurePort": 22,
"SecurePortEnabled": true,
"SessionCount": 0,
"SessionType": "SSH",
"TimeOut": 10
}
},
"Port": 22,
"ProtocolEnabled": true
},
"Status": {
"Health": "OK",
"State": "Enabled"
},
"VNC": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 2,
"NonSecurePort": 5900,
"NonSecurePortEnabled": true,
"SecurePort": null,
"SecurePortEnabled": null,
"SessionCount": 0,
"SessionType": "VNC",
"TimeOut": 10
}
},
"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. |
|
Actions.Oem.Public |
Operations defined by custom actions. |
|
|
Manager.RestartService |
Object |
Restart service. |
|
Description |
String |
Description of the syslog information resource. |
|
HTTPS.Port |
Integer |
HTTPS service current port number. |
|
HTTPS.ProtocolEnabled |
Boolean |
Enabling status of the HTTPS service. |
|
HTTPS.Oem.Public.SecurePort |
Integer |
HTTPS service secure port number. |
|
HTTPS.Oem.Public.NonSecurePort |
Integer |
HTTPS service insecure port number. |
|
HTTPS.Oem.Public.SecurePortEnabled |
Boolean |
Enabling status of the HTTPS service secure port. |
|
HTTPS.Oem.Public.NonSecurePortEnabled |
Boolean |
Enabling status of the HTTPS service non-secure port. |
|
HTTPS.Oem.Public.MaxSessionCount |
Integer |
Maximum supported sessions of the HTTPS service. |
|
HTTPS.Oem.Public.SessionCount |
Integer |
Current session count for HTTPS service. |
|
HTTPS.Oem.Public.TimeOut |
Integer |
Timeout duration for HTTPS service, in minutes. |
|
HTTPS.Oem.Public.SessionType |
String |
Session type information for HTTPS service. |
|
HTTP.Port |
Integer |
HTTP service current port number. |
|
HTTP.ProtocolEnabled |
Boolean |
Enabling status of the HTTP service. |
|
HTTP.Oem.Public.SecurePort |
Integer |
HTTP service secure port number. |
|
HTTP.Oem.Public.NonSecurePort |
Integer |
HTTP service insecure port number. |
|
HTTP.Oem.Public.MaxSessionCount |
Integer |
Maximum supported sessions of the HTTP service. |
|
HTTP.Oem.Public.SessionCount |
Integer |
Current session count for HTTP service. |
|
HTTP.Oem.Public.TimeOut |
Integer |
Timeout duration for HTTP service, in minutes. |
|
HTTP.Oem.Public.SessionType |
String |
Session type information for HTTP service. |
|
HTTP.Oem.Public.NonSecurePortEnabled |
Boolean |
Enabling status of the HTTP service non-secure port. |
|
HTTP.Oem.Public.SecurePortEnabled |
Boolean |
Enabling status of the HTTP service secure port. |
|
IPMI.Port |
Integer |
IPMI service current port number. |
|
IPMI.ProtocolEnabled |
Boolean |
Enabling status of the IPMI service. |
|
IPMI.Oem.Public.SecurePort |
Integer |
IPMI secure port (RMCP+). |
|
IPMI.Oem.Public.NonSecurePort |
Integer |
IPMI insecure port (RMCP). |
|
IPMI.Oem.Public.MaxSessionCount |
Integer |
Maximum supported sessions of the IPMI service. |
|
IPMI.Oem.Public.SessionCount |
Integer |
Current session count for IPMI service. |
|
IPMI.Oem.Public.TimeOut |
Integer |
Timeout duration for IPMI service, in minutes. |
|
IPMI.Oem.Public.SessionType |
String |
Session type information for IPMI service. |
|
IPMI.Oem.Public.NonSecurePortEnabled |
Boolean |
Enabling status of the IPMI service non-secure port. |
|
IPMI.Oem.Public.SecurePortEnabled |
Boolean |
Enabling status of the IPMI service secure port. |
|
KVMIP.Port |
Integer |
KVM service current port number. |
|
KVMIP.ProtocolEnabled |
Boolean |
Enabling status of the KVM service |
|
KVMIP.Oem.Public.SecurePort |
Integer |
KVMIP secure port number. |
|
KVMIP.Oem.Public.NonSecurePort |
Integer |
KVMIP insecure port number. |
|
KVMIP.Oem.Public.MaxSessionCount |
Integer |
Maximum supported sessions of the KVMIP service. |
|
KVMIP.Oem.Public.SessionCount |
Integer |
Current session count for KVMIP service. |
|
KVMIP.Oem.Public.TimeOut |
Integer |
Timeout duration for KVMIP service, in minutes. |
|
KVMIP.Oem.Public.SessionType |
String |
Session type information for KVMIP service. |
|
KVMIP.Oem.Public.NonSecurePortEnabled |
Boolean |
Enabling status of the KVMIP service insecure port. |
|
KVMIP.Oem.Public.SecurePortEnabled |
Boolean |
Enabling status of the KVMIP service secure port. |
|
Remote-ASD.Port or iHDT.Port |
Integer |
ASD service port or iHDT service current port. This field displays ASD for Intel servers and iHDT for AMD servers. |
|
ASD.ProtocolEnabled or iHDT. ProtocolEnabled |
Boolean |
Enabling status of the ASD service or the iHDT service. This field displays ASD for Intel servers and iHDT for AMD servers. |
|
ASD.Oem.Public.SecurePort or iHDT.Oem.Public.SecurePort |
Integer |
ASD service port or iHDT service secure port. This field displays ASD for Intel servers and iHDT for AMD servers. |
|
ASD.Oem.Public.NonSecurePort or iHDT.Oem.Public.NonSecurePort |
Integer |
ASD service port or iHDT service insecure port. This field displays ASD for Intel servers and iHDT for AMD servers. |
|
ASD.Oem.Public.MaxSessionCount or iHDT.Oem.Public.MaxSessionCount |
Integer |
Maximum supported sessions for ASD or iHDT service. This field displays ASD for Intel servers and iHDT for AMD servers. |
|
ASD.Oem.Public.SessionCount or iHDT.Oem.Public.SessionCount |
Integer |
Current session count for ASD or iHDT service. This field displays ASD for Intel servers and iHDT for AMD servers. |
|
ASD.Oem.Public.TimeOut or iHDT. Oem.Public.TimeOut |
Integer |
Timeout duration for ASD or iHDT service, in minutes. This field displays ASD for Intel servers and iHDT for AMD servers. |
|
ASD.Oem.Public.SessionType or iHDT.Oem.Public.SessionType |
String |
Session type information of the ASD or iHDT service. This field displays ASD for Intel servers and iHDT for AMD servers. |
|
ASD.Oem.Public. NonSecurePortEnabled or iHDT.Oem.Public. NonSecurePortEnabled |
Boolean |
Enabling status of the ASD or iHDT insecure service port. This field displays ASD for Intel servers and iHDT for AMD servers. |
|
ASD.Oem.Public.SecurePortEnabled or iHDT.Oem.Public.SecurePortEnabled |
Boolean |
Enabling status of the ASD or iHDT service secure port. This field displays ASD for Intel servers and iHDT for AMD servers. |
|
SNMP.Port |
Integer |
Current enabled port number for SNMP service. |
|
SNMP.ProtocolEnabled |
Boolean |
Enabling status of the SNMP service. |
|
SNMP.Oem.Public.SecurePort |
Integer |
SNMP secure port number. |
|
SNMP.Oem.Public.NonSecurePort |
Integer |
SNMP insecure port number. |
|
SNMP.Oem.Public.MaxSessionCount |
Integer |
Maximum supported sessions of the SNMP service. |
|
SNMP.Oem.Public.SessionCount |
Integer |
Current session count of the SNMP service. |
|
SNMP.Oem.Public.TimeOut |
Integer |
Timeout duration for SNMP service, in minutes. |
|
SNMP.Oem.Public.SessionType |
String |
Session type information for SNMP service. |
|
SNMP.Oem.Public.NonSecurePortEnabled |
Boolean |
Enabling status of the SNMP service insecure port. |
|
SNMP.Oem.Public.SecurePortEnabled |
Boolean |
Enabling status of the SNMP service secure port. |
|
SSDP.Port |
Integer |
Current enabled port number for SSDP service. |
|
SSDP.ProtocolEnabled |
Boolean |
Enabling status of the SSDP service. |
|
SSDP.Oem.Public.SecurePort |
Integer |
Secure SSDP service port number. |
|
SSDP.Oem.Public.NonSecurePort |
Integer |
Insecure SSDP service port number. |
|
SSDP.Oem.Public.MaxSessionCount |
Integer |
Maximum supported sessions of the SSDP service. |
|
SSDP.Oem.Public.SessionCount |
Integer |
Current session count of the SSDP service. |
|
SSDP.Oem.Public.TimeOut |
Integer |
Timeout duration for SSDP service, in minutes. |
|
SSDP.Oem.Public.SessionType |
String |
Session type information for SSDP service. |
|
SSDP.Oem.Public.NonSecurePortEnabled |
Boolean |
Enabling status of the SSDP service insecure port. |
|
SSDP.Oem.Public.SecurePortEnabled |
Boolean |
Enabling status of the SSDP service secure port. |
|
SSH.Port |
Integer |
Current enabled port number for SSH service. |
|
SSH.ProtocolEnabled |
Boolean |
Enabling status of the SSH service. |
|
SSH.Oem.Public.SecurePort |
Integer |
Secure SSH service port number. |
|
SSH.Oem.Public.NonSecurePort |
Integer |
Insecure SSH service port number. |
|
SSH.Oem.Public.MaxSessionCount |
Integer |
Maximum supported sessions of the SSH service. |
|
SSH.Oem.Public.SessionCount |
Integer |
Current session count of the SSH service. |
|
SSH.Oem.Public.TimeOut |
Integer |
Timeout duration for SSH service, in minutes. |
|
SSH.Oem.Public.SessionType |
String |
Session type information for SSH service. |
|
SSH.Oem.Public.NonSecurePortEnabled |
Boolean |
Enabling status of the SSH service insecure port. |
|
SSH.Oem.Public.SecurePortEnabled |
Boolean |
Enabling status of the SSH service secure port. |
|
FD-Media.Port |
Integer |
Current enabled port number for FD media service. |
|
FD-Media.ProtocolEnabled |
Boolean |
Enabling status of the FD media service. |
|
FD-Media.Oem.Public.SecurePort |
Integer |
Secure FD media service port number. |
|
FD-Media.Oem.Public.NonSecurePort |
Integer |
Insecure FD media service port number. |
|
FD-Media.Oem.Public.MaxSessionCount |
Integer |
Maximum supported sessions of the FD media service. |
|
FD-Media.Oem.Public.SessionCount |
Integer |
Current session count of the FD media service. |
|
FD-Media.Oem.Public.TimeOut |
Integer |
Timeout duration for SSH service, in minutes. |
|
FD-Media.Oem.Public.SessionType |
String |
Session type information for FD media service. |
|
FD-Media.Oem.Public.NonSecurePortEnabled |
Boolean |
Enabling status of the FD media service insecure port. |
|
FD-Media.Oem.Public.SecurePortEnabled |
Boolean |
Enabling status of the FD media service secure port. |
|
CD-Media.Port |
Integer |
Current enabled port number for CD media service. |
|
CD-Media.ProtocolEnabled |
Boolean |
Enabling status of the CD media service. |
|
CD-Media.Oem.Public.SecurePort |
Integer |
Secure CD media service port number. |
|
CD-Media.Oem.Public.NonSecurePort |
Integer |
Insecure CD media service port number. |
|
CD-Media.Oem.Public.MaxSessionCount |
Integer |
Maximum supported sessions of the CD media service. |
|
CD-Media.Oem.Public.SessionCount |
Integer |
Current session count of the CD media service. |
|
CD-Media.Oem.Public.TimeOut |
Integer |
Timeout duration for CD service, in minutes. |
|
CD-Media.Oem.Public.SessionType |
String |
Session type information for CD media service. |
|
CD -Media.Oem.Public. NonSecurePortEnabled |
Boolean |
Enabling status of the CD media service insecure port. |
|
CD -Media.Oem.Public. SecurePortEnabled |
Boolean |
Enabling status of the CD media service secure port. |
|
HD-Media.Port |
Integer |
Current enabled port number for HD media service. |
|
HD-Media.ProtocolEnabled |
Boolean |
Enabling status of the HD media service. |
|
HD-Media.Oem.Public.NonSecurePort |
Integer |
Insecure HD media service port number. |
|
HD-Media.Oem.Public. MaxSessionCount |
Integer |
Maximum supported sessions of the HD media service. |
|
HD-Media.Oem.Public. SessionCount |
Integer |
Current session count of the HD media service. |
|
HD-Media.Oem.Public. TimeOut |
Integer |
Timeout duration for HD service, in minutes. |
|
HD-Media.Oem.Public. SessionType |
String |
Session type information for HD media service. |
|
HD-Media.Oem.Public. NonSecurePortEnabled |
Boolean |
Enabling status of the HD media service insecure port. |
|
HD-Media.Oem.Public. SecurePortEnabled |
Boolean |
Enabling status of the HD media service secure port. |
|
VNC.Port |
Integer |
Current enabled port number for VNC service. |
|
VNC.ProtocolEnabled |
Boolean |
Enabling status of the VNC media service. |
|
VNC.Oem.Public.SecurePort |
Integer |
Secure VNC media service port number. |
|
VNC.Oem.Public.NonSecurePort |
Integer |
Insecure VNC media service port number. |
|
VNC.Oem.Public. MaxSessionCount |
Integer |
Maximum supported sessions of the VNC media service. |
|
VNC.Oem.Public. SessionCount |
Integer |
Current session count of the VNC media service. |
|
VNC.Oem.Public. TimeOut |
Integer |
Timeout duration for VNC media, in minutes. |
|
VNC.Oem.Public. SessionType |
String |
Session type information for VNC media service. |
|
VNC.Oem.Public. NonSecurePortEnabled |
Boolean |
Enabling status of the VNC media service insecure port. |
|
VNC.Oem.Public. SecurePortEnabled |
Boolean |
Enabling status of the VNC media service secure port. |
|
HostName |
String |
Host name. |
|
FQDN |
String |
Fully qualified domain name for HDM. This field displays null if no DNS parent domain name is configured. |
|
Id |
String |
Service ID. |
|
Name |
String |
Name of the service collection resource. |
|
Status.Health |
String |
Resource health status. |
|
Status.State |
String |
Resource enabling status. |
|
Oem.Public.Sessions |
Object |
Link to the list of services that can create sessions. |
Change history
|
Version |
Change description |
|
HDM3-1.16 |
Deleted the Telnet service field. |
|
HDM2-2.12 |
Deleted the Telnet service field. |
|
HDM2-2.02 |
Added Actions.Oem.Public and object Manager.RestartService. |
|
HDM2-1.62 |
Added support of G6 AMD products for iHDT. |
Configure service settings
Description
Specify the port number or set the enabling status for the HTTPS, IPMI, KVM, SNMP, SSDP, SSH, virtual media, ASDiHDT, and VNC services.
Privilege module
OemSecurityMgmt
Locking type of the associated system
BMC configuration locking
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": {
"Oem": {
"Public": {
"NonSecurePortEnabled": nonsecure_port_enabled,
"SecurePortEnabled": port_enabled,
"TimeOut": time_out
}
},
"Port": port,
"ProtocolEnabled": protocol_enabled
}
}
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. · SSDP. · SSH. · CD-Media. · VNC. · ASDiHDT. |
|
ServerType.ProtocolEnabled |
Enable or disable the service. |
Boolean. Supported options: · true—Enable. · false—Disable. |
|
ServerType.Port |
Service enabled port number. |
Integer. |
|
ServerType .Oem.Public.SecurePortEnabled |
Enable or disable the Secure port. |
Boolean. Supported options: · true—Enable. · false—Disable. |
|
ServerType .Oem.Public.NonSecurePortEnabled |
Enable or disable the Insecure port. |
Boolean. Supported options: · true—Enable. · false—Disable. |
|
ServerType.Oem.Public.TimeOut |
Timeout duration, in minutes. |
Integer. |
Usage guidelines
You can configure the settings only for one service at a time. However, disabling the HTTPS service is not supported.
By default, the IPMI service has a secure port enabled. Both secure and insecure ports must be set to the same port number.
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:
{
"KVMIP":{
"Oem":{
"Public":{
"NonSecurePortEnabled":false,
"SecurePortEnabled":true,
"TimeOut":30
}
},
"Port":7582,
"ProtocolEnabled":true
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#ManagerNetworkProtocol.ManagerNetworkProtocol",
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol",
"@odata.type": "#ManagerNetworkProtocol.v1_7_0.ManagerNetworkProtocol",
"ASD": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 1,
"NonSecurePort": 6868,
"NonSecurePortEnabled": true,
"SecurePort": null,
"SecurePortEnabled": null,
"SessionCount": 0,
"SessionType": "ASD(Remote_XDP)",
"TimeOut": null
}
},
"Port": 6868,
"ProtocolEnabled": false
},
"Actions": {
"Oem": {
"Public": {
"#Manager.RestartService": {
"target": "/redfish/v1/Managers/1/NetworkProtocol/Actions/Oem/Public/Manager.RestartService"
}
}
}
},
"CD-Media": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 2,
"NonSecurePort": 5120,
"NonSecurePortEnabled": false,
"SecurePort": 5124,
"SecurePortEnabled": true,
"SessionCount": 0,
"SessionType": "CD-Media",
"TimeOut": null
}
},
"Port": 5124,
"ProtocolEnabled": true
},
"Description": "Network Protocol Details",
"FD-Media": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 1,
"NonSecurePort": 5122,
"NonSecurePortEnabled": false,
"SecurePort": 5126,
"SecurePortEnabled": true,
"SessionCount": 0,
"SessionType": "FD-Media",
"TimeOut": null
}
},
"Port": 5126,
"ProtocolEnabled": true
},
"FQDN": null,
"HD-Media": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 2,
"NonSecurePort": 5123,
"NonSecurePortEnabled": false,
"SecurePort": 5127,
"SecurePortEnabled": true,
"SessionCount": 0,
"SessionType": "HD-Media",
"TimeOut": null
}
},
"Port": 5127,
"ProtocolEnabled": true
},
"HTTP": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 20,
"NonSecurePort": 80,
"NonSecurePortEnabled": true,
"SecurePort": null,
"SecurePortEnabled": null,
"SessionCount": 0,
"SessionType": "HTTP",
"TimeOut": 30
}
},
"Port": 80,
"ProtocolEnabled": true
},
"HTTPS": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 20,
"NonSecurePort": null,
"NonSecurePortEnabled": null,
"SecurePort": 443,
"SecurePortEnabled": true,
"SessionCount": 0,
"SessionType": "HTTPS",
"TimeOut": 30
}
},
"Port": 443,
"ProtocolEnabled": true
},
"HostName": "HDM",
"IPMI": {
"Oem": {
"Public": {
"MaxSessionCountSupported": null,
"NonSecurePort": 624,
"NonSecurePortEnabled": true,
"SecurePort": 623,
"SecurePortEnabled": false,
"SessionCount": null,
"SessionType": "IPMI",
"TimeOut": null
}
},
"Port": 624,
"ProtocolEnabled": true
},
"Id": "NetworkProtocol",
"KVMIP": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 4,
"NonSecurePort": 7578,
"NonSecurePortEnabled": false,
"SecurePort": 7582,
"SecurePortEnabled": true,
"SessionCount": 0,
"SessionType": "KVM",
"TimeOut": 30
}
},
"Port": 7582,
"ProtocolEnabled": true
},
"Name": "Manager Network Protocol",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
"Sessions": {
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions"
}
}
},
"SNMP": {
"Oem": {
"Public": {
"MaxSessionCountSupported": null,
"NonSecurePort": 161,
"NonSecurePortEnabled": true,
"SecurePort": null,
"SecurePortEnabled": null,
"SessionCount": null,
"SessionType": "SNMP",
"TimeOut": null
}
},
"Port": 161,
"ProtocolEnabled": true
},
"SSDP": {
"Oem": {
"Public": {
"MaxSessionCountSupported": null,
"NonSecurePort": 1900,
"NonSecurePortEnabled": true,
"SecurePort": null,
"SecurePortEnabled": null,
"SessionCount": null,
"SessionType": "SSDP",
"TimeOut": null
}
},
"Port": 1900,
"ProtocolEnabled": true
},
"SSH": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 3,
"NonSecurePort": null,
"NonSecurePortEnabled": null,
"SecurePort": 22,
"SecurePortEnabled": true,
"SessionCount": 0,
"SessionType": "SSH",
"TimeOut": 10
}
},
"Port": 22,
"ProtocolEnabled": true
},
"Status": {
"Health": "OK",
"State": "Enabled"
},
"VNC": {
"Oem": {
"Public": {
"MaxSessionCountSupported": 2,
"NonSecurePort": 5900,
"NonSecurePortEnabled": true,
"SecurePort": null,
"SecurePortEnabled": null,
"SessionCount": 0,
"SessionType": "VNC",
"TimeOut": 10
}
},
"Port": 5900,
"ProtocolEnabled": false
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain service information."
Change history
|
Version |
Change description |
|
HDM3-1.16 |
Deleted the Telnet service field. |
|
HDM2-2.12 |
Deleted the Telnet service field. |
|
HDM2-1.62 |
Added support of G6 AMD products for iHDT. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Use the restart service
Description
Use the restart service.
Privilege module
OemSecurityMgmt
Request
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
{
"ResetType": "SNMP"
}
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. |
|
ResetType |
String |
Service types to be restarted, IPMI, KVMIP, SNMP, SSDP, SSH, CD-Media, VNC, and ASD|iHDT. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol/Actions/Oem/Public/Manager.RestartService/
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
{
"ResetType": "SNMP"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Detailed information. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
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 |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-2.02 |
Added this interface. |
Obtain the list of services that can create sessions
Description
Obtain the information for the list of services that can create sessions.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol/Oem/Public/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. |
|
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/Oem/Public/Sessions
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#NetworkProtocolSessionsCollection.NetworkProtocolSessionsCollection",
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions",
"@odata.type": "#NetworkProtocolSessionsCollection.v1_0_0.NetworkProtocolSessionsCollection",
"Description": "NetworkProtocol Sessions Collection",
"Members": [
{
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/HTTP"
},
{
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/HTTPS"
},
{
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/KVMIP"
},
{
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/CD-Media"
},
{
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/FD-Media"
},
{
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/HD-Media"
},
{
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/SSH"
},
{
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/ASD"
},
{
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/VNC"
}
],
"Members@odata.count": 10,
"Name": "Manager Network Protocol",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the service session list resource model. |
|
@odata.id |
String |
Link to the service session list resource. |
|
@odata.type |
String |
Type of the service session list resource. |
|
Description |
String |
Description of service session list resource. |
|
Name |
String |
Name of the service session list resource. |
|
Members |
Array |
Service session list resources. |
|
Members@odata.count |
Integer |
Number of service session list resources. |
Change history
|
Version |
Change description |
|
HDM3-1.16 |
Deleted the Telnet service field. |
|
HDM2-2.12 |
Deleted the Telnet service field. |
Obtain detailed session information for a specified service
Description
Obtain information about HTTPS, KVM, SSH, virtual media, ASD|iHDT, and VNC services.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol/Oem/Public/Sessions/protocol_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. |
|
protocol_id |
Service type. |
You can obtain it by querying the interface for the list of services that can create sessions. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/HTTP
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#NetworkProtocolSessions.NetworkProtocolSessions",
"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/HTTP",
"@odata.type": "#NetworkProtocolSessions.v1_0_0.NetworkProtocolSessions",
"Description": "NetworkProtocol Sessions",
"Name": "HTTP",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"Sessions": [
{
"IPAddress": "192.168.247.19",
"MySession": true,
"RoleId": "Administrator",
"SessionId": "16",
"SessionType": "HTTP",
"UserId": "1",
"UserName": "admin"
}
]
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the service session detail resource model. |
|
@odata.id |
String |
Link to the service session detail resource. |
|
@odata.type |
String |
Type of the service session detail resource. |
|
Description |
String |
Description of the service session detail resource. |
|
Name |
String |
Name of the service session detail resource. |
|
Sessions |
Array |
Detailed information of the service session. |
|
SessionId |
String |
Session ID. |
|
SessionType |
String |
Session type. |
|
UserId |
String |
User ID. |
|
UserName |
String |
Username. |
|
IPAddress |
String |
IP address. |
|
RoleId |
String |
User role. |
|
MySession |
Boolean |
Whether it is a local session. |
Delete session information for the specified service
Description
Delete information for the HTTPS, KVM, SSH, virtual media, ASD|iHDT, and VNC services.
Privilege module
OemSecurityMgmt
Locking type of the associated system
BMC configuration locking
Request
DELETE https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol/Oem/Public/Sessions/protocol_id/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. |
|
manager_id |
ID of the manager resource. |
Only value 1 is supported. |
|
protocol_id |
ID of service type. |
You can obtain service type IDs from the interface for the list of services that can create sessions. |
|
session_id |
Session ID. |
You can obtain available session IDs from the detailed session information of the specified service. |
Examples
Method and URL:
DELETE https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol/Oem/Public/Sessions/HTTPS/16
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.62 |
Added support of G6 AMD products for iHDT. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain energy-saving service information
Description
Obtain information about energy-saving services.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Managers/manager_id/ Oem/Public/EnergySavingService
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/Oem/Public/EnergySavingService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context":"/redfish/v1/$metadata#EnergySavingService.EnergySavingService(*)",
"@odata.id":"/redfish/v1/Managers/1/Oem/Public/EnergySavingService",
"@odata.type":"#EnergySavingService.v1_0_0.EnergySavingService",
"ServiceEnabled":true,
"SavingComponents":[
"PSU"
],
"Name":"EnergySavingService",
"Id":"EnergySavingService",
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of energy-saving service information. |
|
@odata.id |
String |
Link to the energy-saving service information resource. |
|
@odata.type |
String |
Type of the energy-saving service information resource. |
|
ServiceEnabled |
Boolean |
Enabled status of energy-saving service information. |
|
SavingComponents |
Array |
Type of the energy-saving component. Supported option: · PSU. |
|
Name |
String |
Name of the energy-saving service information resource. |
|
Id |
String |
ID of the energy-saving service information resource. |
Configure energy-saving service settings
Description
Configure the energy-saving service information.
Privilege module
OemPowerControl
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/EnergySavingService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"ServiceEnabled":true,
"SavingComponents": [
"PSU"
]
}
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. |
|
ServiceEnabled |
Enabling status of energy-saving service information.. |
Boolean. |
|
SavingComponents |
Type of the energy-saving component. |
Array. Supported option: · PSU. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/EnergySavingService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"ServiceEnabled":true,
"SavingComponents": [
"PSU"
]
}
Response:
{
"@odata.context":"/redfish/v1/$metadata#EnergySavingService.EnergySavingService(*)",
"@odata.id":"/redfish/v1/Managers/1/Oem/Public/EnergySavingService",
"@odata.type":"#EnergySavingService.v1_0_0.EnergySavingService",
"ServiceEnabled":true,
"SavingComponents":[
"PSU"
],
"Name":"EnergySavingService",
"Id":"EnergySavingService",
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain energy-saving service information."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Restart HDM
Description
Restart HDM for the server.
Privilege module
OemDiagnosis
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:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Restore BMC factory settings
Description
Restore BMC factory settings.
Privilege module
OemDiagnosis
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.RestoreFactory
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"ConfigurationType": "BMC"
}
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. |
|
ConfigurationType |
Configuration type. This field is available only for BMC. |
String. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/Manager.RestoreFactory
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"ConfigurationType": "BMC"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain network port collection information
Description
Obtain information about all network ports from the server.
Privilege module
Login
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"
}
],
"Members@odata.count": 2,
"Name": "Ethernet Network Interface Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"NcsiEnabled": true,
"PortMode": "Normal",
"SharedNetworkPort": {
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/Oem/Public/SharedNetworkPort"
}
}
}
}
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. |
|
Name |
String |
Name of the network port collection resource. |
|
Members |
Array |
Links to network port resources. |
|
Members@odata.count |
Integer |
Number of network ports. |
|
Oem.Public.PortMode |
String |
Network port mode. Supported options: · Normal. · Bonding. · Activestandby. |
|
Oem.Public.NcsiEnabled |
Boolean |
Enabling status of specified NCSI. Supported options: · true · false |
|
Oem.Public.SharedNetworkPort |
Object |
Link to the shared network port resource. |
Set the network port mode
Description
Set the network port mode for BMC.
Privilege module
ConfigureComponents
Locking type of the associated system
BMC configuration locking
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,
"NcsiEnabled":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. |
|
Oem.Public.PortMode |
Network port mode. |
String. Supported options: · Normal. · Bonding. · Activestandby—G6 is adaptive mode, B05 is network port adaptive mode. |
|
Oem.Public.NcsiEnabled |
Boolean. |
Whether to enable NCSI. Supported options: · true · false |
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": "Activestandby",
"NcsiEnabled": true
}
}
}
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"
}
],
"Members@odata.count": 2,
"Name": "Ethernet Network Interface Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"NcsiEnabled": true,
"PortMode": "Activestandby",
"SharedNetworkPort": {
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/Oem/Public/SharedNetworkPort"
}
}
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain network port collection information."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain shared network port information
Description
Obtain information about a shared network port from the server.
Privilege module
Login
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
GET https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/Oem/Public/SharedNetworkPort
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. |
|
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/Oem/Public/SharedNetworkPort
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Response:
{
"@odata.context": "/redfish/v1/$metadata#SharedNetworkPort.SharedNetworkPort",
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/Oem/Public/SharedNetworkPort",
"@odata.type": "#SharedNetworkPort.v1_0_0.SharedNetworkPort",
"AdaptiveEnabled": false,
"CardAdaptiveEnabled": false,
"CardPriorityList": [
"OCP1 Nic",
"OCP2 Nic",
"OCP3/PCIe Nic"
],
"LastSharedPort": 1,
"ManagementNetworkPort@Redfish.AllowableValues": [
{
"OCP1 Nic": {
"HotPlugSupported": true,
"PortAllowableValues": [
"Port1",
"Port2"
],
"State": true
}
},
{
"OCP2 Nic": {
"HotPlugSupported": true,
"PortAllowableValues": [
"Port1",
"Port2"
],
"State": false
}
},
{
"OCP3/PCIe Nic": {
"HotPlugSupported": false,
"PortAllowableValues": [
"Port1",
"Port2"
],
"State": false
}
}
],
"NetworkCardType": "OCP1 Nic",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SharedPortInUse": 1,
"SharedPortLinkState": [
{
"Port1": "Down"
},
{
"Port2": "Down"
}
]
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
SharedPortInUse |
Integer |
Used shared port. |
|
SharedPortLinkState |
String |
Link status of all ports on the shared network card. Supported options: · Down, · Up, |
|
NetworkCardType |
String |
Type of the network card. |
|
AdaptiveEnabled |
Boolean |
Port adaptive usage. Supported options: · True. · False. |
|
ManagementNetworkPort@Redfish.AllowableValues |
Array |
|
|
State |
String |
Presence status. |
|
HotPlugSupported |
Boolean |
Supports hot-swapping. Supported options: · True. · False. |
|
PortAllowableValues |
String |
All ports. |
|
CardAdaptiveEnabled |
String |
Whether network card adaptive mode is enabled. |
|
LastSharedPort |
String |
Last share port number. |
Change history
|
Version |
Change description |
|
HDM2-2.17 HDM3-1.25 HDM3-2.03 |
Deleted the LinkStatus field in response field description. |
Configure shared network port settings
Description
Obtain the settings information of a shared network port for the server.
Privilege module
ConfigureComponents
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/Oem/Public/SharedNetworkPort
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"AdaptiveEnabled":true,
"NetworkCardType":"Onboard Nic",
"SharedPortInUse":1,
"CardAdaptiveEnabled":true,
"CardPriorityList":[
"OCP3/PCIe Nic",
"OCP2 Nic",
"OCP1 Nic"
]
}
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. |
|
AdaptiveEnabled |
Whether port adaptive mode is enabled. |
Boolean. Supported options: · True. · False. Auto-selection status. Supported options: · true—Enabled. · false—Disabled. |
|
NetworkCardType |
Network card type. |
String. You can obtain the network adapter type from the CardPriorityList field in shared network port information. |
|
SharedPortInUse |
Port number. |
Integer. |
|
CardAdaptiveEnabled |
Whether network card adaptive mode is enabled. |
Boolean. |
|
CardPriorityList |
Network card priority list. |
Array. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces/Oem/Public/SharedNetworkPort
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:W/"6e8c96325a9b7c6a6e5e9f23616fbce0"
Request body:
{
"AdaptiveEnabled": false,
"SharedPortInUse":2,
"CardAdaptiveEnabled":true,
"CardPriorityList":[
"OCP1 Nic",
"OCP2 Nic",
"OCP3/PCIe Nic"
]
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#SharedNetworkPort.SharedNetworkPort",
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/Oem/Public/SharedNetworkPort",
"@odata.type": "#SharedNetworkPort.v1_0_0.SharedNetworkPort",
"AdaptiveEnabled": false,
"CardAdaptiveEnabled": true,
"CardPriorityList": [
"OCP1 Nic",
"OCP2 Nic",
"OCP3/PCIe Nic"
],
"LastSharedPort": 2,
"ManagementNetworkPort@Redfish.AllowableValues": [
{
"OCP1 Nic": {
"HotPlugSupported": true,
"PortAllowableValues": [
"Port1",
"Port2"
],
"State": true
}
},
{
"OCP2 Nic": {
"HotPlugSupported": true,
"PortAllowableValues": [
"Port1",
"Port2"
],
"State": true
}
},
{
"OCP3/PCIe Nic": {
"HotPlugSupported": true,
"PortAllowableValues": [
"Port1",
"Port2"
],
"State": true
}
}
],
"NetworkCardType": "OCP1 Nic",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SharedPortInUse": 2,
"SharedPortLinkState": [
{
"Port1": "Down"
},
{
"Port2": "Up"
}
]
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain shared network port information."
Change history
|
Version |
Change description |
|
HDM3-1.20 |
Edited the description for the NetworkCardType field in the request body. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain network port information
Description
Obtain information about a specific network port from the server. The dedicated network port is not available for X18000 products.
Privilege module
Login
Locking type of the associated system
BMC configuration locking
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/eth0
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/1/EthernetInterfaces/eth0",
"@odata.type":"#EthernetInterface.v1_6_0.EthernetInterface",
"AutoNeg":true,
"Description":"Ethernet Interface eth0",
"FQDN":null,
"FullDuplex":true,
"HostName":"HDM2019",
"IPv4Addresses":[
{
"Address":"192.168.188.198",
"AddressOrigin":"Static",
"Gateway":"",
"SubnetMask":"255.255.0.0"
}
],
"IPv4StaticAddresses":[
{
"Address":"192.168.188.198",
"AddressOrigin":"Static",
"Gateway":"",
"SubnetMask":"255.255.0.0"
}
],
"IPv6Addresses":[
{
"Address":"fe80::a8bb:ccff:fed2:4718",
"AddressOrigin":"LinkLocal",
"AddressState":"Preferred",
"PrefixLength":64
},
{
"Address":"2015::1",
"AddressOrigin":"Static",
"AddressState":"Preferred",
"PrefixLength":64
},
{
"Address":"3ffe:501:eeee:2:a8bb:ccff:fed2:4718",
"AddressOrigin":"SLAAC",
"AddressState":"Preferred",
"PrefixLength":64
}
],
"IPv6DefaultGateway":"2015::123",
"IPv6StaticAddresses":{
"Address":"2015::1",
"PrefixLength":64
},
"IPv6StaticDefaultGateways":[
"2015::123"
],
"Id":"eth0",
"InterfaceEnabled":true,
"MACAddress":"aa:bb:cc:d2:47:18",
"MTUSize":1500,
"MaxIPv6StaticAddresses":16,
"Name":"eth0",
"NameServers":[
null,
null,
null,
null,
null,
null
],
"Oem":{
"Public":{
"AdaptiveFlag":false,
"ChannelNumber":1,
"CompletionCode":0,
"DNS":{
"IPv4DNS":{
"DNSAutoReg":true,
"DNSEnabled":false,
"DNSMode":null,
"SuperiorDomain":""
},
"IPv6DNS":{
"DNSAutoReg":true,
"DNSEnabled":true,
"DNSMode":"Manual",
"SuperiorDomain":""
}
},
"Description":"Success",
"IPv4": {
"StaticRoutes": [
{
"Destination": "",
"Gateway": "",
"SubnetMask": ""
},
{
"Destination": "",
"Gateway": "",
"SubnetMask": ""
}
]
},
"IPv4Enabled":true,
"IPv6": {
"StaticRoutes": [
{
"Destination": "",
"Gateway": "",
"PrefixLength": 0
},
{
"Destination": "",
"Gateway": "",
"PrefixLength": 0
}
]
},
"IPv4Enabled":true,
"IPv6Enabled":true,
"ManagementNetworkPort@Redfish.AllowableValues":[
{
"LinkStatus":"Connected",
"Location":"mainboard",
"Type":"Dedicated"
}
],
"PreferredPortId":"0",
"SameSegmentCode":0
}
},
"PermanentMACAddress":"aa:bb:cc:d2:47:18",
"SpeedMbps":1000,
"Status":{
"Health":"OK",
"State":"Enabled"
},
"VLAN":{
"VLANEnable":false,
"VLANId":0,
"VLANPriority":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. This field displays null If the DNS parent domain name is not configured. |
|
FullDuplex |
Boolean |
Enabling status of full duplex. |
|
HostName |
String |
Host name. |
|
IPv4Addresses.Address |
String |
IPv4 address. |
|
IPv4Addresses.AddressOrigin |
String |
IPv4 address obtaining method. |
|
IPv4Addresses.Gateway |
String |
IPv4 gateway. |
|
IPv4Addresses.SubnetMask |
String |
IPv4 subnet mask. |
|
IPv4StaticAddresses.Address |
String |
Static IPv4 address. |
|
IPv4StaticAddresses.AddressOrigin |
String |
Static IPv4 protocol type. |
|
IPv4StaticAddresses.Gateway |
String |
Static IPv4 gateway. |
|
IPv4StaticAddresses.SubnetMask |
String |
Static IPv4 subnet mask. |
|
IPv6Addresses.Address |
String |
IPv6 address. |
|
IPv6Addresses.AddressOrigin |
String |
IPv6 address obtaining method. |
|
IPv6Addresses.PrefixLength |
Integer |
IPv6 prefix length. |
|
IPv6Addresses.AddressState |
String |
IPv6 address status. Supported options: · Preferred—Successful. · Failed—Failure. · Tentative—Pending. |
|
IPv6DefaultGateway |
String |
Default IPv6 gateway. |
|
IPv6StaticAddresses |
Array |
Static IPv6 addresses. |
|
IPv6StaticDefaultGateways |
Array |
Static IPv6 gateways. |
|
Id |
String |
Network port ID. |
|
Link.Oem.Public.EthernetInterface |
Array |
Links to network port resources. |
|
Link.Oem.Public.ManagementNetworkPort@Redfish.AllowableValues |
Array |
Port list and port information. |
|
LinkStatus |
String |
Network port connection status. Supported options: · Connected. · Disconnected. |
|
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. |
|
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. Specify six DNS server IP addresses, the first three are IPv4 addresses, and the last three are IPv6 addresses. If the DNS server IP address is not set, it will be displayed as null. |
|
Oem.Public.AdaptiveFlag |
Boolean |
Auto-selection status. Supported options: · true—Enabled. · false—Disabled. |
|
Oem.Public.ChannelNumber |
Integer |
Port channel number. |
|
Oem.Public.IPv4Enabled |
Boolean |
Enabled or disabled IPv4 status. |
|
Oem.Public.IPv4.StaticRoutes.Destination |
String |
IPv4 destination network address. |
|
Oem.Public.IPv4.StaticRoutes.SubnetMask |
String |
Subnet mask of the IPv4 address. |
|
Oem.Public.IPv4.StaticRoutes.Gateway |
String |
IPv4 static routing gateway. |
|
Oem.Public.IPv6.StaticRoutes.Destination |
String |
IPv6 destination network address. |
|
Oem.Public.IPv6.StaticRoutes.PrefixLength |
Integer |
Subnet prefix length of the IPv6 address. |
|
Oem.Public.IPv6.StaticRoutes.Gateway |
String |
IPv6 static routing gateway. |
|
Oem.Public.IPv6Enabled |
Boolean |
Enabled or disabled IPv6 status. |
|
Oem.Public.IPv6LocalLinkAddress |
String |
Local IPv6 link address. |
|
Oem.Public.IPv6StatelessAddress |
String |
IPv6 stateless address. |
|
Oem.Public.DNS.IPv4DNS.DNSMode |
String |
IPv4 DNS server auto-configuration. Supported options: · Manual. · Auto. |
|
Oem.Public.DNS.IPv4DNS.DNSEnabled |
Boolean |
Enabling status of IPv4 DNS. |
|
Oem.Public.DNS.IPv4DNS.DNSAutoReg |
Boolean |
Enabling status of IPv4 DNS auto-registration. |
|
Oem.Public.DNS.IPv4DNS.SuperiorDomain |
String |
IPv4 parent domain. |
|
Oem.Public.DNS.IPv6DNS.DNSMode |
String |
IPv6 DNS server auto-configuration. Supported options: · Manual. · Auto. |
|
Oem.Public.DNS.IPv6DNS.DNSEnabled |
Boolean |
Enabling status of IPv6 DNS. |
|
Oem.Public.DNS.IPv6DNS.DNSAutoReg |
Boolean |
Enabling status of IPv6 DNS auto-registration. |
|
Oem.Public.DNS.IPv6DNS.SuperiorDomain |
String |
IPv6 parent domain. |
|
Oem.Public.PreferredPortId |
String |
This field displays 0 for using eth0 and 1 for using eth1. |
|
Oem.Public.SameSegmentCode |
Integer |
Whether network segments are conflict. Supported options: · 0—No conflict · 1—IPv4 conflict · 2—IPv6 conflict · 3— All conflicts |
|
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. |
Change history
|
Version |
Change description |
|
HDM2-1.78 HDM2-2.16 HDM3-1.24 HDM3-2.02 |
Added the Oem.Public.DNS.IPv4DNS.DNSAutoReg and Oem.Public.DNS.IPv6DNS.DNSAutoReg fields. |
|
HDM2-1.60 |
Added the following filed: · Oem.Public.IPv4.StaticRoutes.Destination · Oem.Public.IPv4.StaticRoutes.SubnetMask · Oem.Public.IPv4.StaticRoutes.Gateway · Oem.Public.IPv6StaticRoutes.Destination · Oem.Public.IPv6.StaticRoutes.Gateway · Oem.Public.IPv6StaticRoutes.PrefixLength |
Configure network port settings
Description
Configure the settings of a specific network port for the server.
Privilege module
ConfigureComponents
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:
}
"AutoNeg":false,
"FullDuplex":true,
"SpeedMbps":1000,
"IPv4Addresses":[
{
"Address":"192.168.188.198",
"SubnetMask":"255.255.0.0",
"Gateway":"192.168.1.2",
"AddressOrigin":"Static"
}
],
"IPv4StaticAddresses":[
{
"Address":"192.168.188.198",
"SubnetMask":"255.255.0.0",
"Gateway":"",
"AddressOrigin":"Static"
}
],
"IPv6Addresses":[
{
"Address":"2015::1",
"PrefixLength":64,
"AddressOrigin":"Static"
}
],
"IPv6StaticAddresses":[
{
"Address":"2015::1",
"PrefixLength":64
}
],
"IPv6DefaultGateway":"2015::9",
"IPv6StaticDefaultGateways":[
"2015::123"
],
"HostName":"HDM2019",
"VLAN":{
"VLANEnable":false
},
"NameServers":[
"192.168.1.2",
"192.168.12.25",
null,
"6061::2220:8ff:fe07:1348",
null,
null
],
"Oem":{
"Public":{
"IPv4Enabled":true,
"IPv6Enabled":true,
"IPv4": {
"StaticRoutes": [
{
"Destination": "172.168.0.0",
"Gateway": "192.168.2.2",
"SubnetMask": "255.255.0.0"
},
{
"Destination": "",
"Gateway": "",
"SubnetMask": ""
}
]
},
"IPv6": {
"StaticRoutes": [
{
"Destination": "9001::",
"Gateway": "3001::123",
"PrefixLength": 64
},
{
"Destination": "",
"Gateway": "",
"PrefixLength": 0
}
]
},
"DNS":{
"IPv4DNS":{
"DNSMode":"Manual",
"DNSEnabled":true,
"DNSAutoReg":false,
"SuperiorDomain":"www.li.com"
},
"IPv6DNS":{
"DNSMode":"Manual",
"DNSEnabled":true,
"DNSAutoReg":false,
"SuperiorDomain":"www.hai.com"
}
}
}
}
}
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. |
|
AutoNeg |
Whether to auto-negotiate. |
Boolean. Supported options: · true. · false. |
|
FullDuplex |
Whether to use full duplex. |
Boolean. Supported options: · true. · false. |
|
SpeedMbps |
Port speed (not supported for shared ports), only configurable for dedicated ports when auto-negotiation is off, with only three speeds: 10/100/1000. |
Integer. |
|
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. |
|
IPv4StaticAddresses.Address |
Static IPv4 address. |
String. |
|
IPv4StaticAddresses.Gateway |
Static IPv4 gateway. |
String. |
|
IPv4StaticAddresses.SubnetMask |
Static IPv4 subnet mask. |
String. |
|
IPv4StaticAddresses.AddressOrigin |
Obtain static IPv4 address mode. Supported option: · Static. |
String. |
|
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. |
|
IPv6StaticDefaultGateways |
Static IPv6 gateway. |
Array. |
|
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. New G6 requirement: simultaneously issue 6 addresses, with the first three being IPv4 and the last three being IPv6. If set to empty, issue null. |
|
Oem.Public.ChannelNumber |
Port channel number. |
Integer. |
|
Oem.Public.IPv4Enabled |
Enabled or disabled IPv4. |
Boolean. |
|
Oem.Public.IPv4.StaticRoutes.Destination |
IPv4 destination network address. |
String. |
|
Oem.Public.IPv4.StaticRoutes.SubnetMask |
Subnet mask of the IPv4 address. |
String. |
|
Oem.Public.IPv4.StaticRoutes.Gateway |
IPv4 static routing gateway. |
String. |
|
Oem.Public.IPv6.StaticRoutes.Destination |
IPv6 destination network address. |
String. |
|
Oem.Public.IPv6.StaticRoutes.PrefixLength |
Subnet prefix length of the IPv6 address. |
String. |
|
Oem.Public.IPv6.StaticRoutes.Gateway |
IPv6 static routing gateway. |
String. |
|
Oem.Public.IPv6Enabled |
Enabled or disabled IPv6. |
Boolean. |
|
Oem.Public.DNS.IPv4DNS.HostConfig |
IPv4 host settings parameters. |
Integer. |
|
Oem.Public.DNS.IPv4DNS.DNSMode |
IPv4 DNS server auto-configuration. |
String. Supported options: · Manual. · Auto. |
|
Oem.Public.DNS.IPv4DNS.DNSEnabled |
Whether to enable IPV4DNS. |
Boolean. Supported options: · true—Enable. · false—Disable. |
|
Oem.Public.DNS.IPv4DNS. DNSAutoReg |
Whether to enable IPv4 DNS auto-registration. |
Boolean. Supported options: · true—Enable. · false—Disable. This field is available only when the DNS mode is set to manual. |
|
Oem.Public.DNS.IPv4DNS.SuperiorDomain |
IPv4 parent domain. |
String. |
|
Oem.Public.DNS.IPv6DNS.HostConfig |
IPv6 host configuration parameters |
Integer. |
|
Oem.Public.DNS.IPv6DNS.DNSMode |
IPv6 DNS server auto-configuration. |
String. Supported options: · Manual. · Auto. |
|
Oem.Public.DNS.IPv6DNS.DNSEnabled |
Whether to enable IPV6DNS. |
Boolean. Supported options: · true—Enable. · false—Disable. |
|
Oem.Public.DNS.IPv6DNS. DNSAutoReg |
Whether to enable IPv6 DNS auto-registration. |
Boolean. Supported options: · true—Enable. · false—Disable. This field is available only when the DNS mode is set to manual. |
|
Oem.Public.DNS.IPv6DNS.SuperiorDomain |
IPv6 parent domain. |
String. |
Usage guidelines
When the IP address obtaining method is set to DHCP or DHCPv6, you cannot configure the other network port settings. IPv4, IPv6, and IPv6 static address array sizes can only fix to 1.
When both the Oem.Public.{IPv4Enabled,IPv6Enabled} fields are set to false, the interface is disabled. Do not disable the shared and dedicated ports at the same time. For G5 servers, you cannot use this method to disable the dedicated network 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":"192.168.77.77",
"SubnetMask":"255.255.0.0",
"Gateway":"",
"AddressOrigin":"Static"
}
],
"IPv6Addresses":[
{
"Address":"2015::1",
"PrefixLength":64,
"AddressOrigin":"Static"
}
],
"IPv6StaticAddresses":[
{
"Address":"2015::1",
"PrefixLength":64
}
],
"IPv6DefaultGateway":"2015::9",
"IPv6StaticDefaultGateways":[
"2015::123"
]
}
Response:
{
"@odata.context":"/redfish/v1/$metadata#EthernetInterface.EthernetInterface",
"@odata.id":"/redfish/v1/Managers/1/EthernetInterfaces/eth0",
"@odata.type":"#EthernetInterface.v1_6_0.EthernetInterface",
"AutoNeg":true,
"Description":"Ethernet Interface eth0",
"FQDN":null,
"FullDuplex":true,
"HostName":"HDM2019",
"IPv4Addresses":[
{
"Address":"192.168.77.77",
"AddressOrigin":"Static",
"Gateway":"",
"SubnetMask":"255.255.0.0"
}
],
"IPv4StaticAddresses":[
{
"Address":"192.168.77.77",
"AddressOrigin":"Static",
"Gateway":"",
"SubnetMask":"255.255.0.0"
}
],
"IPv6Addresses":[
{
"Address":"fe80::a8bb:ccff:fed2:4718",
"AddressOrigin":"LinkLocal",
"AddressState":"Preferred",
"PrefixLength":64
},
{
"Address":"2015::1",
"AddressOrigin":"Static",
"AddressState":"Preferred",
"PrefixLength":64
},
{
"Address":"3ffe:501:eeee:2:a8bb:ccff:fed2:4718",
"AddressOrigin":"SLAAC",
"AddressState":"Preferred",
"PrefixLength":64
}
],
"IPv6DefaultGateway":"2015::123",
"IPv6StaticAddresses":{
"Address":"2015::1",
"PrefixLength":64
},
"IPv6StaticDefaultGateways":[
"2015::123"
],
"Id":"eth0",
"InterfaceEnabled":true,
"MACAddress":"aa:bb:cc:d2:47:18",
"MTUSize":1500,
"MaxIPv6StaticAddresses":16,
"Name":"eth0",
"NameServers":[
null,
null,
null,
null,
null,
null
],
"Oem":{
"Public":{
"AdaptiveFlag":false,
"ChannelNumber":1,
"CompletionCode":0,
"DNS":{
"IPv4DNS":{
"DNSEnabled":false,
"DNSMode":null,
"SuperiorDomain":""
},
"IPv6DNS":{
"DNSEnabled":true,
"DNSMode":"Manual",
"SuperiorDomain":""
}
},
"Description":"Success",
"IPv4": {
"StaticRoutes": [
{
"Destination": "",
"Gateway": "",
"SubnetMask": ""
},
{
"Destination": "",
"Gateway": "",
"SubnetMask": ""
}
]
},
"IPv4Enabled":true,
"IPv6": {
"StaticRoutes": [
{
"Destination": "",
"Gateway": "",
"PrefixLength": 0
},
{
"Destination": "",
"Gateway": "",
"PrefixLength": 0
}
]
},
"IPv6Enabled":true,
"ManagementNetworkPort@Redfish.AllowableValues":[
{
"LinkStatus":"Connected",
"Location":"mainboard",
"Type":"Dedicated"
}
],
"PreferredPortId":"0",
"SameSegmentCode":0
}
},
"PermanentMACAddress":"aa:bb:cc:d2:47:18",
"SpeedMbps":1000,
"Status":{
"Health":"OK",
"State":"Enabled"
},
"VLAN":{
"VLANEnable":false,
"VLANId":0,
"VLANPriority":0
}
}
Response code: 200
Examples 2
# Disable the network port.
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces/eth1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"
Request body:
{
"Oem":{
"Public":{
"IPv4Enabled":false,
"IPv6Enabled":false
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",
"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth1",
"@odata.type": "#EthernetInterface.v1_6_0.EthernetInterface",
"AutoNeg": true,
"Description": "Ethernet Interface eth1",
"FQDN": null,
"FullDuplex": true,
"HostName": "HDM",
"IPv4Addresses": [
{
"Address": "",
"AddressOrigin": "DHCP",
"Gateway": "",
"SubnetMask": ""
}
],
"IPv4StaticAddresses": [],
"IPv6Addresses": [
{
"Address": "fe80::2223:5ff:fe24:1147",
"AddressOrigin": "LinkLocal",
"AddressState": "Tentative",
"PrefixLength": 0
},
{
"Address": "",
"AddressOrigin": "DHCPv6",
"AddressState": "N/A",
"PrefixLength": 0
},
{
"Address": "",
"AddressOrigin": "SLAAC",
"AddressState": "N/A",
"PrefixLength": 0
}
],
"IPv6DefaultGateway": "",
"IPv6StaticAddresses": null,
"IPv6StaticDefaultGateways": [],
"Id": "eth1",
"InterfaceEnabled": false,
"MACAddress": "",
"MTUSize": 1500,
"MaxIPv6StaticAddresses": 16,
"Name": "eth1",
"NameServers": [
null,
null,
null,
null,
null,
null
],
"Oem": {
"Public": {
"AdaptiveFlag": false,
"ChannelNumber": 8,
"CompletionCode": 0,
"DNS": {
"IPv4DNS": {
"DNSEnabled": false,
"DNSMode": "Auto",
"SuperiorDomain": ""
},
"IPv6DNS": {
"DNSEnabled": false,
"DNSMode": "Auto",
"SuperiorDomain": ""
}
},
"Description": "Success",
"IPv4": {
"StaticRoutes": [
{
"Destination": "",
"Gateway": "",
"SubnetMask": ""
},
{
"Destination": "",
"Gateway": "",
"SubnetMask": ""
}
]
},
"IPv4Enabled":false,
"IPv6": {
"StaticRoutes": [
{
"Destination": "",
"Gateway": "",
"PrefixLength": 0
},
{
"Destination": "",
"Gateway": "",
"PrefixLength": 0
}
]
},
"IPv6Enabled": false,
"ManagementNetworkPort@Redfish.AllowableValues": [],
"PreferredPortId": "1",
"SameSegmentCode": 0
}
},
"PermanentMACAddress": "",
"SpeedMbps": 1000,
"Status": {
"Health": "OK",
"State": "Disabled"
},
"VLAN": {
"VLANEnable": false,
"VLANId": 0,
"VLANPriority": 0
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain network port information."
Change history
|
Version |
Change description |
|
HDM2-1.78 HDM2-2.16 HDM3-1.24 HDM3-2.02 |
Added the Oem.Public.DNS.IPv4DNS.DNSAutoReg and Oem.Public.DNS.IPv6DNS.DNSAutoReg fields. These fields are available only when the DNS mode is set to manual. |
|
HDM2-1.60 |
Added the following field: · Oem.Public.IPv4.StaticRoutes.Destination · Oem.Public.IPv4.StaticRoutes.SubnetMask · Oem.Public.IPv4.StaticRoutes.Gateway · Oem.Public.IPv6StaticRoutes.Destination · Oem.Public.IPv6.StaticRoutes.Gateway · Oem.Public.IPv6StaticRoutes.PrefixLength |
|
HDM2-1.54 |
Added Examples 2 to illustrate the method of disabling a network port by setting the Oem.Public.{IPv4Enabled,IPv6Enabled} field to false. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Remarks
When you set DNSMode and DNSAutoReg, you must also set the DNSEnabled field to true. If you fail to do so, the settings for DNSMode and DNSAutoReg will become invalid.
If you set the DNSEnabled field to false, the settings for DNSMode, SuperiorDomain, and DNSAutoReg are invalid.
If you change the DNSMode field from Manual to Auto, the settings for SuperiorDomain and DNSAutoReg are invalid.
Obtain virtual media collection information
Description
Obtain information about all virtual media from the server.
Privilege module
Login
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",
"Actions": {
"Oem": {
"Public": {
"#VirtualMedia.Config": {
"target": "/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config"
},
"#VirtualMedia.StopMount": {
"target": "/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.StopMount"
},
"#VirtualMedia.VmmControl": [
{
"target": "/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl"
},
{
"target": "/redfish/v1/Managers/1/VirtualMedia/FD/Oem/Public/Actions/VirtualMedia.VmmControl"
},
{
"target": "/redfish/v1/Managers/1/VirtualMedia/HD/Oem/Public/Actions/VirtualMedia.VmmControl"
}
]
}
}
},
"Description": "Collection of Virtual Media redirected to host via this Manager",
"Members": [
{
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/CD"
},
{
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/FD"
},
{
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/HD"
}
],
"Members@odata.count": 3,
"Name": "Virtual Media Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"MountStatus": {
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/Oem/Public/MountStatus"
}
}
}
}
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. |
|
Members |
Enabled list of virtual media types. |
|
|
@odata.id |
String |
Link to a virtual media node. |
|
Members@odata.count |
Integer |
Number of virtual media resources. |
|
Actions.Oem.Public.#VirtualMedia.Config |
Object |
Virtual media configuration. |
|
Actions.Oem.Public.#VirtualMedia.VmmControl |
Object |
Connect virtual media, |
|
Oem.Public.MountStatus |
Object |
Check virtual media connection status. |
|
Actions.Oem.Public.#VirtualMedia.StopMount |
Object |
Stop virtual media mounting. |
The server returns status code 200 for a successful operation.
Obtain virtual media information
Description
Obtain information about the virtual media resource from the server.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Virtualmedia_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. |
|
Virtualmedia_id |
Type of the virtual media. |
Supported types: · CD. · HD. · FD. |
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(*)",
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/CD",
"@odata.type": "#VirtualMedia.v1_4_0.VirtualMedia",
"Connected": [
{
"ImageName": "CentOS.iso",
"Oem": {
"Public": {
"ImageType": "ImageFile"
}
},
"MediaIndex": 0,
"MediaTypes": "CD",
"SessionIndex": 0
}
],
"Id": "CD",
"Name": "VirtualMedia",
"NotConnected": [
{
"ImageName": "Test1.iso",
"Oem": {
"Public": {
"ImageType": "ImageFile"
}
},
"Index": 0,
"MediaTypes": "CD"
},
{
"ImageName": "Test2.iso",
"Oem": {
"Public": {
"ImageType": "ImageFile"
}
},
"Index": 1,
"MediaTypes": "CD"
},
{
"ImageName": "ZBC.iso",
"Index": 2,
"Oem": {
"Public": {
"ImageType": "ImageFile"
}
},
"MediaTypes": "CD"
},
{
"ImageName": "Zwe.iso",
"Index": 3,
"Oem": {
"Public": {
"ImageType": "ImageFile"
}
},
"MediaTypes": "CD"
}
],
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Connected |
Array |
Connected images. |
|
Connected.MediaTypes |
String |
Media image type. Supported options: · CD/DVD/FD. |
|
Connected.ImageName |
String |
Media image name. |
|
Connected.MediaIndex |
Integer |
Media index. |
|
Connected.SessionIndex |
Integer |
Session index. |
|
Connected.Oem.Public.ImageType |
String |
Image type. |
|
NotConnected |
Array |
Disconnected images. |
|
NotConnected.ImageName |
String |
Media image name. |
|
NotConnected.Oem.Public.ImageType |
String |
Image type. |
|
NotConnected.Index |
Integer |
Disconnected image number, |
|
NotConnected.MediaTypes |
String |
Media image type. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM3-1.15 |
Added the Connected.Oem.Public.ImageType and NotConnected.Oem.Public.ImageType fields. The fields are available only in HDM3 1.15 and later versions and are not available in HDM2. |
Obtain virtual media connection status
Description
Obtain information about the virtual media connection status. from the server.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Oem/Public/MountStatus
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//Oem/Public/MountStatus
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#VirtualMediaMountStatus.VirtualMediaMountStatus",
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/Oem/Public/MountStatus",
"@odata.type": "#VirtualMediaMountStatus.v1_0_0.VirtualMediaMountStatus",
"CD": [
{
"MediaIndex": 0,
"Status": "Access permitted"
},
{
"MediaIndex": 1,
"Status": "Not started"
}
],
"FD": [
{
"MediaIndex": 0,
"Status": "Not started"
}
],
"HD": [
{
"MediaIndex": 0,
"Status": "Not started"
},
{
"MediaIndex": 1,
"Status": "Not started"
}
],
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the virtual media resource connection model. |
|
@odata.id |
String |
Link to the virtual media resource connection. |
|
@odata.type |
String |
Type of the virtual media resource connection. |
|
CD.MediaIndex |
Integer |
Media index.. |
|
CD.Status |
String |
Connection status. Supported options: · Not started. · Access permitted. · Access denied. · Login failed. · Connection in use. · Unauthorized. · Unknown error. · Access permitted. · Max number of login sessions reached. · Access error. · Invalid image. · Installation error. · Opening error. · Expired license. · Connection lost. · Mount canceled by user. · Device popped open. · Session terminated. |
The server returns status code 200 for a successful operation.
Obtain virtual media configuration
Description
Obtain information about the virtual media configuration from the server.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config
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/Oem/Public/Actions/VirtualMedia.Config
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#VirtualMediaConfig.VirtualMediaConfig",
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config",
"@odata.type": "#VirtualMediaConfig.v1_0_0.VirtualMediaConfig",
"Media": [
{
"DomainName": "",
"FromPath": "/Share1",
"MediaType": "CD",
"ServerAddress": "192.168.27.14",
"ShareType": "nfs",
"State": "Enabled",
"UserName": ""
},
{
"DomainName": "",
"FromPath": "",
"MediaType": "FD",
"ServerAddress": "",
"ShareType": "",
"State": "Disabled",
"UserName": ""
},
{
"DomainName": "",
"FromPath": "",
"MediaType": "HD",
"ServerAddress": "",
"ShareType": "",
"State": "Disabled",
"UserName": ""
}
],
"MediaSupport": true,
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"DomainName": "",
"FromPath": "",
"MediaType": "ALL",
"ServerAddress": "",
"ShareType": "",
"State": "Disabled",
"UserName": ""
}
}
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
Description information of the virtual media configuration. |
|
@odata.id |
String |
Link to the virtual media configuration. |
|
@odata.type |
String |
Type of virtual media configuration. |
|
MediaSupport |
Boolean |
Remote media support. |
|
Media.MediaType |
String |
Media type. |
|
Media.ShareType |
String |
Mounting method.. |
|
Media.ServerAddress |
String |
Server address |
|
Media.FromPath |
String |
Source path. |
|
Media.UserName |
String |
Username. |
|
Media.State |
String |
Supported options: · Enabled. · Disabled. · WrongSetting. · Mounting. |
|
Media.DomainName |
String |
Domain name. |
The server returns status code 200 for a successful operation.
Configure virtual media settings
Description
Configure virtual media settings on the server.
Privilege module
OemVmm
Request
PATCH https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"MediaSupport":true,
"Media":[
{
"MediaType":"CD",
"State":"Enabled",
"ShareType":sharetype,
"ServerAddress":ip,
"FromPath":"",
"UserName":"",
"Password":"",
"DomainName":DomainName
},
{
"MediaType":"HD",
"State":"Enabled",
"ShareType": sharetype,
"ServerAddress":ip,
"FromPath":"",
"UserName":"",
"Password":"",
"DomainName":DomainName
},
{
"MediaType":"FD",
"State":"",
"ShareType": sharetype,
"ServerAddress": ip,
"FromPath":"",
"UserName":"",
"Password":"",
"DomainName":DomainName
}
] ,
"Oem":{
"Public":{
"MediaType":"ALL",
"State":"",
"ShareType":"",
"ServerAddress":"",
"FromPath":"",
"UserName":"",
"DomainName":DomainName
}
}
}
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. |
|
MediaSupport |
Remote media support, do not send other parameters when false. |
· Boolean. Options: · True. · False. |
|
Media.MediaType |
Type of the virtual media mounting. |
String. Supported options: · CD. · HD. · FD. |
|
Media.ShareType |
Type of virtual media sharing. |
String. Supported options: · nfs. · cifs. · http. · https. |
|
Media.ServerAddress |
Server address. |
String. |
|
Media.FromPath |
Source path. |
String. Up to 256 characters. |
|
Media.UserName |
Username. |
String. Up to 256 characters. When the sharing type is set to CIFS, this field can take effect. If you set the type of virtual media sharing to CIFS, the username cannot be empty. Only letters, digits, underscores (_), and chinese are allowed. |
|
Media.Password |
Password. |
String. Up to 32 characters. When the sharing type is set to CIFS, this field can take effect. |
|
Media.State |
Virtual media state. |
Supported options: · Enabled. · Disabled. |
|
Media.DomainName |
Domain name. |
String. Up to 255 characters. When the sharing type is set to CIFS, this field can take effect. |
|
Oem.Public.MediaType |
Type of the virtual media mounting. |
String. Supported options: · ALL. |
|
Oem.Public.State |
Virtual media state. |
String. Supported options: · Enabled. · Disabled. |
|
Oem.Public.ShareType |
Share type. |
String. Supported options: · nfs. · cifs. · http. · https. |
|
Oem.Public.ServerAddress |
Server address. |
String. |
|
Oem.Public.FromPath |
Source path. |
String. Up to 256 characters. |
|
Oem.Public.UserName |
Username. |
String. Up to 256 characters. When the sharing type is set to CIFS, this field can take effect, |
|
Oem.Public.DomainName |
Domain name. |
String. Up to 255 characters. When the sharing type is set to CIFS, this field can take effect. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"MediaSupport":true,
"Media": [
{
"MediaType":"CD",
"State":"Enabled",
"ShareType":"cifs",
"ServerAddress":"192.168.44.56",
"FromPath":"/Share1/config/CD",
"UserName":"admin",
"Password":"Password@_",
"DomainName":"www.h3c.com"
},
{
"MediaType":"HD",
"State":"Enabled",
"ShareType":"cifs",
"ServerAddress":"192.168.44.56",
"FromPath":"/Share1/config/HD",
"UserName":"admin",
"Password":"Password@_",
"DomainName":"www.h3c.com"
},
{
"MediaType":"FD",
"State":"Enabled",
"ShareType":"cifs",
"ServerAddress":"192.168.44.56",
"FromPath":"/Share1/config/FD",
"UserName":"admin",
"Password":"Password@_",
"DomainName":"www.h3c.com"
}
] ,
"Oem":{
"Public":{
"MediaType":"ALL",
"State":"Enabled",
"ShareType":"cifs",
"ServerAddress":"192.168.44.56",
"FromPath":"/Share1/config/FD",
"UserName":"admin",
"Password":"Password@_",
"DomainName":"www.h3c.com"
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#VirtualMediaConfig.VirtualMediaConfig",
"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.Config",
"@odata.type": "#VirtualMediaConfig.v1_0_0.VirtualMediaConfig",
"Media": [
{
"DomainName": "www.h3c.com",
"FromPath": "/Share1/config/FD",
"MediaType": "CD",
"ServerAddress": "192.168.44.56",
"ShareType": "cifs",
"State": "Mounting",
"UserName": "admin"
},
{
"DomainName": "www.h3c.com",
"FromPath": "/Share1/config/FD",
"MediaType": "FD",
"ServerAddress": "192.168.44.56",
"ShareType": "cifs",
"State": "Mounting",
"UserName": "admin"
},
{
"DomainName": "www.h3c.com",
"FromPath": "/Share1/config/FD",
"MediaType": "HD",
"ServerAddress": "192.168.44.56",
"ShareType": "cifs",
"State": "Mounting",
"UserName": "admin"
}
],
"MediaSupport": true,
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"DomainName": "www.h3c.com",
"FromPath": "/Share1/config/FD",
"MediaType": "ALL",
"ServerAddress": "192.168.44.56",
"ShareType": "cifs",
"State": "Mounting",
"UserName": "admin"
}
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain virtual media configuration."
Change history
|
Version |
Change description |
|
HDM2-2.12 |
Refreshed the command format example. |
|
HDM2-2.08 |
Added support for http and https in the Media.ShareType and Oem.Public.ShareType fields. |
Connect to virtual media
Description
Connect the server to the virtual media.
Privilege module
OemVmm
Request
Method and URL:
POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Virtualmedia_id/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",
"Oem": {
"Public": {
"MediaIndex": value,
"ImageType": image_type
}
}
}
cifs:
{
"VmmControlType":"Connect",
"Image":"cifs://user:password@IP/img/ERP.iso",
"Oem": {
"Public": {
"MediaIndex": value
}
}
}
https:
{
"VmmControlType":"Connect",
"Image":"https://IP/img/ERP.iso",
"Oem": {
"Public": {
"MediaIndex": value
}
}
}
http:
{
"VmmControlType":"Connect",
"Image":"http://IP/img/ERP.iso",
"Oem": {
"Public": {
"MediaIndex": 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. |
|
Virtualmedia_id |
Type of the virtual media mounting. |
Supported options: · CD. · HD. · FD. |
|
VmmControlType |
Operation on virtual media. |
Supported option is Connect. |
|
Image |
Virtual media URI. |
Supported protocols include: · nfs. · cifs. · http. · https. The image name such as ERP.iso cannot exceed 1024 characters. For information about the field length, see "Configure virtual media settings." |
|
Oem.Public.MediaIndex |
Media index. |
Integer. |
|
Oem.Public.ImageType |
Image type. |
String. |
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.iso",
"Oem": {
"Public": {
"MediaIndex": 1,
"ImageType": "ImageFile"
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/3"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
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:pass123@192.168.190.51/img/image.iso",
"Oem": {
"Public": {
"MediaIndex": 1,
"ImageType": "ImageFile"
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/3"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
# Connect the server to the virtual media through HTTP.
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":"http://192.168.190.51/img/image.iso",
"Oem": {
"Public": {
"MediaIndex": 1,
"ImageType": "ImageFile"
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/3"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
# Connect the server to the virtual media through HTTPS.
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":"https://192.168.190.51/img/image.iso",
"Oem": {
"Public": {
"MediaIndex": 1,
"ImageType": "ImageFile"
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/3"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the task service resource model. |
|
@odata.type |
String |
Type of the task service resource. |
|
Name |
String |
Name of the task collection resource. |
|
Members@odata.count |
Integer |
Number of currently running tasks. |
|
Members |
Task list. |
|
|
@odata.id |
String |
Link to the specified task. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the specified task. |
The server returns status code 202 for a successful operation.
Change history
|
Version |
Change description |
|
HDM3-1.15 |
The Oem.Public.ImageType field in the request body is available only in HDM3 1.15 and later versions and is not available in HDM2. |
|
HDM2-2.08 |
Added support for http and https for connecting to virtual media. |
Disconnect from virtual media
Description
Disconnect the server from the virtual media.
Privilege module
OemVmm
Request
Method and URL:
POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Virtualmedia_id/Oem/Public/Actions/VirtualMedia.VmmControl
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"VmmControlType": value
"Oem": {
"Public": {
"MediaIndex": 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. |
|
Virtualmedia_id |
Mount media type. |
Supported options: · CD. · HD. · FD. |
|
VmmControlType |
Disconnect. |
Disconnect: Disconnect virtual media. |
|
Oem.Public.MediaIndex |
Disconnect which virtual media. |
This field is optional. The value range is 0 to 1. By default, the command disables image with MediaIndex 0. |
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",
"Oem":{
"Public":{
"MediaIndex":1
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the task service resource model. |
|
@odata.type |
String |
Type of the task service resource. |
|
Name |
String |
Name of the task collection resource. |
|
Members@odata.count |
Integer |
Number of currently running tasks. |
|
Members |
Task list. |
|
|
@odata.id |
String |
Link to the specified task. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the specified task. |
The server returns status code 200 for a successful operation.
Stop virtual media mounting
Description
Stop virtual media mounting.
Privilege module
OemVmm
Request
POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/Oem/Public/Actions/VirtualMedia.StopMount
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. |
|
manager_id |
System resource ID. |
This field is 1 for all current models. |
Examples
POST https://192.168.33.66/redfish/v1/Managers/1/VirtualMedia/Oem/Public/Actions/VirtualMedia.StopMount
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code": "Base.1.8.1.Success",
"message": "Successfully Completed Request"
}
}
Response code: 200
Response field description
|
Field |
Format |
Parameters |
|
@Message.ExtendedInfo |
Error message extension information. |
|
|
@odata.type |
String |
OData description information of message resources. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Description |
|
MessageArgs |
Array |
Information arguments. |
|
MessageSeverity |
String |
Severity. Options include OK, Warning, and Critical. |
|
Resolution |
String |
Recommended actions. |
Obtain all operation log collection information
Description
Obtain information about all operation logs from the server.
Privilege module
OemSystemAudit
Request
Method and URL:
GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/OperationLog
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/Oem/Public/OperationLog
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#OperationLogCollection.OperationLogCollection",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/OperationLog",
"@odata.type": "#OperationLogCollection.OperationLogCollection",
"Description": "Collection of entries for this operation log",
"Members": [
{
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/6"
},
{
"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/5"
},
{
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/4"
},
{
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/3"
},
{
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/2"
},
{
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/1"
}
],
"Members@odata.count": 6,
"Name": "Operate Log Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of all operation log collection resource models. |
|
@odata.id |
String |
Link to all operation log collection resource. |
|
@odata.type |
String |
Type of all operation log collection resource. |
|
Name |
String |
Name of all operation log collection resource. |
|
Members@odata.count |
Integer |
Number of all operation log resource. |
|
Members |
List of all operation log resource. |
|
|
@odata.id |
String |
Link to operation log resource node. |
The server returns status code 200 for a successful operation.
Obtain log service collection information
Description
Obtain information about all current log service resources from the server.
Privilege module
Login
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
Method and URL:
GET https://192.168.18.18/redfish/v1/Managers/1/LogServices
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/LogServices/$entity",
"@odata.id": "/redfish/v1/Managers/1/LogServices",
"@odata.type": "#LogServiceCollection.LogServiceCollection",
"Actions": {
"Oem": {
"Public": {
"#LogService.ClearOperationLog": {
"target": "/redfish/v1/Managers/1/LogServices/Actions/Oem/Public/LogService.ClearOperationLog"
},
"#LogService.ExportOperationLog": {
"target": "/redfish/v1/Managers/1/LogServices/Actions/Oem/Public/LogService.ExportOperationLog"
}
}
}
},
"Description": "Collection of LogServices resource",
"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"
}
],
"Members@odata.count": 4,
"Name": "LogServices Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
Integer |
Number of log service resources. |
|
Members |
List of log service resources. |
|
|
@odata.id |
String |
Link to a log service resource. |
|
Actions.Oem.Public.#LogService.ExportOperationLog |
Object |
Link to export operation logs. |
|
Actions.Oem.Public.#LogService.ClearOperationLog |
Object |
Link to clear operation logs. |
The server returns status code 200 for a successful operation.
Obtain log service information
Description
Obtain information about a specific log service resource from the server.
Privilege module
Login
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/ConfigurationLog
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/LogServices/Members/$entity",
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog",
"@odata.type": "#LogService.v1_2_0.LogService",
"DateTime": "2022-02-19T14:59:34+08:00",
"DateTimeLocalOffset": "UTC+08:00",
"Description": "Managers ServiceLog Instance for this Computer System",
"Entries": {
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries"
},
"Id": "ConfigurationLog",
"LogEntryType": "Multiple",
"MaxNumberOfRecords": 1000,
"Name": "ConfigurationLog",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ServiceEnabled": true,
"Status": {
"Health": "OK",
"State": "Enabled"
}
}
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. |
|
MaxNumberOfRecords |
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.
Obtain log entry collection information
Description
Obtain information about all current log entries of a log service from the server.
Privilege module
OemSystemAudit
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/ConfigurationLog/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/ConfigurationLog/Entries",
"@odata.type": "#LogEntryCollection.LogEntryCollection",
"Description": "Collection of entries for this log service",
"Members": [
{
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/6"
},
{
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/4"
},
{
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/3"
},
{
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/2"
},
{
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/1"
}
],
"Members@odata.count": 5,
"Name": "Log Service Entries Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
Integer |
Number of log entry resources. |
|
Members |
List of log entry resources. |
|
|
@odata.id |
String |
Link to a log entry resource. |
The server returns status code 200 for a successful operation.
Obtain log entry information
Description
Obtain information about a specific log entry resource from the server.
Privilege module
OemSystemAudit
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/3
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/LogServices/Log1/Entries/Members/$entity",
"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog/Entries/3",
"@odata.type": "#LogEntry.v1_7_0.LogEntry",
"Created": "2022-02-19T12:11:18+08:00",
"Description": "Instance of entries for this log service",
"EntryType": "Multiple",
"Id": 3,
"Message": "Remote media settings configured successfully. Remote IP: 192.168.17.17, soure path: /Share1, server type: nfs, media type: CD/DVD.",
"Modified": "2022-02-19T12:11:18+08:00",
"Name": "ConfigurationLog",
"Oem": {
"Public": {
"Address": "192.168.17.17",
"CompletionCode": 0,
"Description": "Success",
"Hostname": "HDM",
"Interface": "redfish",
"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. |
|
Message |
String |
Description of the log entry. |
|
Modified |
String |
Modification time. |
|
Id |
Integer |
Log 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.
Export operation log information
Description
Export operation log information from the server.
Privilege module
OemSystemAudit
Request
Method and URL:
POST https://device_ip/redfish/v1/Managers/manager_id/LogServices/Actions/Oem/Public/LogService.ExportOperationLog
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
Local export.
{
"Type":"URI",
"Content": "/tmp/web/dump.tar.gz"
}
Remote export.
Cifs or sftp
{
"Type":"URI",
"Content": "sftp://username:password@10.10.10.191/usr/dump.tar.gz"
}
http, tftp, nfs, or https
{
"Type":"URI",
"Content": "http://ip/filename",
"Oem": {
"Public": {
"ScriptName":"1.php"
}
}
}
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 |
URI. |
String. |
|
Content |
Export path. |
See "Others." |
|
Oem.Public.ScriptName |
Script file name. |
String. This field is required if you use the HTTP or HTTPS to export the file. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/LogServices/Actions/Oem/Public/LogService.ExportOperationLog
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
Local export.
{
"Type":"URI",
"Content": "/tmp/web/OperateLog.csv"
}
Remote export.
{
"Type":"URI",
"Content": "sftp://username:password@10.10.10.191/usr/OperateLog.csv"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Clear operation log information
Description
Clear operation log information from the server.
Privilege module
Login
Request
Method and URL:
POST https://device_ip/redfish/v1/Managers/manager_id/LogServices/Actions/Oem/Public/LogService. ClearOperationLog
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:
POST https://192.168.18.18/redfish/v1/Managers/1/LogServices/Actions/Oem/Public/LogService.ClearOperationLog
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Collect SDS log entry information
Description
Collect and package SDS logs, and place them in the user-specified directory.
Privilege module
OemSystemAudit
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:
{
"StartTime":time,
"EndTime": time,
"Name":name,
"Telephone":phone,
"EmailAddress":address
"Type":"URI",
"Content": content,
"LogType":logtype,
"Oem": {
"Public": {
"ScriptName":"xxxxx"
}
}
}
Content:
// Local export, only supports /mnt/sdmmc0p1/sds/bmc/filename:
/mnt/sdmmc0p1/sds/bmc/dump.tar.gz
// Remote export:
sftp://username:password@ip/usr/dump.tar.gz
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. |
|
StartTime |
SDS log start time. |
String. For example: 2017-04-05. When StartTime and EndTime are in the request body, collect SDS logs for that time period. If both times are absent, collect all SDS logs. |
|
EndTime |
SDS log end time. |
String. |
|
Name |
Name of the contact person. (Not provided externally, for page use only). |
String. |
|
Telephone |
Phone number of the contact person. (Not provided externally, for page use only). |
String. |
|
EmailAddress |
Email address of the contact person. (Not provided externally, for page use only). |
String. |
|
Type |
Export file method. |
URI |
|
Content |
Link to the SDS log collection. |
See "Others." This interface only supports /mnt/sdmmc0p1/sds/bmc/filename, Special characters except commas (,) will be ignored. |
|
LogType |
Download log type. |
String. Supported options: · EventLog. If this parameter is not specified, all logs will be downloaded by default. |
|
Oem.Public.ScriptName |
Script file name. |
String. This field is required if you use HTTP or HTTPS to export the file. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/Manager.Dump
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"StartTime":"2022-04-05",
"EndTime":"2022-04-20",
"Type":"URI",
"Content": "/mnt/sdmmc0p1/sds/bmc/dump.tar.gz"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/1"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"FileName": "dump__20220219T082103-0400.tar.gz",
"TaskUniqueID": 1678656297
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the task service resource model. |
|
@odata.type |
String |
Type of the task service resource. |
|
Name |
String |
Name of the task service resource. |
|
Members@odata.count |
String |
Number of currently running tasks. |
|
Members |
Task list. |
|
|
@odata.id |
String |
Link to the specified task. |
|
Oem.Public.FileName |
String |
Filename. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the specified task. |
Change history
|
Version |
Change description |
|
HDM2-1.54 |
Modified description of the Content field. |
Download BMC file
Description
Use PostMan to display the content of the specified BMC file. Users can download the file using Postman or in combination with the curl command.
As a best practice, for large SDS files, consider using the remote export method.
Privilege module
ConfigureComponents
Request
Method and URL:
POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.GeneralDownload
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"TransferProtocol":value,
"Content":path
}
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 manage resource. |
Only value 1 is supported. |
|
TransferProtocol |
Supported protocols. |
String. Only includes HTTPS. |
|
Content |
File download content. |
String. See "Others." This interface supports file downloads from the following directories: 1. /conf/secure_erase. 2. /tmp/web. 3. /mnt/sdmmc0p1/sds/bmc. 4. /mnt/sdmmc0p4/bsod. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralDownload
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
Local export.
{
"TransferProtocol":"HTTPS",
"Content":"/tmp/web/web.pem"
}
Response:
Display file content.
Response code: 200
Obtain VNC information
Description
Obtain information about the VNC service.
Privilege module
Login
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,
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"Password": null,
"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. |
|
Password |
null |
Password. This field displays null. |
The server returns status code 200 for a successful operation.
Edit VNC settings
Description
Edit settings of the VNC service for the server.
Privilege module
OemKvm
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": 6,
"ComplexityCheck": false,
"Password":"Pass1234"
}
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 VNC service, in minutes. |
Integer. Value range: 5 to 30. |
|
ComplexityCheck |
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 |
Password. |
String. Maximum password length allowed is 8 characters. |
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,
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"Password": null,
"SessionTimeoutMinutes": 10
}
Response code: 200
The server returns status code 200 for a successful operation.
Obtain KVM information
Description
Obtain information about the KVM service.
Privilege module
Login
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",
"@odata.id": "/redfish/v1/Managers/1/KvmService",
"@odata.type": "#KvmService.v1_0_0.KvmService",
"ActivatedSessionsType": "Shared",
"H5ActivatedSessionsType": "Private",
"H5EncryptionEnabled": true,
"MaximumNumberOfSessions": 4,
"NumberOfActivatedSessions": 0,
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"PersistentUSBConnectionEnabled": false,
"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. |
|
ActivatedSessionsType |
String |
KVM (JAVA KVM) session type. Supported options: · Shared. · Private. |
|
H5ActivatedSessionsType |
String |
H5 KVM session type. Supported options: · Shared. · Private. |
|
H5EncryptionEnabled |
Boolean |
HDM2: H5 KVM encryption enabled. HDM3: Reserved field. Whether encryption is enabled depends on KVM settings. |
|
MaximumNumberOfSessions |
Integer |
Maximum number of KVM sessions. |
|
NumberOfActivatedSessions |
Integer |
Number of current KVM sessions. |
|
PersistentUSBConnectionEnabled |
Boolean |
HDM2: Enabling status of continuous connection to the virtual mouse. HDM3: Fixed at the false option. |
|
SessionTimeoutMinutes |
Integer |
Session idle timeout for the KVM service. |
Edit KVM settings
Description
Edit settings of the KVM service for the server.
Privilege module
OemKvm
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,
"ActivatedSessionsType": "Shared",
"H5ActivatedSessionsType": "Private"
}
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. |
|
ActivatedSessionsType |
KVM session type. |
String. Supported options: · Shared. · Private. |
|
H5ActivatedSessionsType |
H5 KVM session type. |
String. Supported options: · Shared. · Private. |
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,
"ActivatedSessionsType": "Shared",
"H5ActivatedSessionsType": "Private"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#KvmService.KvmService",
"@odata.id": "/redfish/v1/Managers/1/KvmService",
"@odata.type": "#KvmService.v1_0_0.KvmService",
"ActivatedSessionsType": "Shared",
"H5ActivatedSessionsType": "Private",
"H5EncryptionEnabled": false,
"MaximumNumberOfSessions": 4,
"NumberOfActivatedSessions": 0,
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"PersistentUSBConnectionEnabled": false,
"SessionTimeoutMinutes":
10
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain KVM information."
Obtain serial port collection information
Description
Obtain information about all serial ports from the server.
Privilege module
Login
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"
}
],
"Members@odata.count": 1,
"Name": "Serial Interface Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
Integer |
Number of serial port resources. |
|
Name |
String |
Name of the serial port collection resource. |
Obtain serial port information
Description
Obtain information about a specific serial port resource from the server.
Privilege module
Login
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.18.18/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_8.SerialInterface",
"BitRate": "115200",
"DataBits": "8",
"Description": "IPMI Serial over LAN",
"FlowControl": "Hardware",
"Id": "IPMI-SOL",
"InterfaceEnabled": true,
"Name": "IPMI-SOL",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"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. |
Obtain LLDP service information
Description
Obtain information about the LLDP service.
Privilege module
Login
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.18.18/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#LldpService.LldpService",
"@odata.id":"/redfish/v1/Managers/1/LldpService",
"@odata.type":"#LldpService.v1_0_0.LldpService",
"Description":"Lldp Service",
"Id":"LldpService",
"LLDP":[
{
"ChassisMac":"N/A",
"ChassisName":"N/A",
"EthIndex":"eth0",
"PortDesc":"N/A",
"PortIfName":"N/A",
"VlanId":4294967295
},
{
"ChassisMac":"N/A",
"ChassisName":"N/A",
"EthIndex":"eth1",
"PortDesc":"N/A",
"PortIfName":"N/A",
"VlanId":4294967295
}
],
"LldpEnabled":true,
"Name":"LldpService",
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
},
"WorkMode":"TxRx"
}
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: · Rx—Receive mode · Tx—Trasmit mode. · TxRx—Transmit and receive mode. |
|
Name |
String |
Name of the LLDP service. |
Change history
|
Version |
Change description |
|
HDM2-1.59 |
· Changed the Rx/Tx option of the WorkMode field to TxRx (compatible with Rx/Tx), and added the Tx option. · Changed the description of the LldpEnabled field from Enabling status of LLDP frame sending to Enabling status of LLDP. |
Edit LLDP service settings
Description
Edit settings of the LLDP service for the server.
Privilege module
ConfigureComponents
Locking type of the associated system
BMC configuration locking
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": true,
"WorkMode": "TxRx"
}
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. |
|
WorkMode |
LLDP operating mode. Supported options: · Rx—Receive mode. · Tx—Trasmit mode. · TxRx—Transmit and receive mode. |
String. |
Examples
Method and URL:
PATCH http://192.168.18.18/redfish/v1/Managers/1/LldpService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"
Request body:
{
.."LldpEnabled": true,
"WorkMode": "TxRx"
}
Response:
{
"@odata.context":"/redfish/v1/$metadata#LldpService.LldpService",
"@odata.id":"/redfish/v1/Managers/1/LldpService",
"@odata.type":"#LldpService.v1_0_0.LldpService",
"Description":"Lldp Service",
"Id":"LldpService",
"LLDP":[
{
"ChassisMac":"N/A",
"ChassisName":"N/A",
"EthIndex":"eth0",
"PortDesc":"N/A",
"PortIfName":"N/A",
"VlanId":4294967295
},
{
"ChassisMac":"N/A",
"ChassisName":"N/A",
"EthIndex":"eth1",
"PortDesc":"N/A",
"PortIfName":"N/A",
"VlanId":4294967295
}
],
"LldpEnabled":true,
"Name":"LldpService",
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
},
"WorkMode":"TxRx"
}
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 |
|
HDM2-1.59 |
Changed the description of the LldpEnabled field from Enabling status of LLDP frame sending to Enabling status of LLDP, and added the WorkMode field. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain wireless information
Description
Obtain information about the wireless resource. This interface is not available for X18000 products. HDM3 does not support this interface.
Privilege module
Login
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":[
],
"DHCPServers":[
{
"DHCPAddrEnd":"192.168.199.254",
"DHCPAddrStart":"192.168.199.2",
"IPAddress":"192.168.199.1",
"Id":0
}
],
"IsSameSegment":false,
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
},
"Ssids":[
{
"ClientMaxNum":2,
"EncryptionMode":"None",
"Id":0,
"Name":"BMC_WIFI_162022",
"Password":""
}
],
"Status":{
"Health":"OK",
"State":"Absent"
},
"USBDeviceEnabled":true,
"WlanChannel":11,
"WlanCurrentState":"Closed",
"WlanEnabled":false,
"WlanTimeout":1
}
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 |
Current state of the wireless service. Supported options: · Open. · Closed. |
|
WlanEnabled |
Boolean |
Enable or disable the wireless service. Supported options: · true. · false. |
|
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. |
|
IsSameSegment |
Boolean |
Wireless same network segment check. |
|
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. |
|
Status.Health |
String |
Wireless health status. |
|
Status.State |
String |
Presence status of the wireless device. Supported options: · Enabled—Present. · Absent—Not present. |
|
USBDeviceEnabled |
Boolean |
Enable status of USB physical interface. |
Change history
|
Version |
Change description |
|
HDM3-1.14 |
HDM3 does not support this interface. |
Edit wireless settings
Description
Edit settings for the wireless service. This interface is not available for X18000 products. HDM3 does not support this interface.
Privilege module
ConfigureComponents
Locking type of the associated system
BMC configuration locking
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": "test",
"Password": "123456789"
}
],
"USBDeviceEnabled": true,
"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. Default name: BMC_WIFI_BMC dedicated network port MAC address last 6 digits. A string of 1 to 31 characters. Supporting only letters, numbers, periods (.), hyphens (-), and underscores (_), case-sensitive. |
|
Ssids.Password |
String |
Password of the wireless service. It is required when the encryption method is encrypted A string of 8 to 63 characters. Supporting only letters, numbers, spaces, and special characters `~!@#\$%^&*()_+-=[]\{}|;':,./<>?, case-sensitive. |
|
USBDeviceEnabled |
Boolean |
USB physical interface enable status. When false is displayed, it means other parameters are not issued. |
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.199.254",
"DHCPAddrStart":"192.168.199.2",
"IPAddress":"192.168.199.1"
}
],
"Ssids":[
{
"EncryptionMode":"None",
"Name":"BMC_WIFI_162022",
"Password":""
}
],
"WlanEnabled":false,
"WlanTimeout":1,
"USBDeviceEnabled":true
}
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.199.254",
"DHCPAddrStart":"192.168.199.2",
"IPAddress":"192.168.199.1",
"Id":0
}
],
"IsSameSegment":false,
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
},
"Ssids":[
{
"ClientMaxNum":2,
"EncryptionMode":"None",
"Id":0,
"Name":"BMC_WIFI_162022",
"Password":""
}
],
"Status":{
"Health":"OK",
"State":"Absent"
},
"USBDeviceEnabled":true,
"WlanChannel":11,
"WlanCurrentState":"Closed",
"WlanEnabled":false,
"WlanTimeout":1
}
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 |
|
HDM3-1.14 |
HDM3 does not support this interface. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Import the BIOS, BMC, and RAID controller settings
Description
Import the BIOS, BMC, and RAID controller settings.
Privilege module
ConfigureUsers
Locking type of the associated system
BIOS configuration lock (when importing BIOS configuration), BMC configuration lock (when importing BMC configuration), hardware configuration lock (when importing RAID configuration)
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:
· Local import:
Use this interface after transferring the file to the /tmp/web/ directory. For more information, see "Upload BMC file."
{
"Type":"URI",
"Content": "/tmp/web/filename",
"Oem": {
"Public": {
"ConfigType":type
}
}
}
· Remote import:
¡ CIFS or SFTP:
{
"Type":"URI",
"Content":"cifs://username:password@ip/filename",
"Oem": {
"Public": {
"ConfigType":type
}
}
}
¡ HTTP, TFTP, NFS, or HTTPS:
{
"Type":"URI",
"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. |
See "Others." |
|
Oem.Public.ConfigType |
Type of the configuration. |
· BMC. · 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#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the import TaskService. |
|
@odata.type |
String |
Type of the import TaskService. |
|
Members@odata.id |
String |
Link to the import TaskService. |
|
Oem.Public.TaskUniqueID |
String |
Unique ID of the import TaskService. |
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Export the BIOS, BMC, and RAID controller settings
Description
Export the BIOS, BMC, and RAID controller settings.
Privilege module
ConfigureUsers
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:
Local import:
{
"Type":"URI",
"Content": "/tmp/web/filename",
"Oem": {
"Public": {
"ConfigType":type,
"ExportPasswordEnabled":true
}
}
}
Remote import
cifs or sftp:
{
"Type":"URI",
"Content":"cifs://username:password@ip/filename",
"Oem": {
"Public": {
"ConfigType":type,
"ExportPasswordEnabled":true
}
}
http, tftp, nfs, or https:
{
"Type":"URI",
"Content":"http://ip/filename",
"Oem": {
"Public": {
"ConfigType":type,
"ScriptName":"1.php",
"ExportPasswordEnabled":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. |
|
Type |
Method to export the configuration file. |
URI. |
|
Content |
Destination configuration file path. |
See "Others." |
|
Oem.Public.ConfigType |
Type of the configuration. |
· HDM. · BIOS. · RAID. |
|
Oem.Public.ScriptName |
Script file name. |
String. This field is required if you use HTTP or HTTPS to export the configuration file. |
|
Oem.Public.ExportPasswordEnabled |
Whether to export the local user passwords. |
Boolean. |
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#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the exported TaskService. |
|
@odata.type |
String |
Type of the exported TaskService. |
|
Members@odata.id |
String |
Link to the generated Task. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID for the exported TaskService. |
Change history
|
Version |
Change description |
|
HDM2-2.04 HDM3-2.03 |
Added the Oem.Public.ExportPasswordEnabled field. |
Obtain trusted password module status configuration
Description
Obtain information about TPM/TCM configuration.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/TrustedModuleConfiguration
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/Oem/Public/TrustedModuleConfiguration
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#TrustedModuleConfiguration.TrustedModuleConfiguration",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/TrustedModuleConfiguration",
"@odata.type": "#TrustedModuleConfiguration.v1_0_0.TrustedModuleConfiguration",
"Description": "Get trusted module configuration.",
"Id": "TrustedModule Configuration",
"Name": "TrustedModule Configuration",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"State": "NotSupported",
"Type": null
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the trusted password module resource model. |
|
@odata.id |
String |
Link to the trusted password module resource. |
|
@odata.type |
String |
Type of the trusted password module resource. |
|
Type |
String |
Name of the trusted password module. Supported options: · TPM. · TCM. |
|
State |
String |
State of the trusted password module. Supported options: · Enabled. · Disabled. · Absent. · NotSupported. |
Obtain firewall configuration information
Description
Obtain firewall configuration information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/FirewallRules
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/FirewallRules
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#FirewallRules.FirewallRules",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/FirewallRules",
"@odata.type": "#FirewallRules.v1_0_0.FirewallRules",
"Actions": {
"#Firewall.AddRules": {
"target":
"redfish/v1/Managers/manager_id/Actions/Oem/Public/Firewall.AddRules"
},
"#Firewall.DeleteRules": {
"target":
"redfish/v1/Managers/manager_id/Actions/Oem/Public/Firewall.DeleteRules"
}
},
"BlacklistRules": [
{
"EndDateTime": "2019-02-15T20:21:36+08:00",
"EndIPAddress": "10.33.255.255",
"EndPort":6567,
"MACAddress": "C4:36:6B:3E:7C:2B",
"MemberId": "1",
"StartDateTime": "2019-02-14T20:21:36+08:00",
"StartIPAddress": "10.33.40.0",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
},
{
"EndDateTime": "2019-02-15T20:21:36+08:00",
"EndIPAddress": "10.99.255.255",
"EndPort":6567,
"MACAddress": "C4:36:6B:3E:7A:2B",
"MemberId": "2",
"StartDateTime": "2019-02-14T20:21:36+08:00",
"StartIPAddress": "10.99.40.0",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
},
{
"EndDateTime": null,
"EndIPAddress": "11.99.255.255",
"EndPort":6567,
"MACAddress": "C6:36:6B:3E:7A:2B",
"MemberId": "3",
"StartDateTime": null,
"StartIPAddress": "10.99.40.0",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
}
],
"BlacklistRules@odata.count": 3,
"Name": "FirewallConfig Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"WhitelistRules": [
{
"EndDateTime": null,
"EndIPAddress": "192.168.30.255",
"EndPort":6567,
"MACAddress": "C6:36:6B:3E:7A:2B",
"MemberId": "1",
"StartDateTime": null,
"StartIPAddress": "192.168.30.40",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
},
{
"EndDateTime": "2019-02-15T20:21:36+08:00",
"EndIPAddress": "192.168.30.255",
"EndPort":6567,
"MACAddress": "C6:36:6B:3E:7A:2B",
"MemberId": "2",
"StartDateTime": "2019-02-14T20:21:36+08:00",
"StartIPAddress": "192.168.30.40",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
}
],
"WhitelistRules@odata.count": 2
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the specified role resource model. |
|
@odata.id |
String |
Link to the specified role resource. |
|
@odata.type |
String |
Type of the specified role resource. |
|
BlacklistRules |
Object or array |
List of members on the blacklist. |
|
WhitelistRules |
Object or array |
List of members on the whitelist. |
|
MemberId |
String |
ID of the rule. |
|
StartIPAddress |
Boolean |
Starting IP address for this rule. |
|
EndIPAddress |
String |
Ending IP address for this rule. |
|
MACAddress |
String |
MAC address. |
|
StartDateTime |
String |
Start time of the rule. |
|
EndDateTime |
String |
End time of the rule. |
|
EndPort |
Integer |
Ending port number for this rule. Null indicates this field is not set. |
|
StartPort |
Integer |
Starting port number for this rule. Null indicates this field is not set. |
|
Protocol |
Array |
Supported protocols for this rule. Supported options: · TCP · UDP |
The server returns status code 200 for a successful operation.
Add firewall rule settings
Description
Add firewall configuration rule settings.
Privilege module
OemSecurityMgmt
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Firewall.AddRules
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"BlacklistRules": [
{
"EndDateTime": "2019-02-15T20:21:36+08:00",
"EndIPAddress": "10.33.255.255",
"EndPort":6567,
"MACAddress": "C4:36:6B:3E:7C:2B",
"StartDateTime": "2019-02-14T20:21:36+08:00",
"StartIPAddress": "10.33.40.0",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
},
...
],
"WhitelistRules": [
{
"EndDateTime": "2019-02-15T20:21:36+08:00",
"EndIPAddress": "192.168.30.255",
"EndPort":6567,
"MACAddress": "C6:36:6B:3E:7A:2B",
"StartDateTime": "2019-02-14T20:21:36+08:00",
"StartIPAddress": "192.168.30.40",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
},
...
]
}
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. |
|
BlacklistRules |
List of members on the blacklist. |
Object or array. |
|
WhitelistRules |
List of members on the whitelist. |
Object or array. |
|
StartIPAddress |
Starting IP address for this rule. |
Boolean. |
|
EndIPAddress |
Ending IP address for this rule. |
String. |
|
MACAddress |
MAC address. |
String. |
|
StartDateTime |
Starting port number for this rule. Null indicates this field is not set. |
String. |
|
EndDateTime |
Ending port number for this rule. Null indicates this field is not set. |
String. |
|
EndPort |
Rule end port number. |
Integer. 1 to 65535. Null indicates this field is not set. |
|
StartPort |
Rule start port number. |
Integer. 1 to 65535. Null indicates this field is not set. |
|
Protocol |
Supported protocols for this rule. |
Array. Supported options: · TCP · UDP |
Examples
Method and URL:
POST https://192.168.77.77/redfish/v1/Managers/1/Actions/Oem/Public/Firewall.AddRules
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"BlacklistRules": [
{
"EndDateTime": "2019-02-15T21:21:36+08:00",
"EndIPAddress": "10.33.255.255",
"EndPort":6567,
"MACAddress": "C4:36:6B:3E:7C:2B",
"StartDateTime": "2019-02-14T20:21:36+08:00",
"StartIPAddress": "10.33.40.0",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
},
...
],
"WhitelistRules": [
{
"EndDateTime": "2019-02-15T21:21:36+08:00",
"EndIPAddress": "192.168.30.255",
"EndPort":6567,
"MACAddress": "C6:36:6B:3E:7A:2B",
"StartDateTime": "2019-02-14T20:21:36+08:00",
"StartIPAddress": "192.168.30.40",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
},
...
]
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Edit firewall rule settings
Description
Edit firewall rule settings.
Privilege module
OemSecurityMgmt
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public//FirewallRules
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"BlacklistRules": [
{
"EndDateTime": "2019-02-15T20:21:36+08:00",
"EndIPAddress": "10.33.255.255",
"EndPort":6567,
"MACAddress": "C4:36:6B:3E:7C:2B",
"MemberId": "1",
"StartDateTime": "2019-02-14T20:21:36+08:00",
"StartIPAddress": "10.33.40.0",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
},
...
],
"WhitelistRules": [
{
"EndDateTime": "2019-02-15T20:21:36+08:00",
"EndIPAddress": "192.168.30.255",
"EndPort":6567,
"MACAddress": "C6:36:6B:3E:7A:2B",
"MemberId": "1",
"StartDateTime": "2019-02-14T20:21:36+08:00",
"StartIPAddress": "192.168.30.40",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
},
...
]
}
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. |
|
BlacklistRules |
List of members on the blacklist. |
Object or array. |
|
WhitelistRules |
List of members on the whitelist. |
Object or array. |
|
MemberId |
ID of the rule. |
String. |
|
StartIPAddress |
Starting IP address for this rule. |
Boolean. |
|
EndIPAddress |
Ending IP address for this rule. |
String. |
|
MACAddress |
MAC address. |
String. |
|
StartDateTime |
Starting port number for this rule. Null indicates this field is not set. |
String. |
|
EndDateTime |
Ending port number for this rule. Null indicates this field is not set. |
String. |
|
EndPort |
Rule end port number. |
Integer. 1 to 65535. Null indicates this field is not set. |
|
StartPort |
Rule start port number. |
Integer. 1 to 65535. Null indicates this field is not set. |
|
Protocol |
Supported protocols for this rule. |
Array. Supported options: · TCP · UDP |
Examples
Method and URL:
PATCH https://192.168.77.77/redfish/v1/Managers/1/Oem/Public/FirewallRules
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"BlacklistRules": [
{
"EndDateTime": "2022-04-27T20:21:36+08:00",
"EndIPAddress": "10.33.255.255",
"EndPort":6568,
"MACAddress": "C4:36:6B:3E:7C:2B",
"MemberId": "1",
"StartDateTime": "2022-03-26T12:39:36+08:00",
"StartIPAddress": "10.33.255.253",
"StartPort": 5678,
"Protocol": ["UDP","TCP"]
}
],
"WhitelistRules": [
{
"EndDateTime": "2022-04-27T20:21:36+08:00",
"EndIPAddress": "192.168.30.255",
"EndPort":6567,
"MACAddress": "C6:36:6B:3E:7A:2B",
"MemberId": "1",
"StartDateTime": "2022-03-26T12:39:36+08:00",
"StartIPAddress": "192.168.30.40",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
}
]
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#FirewallRules.FirewallRules",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Manager.FirewallRules",
"@odata.type": "#FirewallRules.v1_0_0.FirewallRules",
"BlacklistRules": [
{
"EndDateTime": "2022-04-27T20:21:36+08:00",
"EndIPAddress": "10.33.255.255",
"EndPort":6568,
"MACAddress": "C4:36:6B:3E:7C:2B",
"MemberId": "1",
"StartDateTime": "2022-03-26T12:39:36+08:00",
"StartIPAddress": "10.33.255.253",
"StartPort": 5678,
"Protocol": ["UDP","TCP"]
},
{
"EndDateTime": "2019-02-15T20:21:36+08:00",
"EndIPAddress": "10.99.255.255",
"EndPort":6567,
"MACAddress": "C4:36:6B:3E:7A:2B",
"MemberId": "2",
"StartDateTime": "2019-02-14T20:21:36+08:00",
"StartIPAddress": "10.99.40.0",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
},
{
"EndDateTime": null,
"EndIPAddress": "11.99.255.255",
"EndPort":6567,
"MACAddress": "C6:36:6B:3E:7A:2B",
"MemberId": "3",
"StartDateTime": null,
"StartIPAddress": "11.99.40.0",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
}
],
"BlacklistRules@odata.count": 3,
"Name": "FirewallConfig Collection",
"Oem": {
"CompletionCode": 0,
"Description": "Success"
},
"WhitelistRules": [
{
"EndDateTime": "2022-04-27T20:21:36+08:00",
"EndIPAddress": "192.168.30.255",
"EndPort":6567,
"MACAddress": "C6:36:6B:3E:7A:2B",
"MemberId": "1",
"StartDateTime": "2022-03-26T12:39:36+08:00",
"StartIPAddress": "192.168.30.40",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
},
{
"EndDateTime": "2019-02-15T20:21:36+08:00",
"EndIPAddress": "192.168.30.255",
"EndPort":6567,
"MACAddress": "C6:36:6B:3E:7A:2B",
"MemberId": "2",
"StartDateTime": "2019-02-14T20:21:36+08:00",
"StartIPAddress": "192.168.30.40",
"StartPort": 5677,
"Protocol": ["UDP","TCP"]
}
],
"WhitelistRules@odata.count": 2
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain firewall configuration information."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Delete firewall configuration rule
Description
Delete firewall configuration rule.
Privilege module
OemSecurityMgmt
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/Managers/manager_id/ Actions/Oem/Public/Firewall.DeleteRules
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"BlacklistRules": [
{
"MemberId": "1",
},
{
"MemberId": "2",
}
……
],
"WhitelistRules": [
{
"MemberId": "1",
},
{
"MemberId": "2",
}
……
],
}
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. |
|
BlacklistRules |
Object or array |
List of members on the blacklist. |
|
WhitelistRules |
Object or array |
List of members on the whitelist. |
|
MemberId |
String |
ID of the rule. |
Examples
Method and URL:
POST https://192.168.77.77/redfish/v1/Managers/1/Actions/Oem/Public/Firewall.DeleteRules
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"BlacklistRules":[
{
"MemberId":"1"
},
{
"MemberId":"2"
}
],
"WhitelistRules":[
{
"MemberId":"1"
},
{
"MemberId":"2"
}
]
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain server security service information
Description
Obtain server security service information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Managers/manager_id/SecurityService
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/SecurityService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SecurityService/$entity",
"@odata.id": "/redfish/v1/Managers/1/SecurityService",
"@odata.type": "#SecurityService.v1_0_0.SecurityService",
"Actions": {
"#HttpsCert.GenerateCSR": {
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/HttpsCert/GenerateCSRActionInfo",
"target": "/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR"
}
},
"Description": "Security Service",
"Id": "SecurityService",
"Links": {
"HttpsCert": {
"@odata.id": "/redfish/v1/Managers/1/SecurityService/HttpsCert"
}
},
"Name": "Security Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"PublicKeyExponent": "010001",
"PublicKeyModulus": "EBAD25A6352D93B7DC9273DDE0C0CB92694E00BCCCE7648F508F21E9A276446E183B9A4F13B95566B7318AD046A4C350B2B5CEB0566733A75A340A040D924EA70FADE5C44D0B1B48F729997A24EDD5D148DF50A49AA98037B00CF353FF3F25D4BFF132A86205D95F1063A050706F3FA7823857250EAD57F0F8725274E376CE7D",
"RSAIndex": 1
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the security service resource model. |
|
@odata.id |
String |
Link to the security service information node. |
|
@odata.type |
String |
Type of the security service information. |
|
Description |
String |
Description of the security service resource. |
|
Id |
String |
ID of the security service information. |
|
Name |
String |
Name of the security service information. |
|
Links.HttpsCert |
Object |
Link to the SSL certificate service. |
|
Actions.#HttpsCert.GenerateCSR |
Object |
Information resource of the generate SSL certificate. |
|
Oem.Public.RSAIndex |
Integer |
RSA index corresponding to user login, ranging from 1 to 40, needs to be set in the request header. |
|
Oem.Public.PublicKeyExponent |
String |
RSA public key exponent e. |
|
Oem.Public.PublicKeyModulus |
String |
RSA public key modulus n. |
The server returns status code 200 for a successful operation.
View SSL certificate resource information
Description
Obtain SSL certificate resource information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert
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/SecurityService/HttpsCert
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"#HttpsCert.ImportServerCertificate": {
"#HttpsCert.GenerateCSR": {
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/HttpsCert/ImportServerCertificateActionInfo",
"target": "/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate"
}
},
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/SecurityService/HttpsCert/$entity",
"@odata.id": "/redfish/v1/Managers/1/SecurityService/HttpsCert",
"@odata.type": "#HttpsCert.v1_0_0.HttpsCert",
"Actions": {
"#HttpsCert.GenerateCSR": {
"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SecurityService/HttpsCert/GenerateCSRActionInfo",
"target": "/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR"
}
},
"CertificateSigningRequest": null,
"Id": "HttpsCert",
"Name": "Https cert info",
"Oem": {
"Public": {
"CompletionCode": 0,
"CurrentHttpsCert": {
"DateOfCertificate": "2023-03-31T18:43:04+08:00",
"DateOfPrivateKey": "2023-03-31T18:43:04+08:00"
},
"Description": "Success"
}
},
"Version": "3",
"X509CertificateInformation": {
"ServerCert": {
"CertificateString": null,
"CertificateType": null,
"Issuer": {
"City": "Hangzhou",
"CommonName": "H3C",
"Country": "CN",
"Organization": "New H3C Technologies Co.,Ltd",
"OrganizationalUnit": "Compute and Storage Product Line",
"State": "Zhejiang"
},
"IssuerAddress": "service@h3c.com",
"KeyUsage": "Digital Signature, Non Repudiation, Key Encipherment",
"PublicKey": "",
"PublicKeyLengthBits": 2048,
"SerialNumber": "4FF5D2D1B5A683DE8616801FAE92BA0D888DA5F9",
"SignatureAlgorithm": "sha256WithRSAEncryption",
"Subject": {
"City": "Hangzhou",
"CommonName": "H3C",
"Country": "CN",
"Organization": "New H3C Technologies Co.,Ltd",
"OrganizationalUnit": "Compute and Storage Product Line",
"State": "Zhejiang"
},
"SubjectAddress": "service@h3c.com",
"ValidNotAfter": "2036-04-26T09:49:41+08:00",
"ValidNotBefore": "2021-04-30T09:49:41+08:00"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the SSL certificate resource. |
|
@odata.id |
String |
Link to the SSL certificate resource. |
|
@odata.type |
String |
Type of the SSL certificate resource. |
|
Description |
Integer |
Description of the SSL certificate resource. |
|
Id |
String |
ID of the SSL certificate resource. |
|
Name |
String |
Name of the SSL certificate resource. |
|
DateOfCertificate |
String |
Current certificate of the SSL resource. |
|
DateOfPrivateKey |
String |
Current private key. |
|
Version |
String |
Version. |
|
CertificateString |
String |
Certificate content; this field is not supported. |
|
CertificateType |
String |
Certificate type; this field is not supported. |
|
IssuerAddress |
String |
Issuer email address. |
|
KeyUsage |
String |
Certificate purpose. |
|
PublicKey |
String |
Public key. |
|
PublicKeyLengthBits |
String |
Public key length. |
|
SerialNumber |
String |
Serial number. |
|
SignatureAlgorithm |
String |
Signature algorithm. |
|
Issuer |
Object |
Certificate issuer. |
|
Subject |
Object |
Certificate recipient. |
|
City |
String |
City or region. |
|
CommonName |
String |
Common name. |
|
Country |
String |
Country. |
|
Organization |
String |
Organization. |
|
OrganizationalUnit |
String |
Organizational unit. |
|
State |
String |
Province (state). |
|
SubjectAddress |
String |
Recipient email address. |
|
ValidNotAfter |
String |
Certificate effective date. |
|
ValidNotBefore |
String |
Certificate expiration date. |
The server returns status code 200 for a successful operation.
Generate SSL certificate
Description
Generate CSR for SSL certificate.
Privilege module
OemSecurityMgmt
Request
Method and URL:
POST https://device_ip/redfish/v1/Managers/manager_id/OSecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Country":"CN",
"CommonName":"iBMC",
"City":"Shenzhen",
"State":"Guangdong",
"OrgName":"h3c",
"OrgUnit":"IT",
"EmailAddress":"h3c@123.com",
"PublicKeyLengthBits":1024,
"ValidityDays":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. |
|
Country |
Country. |
String. Only allows issuing two characters. |
|
CommonName |
Common name. |
String. Up to 64 characters. |
|
City |
City or region. |
String. Up to 128 characters. |
|
State |
Province (state).. |
String. Up to 128 characters. |
|
OrgName |
Organizational. |
String. Up to 64 characters. |
|
OrgUnit |
Organizational unit. |
String. Up to 128 characters. |
|
EmailAddress |
Email address. |
String. Up to 128 characters. |
|
PublicKeyLengthBits |
Key length. |
Integer. Only supports 1024 and 2048. |
|
ValidityDays |
Valid days. |
Integer. The value range is 1 to 5475. |
Examples
Method and URL:
POST https://192.168.188.188/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HttpsCert.GenerateCSR
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Country":"CN",
"CommonName":"iBMC",
"City":"Shenzhen",
"State":"Guangdong",
"OrgName":"h3c",
"OrgUnit":"IT",
"EmailAddress":"h3c@123.com",
"PublicKeyLengthBits":1024,
"ValidityDays":30
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Import SSL certificate
Description
Import SSL certificate.
Privilege module
OemSecurityMgmt
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/Managers/manager_id/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
· Local import:
Use this interface after transferring the file to the /tmp/web/ directory. For more information, see "Upload BMC file."
{
"Certificate": "/tmp/web/server.pem",
"Privatekey": "/tmp/web/privkey.pem"
}
· Remote import
¡ CIFS or SFTP:
{
"Certificate": "sftp://username:password@192.168.170.57/server.pem",
"Privatekey": "sftp://username:password@192.168.170.57/privkey.pem"
}
¡ http, tftp, nfs, or https:
{
"Certificate": "tftp://192.168.170.57/server.pem",
"Privatekey": "tftp://192.168.170.57/privkey.pem"
}
Upload text content directly:
{
"Certificate":"-----BEGIN CERTIFICATE----- \nMIIDrzCCApegAwIBAgIUC9Bj/YPQNv0SjljzLuEQVVPj83EwDQYJKoZIhvcNAQEL \nBQAwZzELMAkGA1UEBhMCY2QxDDAKBgNVBAgMA2ZkZjEMMAoGA1UEBwwDZmRmMQ4w \nDAYDVQQKDAVkZmRmZDELMAkGA1UECwwCZmQxCzAJBgNVBAMMAmZkMRIwEAYJKoZI \nhvcNAQkBFgNmZGYwHhcNMjIwMTA1MDMyMzAxWhcNMjMwMTA1MDMyMzAxWjBnMQsw \nCQYDVQQGEwJjZDEMMAoGA1UECAwDZmRmMQwwCgYDVQQHDANmZGYxDjAMBgNVBAoM \nBWRmZGZkMQswCQYDVQQLDAJmZDELMAkGA1UEAwwCZmQxEjAQBgkqhkiG9w0BCQEW \nA2ZkZjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOkN3vbmceJ1MCdt \nEW3/V8x0Rxc/L4iYFLP2fNZmn4ANrEEyQ0AIuIbCUml1ehK02wREN36cdmoz5xKD \n7swLxNNDHoJr4jASAma4IFX77M7Ro9uFOxOBHdSvY7fuTPRXCC+V0ttU3NQg9XbG \nUvB6ZtV+YEX7x6XD0SAgHPWgesHcxpfwkaBimZ83NaU/Jdjv+fEDk8LqoFeX4OQT \n5Fpz19dqgyAkoxc7LBOAN1UEipIgIQ4v2zsjcF9+7EQevso6oDKPgllZoOQ5SR9o \neHJ1PFTbuz0EzMICfsLL0yZ8gjW/tjjszxAlntpIc9JIhefnmBX7yAo16AtNdb1V \n7DanjlsCAwEAAaNTMFEwHQYDVR0OBBYEFKNIPyVAN+J2fkQX9bFuYtUZQ9Q1MB8G \nA1UdIwQYMBaAFKNIPyVAN+J2fkQX9bFuYtUZQ9Q1MA8GA1UdEwEB/wQFMAMBAf8w \nDQYJKoZIhvcNAQELBQADggEBAC3BIyK5DLzN7f33dw7C0RDFeV/L+bUc4qJXH4Le \npYJmLY2zWKOC4BSuhoJy6f+EfgbI+nOPcISSxzJM/2nr5XsWslyXLon+dO4D8QlZ \nDuaNjgERCCcy99xwiR6JPkQheF5Fs5EF8sLj2BEAFYf3dArXkugRg0jqTA6Q7ZUG \ngQUCH4fHyBd7LyB9XRUp7TXhYh0M3m3JJ4vqWli7KiQMTc9lWOfB1Kp3TxsmFKXw \noUiAb44TSeJBuPv41sc5PXsGnPu0REM2qSsWccstUAXeI1aw/2aWY+a05yDPIOke \nAHR7hdjLURsNAjCCUh/IHv6R4uy1koOt0wrLen3+UT9w1dg= \n-----END CERTIFICATE-----\n",
"Privatekey":"-----BEGIN PRIVATE KEY----- \nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDpDd725nHidTAn \nbRFt/1fMdEcXPy+ImBSz9nzWZp+ADaxBMkNACLiGwlJpdXoStNsERDd+nHZqM+cS \ng+7MC8TTQx6Ca+IwEgJmuCBV++zO0aPbhTsTgR3Ur2O37kz0VwgvldLbVNzUIPV2 \nxlLwembVfmBF+8elw9EgIBz1oHrB3MaX8JGgYpmfNzWlPyXY7/nxA5PC6qBXl+Dk \nE+Rac9fXaoMgJKMXOywTgDdVBIqSICEOL9s7I3BffuxEHr7KOqAyj4JZWaDkOUkf \naHhydTxU27s9BMzCAn7Cy9MmfII1v7Y47M8QJZ7aSHPSSIXn55gV+8gKNegLTXW9 \nVew2p45bAgMBAAECggEALQ8Yf8YYWL9tmwHUb98Bm68Tm6QEzbURs6XBhzZ6Oijq \nmAReyj+lZbCmfGtROdKr0cxaqmkX3/q+/25wuhTAblQ4zuCK795bhn6tCdLWezo/ \nIw9EV8YL/XYXopU5XbiCBalDBlMHCyCANQGtQX946GgxtvYyKJOOmFZ9IuRvN5HY \ncz/elp8kdRi3hS/xEeiq8g8wKFXb74v39s9ZQlDSvUDMg2dY9O6h/5SWC+blKphN \n86eMyW8N8IViF3l3YqyeKhekhfcsK+SWjVQmm04gp925p1wr+BqDjlXBs8vYBZ20 \nOe09Kv7LDSskweZk77dnxSv/9jTiommEphGEImtLQQKBgQD9j5rd/GTJ01HKYQY7 \nWVx8bNg14njxnZ/ChLZguhTRDLkTMcLI5QmiOlMNrm/U1A0TfuhQD59T/FeF9Mf9 \nuZBeluGuCe4HcWfbp4q9mEZEeaq0xt/CImoVWRb04mErjg7gvijJMxkQhbQo6hnS \ns0Lt2ze5zNGC47KW0InA115buwKBgQDrS8SaRm8XfohzIKzCInFZYKYUPoMDAfoR \nbS2hVSGbPxNEkfQZWM+Xvn7vK+0J68kjGPonpbXyFutNPXe1hqdzhFPZpuNNlSYc \nt0+9fV+ZXTGuc+0CngJ81OaMVEdi1BqVMvkOM+zlXksTgf1ONJ25rHTLTRLBaymr \nMR9x0tJd4QKBgHdqd4ROhuUqed23PikbV9xdoqIWC+G223PP7ti1KnKd7Ffm2pak \nj5nwoAbUfWSdjZ796Mkz4lS6hjnXY4zSJPT3WEgP8yNcPI6NZGEQYx+CsWu8McuL \nS6zMLWydZSgPGmCsDidbwlUusv+F6S17MW02DhOaK53aQNSYWBgTFiRbAoGBAMt9 \nXWwm2dCxx4P5kC7c5rZrVXZQkbE6NnB3wWyzWTsQE7PLnhWFrxMG1nQ1wuw/lFXc \nNguvzmit1ZWZQTwmVg8bNAEZyZ7BDJLtHfM8yD60UFEVRLZsvK4E2dYm1Q3tbYf2 \n61mTIp9DKx6V3uGRs45uTRu9bikEaqb49r7TmsdBAoGBAK0bRD8BdrsFKlpsTAW4 \nYCrLTlSQtQ4ggjOVKqh5kaorhpPS8MBXLMYgvdunYcRu9MafIQn8YmClZrvUHula \nNckI0KcibnguWxQ3KFuFTbrYz60HRwNsVMKT4XcQUbfO/WUfOY2T2Q+pmrmQlb6B \nf0O0j3Q0L1ZrLGuinUBj8XvW \n-----END PRIVATE KEY-----\n"
}
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. |
|
Certificate |
Server certificate file or certificate chain file. |
String. |
|
Privatekey |
Private key certificate file or certificate chain file. |
String. |
Examples
Method and URL:
POST https://192.168.188.188/redfish/v1/Managers/1/SecurityService/HttpsCert/Actions/HttpsCert.ImportServerCertificate
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Certificate": "/tmp/web/server.pem",
"Privatekey": "/tmp/web/privkey.pem"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/3"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the TaskService resource when importing SSL certificate. |
|
@odata.id |
String |
Link to the TaskService resource when importing SSL certificate. |
|
@odata.type |
String |
Type of the TaskService resource when importing SSL certificate. |
|
Members@odata.id |
String |
Task link generated during SSL certificate import. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of TaskService resource for importing SSL certificate. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain login security information feature
Description
Obtain login security information feature details.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/LoginSecurityInformation
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/Oem/Public/LoginSecurityInformation
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#LoginSecurityInformation.LoginSecurityInformation",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/LoginSecurityInformation",
"@odata.type": "#LoginSecurityInformation.v1_0_0.LoginSecurityInformation",
"Name": "LoginSecurity Information",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SecurityEnabled": false,
"SecurityInformation": ""
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the specified role resource model. |
|
@odata.id |
String |
Link to the specified role resource model. |
|
@odata.type |
String |
Type of the specified role resource model. |
|
SecurityEnabled |
Boolean |
Enable status. Supported options: · false. · true. |
|
SecurityInformation |
String |
Content of login security information. |
The server returns status code 200 for a successful operation.
Set login security information feature
Description
Set login security information feature details.
Privilege module
OemSecurityMgmt
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public//LoginSecurityInformation
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"SecurityEnabled": security_enabled,
"SecurityInformation": security_infomation
}
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:
PATCH
https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/LoginSecurityInformation
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"SecurityEnabled": true,
"SecurityInformation": "G6 6900"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#LoginSecurityInformation.LoginSecurityInformation",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/LoginSecurityInformation",
"@odata.type": "#LoginSecurityInformation.v1_0_0.LoginSecurityInformation",
"Name": "LoginSecurity Information",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SecurityEnabled": true,
"SecurityInformation": "G6 6900"
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain login security information feature."
Obtain platform firmware resilience configuration
Description
Obtain the Platform Firmware Resilience (PFR) configuration.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/PFRSettings
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/Oem/Public/PFRSettings
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#PFRFirmwareProtect.PFRFirmwareProtect",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/PFRSettings",
"@odata.type": "#PFRFirmwareProtect.v1_0_0.PFRFirmwareProtect",
"BootFromSubareaEnabled": false,
"CPLDState": "Absent",
"Enabled": true,
"FirmwareStatus": "normal",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the specified role resource model. |
|
@odata.id |
String |
Link to the specified role resource. |
|
@odata.type |
String |
Type of the specified role resource. |
|
CPLDState |
String |
PRFCPLD statue. |
|
Enabled |
Boolean |
Status of PFR firmware protection feature switch. |
|
BootFromSubareaEnabled |
Boolean |
Whether to boot from backup partition if verification fails. |
|
FirmwareStatus |
String |
Display the firmware verification status for the current boot. If PFR firmware protection is disabled, it displays N/A. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.61 |
Added the CPLDState field. |
Configure platform firmware resilience settings
Description
Configure the Platform Firmware Resilience (PFR) settings.
Privilege module
OemSecurityMgmt
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/PFRSettings
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"BootFromSubareaEnabled":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. |
|
BootFromSubareaEnabled |
Check if it is enabled from the backup area after verification fails. |
Boolean. |
Examples
Method and URL:
PATCH
https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/PFRSettings
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"BootFromSubareaEnabled": true
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#PFRFirmwareProtect.PFRFirmwareProtect",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/PFRSettings",
"@odata.type": "#PFRFirmwareProtect.v1_0_0.PFRFirmwareProtect",
"BootFromSubareaEnabled": true,
"CPLDState": "Absent",
"Enabled": true,
"FirmwareStatus": "normal",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain platform firmware resilience configuration."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain serial port redirection settings
Description
Obtain serial port redirection settings. This interface is not available for X18000 products.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/SOLMode
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/Oem/Public/SOLMode
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#SOLMode.SOLMode",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/SOLMode",
"@odata.type": "#SOLMode.v1_0_0.SOLMode",
"BitRate": "115200",
"ConnectType": "BIOS",
"Name": "Serial Over Lan Mode",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the serial port redirection settings resource model. |
|
@odata.id |
String |
Link to the serial port redirection setting resource. |
|
@odata.type |
String |
Type of the serial port redirection setting resource. |
|
ConnectType |
String |
Supported options: · BIOS · IntelligentNIC |
|
BitRate |
String |
Baud rate. Only 115200 is supported. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.58 |
Deleted the BMC option from the ConnectType field. |
|
HDM2-1.56 |
Deleted the RAID option from the ConnectType field. |
Set serial port redirection settings
Description
Set serial port redirection settings. This interface is not available for X18000 products.
Privilege module
OemKvm
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/SOLMode
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"ConnectType":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. |
|
manager_id |
ID of the manager resource. |
Only value 1 is supported. |
|
ConnectType |
Supported options: · BIOS · IntelligentNIC |
String. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Managers/manager_id/Oem/Public/SOLMode
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"ConnectType" : "BIOS"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#SOLMode.SOLMode",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/SOLMode",
"@odata.type": "#SOLMode.v1_0_0.SOLMode",
"BitRate": "115200",
"ConnectType": "BIOS",
"Name": "Serial Over Lan Mode",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
For information about the response fields, see "Obtain serial port redirection settings."
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.58 |
Deleted the BMC option from the ConnectType field. |
|
HDM2-1.56 |
Deleted the RAID option from the ConnectType field. |
Obtain screen snapshots
Description
Obtain screen snapshot information.
Privilege module
Login
Request
Method and URL:
GET
https://device_ip/redfish/v1/Managers/manager_id/Oem/DiagnosticService/ScreenShot
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/DiagnosticService/ScreenShot
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "redfish/v1/$metadata#Managers/Members/1/DiagnosticService/ScreenShot/$entity",
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/ScreenShot",
"@odata.type": "#ScreenShot.v1_0_0.ScreenShot",
"Members": [
{
"FileName": "BSOD_20211111T172700+0800_01.jpeg"
}
],
"Members@odata.count": 1,
"Name": "CaptureScreenShot",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the screen snapshot resource model. |
|
@odata.id |
String |
Link to the screen snapshot resource. |
|
@odata.type |
String |
Type of the screen snapshot resource. |
|
FileName |
String |
Screenshot file name. |
The server returns status code 200 for a successful operation.
Delete screen snapshots
Description
Delete screen snapshots.
Privilege module
ConfigureComponents
Request
Method and URL:
POST
https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/Actions/DiagnosticService.DeleteScreenShot
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"FileName": 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. |
|
FileName |
Name of the snapshot file to be deleted. If set to deleteAll, all will be deleted. HDM3 supports only one snapshot. |
String. Options include false and true. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.DeleteScreenShot
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"FileName": "BSOD_20211111T172700+0800_01.jpeg"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Obtain video playback
Description
Obtain video playback information.
Privilege module
Login
Request
Method and URL:
GET
https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/Videos
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/DiagnosticService/Videos
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/DiagnosticService/Videos/$entity",
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/Videos",
"@odata.type": "#RecordedVideos.v1_0_0.RecordedVideos",
"Members": [
{
"CreateTime": "2022-06-02T23:09:47+08:00",
"FileName": "pre_shutdown_video_20210918T142531+0800.dat",
"VideoType": "PoweroffVideo"
}
],
"Members@odata.count": 1,
"Name": "RecordedVideos",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the video playback model. |
|
@odata.id |
String |
Link to the video playback. |
|
@odata.type |
String |
Type of the video playback. |
|
Members |
Object |
· Video information. |
|
FileName |
String |
Video file name. |
|
VideoType |
String |
· Video type. · Supported options: · CrashVideo. · OsresetVideo. · PoweroffVideo. |
|
CreateTime |
String |
· Video file timestamp. |
|
Members@odata.count |
Integer |
· Number of videos. |
|
Name |
String |
Name of the video resource. |
The server returns status code 200 for a successful operation.
Obtain advanced video playback configuration
Description
Obtain advanced video playback configuration.
Privilege module
Login
Request
Method and URL:
GET
https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/VideoConfig
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/DiagnosticService/VideoConfig
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/DiagnosticService/VideosConfig/$entity",
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/VideoConfig",
"@odata.type": "#RecordedVideosConfig.v1_0_0.RecordedVideosConfig",
"Name": "RecordedVideos Config",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RecordingStrategy": {
"PreCrashEnabled": false,
"PreRestartEnabled": false,
"PreShutdownEnabled": false
},
"RecordingTime": 15,
"VideoRecordingEnabled": true
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the video playback settings resource model. |
|
@odata.id |
String |
Link to the video playback settings resource. |
|
@odata.type |
String |
Type of the video playback settings resource. |
|
Name |
String |
Name of the video playback settings resource. |
|
VideoRecordingEnabled |
Boolean |
Enabling status of the video recording function. |
|
RecordingTime |
Integer |
Length of video recording time, limited to 15-255s. |
|
RecordingStrategy.PreCrashEnabled |
Boolean |
· Whether recording is enabled before a crash. |
|
RecordingStrategy.PreRestartEnabled |
Boolean |
· Whether recording is enabled before a reset. |
|
RecordingStrategy.PreShutdownEnabled |
Boolean |
Whether recording is enabled before shutdown. |
The server returns status code 200 for a successful operation.
Set advanced video playback configuration
Description
Configure video playback parameters.
Privilege module
ConfigureComponents
Request
Method and URL:
PATCH
https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/VideoConfig
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"VideoRecordingEnabled": true,
"RecordingTime": time_s,
"RecordingStrategy": {
"PreCrashEnabled": true,
"PreRestartEnabled": false,
"PreShutdownEnabled": 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. |
|
VideoRecordingEnabled |
Enabling status of the video recording function. |
Boolean. |
|
RecordingTime |
Length of the video recording time, limited to 15-255s. |
Integer. |
|
RecordingStrategy.PreCrashEnabled |
Whether recording is enabled before a crash. |
Boolean. |
|
RecordingStrategy.PreRestartEnabled |
Whether recording is enabled before a reset. |
Boolean. |
|
RecordingStrategy.PreShutdownEnabled |
Whether recording is enabled before shutdown. |
Boolean. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/VideoConfig
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"VideoRecordingEnabled": true,
"RecordingTime": 120,
"RecordingStrategy": {
"PreCrashEnabled": true,
"PreRestartEnabled": false,
"PreShutdownEnabled": true
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/DiagnosticService/VideosConfig/$entity",
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/VideoConfig",
"@odata.type": "#RecordedVideosConfig.v1_0_0.RecordedVideosConfig",
"Name": "RecordedVideos Config",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RecordingStrategy": {
"PreCrashEnabled": true,
"PreRestartEnabled": false,
"PreShutdownEnabled": true
},
"RecordingTime": 120,
"VideoRecordingEnabled": true
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain advanced video playback configuration."
Play video playback
Description
Play a video playback.
Privilege module
ConfigureComponents
Request
Method and URL:
POST
https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/Actions/DiagnosticService.PlayVideo
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"FileName": 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. |
|
FileName |
Filename of the video to be played. |
String. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.PlayVideo
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"FileName": "pre_crash_video_20211111T172700+0800.dat"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/DiagnosticService/Actions/$entity",
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.PlayVideo",
"@odata.type": "#RecordedVideos.v1_0_0.RecordedVideos",
"FilePath":"/usr/local/www/video/HDM/pre_crash_video_20211111T172700+0800.dat",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the video playback settings resource model. |
|
@odata.id |
String |
Link to the video playback settings resource. |
|
@odata.type |
String |
Type of the video playback settings resource. |
|
FilePath |
String |
Name of the video playback file. |
The server returns status code 200 for a successful operation.
Export video playback
Description
Export a video playback.
Privilege module
ConfigureComponents
Request
Method and URL:
POST
https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/Actions/DiagnosticService.ExportVideo
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
Local export
{
"Type":"URI",
"Content": "/tmp/web/dump.tar.gz",
"Oem": {
"Public": {
"FileName": FileName
}
}
}
Remote export
Cifs or sftp
{
"Type":"URI",
"Content": "sftp://username:password@10.10.10.191/usr/dump.tar.gz",
"Oem": {
"Public": {
"FileName": FileName
}
}
}
http, tftp, nfs, or https
{
"Type":"URI",
"Content": http://ip/filename,
"Oem": {
"Public": {
"FileName": FileName,
"ScriptName":"1.php"
}
}
}
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 of exporting video playback. |
URI. |
|
Content |
Link to export video playback. |
See "Others." |
|
Oem.Public.ScriptName |
Script file name. |
String. This field is required if you use HTTP or HTTPS to export the configuration file. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.ExportVideo
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Type":"URI",
"Content": "nfs://192.168.20.177/Share1/pre.dat ",
"Oem": {
"Public": {
"FileName":"pre_crash_video_20211111T172700+0800.dat"
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the video export TaskService. |
|
@odata.id |
String |
Link to the video export TaskService. |
|
@odata.type |
String |
Type of the video export TaskService. |
|
Members |
Array |
Link to the video export Task. |
|
Members@odata.count |
Integer |
Number of links generated by the video export Task. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the video export TaskService. |
The server returns status code 200 for a successful operation.
Delete video playback
Description
Delete a video playback.
Privilege module
ConfigureComponents
Request
Method and URL:
POST
https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService/Actions/DiagnosticService.DeleteVideo
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"FileName": 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. |
|
FileName |
Filename of the video to be played. |
String. If the parameter is deleteAll, all videos will be deleted. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.DeleteVideo
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"FileName": "pre_crash_video_20211111T172700+0800.dat"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Unified management: Obtain managed device collection resources
Description
Obtain managed device collection information.
Privilege module
Login
Request
Method and URL:
GET
https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/JointManagement
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/Oem/Public/JointManagement
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#JointManagement.JointManagement",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/JointManagement",
"@odata.type": "#JointManagement.v1_0_0.JointManagement",
"Actions": {
"Oem": {
"Public": {
"#JointManagement.AddDevices": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/JointManagement.AddDevices"
},
"#JointManagement.ComputerSystemReset": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/JointManagement.ComputerSystemReset"
},
"#JointManagement.RemoveDevices": {
"target": "/redfish/v1/Managers/1/Actions/Oem/Public/JointManagement.RemoveDevices"
}
}
}
},
"Description": "Joint management information",
"Members": [
{
"AssignedPrivileges": [],
"IPAddress": "192.168.7.23",
"IndicatorLED": "N/A",
"MemberId": "0",
"OemPrivileges": [],
"OnlineEnabled": false,
"PowerState": "N/A",
"ProductName": "N/A",
"SerialNumber": "N/A",
"Severity": "N/A"
},
{
"AssignedPrivileges": [
"ConfigureUsers",
"ConfigureComponents",
"Login",
"ConfigureSelf"
],
"IPAddress": "192.168.188.187",
"IndicatorLED": "Off",
"MemberId": "1",
"OemPrivileges": [
"OemKvm",
"OemVmm",
"OemSecurityMgmt",
"OemPowerControl",
"OemDiagnosis",
"OemSystemAudit"
],
"OnlineEnabled": true,
"PowerState": "On",
"ProductName": "RS33M2C9S",
"SerialNumber": "",
"Severity": "Critical"
}
],
"Members@odata.count": 2,
"Name": "JointManagement Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the managed device collection resource model. |
|
@odata.id |
String |
Link to the managed device collection resource. |
|
@odata.type |
String |
Type of the managed device collection resource. |
|
Members |
Object |
Link to the video export Task. |
|
Members.AssignedPrivileges |
Array |
Number of links generated by the video export Task. |
|
Members.OemPrivileges |
Array |
Member list. |
|
Members.MemberId |
String |
Specified privileges. |
|
Members.OnlineEnabled |
Boolean |
Server-defined privileges. |
|
Members.IPAddress |
String |
Device member ID. |
|
Members.ProductName |
String |
Online status. |
|
Members.Severity |
String |
Device IP. |
|
Members.PowerState |
String |
Device name. |
|
Members.IndicatorLED |
String |
UID LED status. |
|
Members.SerialNumber |
String |
Serial number. |
|
Members@odata.count |
Integer |
Current number of managed devices. |
|
Actions.Oem.Public#JointManagement.ComputerSystemReset |
Object |
Host power operation. |
|
Actions.Oem.Public#JointManagement.RemoveDevices |
Object |
Delete managed device. |
|
Actions.Oem.Public #JointManagement.AddDevices |
Object |
Add device management. |
|
Name |
String |
Name of the managed device collection resource information. |
The server returns status code 200 for a successful operation.
Unified management: Add managed device resources
Description
Add a managed device resource.
Privilege module
ConfigureUsers
Request
Method and URL:
POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/JointManagement.AddDevices
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"StartIPAddress": StartIPAddress,
"EndIPAddress": EndIPAddress,
"UserName": UserName,
"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. |
|
manager_id |
ID of the manager resource. |
Only value 1 is supported. |
|
StartIPAddress |
Starting IP. |
String. |
|
EndIPAddress |
Ending IP. |
String. |
|
UserName |
Username for adding devices. |
String. |
|
Password |
Password for adding devices. |
String. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/JointManagement.AddDevices
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"StartIPAddress": "192.168.122.178",
"EndIPAddress": "192.168.122.178",
"UserName": "admin",
"Password": "Password@_"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1685303949
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
Add OData description information for managing the TaskService management device. |
|
@odata.type |
String |
Add the type of management device TaskService. |
|
@odata.id |
String |
Add the access path of management device TaskService. |
|
Members@odata.id |
String |
Add the task link generated by the management device. |
|
Name |
String |
Add the name of management device TaskService. |
Change history
|
Version |
Change description |
|
HDM2-1.54 |
Modified the method for adding devices to unified management by using tasks to return. |
Unified management: Delete managed device resources
Description
Delete a managed device resource.
Privilege module
ConfigureUsers
Request
Method and URL:
POST
https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/JointManagement.RemoveDevices
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"ServerList":[
{
"MemberId": MemberId,
"IPAddress": ip
},
{
"MemberId": MemberId,
"IPAddress": ip
}
]
}
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. |
|
ServerList |
Device list |
Array. |
|
ServerList.MemberId |
Device member ID. |
String. |
|
ServerList.IPAddress |
IP of the device to be deleted.
|
IP address range cannot exceed 255. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/JointManagement.RemoveDevices
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"ServerList":[
{
"MemberId": "1",
"IPAddress": "192.168.18.20"
},
{
"MemberId": "2",
"IPAddress": "192.168.18.21"
}
]
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Unified management: Host power operation
Description
Perform host power operation.
Privilege module
ConfigureUsers
Request
Method and URL:
POST
https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/JointManagement.ComputerSystemReset
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"MemberId": MemberId,
"PowerState": PowerState
}
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 |
Device ID. |
String. |
|
PowerState |
Modify power state. |
String type. Supported options: · On. · ForceOff. · GracefulShutdown. · ForceRestart. · ForcePowerCycle. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Oem/Public/JointManagement.ComputerSystemReset
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"MemberId": "1",
"PowerState": "On"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Obtain service USB drive resource information
Description
Obtain service USB drive resource information. This interface is not available for X18000 products.
Privilege module
Login
Request
Method and URL:
GET
https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/USBDeviceService
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/Oem/Public/USBDeviceService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#USBDeviceService/$entity",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/USBDeviceService",
"@odata.type": "#USBDeviceService.v1_0_0.USBDeviceService",
"AutomaticDownloadEnabled": false,
"Description": "USB Device Service",
"USBDeviceEnabled": true,
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ServiceEnabled": true,
"State": "Absent"
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the service USB drive resource model. |
|
@odata.id |
String |
Link to the service USB drive resource information. |
|
@odata.type |
String |
Type of the service USB drive resource information. |
|
Description |
String |
Description of the service USB drive resource information. |
|
State |
Boolean |
· USB Drive Status. Supported options: · Enabled. · Absent. · Starting. |
|
ServiceEnabled |
Boolean |
Whether the service USB drive is enabled. |
|
AutomaticDownloadEnabled |
Boolean |
· Whether the automatic download SDS function is enabled. |
|
USBDeviceEnabled |
Boolean |
· Enabling status USB physical interface. |
Set service USB drive resource information
Description
Set service USB drive resource information. This interface is not available for X18000 products.
Privilege module
OemDiagnosis
Request
Method and URL:
PATCH
https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/USBDeviceService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"ServiceEnabled": true,
"USBDeviceEnabled": true,
"AutomaticDownloadEnabled": 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. |
|
ServiceEnabled |
Enabling status of the service USB drive. |
Boolean. |
|
AutomaticDownloadEnabled |
Enabling status of the automatic SDS download function. |
Boolean. |
|
USBDeviceEnabled |
Enabling status of the USB physical interface. |
Boolean. |
Examples
Method and URL:
Patch https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/USBDeviceService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"ServiceEnabled": true,
"USBDeviceEnabled": true,
"AutomaticDownloadEnabled": true
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#USBDeviceService/$entity",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/USBDeviceService",
"@odata.type": "#USBDeviceService.v1_0_0.USBDeviceService",
"AutomaticDownloadEnabled": true,
"Description": "USB Device Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"USBDeviceEnabled": true,
"ServiceEnabled": true,
"State": "Absent"
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain service USB drive resource information."
Upload BMC file
Description
Display the specified BMC file content using PostMan. Users can upload files using Postman or in combination with curl command.
Privilege module
ConfigureComponents
Request
Method and URL:
POST
https://device_ip/redfish/v1/Managers/manager_id/ Actions/Oem/Public/Manager.GeneralUpload
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
<form enctype="multipart/form-data" action="
https://192.168.188.188/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralUpload" method="POST">
<input name=""file name" type="file">
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/Oem/Public/Manager.GeneralUpload
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
<form enctype="multipart/form-data" action="
https://192.168.188.188/redfish/v1/Managers/1/Actions/Oem/Public/Manager.GeneralUpload" method="POST">
<input name="BIOSConfiguration" type="file">
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Reset the SD card
Description
Reset the SD card.
Privilege module
OemKvm
Request
Method and URL:
POST
https://device_ip/redfish/v1/Managers/manager_id/ Actions/Oem/Public/Manager.ResetSD
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/Oem/Public/Manager.ResetSD
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Obtain security dashboard information
Description
Obtain the security dashboard information.
Privilege module
Login
Request
Method and URL:
GET
https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/SecurityDashboard
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/Oem/Public/SecurityDashboard
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#SecurityDashboard.SecurityDashboard",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/SecurityDashboard",
"@odata.type": "#SecurityDashboard.v1_0_0.SecurityDashboard",
"AccountAuthenticationSecurity": {
"AccountLockoutDuration": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "5",
"Id":"4",
"IgnoreRiskSupported": "Disabled"
},
"AccountLockoutThreshold": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "1",
"Id":"3",
"IgnoreRiskSupported": "Disabled"
},
"LDAPCertificateVerification":{
"ConfigurationStatus": "OK",
"ConfigurationValue": "Enabled",
"Id": "7",
"IgnoreRiskSupported": "Disabled"
},
"PasswordComplexityCheck": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "Enabled",
"Id":"1",
"IgnoreRiskSupported": "Disabled"
},
"PasswordHistoryCount": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "0",
"Id":"5",
"IgnoreRiskSupported": "Disabled"
},
"PasswordValidityDays": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "0",
"Id":"6",
"IgnoreRiskSupported": "Disabled"
},
"WeakPasswordVerification": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Disabled",
"Id":"2",
"IgnoreRiskSupported": "Disabled"
}
},
"Description": "SecurityDashboard Gettings",
"Id": "SecurityDashboard",
"IgnoreRiskAllocationsCount": 0,
"Name": "SecurityDashboard",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RiskAllocationsCount": 9,
"ServiceEnabled": true,
"ServiceSecurity": {
"CertificateRemainingTime": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "805",
"Id":"10",
"IgnoreRiskSupported": "Disabled"
},
"CommunityComplexityCheck": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Disabled",
"Id": "1",
"IgnoreRiskSupported": "Disabled"
},
"DefaultCertificateEnabled": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Enabled",
"Id":"8",
"IgnoreRiskSupported": "Disabled"
},
"KVMEncryption": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "Enabled",
"Id":"5",
"IgnoreRiskSupported": "Disabled"
},
"RMCPPlusEnabled": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "Enabled",
"Id":"3",
"IgnoreRiskSupported": "Disabled"
},
"SMTPTLSEncryption": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Disabled",
"Id":"7",
"IgnoreRiskSupported": "Disabled"
},
"SNMPV1V2CEnabled": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Enabled",
"Id":"2",
"IgnoreRiskSupported": "Disabled"
},
"SyslogTLSEnabled": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Disabled",
"Id":"6",
"IgnoreRiskSupported": "Disabled"
},
"TLSVersion": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "TLSv1.2",
"Id":"9",
"IgnoreRiskSupported": "Disabled"
},
"VNCPasswordComplexityCheck": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Disabled",
"Id":"4",
"IgnoreRiskSupported": "Disabled"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the safety instrument information resource model. |
|
@odata.id |
String |
Link to the safety instrument information resource. |
|
@odata.type |
String |
Type of the safety instrument information resource. |
|
Description |
String |
Description of the safety instrument information resource. |
|
Id |
String |
ID of the safety instrument information resource. |
|
Name |
String |
Name of the safety instrument information resource. |
|
RiskAllocationsCount |
Integer |
Risk configuration item, displayed as 0 when disabled. |
|
IgnoreRiskAllocationsCount |
Integer |
Ignore risk items, displayed as 0 when disabled. |
|
ServiceEnabled |
Boolean |
Safety detection function. When this feature is enabled, its status is displayed as true. When the feature is disabled, its status is displayed as false |
|
AccountAuthenticationSecurity |
Account authentication security. |
|
|
AccountLockoutThreshold |
Object |
Allowed number of incorrect password attempts. |
|
AccountLockoutThreshold.ConfigurationValue |
String |
Configuration value. |
|
AccountLockoutThreshold.ConfigurationStatus |
String |
Status (OK, Risky). |
|
AccountLockoutThreshold.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
AccountLockoutThreshold.Id |
String |
Configuration item ID. |
|
PasswordComplexityCheck |
Object |
Password complexity check. |
|
PasswordComplexityCheck.ConfigurationValue |
String |
Configuration value. |
|
PasswordComplexityCheck.ConfigurationStatus |
String |
Status (OK, Risky). |
|
PasswordComplexityCheck.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
PasswordComplexityCheck.Id |
String |
Configuration item ID. |
|
AccountLockoutDuration |
Object |
Duration of user lockout following failed login attempts. |
|
AccountLockoutDuration.ConfigurationValue |
String |
Configuration value. |
|
AccountLockoutDuration.ConfigurationStatus |
String |
Status (OK, Risky). |
|
AccountLockoutDuration.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
AccountLockoutDuration.Id |
String |
Configuration item ID. |
|
WeakPasswordVerification |
Object |
Weak password validation. |
|
WeakPasswordVerification.ConfigurationValue |
String |
Configuration value. |
|
WeakPasswordVerification.ConfigurationStatus |
String |
Status (OK, Risky). |
|
WeakPasswordVerification.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
WeakPasswordVerification.Id |
String |
Configuration item ID. |
|
PasswordHistoryCount |
Object |
Password history count. |
|
PasswordHistoryCount.ConfigurationValue |
String |
Configuration value. |
|
PasswordHistoryCount.ConfigurationStatus |
String |
Status (OK, Risky). |
|
PasswordValidityDays.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
PasswordHistoryCount.Id |
String |
Configuration item ID. |
|
PasswordValidityDays |
Object |
Password validity period. |
|
PasswordValidityDays.ConfigurationValue |
String |
Configuration value. |
|
PasswordValidityDays.ConfigurationStatus |
String |
Status (OK, Risky). |
|
PasswordValidityDays.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
PasswordValidityDays.Id |
String |
Configuration item ID. |
|
LDAPCertificateVerification |
Object |
LDAP certificate verification enabling. |
|
LDAPCertificateVerification.ConfigurationValue |
String |
Configuration value. |
|
LDAPCertificateVerification.ConfigurationStatus |
String |
State (OK or Risky). |
|
LDAPCertificateVerification.IgnoreRiskSupported |
String |
Enabling status of ignoring. |
|
LDAPCertificateVerification.Id |
String |
Configuration item ID. |
|
ServiceSecurity |
Application service security. |
|
|
CommunityComplexityCheck |
Object |
Community complexity check. |
|
CommunityComplexityCheck.ConfigurationValue |
String |
Configuration value. |
|
CommunityComplexityCheck.ConfigurationStatus |
String |
Status (OK, Risky). |
|
CommunityComplexityCheck.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
CommunityComplexityCheck.Id |
String |
Configuration item ID. |
|
SNMPV1V2CEnabled |
Object |
Enabling status of the V1/V2C. |
|
SNMPV1V2CEnabled.ConfigurationValue |
String |
Configuration value. |
|
SNMPV1V2CEnabled.ConfigurationStatus |
String |
Status (OK, Risky). |
|
SNMPV1V2CEnabled.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
SNMPV1V2CEnabled.Id |
String |
Configuration item ID. |
|
RMCPPlusEnabled |
Object |
IPMI RMCP+ configuration. |
|
RMCPPlusEnabled.ConfigurationValue |
String |
Configuration value. |
|
RMCPPlusEnabled.ConfigurationStatus |
String |
Status (OK, Risky). |
|
RMCPPlusEnabled.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
RMCPPlusEnabled.Id |
String |
Configuration item ID. |
|
VNCPasswordComplexityCheck |
Object |
VNC password complexity check. |
|
VNCPasswordComplexityCheck.ConfigurationValue |
String |
Configuration value. |
|
VNCPasswordComplexityCheck.ConfigurationStatus |
String |
Status (OK, Risky). |
|
VNCPasswordComplexityCheck.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
VNCPasswordComplexityCheck.Id |
String |
Configuration item ID. |
|
KVMEncryption |
Object |
KVM encryption. |
|
KVMEncryption.ConfigurationValue |
String |
Configuration value. |
|
KVMEncryption.ConfigurationStatus |
String |
Status (OK, Risky). |
|
KVMEncryption.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
KVMEncryption.Id |
String |
Configuration item ID. |
|
CertificateRemainingTime |
Object |
Remaining certificate validity period. |
|
CertificateRemainingTime.ConfigurationValue |
String |
Configuration value. |
|
CertificateRemainingTime.ConfigurationStatus |
String |
Status (OK, Risky). |
|
CertificateRemainingTime.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
CertificateRemainingTime.Id |
String |
Configuration item ID. |
|
TLSVersion |
Object |
TLS version. |
|
TLSVersion.ConfigurationValue |
String |
Configuration value. |
|
TLSVersion.ConfigurationStatus |
String |
Status (OK, Risky). |
|
TLSVersion.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
TLSVersion.Id |
String |
Configuration item ID. |
|
DefaultCertificateEnabled |
Object |
Use of default certificate. |
|
DefaultCertificateEnabled.ConfigurationValue |
String |
Configuration value. |
|
DefaultCertificateEnabled.ConfigurationStatus |
String |
Status (OK, Risky). |
|
DefaultCertificateEnabled.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
DefaultCertificateEnabled.Id |
String |
Configuration item ID. |
|
SMTPTLSEncryption |
Object |
SMTP TLS encryption. |
|
SMTPTLSEncryption.ConfigurationValue |
String |
Configuration value. |
|
SMTPTLSEncryption.ConfigurationStatus |
String |
Status (OK, Risky). |
|
SMTPTLSEncryption.IgnoreRiskSupported |
String |
Ignore option (Enabled, Disabled). |
|
SMTPTLSEncryption.Id |
String |
Configuration item ID. |
|
SyslogTLSEnabled |
Object |
Syslog TLS enablement. |
|
SyslogTLSEnabled.ConfigurationValue |
String |
Configuration value. |
|
SyslogTLSEnabled.ConfigurationStatus |
String |
Status (OK or Risky). |
|
SyslogTLSEnabled.IgnoreRiskSupported |
String |
Ignore option (Enabled or Disabled). |
|
SyslogTLSEnabled.Id |
String |
Configuration item ID. |
Change history
|
Version |
Change description |
|
HDM2-1.57 |
Added LDAP certificate verification and the LDAPCertificateVerification, LDAPCertificateVerification.ConfigurationValue, LDAPCertificateVerification.ConfigurationStatus, and LDAPCertificateVerification.IgnoreRiskSupported fields and their corresponding configuration item ID fields. |
Set security dashboard information
Description
Set the security dashboard information.
Privilege module
OemSecurityMgmt
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/SecurityDashboard
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"ServiceEnabled": false,
"AccountAuthenticationSecurity":{
"AccountSecurityType":{
"IgnoreRiskSupported": "Enabled"}
},
" ServiceSecurity":{
"ServiceSecurityType":{
"IgnoreRiskSupported": "Disabled"}
}
}
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. |
|
ServiceEnabled |
Security detection feature. |
Boolean. |
|
AccountAuthenticationSecurity. AccountSecurityType |
Account authentication security type to be set. |
Possible account authentication security types include: · AccountLockoutDuration. · AccountLockoutThreshold. · PasswordComplexityCheck. · PasswordHistoryCount. · PasswordValidityDays. · WeakPasswordVerification. |
|
AccountAuthenticationSecurity. AccountSecurityType. IgnoreRiskSupported |
Ignore option. |
String. Supported options: · Enabled. · Disabled. |
|
ServiceSecurity. ServiceSecurityType |
Application service security type to be set. |
Possible application service security types include: · CertificateRemainingTime. · CommunityComplexityCheck. · DefaultCertificateEnabled. · KVMEncryption. · RMCPPlusEnabled. · SMTPTLSEncryption. · SNMPV1V2CEnabled. · SyslogTLSEnabled. · TLSVersion. · VNCPasswordComplexityCheck. |
|
ServiceSecurity. ServiceSecurityType. IgnoreRiskSupported |
Ignore option. |
String. Supported options: · Enabled. · Disabled. |
Examples
Method and URL:
Patch https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/SecurityDashboard
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"ServiceEnabled": false,
"AccountAuthenticationSecurity":{
"PasswordComplexityCheck":{
"IgnoreRiskSupported": "Enabled"}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#SecurityDashboard.SecurityDashboard",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/SecurityDashboard",
"@odata.type": "#SecurityDashboard.v1_0_0.SecurityDashboard",
"AccountAuthenticationSecurity": {
"AccountLockoutDuration": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "5",
"Id":"4",
"IgnoreRiskSupported": "Disabled"
},
"AccountLockoutThreshold": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "1",
"Id":"3",
"IgnoreRiskSupported": "Disabled"
},
"LDAPCertificateVerification":{
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Disabled",
"Id": "7",
"IgnoreRiskSupported": "Disabled"
},
"PasswordComplexityCheck": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "0",
"Id":"5",
"IgnoreRiskSupported": "Disabled"
},
"PasswordValidityDays": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "0",
"Id":"6",
"IgnoreRiskSupported": "Disabled"
},
"WeakPasswordVerification": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Disabled",
"Id":"2",
"IgnoreRiskSupported": "Disabled"
}
},
"Description": "SecurityDashboard Gettings",
"Id": "SecurityDashboard",
"IgnoreRiskAllocationsCount": 1,
"Name": "SecurityDashboard",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RiskAllocationsCount": 9,
"ServiceEnabled": false,
"ServiceSecurity": {
"CertificateRemainingTime": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "4848",
"Id": "10",
"IgnoreRiskSupported": "Disabled"
},
"CommunityComplexityCheck": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Disabled",
"Id":"1",
"IgnoreRiskSupported": "Disabled"
},
"DefaultCertificateEnabled": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Enabled",
"Id":"8",
"IgnoreRiskSupported": "Disabled"
},
"KVMEncryption": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "Enabled",
"Id":"5",
"IgnoreRiskSupported": "Disabled"
},
"RMCPPlusEnabled": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "Enabled",
"Id":"3",
"IgnoreRiskSupported": "Disabled"
},
"SMTPTLSEncryption": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Disabled",
"Id":"7",
"IgnoreRiskSupported": "Disabled"
},
"SNMPV1V2CEnabled": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Enabled",
"Id":"2",
"IgnoreRiskSupported": "Disabled"
},
"SyslogTLSEnabled": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Disabled",
"Id": "6",
"IgnoreRiskSupported": "Disabled"
},
"TLSVersion": {
"ConfigurationStatus": "OK",
"ConfigurationValue": "TLSv1.2",
"Id":"9",
"IgnoreRiskSupported": "Disabled"
},
"VNCPasswordComplexityCheck": {
"ConfigurationStatus": "Risky",
"ConfigurationValue": "Disabled",
"Id":"4",
"IgnoreRiskSupported": "Disabled"
}
}
}
Response code: 200
Response field description
For information about the response fields, see "Obtain security dashboard information."
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associate system. |
Obtain system lock resource information
Description
Obtain system lock resource information. This resource is licensed and requires authorization through licensing before use.
For the lock range, see the online help. For detailed information, see the description for each command.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/SystemLockResource
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/Oem/Public/SystemLockResource
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#SystemLockState.SystemLockState"
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/SystemLockResource"
"@odata.type": "#SystemLockResource.v1_0_0.SystemLockResource"
"AccessIsolationEnabled": false
"BIOSLockEnabled": false
"BMCLockEnabled": false
"Description": "Resources Locked By The System"
"HardwareLockEnabled": false
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
"PowerControlLockEnabled": false
"ServiceEnabled": false
"UpgradeLockEnabled": false
}
Response code: 200
Response field description
|
Field |
Type |
Description |
|
@odata.context |
String |
OData description of the system lock resource model. |
|
@odata.id |
String |
Access path to the system lock resource. |
|
@odata.type |
String |
Type of the system lock resource. |
|
Description |
String |
Description of the system lock resource. |
|
ServiceEnabled |
Boolean |
Enabling state of system lock. |
|
PowerControlLockEnabled |
Boolean |
Power control lock state. |
|
UpgradeLockEnabled |
Boolean |
Firmware version lock state. |
|
HardwareLockEnabled |
Boolean |
Hardware configuration lock state. |
|
BIOSLockEnabled |
Boolean |
BIOS configuration lock state. |
|
BMCLockEnabled |
Boolean |
BMC lock state. |
|
AccessIsolationEnabled |
Boolean |
Isolation state of in-band and out-of-band access. |
Modify system lock resource information
Description
Modify system lock resource information. This resource is licensed and requires authorization through licensing before use.
For the lock range, see the online help. For detailed information, see the description for each command.
Privilege module
ConfigureUsers
Request
PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/SystemLockResource
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"ServiceEnabled": true,
"PowerControlLockEnabled": true,
"UpgradeLockEnabled":true,
"HardwareLockEnabled": true,
"BIOSLockEnabled": true,
"BMCLockEnabled": true,
"AccessIsolationEnabled": 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 |
Matching parameters for the request message. |
It can be obtained by sending a GET request to the corresponding resource and retrieving it from the response header (corresponding to the "ETag" parameter). |
|
ServiceEnabled |
System lock enabling state. |
Boolean |
|
PowerControlLockEnabled |
Power control lock state. |
Boolean |
|
UpgradeLockEnabled |
Firmware version lock state. |
Boolean |
|
HardwareLockEnabled |
Hardware configuration lock state. |
Boolean |
|
BIOSLockEnabled |
BIOS configuration lock state. |
Boolean |
|
BMCLockEnabled |
BMC configuration lock state. |
Boolean |
|
AccessIsolationEnabled |
Isolation state of in-band and out-of-band access. |
Boolean |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Managers/1/Oem/Public/SystemLockResource
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match: ifmatch_value
Request body:
{
"ServiceEnabled": true,
"PowerControlLockEnabled": true,
"UpgradeLockEnabled":true,
"HardwareLockEnabled": true,
"BIOSLockEnabled": true,
"BMCLockEnabled": true,
"AccessIsolationEnabled": true
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#SystemLockState.SystemLockState"
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/SystemLockResource"
"@odata.type": "#SystemLockResource.v1_0_0.SystemLockResource"
"AccessIsolationEnabled": true
"BIOSLockEnabled": true
"BMCLockEnabled": true
"Description": "Resources Locked By The System"
"HardwareLockEnabled": true
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
"PowerControlLockEnabled": true
"ServiceEnabled": true
"UpgradeLockEnabled": true
}
Response code: 200
Response field description
The response returns status code 200 to indicate operation success.
For more information about the returned fields, see "Obtain system lock resource information."
Obtain intelligent monitoring service information
Description
Obtain intelligent monitoring service information.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/IntelligentMonitoringService
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/Oem/Public/IntelligentMonitoringService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#IntelligentMonitoringService.IntelligentMonitoringService",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService",
"@odata.type": "#IntelligentMonitoringService.v1_0_0.IntelligentMonitoringService",
"Description": "Dynamic monitoring of system resources",
"Drives": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives"
},
"DrivesPredictDays": 4294967295,
"DrivesPredictEnabled": false,
"DrivesReportEnabled": false,
"DrivesUsageThreshold": 4294967295,
"Id": "IntelligentMonitoringService",
"Memory": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Memory"
},
"MemoryAlertReportingEnabled": true,
"MemoryPageOfflineEnabled": true,
"MemoryLevel": 2,
"MemoryPageOfflineSizeKB": 1024,
"MemoryPageOfflineState": "Enabled",
"Name": "IntelligentMonitoring Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ServiceEnabled": true,
"Status": {
"Health": "OK",
"State": "Enabled"
}
}
Response code: 200
Response field description
|
Field |
Type |
Description |
|
@odata.context |
String |
OData description of the intelligent monitoring service model. |
|
@odata.id |
String |
Access path to the intelligent monitoring service resource. |
|
@odata.type |
String |
Type of the intelligent monitoring service resource. |
|
Description |
String |
Description of the intelligent monitoring service resource. |
|
Id |
String |
ID of the intelligent monitoring service resource. |
|
Name |
String |
Name of the intelligent monitoring service resource. |
|
ServiceEnabled |
Boolean |
Service enabling state. |
|
SensorsPreServiceEnabled |
Boolean |
Sensor prediction enabling state. This field is reserved. |
|
MemoryAlertReportingEnabled |
Boolean |
Enabling state of alarm predictive alarm reporting. This field is not supported on AMD models and is displayed as null. |
|
MemoryAlertReportingEnabled |
Boolean |
Enabling status of memory alarm reporting. This field is available only for Intel models. For non-Intel models, this field displays null. |
|
MemoryPageOfflineEnabled |
Boolean |
Memory intelligent repair. This field is available only for Intel models. For non-Intel models, this field displays null. |
|
MemoryPageOfflineState |
String |
Memory intelligent repair status. This field is available only for Intel models. For non-Intel models, this field displays null. |
|
MemoryPageOfflineSizeKB |
Integer |
Memory isolation page size. This field is available only for Intel models. For non-Intel models, this field displays null. |
|
Status.Health |
String |
Health state of intelligent monitoring service information. |
|
Status.State |
String |
Enabling state of intelligent monitoring service information. |
|
Memory |
Object |
Access path to memory resources. |
|
Drives |
Object |
Access path to disk resources. This field is not supported by X18000. |
|
Sensors |
Object |
Access path to sensor resources. This field is reserved. |
|
DrivesPredictDays |
Integer |
Drive prediction days. |
|
DrivesPredictEnabled |
Boolean |
Drive prediction enabling state. |
|
DrivesReportEnabled |
Boolean |
Enabling state of drive prediction reporting. |
|
DrivesUsageThreshold |
Integer |
Drive usage alarm threshold. |
Change history
|
Version |
Change description |
|
HDM2-1.72 HDM2-2.11 |
Added the MemoryPageOfflineState, MemoryPageOfflineSizeKB, and MemoryLevel fields. |
|
HDM2-2.04 |
Added a description for the MemoryAlertReportingEnabled field. Changde the description of the MemoryPageOfflineEnabled field from "Memory page isolation state in the OS" to "Memory intelligent repair." |
|
HDM2-1.55 |
Removed the license control over the interface. To use the interface, license is no longer required. |
|
HDM2-1.54 |
· Added the interface. · Added memory monitoring related fields. · Added description for the MemoryPageOfflineEnabled field. · Added fields DrivesPredictDays, DrivesPredictEnabled, DrivesReportEnabled, and DrivesUsageThreshold. |
Configure intelligent monitoring service information
Description
Configure intelligent monitoring service information. This interface is licensed and requires authorization through licensing before use.
Privilege module
ConfigureComponents
Request
PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/IntelligentMonitoringService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"MemoryAlertReportingEnabled":alert_reporting_enabled,
"MemoryPageOfflineEnabled":page_offline_enabled,
"MemoryLevel": level_value,
"MemoryPageOfflineSizeKB": page_offline_size_value,
"DrivesPredictDays":drives_predictdays_value,
"DrivesPredictEnabled":drives_predict_enabled,
"DrivesReportEnabled":drives_report_enabled,
"DrivesUsageThreshold":drives_usagethreshold_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. |
|
MemoryAlertReportingEnabled |
Enabling state of memory alarm reporting. |
Boolean. This field is available only for Intel models. For non-Intel models, this field cannot be set. |
|
MemoryPageOfflineEnabled |
Enabling state of memory intelligent repair. |
Boolean. This field is available only for Intel models. For non-Intel models, this field cannot be set. |
|
MemoryPageOfflineSizeKB |
Memory isolation page size. |
Integer. This field is available only for Intel models. For non-Intel models, this field cannot be set. Setting this field might change the value of the MemoryPageOfflineState field. |
|
MemoryLevel |
Memory isolation level. · Level 1 (For each additional memory module, the isolation total increases by 10MB) · Level 2 (For each additional memory module, the isolation total increases by 15MB) · Level 3 (For each additional memory module, the isolation total increases by 30MB) |
Integer. This field is available only for Intel models. For non-Intel models, this field cannot be set. |
|
DrivesPredictDays |
Drive prediction days. |
Integer. |
|
DrivesPredictEnabled |
Drive prediction enabling state. |
Boolean. |
|
DrivesReportEnabled |
Drive prediction reporting state. |
Boolean. |
|
DrivesUsageThreshold |
Drive usage alarm threshold. |
Integer. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Managers/manager_id/Oem/Public/IntelligentMonitoringService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"DrivesPredictDays": 7,
"DrivesPredictEnabled": true,
"DrivesReportEnabled": true,
"DrivesUsageThreshold": 30,
"MemoryLevel": 2,
"MemoryPageOfflineSizeKB": 1024,
"MemoryPageOfflineEnabled": "true",
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#IntelligentMonitoringService.IntelligentMonitoringService",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService",
"@odata.type": "#IntelligentMonitoringService.v1_0_0.IntelligentMonitoringService",
"Description": "Dynamic monitoring of system resources",
"Drives": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives"
},
"DrivesPredictDays": 7,
"DrivesPredictEnabled": true,
"DrivesReportEnabled": true,
"DrivesUsageThreshold": 30,
"Id": "IntelligentMonitoringService",
"Memory": {
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Memory"
},
"MemoryAlertReportingEnabled": true,
"MemoryPageOfflineEnabled": true,
"MemoryLevel": 2,
"MemoryPageOfflineSizeKB": 1024,
"MemoryPageOfflineState": "Enabled",
"Name": "IntelligentMonitoring Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ServiceEnabled": true,
"Status": {
"Health": "OK",
"State": "Enabled"
}
}
Response code: 200
Response field description
The response returns status code 200 to indicate operation success.
For more information about the returned fields, see "Obtain intelligent monitoring service information."
Change history
|
Version |
Change description |
|
HDM2-1.72 HDM2-2.11 |
Added the MemoryPageOfflineState, MemoryPageOfflineSizeKB, and MemoryLevel fields. |
|
HDM2-2.04 |
Added a description for the MemoryAlertReportingEnabled field. Changde the description of the MemoryPageOfflineEnabled field from "Memory page isolation state in the OS" to "Memory intelligent repair." |
|
HDM2-1.54 |
· Added support for the interface. · Added description for the MemoryPageOfflineEnabled field. · Added fields DrivesPredictDays, DrivesPredictEnabled, DrivesReportEnabled, and DrivesUsageThreshold. |
Obtain intelligent monitoring drive resource information
Description
Obtain intelligent monitoring drive resource information. This interface is not supported by X18000 products.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/IntelligentMonitoringService/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. |
|
manager_id |
ID of the manager resource. |
Only value 1 is supported. |
Examples
Method and URL:
GET https://192.168.55.66/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives/
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Reponse:
{
"@odata.context": "/redfish/v1/$metadata#IntelligentMonitoringServiceDrives.IntelligentMonitoringServiceDrives",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives",
"@odata.type": "#IntelligentMonitoringServiceDrives.v1_0_0.IntelligentMonitoringServiceDrives",
"AccumulatedPreWarningCount": 2,
"AccumulatedRepairedCount": 1,
"DriveList": [
{
"HistoryDriveUsageRate": [
{
"FreeSpaceMB": 0,
"Time": "2018-06-22T07:08:00-05:00",
"TotalCapacityMB": 1813,
"UsageRatePercents": 100.0
},
…
],
"Name": "/dev/loop0",
"PredictedDriveUsageRate": [
{
"FreeSpaceMB": 0,
"Time": "2018-06-22T07:29:00-05:00",
"TotalCapacityMB": 1813,
"UsageRatePercents": 100.0
},
…
]
},
…
],
"Id": "IntelligentMonitoringServiceDrives",
"Name": "Intelligent Monitoring Service Drives",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"PredictableDrives": [
{
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives/DiskFront7"
}
],
"RepairedRecords": [
{
"CurrentStatus": Early warning,
"Location": "Front12",
"Manufacturer": "Seagate",
"SerialNumber": "S4713TM0",
"TimeStamp": "2018-06-22T07:29:00+00:00"
}
]
}
Response code: 200
Response field description
|
Field |
Type |
Description |
|
@odata.context |
String |
OData description of the intelligent monitoring drive resource. |
|
@odata.id |
String |
Access path of the intelligent monitoring drive resource. |
|
@odata.type |
String |
Type of the intelligent monitoring drive resource. |
|
Id |
String |
ID of the intelligent monitoring drive resource. |
|
Name |
String |
Name of the intelligent monitoring drive resource. |
|
RepairedRecords |
Array |
Drive repairing record. |
|
TimeStamp |
String |
Time. |
|
Location |
String |
Physical drive slot number. |
|
SerialNumber |
String |
Serial number. |
|
Manufacturer |
String |
Manufacturer. |
|
CurrentStatus |
String |
Drive prediction state. · Repaired. · Early warning. |
|
AccumulatedRepairedCount |
Integer |
Number of resolved issues. |
|
AccumulatedPreWarningCount |
Integer |
Number of predictive alarms. |
|
PredictableDrives |
Array |
Drives that support prediction. |
|
DriveList |
Array |
Drive usage data. |
|
HistoryDriveUsageRate |
Array |
History drive usage data. |
|
PredictedDriveUsageRate |
Array |
Predicted drive usage data. |
|
Name |
String |
Specified drive name. |
|
FreeSpaceMB |
Integer |
Available drive capacity. |
|
UsageRatePercents |
Integer |
Drive usage. |
|
Time |
String |
Tine at which the data was recorded. |
|
TotalCapacityMB |
Integer |
Total drive capacity. |
Change history
|
Version |
Change description |
|
HDM2-1.57 |
Removed the license control over the interface. To use the interface, license is no longer required. |
|
HDM2-1.54 |
Added the interface. Added fields DriveList, HistoryDriveUsageRate, PredictedDriveUsageRate, Name, FreeSpaceMB, UsageRatePercents, Time, and TotalCapacityMB. Modified the response example format. |
Obtain intelligent monitoring information of a drive
Description
Obtain intelligent monitoring information of a drive.
This interface is not available for X18000 products.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/IntelligentMonitoringService/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. |
|
manager_id |
ID of the manager resource. |
Only value 1 is supported. |
|
driver_id |
Drive ID. |
You can obtain available drive IDs from intelligent monitoring drive resource information. |
Examples
Method and URL:
GET https://192.168.55.66/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives/DiskFront0/
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
SATA drive response:
{
"@odata.context": "/redfish/v1/$metadata#IntelligentMonitoringServiceDrives.IntelligentMonitoringServiceDrives",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives/DiskFront0",
"@odata.type": "#IntelligentMonitoringServiceDrives.v1_0_0.IntelligentMonitoringServiceDrives",
"Id": "DiskFront0",
"LoadUnloadCycles": {
"HistoryDataList": [
{
"Time": "2029-07-27T03:31:51+00:00",
"Value": 30
},
…
{
"Time": "2029-07-30T21:30:33+00:00",
"Value": 30
}
],
"PredictedDataList": [
{
"Time": "2029-07-31T03:30:33+00:00",
"Value": 30
},
{
"Time": "2029-07-31T09:30:33+00:00",
"Value": 30
}
],
"Threshold": 0
},
"Manufacturer": "Seagate",
"MediaType": "HDD",
"Name": "DiskFront0",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"PowerOnHours": {
"HistoryDataList": [
{
"Time": "2029-07-27T03:31:51+00:00",
"Value": 8854
},
…
{
"Time": "2029-07-30T21:30:33+00:00",
"Value": 8855
}
],
"PredictedDataList": [
{
"Time": "2029-07-31T03:30:33+00:00",
"Value": 8855
},
{
"Time": "2029-07-31T09:30:33+00:00",
"Value": 8855
}
],
"Threshold": null
},
"Protocol": "SATA",
"ReadErrorRate": {
"HistoryDataList": [
{
"Time": "2029-07-27T03:31:51+00:00",
"Value": 81
},
…
{
"Time": "2029-07-30T21:30:33+00:00",
"Value": 81
}
],
"PredictedDataList": [
{
"Time": "2029-07-31T03:30:33+00:00",
"Value": 81
},
{
"Time": "2029-07-31T09:30:33+00:00",
"Value": 81
}
],
"Threshold": 44
},
"ReadTimes": {
"HistoryDataList": [
{
"Time": "2029-07-27T03:31:51+00:00",
"Value": 336398914824
},
…
{
"Time": "2029-07-30T21:30:33+00:00",
"Value": 336398914824
}
],
"PredictedDataList": [
{
"Time": "2029-07-31T03:30:33+00:00",
"Value": 336398914824
},
{
"Time": "2029-07-31T09:30:33+00:00",
"Value": 336398914824
}
],
"Threshold": null
},
"SerialNumber": "ZAD29G96",
"StartStopCycles": {
"HistoryDataList": [
{
"Time": "2029-07-27T03:31:51+00:00",
"Value": 99
},
…
{
"Time": "2029-07-30T21:30:33+00:00",
"Value": 99
}
],
"PredictedDataList": [
{
"Time": "2029-07-31T03:30:33+00:00",
"Value": 99
},
{
"Time": "2029-07-31T09:30:33+00:00",
"Value": 99
}
],
"Threshold": 20
},
"Temperature": {
"HistoryDataList": [
{
"Time": "2029-07-27T03:31:51+00:00",
"Value": 32
},
…
{
"Time": "2029-07-30T21:30:33+00:00",
"Value": 33
}
],
"PredictedDataList": [
{
"Time": "2029-07-31T03:30:33+00:00",
"Value": 33
},
{
"Time": "2029-07-31T09:30:33+00:00",
"Value": 33
}
],
"Threshold": null
},
"WriteTimes": {
"HistoryDataList": [
{
"Time": "2029-07-27T03:31:51+00:00",
"Value": 65391908603
},
…
{
"Time": "2029-07-30T21:30:33+00:00",
"Value": 65391908603
}
],
"PredictedDataList": [
{
"Time": "2029-07-31T03:30:33+00:00",
"Value": 65391908603
},
{
"Time": "2029-07-31T09:30:33+00:00",
"Value": 65391908603
}
],
"Threshold": null
}
}
SAS drive response:
{
"@odata.context": "/redfish/v1/$metadata#IntelligentMonitoringServiceDrives.IntelligentMonitoringServiceDrives",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Drives/DiskFront0",
"@odata.type": "#IntelligentMonitoringServiceDrives.v1_0_0.IntelligentMonitoringServiceDrives",
"Id": "DiskFront0",
"LoadUnloadCycles": {
"HistoryDataList": [
{
"Time": "2029-07-27T03:31:51+00:00",
"Value": 30
},
…
{
"Time": "2029-07-30T21:30:33+00:00",
"Value": 30
}
],
"PredictedDataList": [
{
"Time": "2029-07-31T03:30:33+00:00",
"Value": 30
},
{
"Time": "2029-07-31T09:30:33+00:00",
"Value": 30
}
],
"Threshold": 300000
},
"Manufacturer": "Seagate",
"MediaType": "HDD",
"Name": "DiskFront0",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"PowerOnHours": {
"HistoryDataList": null,
"PredictedDataList": null,
"Threshold": null
},
"Protocol": "SAS",
"ReadErrorRate": {
"HistoryDataList": null,
"PredictedDataList": null,
"Threshold": null
},
"ReadTimes": {
"HistoryDataList": null,
"PredictedDataList": null,
"Threshold": null
},
"SerialNumber": "S7K1LSPS",
"StartStopCycles": {
"HistoryDataList": [
{
"Time": "2029-07-27T03:31:51+00:00",
"Value": 99
},
…
{
"Time": "2029-07-30T21:30:33+00:00",
"Value": 99
}
],
"PredictedDataList": [
{
"Time": "2029-07-31T03:30:33+00:00",
"Value": 99
},
{
"Time": "2029-07-31T09:30:33+00:00",
"Value": 99
}
],
"Threshold": 10000
},
"Temperature": {
"HistoryDataList": [
{
"Time": "2029-07-27T03:31:51+00:00",
"Value": 32
},
…
{
"Time": "2029-07-30T21:30:33+00:00",
"Value": 33
}
],
"PredictedDataList": [
{
"Time": "2029-07-31T03:30:33+00:00",
"Value": 33
},
{
"Time": "2029-07-31T09:30:33+00:00",
"Value": 33
}
],
"Threshold": 60
},
"WriteTimes": {
"HistoryDataList": null,
"PredictedDataList": null,
"Threshold": null
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the intelligent monitoring resource model for the drive. |
|
@odata.id |
String |
Link to the intelligent monitoring resource for the drive. |
|
@odata.type |
String |
Type of the intelligent monitoring resource for the drive. |
|
Id |
String |
ID of the intelligent monitoring resource for the drive. |
|
Name |
String |
Name of the intelligent monitoring resource for the drive. |
|
MediaType |
String |
Media type of the physical drive: · HDD |
|
Protocol |
String |
Protocol of the physical drive: · SAS · SATA |
|
SerialNumber |
String |
Serial number of the drive. |
|
Manufacturer |
String |
Drive manufacturer. |
|
PowerOnHours |
Object |
Power-on duration and predictive data of the drive. |
|
StartStopCycles |
Object |
Monitoring and predictive data for the number of power-ons of the drive. |
|
LoadUnloadCycles |
Object |
Monitroing and predictive data for the number of drive loads. |
|
WriteTimes |
Object |
Monitroing and predictive data for the number of drive writes. |
|
ReadTimes |
Object |
Monitroing and predictive data for the number of drive reads. |
|
ReadErrorRate |
Object |
Monitroing and predictive data for drive read error rates. |
|
Temperature |
Object |
Monitroing and predictive data for drive temperature. |
|
Threshold |
Integer |
Threshold. |
|
HistoryDataList |
Array |
Historical monitoring data. |
|
PredictedDataList |
Array |
Predictive data. |
|
Time |
String |
Time for recording the specified data. |
|
Value |
Integer |
Value for the recorded specified data. |
Change history
|
Version |
Change description |
|
HDM2-1.55 |
Modify the interface to be unrestricted by licenses. |
|
HDM2-1.54 |
Added this interface. |
Obtain intelligent monitoring memory resource information
Description
Obtain intelligent monitoring memory resource information.
This resource is licensed and requires authorization through licensing before use.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/IntelligentMonitoringService/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. |
|
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/Oem/Public/IntelligentMonitoringService/ Memory
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#IntelligentMonitoringServiceMemory.IntelligentMonitoringServiceMemory",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/IntelligentMonitoringService/Memory",
"@odata.type": "#IntelligentMonitoringServiceMemory.v1_0_0.IntelligentMonitoringServiceMemory",
"Id": "IntelligentMonitoringServiceMemory",
"Name": "Intelligent Monitoring Service Memory",
"Description": "Intelligent Monitoring Memory Source Getting",
"RepairedMemoryCount":7,
"TotalRepairdCount":132,
"RepairedRecords": [
{
"TimeStamp":"2022-06-08T09:55:43+08:00",
"RepairedCount":3,
"DeviceLocator": "CPU1_CH1_D0",
"SerialNumber": "2B6BAE3E",
"Manufacturer": "Micron",
"Description": "MTR"
"CurrentStatus": "Repaired"
},
...
],
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the intelligent monitoring memory resource. |
|
@odata.id |
String |
Link to the intelligent monitoring memory resource. |
|
@odata.type |
String |
Type of the intelligent monitoring memory resource. |
|
Description |
String |
Description of the intelligent monitoring memory resource. |
|
Id |
String |
ID of the intelligent monitoring memory resource. |
|
Name |
String |
Name of the intelligent monitoring memory resource. |
|
RepairedMemoryCount |
Integer |
Number of repaired memory modules. This field is not supported by AMD models and is displayed as null. |
|
TotalRepairdCount |
Integer |
Total number of repairs This field is not supported by AMD models and is displayed as null. |
|
RepairedRecords |
Array |
Memory repair records. This field is not supported by AMD models and is displayed as []. |
|
TimeStamp |
String |
Repair time. |
|
RepairedCount |
Integer |
Number of repairs. |
|
DeviceLocator |
String |
Memory label. |
|
SerialNumber |
String |
Serial number. |
|
Manufacturer |
String |
Memory manufacturer. |
|
Description |
String |
Repair description: · MRT |
|
CurrentStatus |
String |
Current repair status: · Repaired · Unrepaired |
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added explanations for the RepairedMemoryCount, TotalRepairdCount, and RepairedRecords fields. Retained only the MRT value for the Description field. |
|
HDM2-1.54 |
Added this interface. |
Obtain configuration information about fast OS installation
Description
Obtain configuration information about fast OS installation of the server.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/OSInstallService
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.188/redfish/v1/Managers/1/Oem/Public/OSInstallService
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#OSInstallService.OSInstallService",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/OSInstallService",
"@odata.type": "#OSInstallService.v1_0_0.OSInstallService",
"Description": "OS Install Service",
"Id": "OSInstallService",
"Image": {
"ImageName": "CentOS-8.5.2111-x86_64-dvd1.iso",
"Path": "/data/share",
"ServerAddress": "172.14.81.158",
"ServerType": "nfs",
"UserName": ""
},
"Name": "OS Install Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ServiceEnabled": true,
"ServiceStatus": "Pending"
}
Response code:200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the resource model for the fast OS installation service. |
|
@odata.id |
String |
Link to the resource node for the fast OS installation service. |
|
@odata.type |
String |
Resource type of the fast OS installation service. |
|
Description |
String |
Resource description of the fast OS installation service. |
|
Id |
String |
Resource ID of the fast OS installation service. |
|
Name |
String |
Resource name of the fast OS installation service. |
|
ServiceEnabled |
Boolean |
Enabling status of the service. |
|
ServiceStatus |
String |
Current status of the service: · Initial—Image transfer has not started. · Completed—Image transfer is completed. · Pending—Waiting for image transfer. · Running—Image transfer is in progress. |
|
Image |
Object |
|
|
Image.Path |
String |
Path where the image resides. |
|
Image.ImageName |
String |
Image name. |
|
Image.ServerAddress |
String |
Server address. |
|
Image.ServerType |
String |
Server type, including CIFS and NFS. |
|
Image.UserName |
String |
Username. |
The server returns status code 200 for a successful operation.
Create a fast OS installation configuration service
Description
Create a fast OS installation configuration service.
Privilege module
OemVmm
Request
PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/OSInstallService
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
}
"ServiceEnabled": true,
"Image":{
"Path": path,
"ImageName": imagename,
"ServerAddress": serveraddress,
"ServerType": servertype,
"UserName": username,
"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. |
|
ServiceEnabled |
Boolean |
Enabling status of the service. |
|
Image |
Object |
|
|
Image.Path |
String |
Path where the image resides. |
|
Image.ImageName |
String |
Image name. |
|
Image.ServerAddress |
String |
Server address. |
|
Image.ServerType |
String |
Server type, including CIFS and NFS. |
|
Image.UserName |
String |
Username (only supported by CIFS). |
|
Image.Password |
String |
Password (only supported by CIFS). |
Examples
Method and URL:
PATCH https://192.168.18.188/redfish/v1/Managers/1/Oem/Public/OSInstallService
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
{
"ServiceEnabled":true,
"Image":{
"Path":"/homes",
"ImageName":"rhel-baseos-9.0-x86_64-dvd.iso",
"ServerAddress":"172.14.81.158",
"ServerType":"cifs",
"UserName":"gfy",
"Password":"111111"
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#OSInstallService.OSInstallService",
"@odata.id": "/redfish/v1/Managers/1/Oem/Public/OSInstallService",
"@odata.type": "#OSInstallService.v1_0_0.OSInstallService",
"Description": "OS Install Service",
"Id": "OSInstallService",
"Image": {
"ImageName": "rhel-baseos-9.0-x86_64-dvd.iso",
"Path": "/homes",
"ServerAddress": "172.14.81.158",
"ServerType": "cifs",
"UserName": "gfy"
},
"Name": "OS Install Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ServiceEnabled": true,
"ServiceStatus": "Pending"
}
Response code:200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain configuration information about fast OS installation."
Obtain system diagnosis information
Description
Obtain system diagnosis configuration information.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService
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/DiagnosticService
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/DiagnosticService/$entity",
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService",
"@odata.type": "#DiagnosticService.v1_0_0.DiagnosticService",
"Actions": {
"#DiagnosticService.DeleteScreenShot": {
"target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.DeleteScreenShot"
},
"#DiagnosticService.DeleteVideo": {
"target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.DeleteVideo"
},
"#DiagnosticService.ExportVideo": {
"target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.ExportVideo"
},
"#DiagnosticService.PlayVideo": {
"target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.PlayVideo"
}
},
"DiagnosticDescription": "",
"DiagnosticDeviceList": {
"Memory": "Healthy",
"PCH": "Healthy",
"PCIe": "Healthy",
"PCIeUnderPCH": "Healthy",
"Processor": "Healthy",
"SATAController": "Healthy",
"USB": "Healthy",
"sSATAController": "Healthy",
"tSATAController": "Healthy"
},
"DiagnosticResult": "Failed",
"FDIStartupMode": "Disabled",
"Id": "Diagnostic Configuration Information",
"MiniModeEnabled": true,
"Name": "Diagnostic Configuration Information",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ScreenShot": {
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/ScreenShot"
},
"VideoConfig": {
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/VideoConfig"
},
"Videos": {
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/Videos"
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the diagnosis resource model. |
|
@odata.id |
String |
Link to the diagnosis resource. |
|
@odata.type |
String |
Type of the diagnosis resource. |
|
MiniModeEnabled |
Boolean |
Whether minimum configuration startup is enabled. Options: · true—Enabled. · false—Disabled. |
|
FDIStartupMode |
String |
Whether diagnosis isolation is enabled. Options: · Disabled—Disables diagnosis isolation. · DiagnosticMode—Performs only diagnosis. · FDI—Performs both diagnosis and isolation. |
|
DiagnosticResult |
String |
Diagnosis result: · Success. · Failed. |
|
DiagnosticDeviceList |
Object |
Diagnosis device list. |
|
Processor |
String |
CPU diagnosis result: · Healthy. · Unhealthy. · null—No errors are detected. |
|
Memory |
String |
Memory diagnosis result: · Healthy. · Unhealthy. · null—No errors are detected. |
|
PCIe |
String |
PCIe device diagnosis result for the CPU root port: · Healthy. · Unhealthy. · null—No errors are detected. |
|
PCH |
String |
Device diagnosis result for PCH: · Healthy. · Unhealthy. · null—No errors are detected. |
|
SATAController |
String |
Device diagnosis result for the PCH SATA controller: · Healthy. · Unhealthy. · null—No errors are detected. |
|
sSATAController |
String |
Device diagnosis result for the PCH sSATA controller: · Healthy. · Unhealthy. · null—No errors are detected. |
|
tSATAController |
String |
Device diagnosis result for the PCH tSATA controller: · Healthy. · Unhealthy. · null—No errors are detected. |
|
USB |
String |
USB device diagnosis result: · Healthy. · Unhealthy. · null—No errors are detected. |
|
PCIeUnderPCH |
String |
PCIe device diagnosis result for the PCH root port: · Healthy. · Unhealthy. · null—No errors are detected. |
|
DiagnosticDescription |
String |
Diagnosis description. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the interface. |
Configure system diagnosis settings
Description
Configure system diagnosis settings.
Privilege module
ConfigureComponents
Request
Method and URL:
PATCH https://device_ip/redfish/v1/Managers/manager_id/DiagnosticService
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
{
"MiniModeEnabled":true,
"FDIStartupMode":"Disabled"
}
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. |
|
MiniModeEnabled |
Boolean |
Minimum configuration startup mode. |
|
FDIStartupMode |
String |
Whether diagnosis isolation is enabled. Options: · Disabled—Disables diagnosis isolation. · DiagnosticMode—Performs only diagnosis. · FDI—Performs both diagnosis and isolation. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/Managers/1/DiagnosticService
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
{
"MiniModeEnabled":true,
"FDIStartupMode": "Disabled"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/1/DiagnosticService/$entity",
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService",
"@odata.type": "#DiagnosticService.v1_0_0.DiagnosticService",
"Actions": {
"#DiagnosticService.DeleteScreenShot": {
"target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.DeleteScreenShot"
},
"#DiagnosticService.DeleteVideo": {
"target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.DeleteVideo"
},
"#DiagnosticService.ExportVideo": {
"target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.ExportVideo"
},
"#DiagnosticService.PlayVideo": {
"target": "/redfish/v1/Managers/1/DiagnosticService/Actions/DiagnosticService.PlayVideo"
}
},
"DiagnosticDescription": "",
"DiagnosticDeviceList": {
"Memory": "Healthy",
"PCH": "Healthy",
"PCIe": "Healthy",
"PCIeUnderPCH": "Healthy",
"Processor": "Healthy",
"SATAController": "Healthy",
"USB": "Healthy",
"sSATAController": "Healthy",
"tSATAController": "Healthy"
},
"DiagnosticResult": "Failed",
"FDIStartupMode": "Disabled",
"Id": "Diagnostic Configuration Information",
"MiniModeEnabled": true,
"Name": "Diagnostic Configuration Information",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ScreenShot": {
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/ScreenShot"
},
"VideoConfig": {
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/VideoConfig"
},
"Videos": {
"@odata.id": "/redfish/v1/Managers/1/DiagnosticService/Videos"
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain system diagnosis information."
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the interface. |
Perform node control on a multi-node device
Description
Perform node control on a multi-node device. Only the E3300 G6 supports this task.
Privilege module
OemDiagnosis
Request
Method and URL:
POST
https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.NodeSwitch
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 system resource. |
Only value 1 is supported. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/Managers/<str>/Actions/Oem/<str>/Manager.NodeSwitch/
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Detailed message information. |
|
MessageArgs |
Integer |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
Change history
|
Version |
Change description |
|
HDM2-2.09 |
Added the interface. HDM3 does not support the interface. |
Manually take screen snapshots
Descritpion
Manually take screen snapshots.
Privilege module
ConfigureComponents
Request
Method and URL:
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 system resource. |
Only value 1 is supported. |
Examples
Method and URL:
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Detailed message information. |
|
MessageArgs |
Integer |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM3-1.18 |
Added the interface. Only HDM3 supports the interface. |
Operations on account service resources
Obtain account service information
Description
Obtain information about the account service from the server.
Privilege module
Login
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_7_0.AccountService",
"ADService": {
"@odata.id": "/redfish/v1/AccountService/ADService"
},
"AccountLockoutDuration": 5,
"AccountLockoutThreshold": 5,
"Accounts": {
"@odata.id": "/redfish/v1/AccountService/Accounts"
},
"Actions": {
"Oem": {
"Public": {
"#CertificateService.ImportRootCertificate": {
"#AccountService.ExportWeakPasswordDictionary": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ExportWeakPasswordDictionary"
},
"#AccountService.ImportWeakPasswordDictionary": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ImportWeakPasswordDictionary"
},
"target": "/redfish/v1/AccountService/Actions/Oem/Public/CertificateService.ImportRootCertificate"
},
"#SSHCiphers.BindUser": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.BindUser"
},
"#SSHCiphers.DeleteUser": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.DeleteUser"
},
"#SSHCiphers.ImportSSHCiphers": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.ImportSSHCiphers"
}
"#LDAPService.ImportLDAPCertificate":{
"target":"/redfish/v1/AccountService/Actions/Oem/Public/LDAPService.ImportLDAPCertificate"
}
}
}
},
"Description": "BMC User Accounts",
"Id": "AccountService",
"LDAPService": {
"@odata.id": "/redfish/v1/AccountService/LDAPService"
},
"MaxPasswordLength": 40,
"MinPasswordLength": 8,
"Name": "Account Service",
"Oem": {
"Public": {
"CertificateService": {
"@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService"
},
"CompletionCode": 0,
"RoleNames": {
"@odata.id": "/redfish/v1/AccountService/Roles/Oem/Public/RoleNames"
},
"Description": "Success",
"PasswordRule": {
"PasswordComplexityCheckEnabled": true,
"PasswordValidityDays": 0,
"PreviousPasswordsDisallowedCount": 0,
"WeakPasswordDictionaryEnabled": false
},
"WeakPasswordDictionaryName":"pw_dict_default.txt",
"TwoFactorAuthenticationInformation": {
"OTPServerAddress": "",
"OTPServerPort": 1812,
"OTPServerSharedKey": "",
"TwoFactorAuthenticationStateEnabled": false
}
}
},
"Roles": {
"@odata.id": "/redfish/v1/AccountService/Roles"
},
"SSHCiphers": {
"@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers"
},
"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. |
|
LDAPService |
Object |
Link to the LDAPService 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. |
|
ADService |
Object |
Link to the ADService resource. |
|
Accounts |
Object |
Link to the account resource. |
|
Actions.Oem.Public |
Custom executable actions for the AccountService resource. |
|
|
#CertificateService.ImportRootCertificate |
Object |
Link to the root certificate file import operation. |
|
#SSHCiphers.BindUser |
Object |
Link to the operation of binding a user to an SSH public key. |
|
#SSHCiphers.DeleteUser |
Object |
Link to the operation of unbinding SSH public key from a user. |
|
#SSHCiphers.ImportSSHCiphers |
Object |
Link to the SSH public key import operation. |
|
#LDAPService.ImportLDAPCertificate |
Object |
Import the LDAP CA certificate file. |
|
Oem.Public |
Custom properties of the account service. |
|
|
CertificateService |
Object |
Link to the CertificateService resource. |
|
RoleNames |
Object |
Link to the role configuration resource. |
|
PasswordRule.PasswordComplexityCheckEnabled |
Boolean |
Enabling status of password complexity check. |
|
PasswordRule.PreviousPasswordsDisallowedCount |
Integer |
Disable users from changing the password to one of the specified number of most recent historical passwords. The value range is 0 to 5. 0 indicates no restriction on using historical passwords. |
|
PasswordRule.PasswordValidityDays |
Integer |
Password validity period. |
|
PasswordRule.WeakPasswordDictionaryEnabled |
Boolean |
Enable weak password dictionary. |
|
WeakPasswordDictionaryName |
String |
Name of the weak password dictionary. |
|
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 |
Object |
Link to the Roles resource. |
|
SSHCiphers |
Object |
Link to the SSHCiphers 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 |
|
HDM2-1.59 |
Added the WeakPasswordDictionaryName field. |
|
HDM2-1.57 |
Added the #LDAPService.ImportLDAPCertificate field. |
Edit account service settings
Description
Edit the settings of the account service for the server.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
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:
{
"AccountLockoutDuration": 5,
"AccountLockoutThreshold": 5,
"Oem": {
"Public": {
"PasswordRule": {
"PasswordComplexityCheckEnabled": true,
"PreviousPasswordsDisallowedCount": 5,
"PasswordValidityDays": 15,
"WeakPasswordDictionaryEnabled": false
},
"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. |
|
AccountLockoutDuration |
Integer |
Amount of time before a locked account can be used again. |
|
AccountLockoutThreshold |
Integer |
Number of consecutive login failures that will cause a user account to be locked. Number of incorrect password attempts. If the specified number is exceeded, the user will be locked out. |
|
PassWordRule |
Object |
|
|
PasswordComplexityCheckEnabled |
Boolean |
Enabling status of password complexity check. |
|
PreviousPasswordsDisallowedCount |
Integer |
Disable users from changing the password to one of the specified number of most recent historical passwords. The value range is 0 to 5. 0 indicates no restriction on using historical passwords. |
|
PasswordValidityDays |
Integer |
Password validity period. |
|
WeakPasswordDictionaryEnabled |
Boolean |
Enable weak password dictionary. |
|
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_7_0.AccountService",
"ADService": {
"@odata.id": "/redfish/v1/AccountService/ADService"
},
"AccountLockoutDuration": 5,
"AccountLockoutThreshold": 5,
"Accounts": {
"@odata.id": "/redfish/v1/AccountService/Accounts"
},
"Actions": {
"Oem": {
"Public": {
"#AccountService.ExportWeakPasswordDictionary": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ExportWeakPasswordDictionary"
},
"#AccountService.ImportWeakPasswordDictionary": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ImportWeakPasswordDictionary"
},
"#CertificateService.ImportRootCertificate": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/CertificateService.ImportRootCertificate"
},
"#SSHCiphers.BindUser": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.BindUser"
},
"#SSHCiphers.DeleteUser": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.DeleteUser"
},
"#SSHCiphers.ImportSSHCiphers": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.ImportSSHCiphers"
}
"#LDAPService.ImportLDAPCertificate":{
"target": "/redfish/v1/AccountService/Actions/Oem/Public/LDAPService.ImportLDAPCertificate"
}
}
}
},
"Description": "BMC User Accounts",
"Id": "AccountService",
"LDAPService": {
"@odata.id": "/redfish/v1/AccountService/LDAPService"
},
"MaxPasswordLength": 40,
"MinPasswordLength": 8,
"Name": "Account Service",
"Oem": {
"Public": {
"CertificateService": {
"@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService"
},
"CompletionCode": 0,
"RoleNames": {
"@odata.id": "/redfish/v1/AccountService/Roles/Oem/Public/RoleNames"
},
"Description": "Success",
"PasswordRule": {
"PasswordComplexityCheckEnabled": true,
"PasswordValidityDays": 0,
"PreviousPasswordsDisallowedCount": 0,
"WeakPasswordDictionaryEnabled": false
},
"WeakPasswordDictionaryName":"pw_dict_default.txt",
"TwoFactorAuthenticationInformation": {
"OTPServerAddress": "192.168.1.36",
"OTPServerPort": 1812,
"OTPServerSharedKey": "admin",
"TwoFactorAuthenticationStateEnabled": false
}
}
},
"Roles": {
"@odata.id": "/redfish/v1/AccountService/Roles"
},
"SSHCiphers": {
"@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers"
},
"ServiceEnabled
": true,
"Status": {
"Health": "OK",
"State": "Enabled"
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain account service information."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain user account collection information
Description
Obtain information about all user accounts from the server.
Privilege module
Login
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"
}
],
"Members@odata.count": 2,
"Name": "Accounts Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
Integer |
Number of user accounts. |
|
Members@odata.id |
String |
Link to a user account resource. |
The server returns status code 200 for a successful operation.
Obtain user account information
Description
Obtain information about a specific user account from the server.
Privilege module
Login
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",
"@odata.id": "/redfish/v1/AccountService/Accounts/2",
"@odata.type": "#ManagerAccount.v1_6_0.ManagerAccount",
"Description": "Default Account",
"Enabled": true,
"Id": "2",
"Links": {
"Roles": {
"@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
}
},
"Locked": false,
"Name": "Default Account",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"IPMIEnable": true,
"SnmpEncryptPwdInit": true,
"SnmpV3AccessPermission": "read_only",
"SnmpV3AuthProtocol": "SHA",
"SnmpV3Enable": false,
"SnmpV3Password": null,
"SnmpV3PrivProtocol": "DES",
"WebEnable": true,
"DefaultPasswordModifyPolicy":"NotModify"
}
},
"Password": null,
"RoleId": "Administrator",
"UserName": "admin"
}
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.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.SnmpEncryptPwdInit |
Boolean |
Specifies whether the SNMP encryption password is set separately. Value true indicates that the encryption password is set separately, and value false indicates that the encryption password is not set separately. |
|
Oem.Public.SnmpV3Password |
String |
SNMPv3 encryption password. This field always displays null. |
|
Oem.Public.SnmpV3AccessPermission |
String |
SNMPv3 access privilege. Supported options: · read_only. · read_write. When the Oem.Public.SnmpV3Enable field is set to false, this field returns read_only by default. |
|
Oem.Public.SnmpV3AuthProtocol |
String |
SNMPv3 authentication algorithm. Supported options: · SHA. · MD5. · SHA256. · SHA384. · SHA512. When the Oem.Public.SnmpV3Enable field is set to false, this field returns SHA by default. |
|
Oem.Public.SnmpV3PrivProtocol |
String |
SNMPv3 encryption algorithm. Supported options: · DES. · AES. · AES192. · AES256. When the Oem.Public.SnmpV3Enable field is set to false, this field returns DES by default. |
|
Oem.Public.DefaultPasswordModifyPolicy |
String |
Default password change policy. Supported options: · NotModify. · ForcedModify. · Optional. |
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 |
|
HDM2-2.04 HDM3-2.03 |
Added the Oem.Public.DefaultPasswordModifyPolicy field. |
Add a user account
Description
Add user accounts to the server.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
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,
"Id": userid,
"RoleId": role,
"Locked": false,
"Oem": {
"Public": {
"RSAEncryptionEnabled": true,
"IPMIEnable": true,
"WebEnable": true,
"SnmpV3Enable": true,
"SnmpV3AccessPermission": "read_only",
"SnmpV3AuthProtocol": "SHA",
"SnmpV3PrivProtocol": "DES",
"SnmpV3Password": snmpv3password,
"DefaultPasswordModifyPolicy":"NotModify"
}
}
}
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. Up to 32 characters are supported. |
|
Id |
(Optional.) User sequence number. The value range is 1 to 16. The specified ID cannot be the same as an existing ID. |
String. |
|
RSAEncryptionEnabled |
Whether to support RSA encryption. This field is available only when you set a password on the webpage. |
Boolean. |
|
Password |
Password. Up to 40 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. When the RoleId field is Administrator or Operator, this field can only be set to true. |
|
Oem.Public.WebEnable |
Enable or disable the Web extended privilege. |
Boolean. When the RoleId field is Administrator or Operator, this field can only be set to true. |
|
Oem.Public.SnmpV3Enable |
Enable or disable SNMPv3 |
Boolean. |
|
Oem.Public.SnmpV3AccessPermission |
SNMPv3 access privilege. |
String. Supported options: · read_only. · read_write. |
|
Oem.Public.SnmpV3Password |
Snmpv3 encryption password. |
String. Up to 40 characters. |
|
Oem.Public.SnmpV3AuthProtocol |
SNMPv3 authentication algorithm. |
String. Supported options: · SHA. · MD5. · SHA256. · SHA384. · SHA512.. |
|
Oem.Public.SnmpV3PrivProtocol |
SNMPv3 encryption algorithm. |
String. Supported options: · DES. · AES. · AES192. · AES256.. Encryption algorithms AES192 and AES256 can only be used in combination with authentication algorithms SHA256, SHA384, or SHA512. |
|
Oem.Public.DefaultPasswordModifyPolicy |
String |
Default password change policy. Supported options: · NotModify. · ForcedModify. · Optional. |
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",
"Id":"3",
"RoleId": "Administrator",
"Locked": false,
"Oem": {
"Public": {
"IPMIEnable": true,
"WebEnable": true,
"SnmpV3Enable": false,
"SnmpV3AccessPermission": "read_only",
"SnmpV3AuthProtocol": "SHA",
"SnmpV3PrivProtocol": "DES"
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount",
"@odata.id": "/redfish/v1/AccountService/Accounts/2",
"@odata.type": "#ManagerAccount.v1_6_0.ManagerAccount",
"Description": "Default Account",
"Enabled": true,
"Id": "3",
"Links": {
"Roles": {
"@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
}
},
"Locked": false,
"Name": "Default Account",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"IPMIEnable": true,
"SnmpEncryptPwdInit": false,
"SnmpV3AccessPermission": "read_only",
"SnmpV3AuthProtocol": "SHA",
"SnmpV3Enable": false,
"SnmpV3Password": null,
"SnmpV3PrivProtocol": "DES",
"WebEnable": true,
"DefaultPasswordModifyPolicy":"NotModify"
}
},
"Password": null,
"RoleId": "Administrator",
"UserName": "User123"
}
Response code: 201
Response field description
The server returns status code 201 for a successful operation.
For information about the response fields, see "Obtain user account information."
Change history
|
Version |
Change description |
|
HDM2-2.04 HDM3-2.03 |
Added the Oem.Public.DefaultPasswordModifyPolicy field. |
|
HDM2-2.02 |
The length of the value for the UserName field changes from 16 characters to 32 characters. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
|
HDM2-1.19 |
Deleted the restrictions of supported characters for an SNMPv3 encryption password. |
|
HDM2-1.18 |
Changed the Id field to be optional. |
|
HDM2-1.14 |
Removed the description table for the response fields. For more information, see "Obtain user account information." |
Edit user account settings
Description
Edit the settings of a specific user account.
Privilege module
ConfigureUsers/ConfigureSelf
Locking type of the associated system
BMC configuration locking (except when users configure passwords)
Request
Method and URL:
PATCH https://device_ip/redfish/v1/AccountService/Accounts/userid
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": {
"RSAEncryptionEnabled": true,
"IPMIEnable": true,
"WebEnable": true,
"SnmpV3Enable": true,
"SnmpV3AccessPermission": "read_only",
"SnmpV3Password": snmpv3password,
"SnmpV3AuthProtocol": "SHA",
"SnmpV3PrivProtocol": "DES",
"DefaultPasswordModifyPolicy":"NotModify"
}
}
}
Parameters
|
Parameter |
Description |
Value |
|
device_ip |
IP address for logging in to the device. |
IPv4 or IPv6 address. |
|
userid |
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. Up to 32 characters. |
String. |
|
RSAEncryptionEnabled |
Whether to support RSA encryption. This field is available only when you set a password on the webpage. |
Boolean |
|
Password |
Password. Up to 40 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.SnmpV3Password |
SNMPv3 encryption password. |
String. Up to 40 characters. |
|
Oem.Public.SnmpV3AuthProtocol |
SNMPv3 authentication algorithm. |
String. Supported options: · SHA. · MD5. · SHA256. · SHA384. · SHA512. |
|
Oem.Public.SnmpV3PrivProtocol |
SNMPv3 encryption algorithm. |
String. Supported options: · DES. · AES. · AES192. · AES256. Encryption algorithms AES192 and AES256 can only be used in combination with authentication algorithms SHA256, SHA384, or SHA512. |
|
Oem.Public.DefaultPasswordModifyPolicy |
String |
Default password change policy. Supported options: · NotModify. · ForcedModify. · Optional. |
Usage guidelines
Non-administrator users can edit only their own passwords and their modification of other fields will not take effect.
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",
"SnmpV3Password": "Password@_",
"SnmpV3AuthProtocol": "SHA",
"SnmpV3PrivProtocol": "DES"
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount",
"@odata.id": "/redfish/v1/AccountService/Accounts/1",
"@odata.type": "#ManagerAccount.v1_6_0.ManagerAccount",
"Description": "Default Account",
"Enabled": true,
"Id": "3",
"Links": {
"Roles": {
"@odata.id": "/redfish/v1/AccountService/Accounts/1"
}
},
"Locked": false,
"Name": "Default Account",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"IPMIEnable": true,
"SnmpEncryptPwdInit": true,
"SnmpV3AccessPermission": "read_only",
"SnmpV3AuthProtocol": "SHA",
"SnmpV3Enable": true,
"SnmpV3Password": null,
"SnmpV3PrivProtocol": "DES",
"WebEnable": true,
"DefaultPasswordModifyPolicy":"NotModify"
}
},
"Password": null,
"RoleId": "User",
"UserName": "User123"
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain user account information."
Change history
|
Version |
Change description |
|
HDM2-2.04 HDM3-2.03 |
Added the Oem.Public.DefaultPasswordModifyPolicy field. |
|
HDM2-2.02 |
The length of the value for the UserName field changes from 16 characters to 32 characters. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
|
HDM2-1.19 |
Deleted the restrictions of supported characters for an SNMPv3 encryption password. |
Delete a user account
Description
Delete a specific user account from the server.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
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:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "The account was successfully removed.",
"MessageArgs": [],
"MessageId": "Base.1.8.1.AccountRemoved",
"MessageSeverity": "OK",
"Resolution": "No resolution is required."
}
],
"code":"Base.1.8.1.AccountRemoved",
"message":"The account was successfully removed."
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain role collection information
Description
Obtain information about all roles from the server.
Privilege module
Login
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"
}
],
"Members@odata.count": 9,
"Name": "Roles Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
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
Login
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 resource 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/Operator
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/Operator",
"@odata.type": "#Role.v1_3_0.Role",
"AssignedPrivileges": [
"ConfigureComponents",
"Login",
"ConfigureSelf"
],
"Description": "Operator User Role",
"Id": "Operator",
"IsPredefined": true,
"Name": "User Role",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"OemPrivileges": [
"OemKvm",
"OemVmm",
"OemSecurityMgmt",
"OemPowerControl",
"OemSystemAudit"
]
}
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. If no custom privileges are specified, [] is displayed. Supported options: · OemKvm. · OemVmm. · OemSecurityMgmt. · OemPowerControl. · OemDiagnosis. · OemSystemAudit. |
The server returns status code 200 for a successful operation.
Edit role settings
Description
Edit the settings for a specific role.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
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",
"OemSystemAudit"
]
}
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 resource 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. |
|
AssignedPrivileges |
Array |
Supported options: · ConfigureSelf. · ConfigureComponents. |
|
OemPrivileges.OemKvm |
Array |
Supported options: · OemKvm. · OemVmm. · OemSecurityMgmt. · OemPowerControl. · OemDiagnosis. · OemSystemAudit. |
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",
"OemSystemAudit"
]
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#Role.Role(*)",
"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole1",
"@odata.type": "#Role.v1_3_0.Role",
"AssignedPrivileges": [
"ConfigureComponents",
"Login",
"ConfigureSelf"
],
"Description": "CustomRole1 User Role",
"Id": "CustomRole1",
"IsPredefined": true,
"Name": "User Role",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"OemPrivileges": [
"OemKvm",
"OemVmm",
"OemSecurityMgmt",
"OemPowerControl",
"OemDiagnosis",
"OemSystemAudit"
]
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain role information."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain role names
Description
Obtain role names from the server.
Privilege module
Login
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#RoleNames.RoleNames",
"@odata.id": "/redfish/v1/AccountService/Roles/Oem/Public/RoleNames",
"@odata.type": "#RoleNames.v1_0_0.RoleNames",
"Administrator": "Administrator",
"CustomRole1Name": "CustomRole1",
"CustomRole2Name": "CustomRole2",
"CustomRole3Name": "CustomRole3",
"CustomRole4Name": "CustomRole4",
"CustomRole5Name": "CustomRole5",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"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. |
|
Administrator |
String |
Administrator. |
|
Operator |
String |
Operator. |
|
User |
String |
User. |
Edit a role name
Description
Edit the name of a specific role.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
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/redfish/v1/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#RoleNames.RoleNames",
"@odata.id": "/redfish/v1/AccountService/Roles/Oem/Public/RoleNames",
"@odata.type": "#RoleNames.v1_0_0.RoleNames",
"Administrator": "Administrator",
"CustomRole1Name": "abc",
"CustomRole2Name": "123",
"CustomRole3Name": "zxc",
"CustomRole4Name": "h3c",
"CustomRole5Name": "vbn",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"Operator": "Operator",
"User": "User"
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain role names."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain the LDAP service resource
Description
Obtain the LDAP service resource.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/LDAPService
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/LDAPService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService",
"@odata.id": "/redfish/v1/AccountService/LDAPService",
"@odata.type": "#LDAPService.v1_0_0.LDAPService",
"BindDN": "",
"BindPassword": null,
"CertificateName":"",
"CertificateVerificationEnabled": false,
"CertificateVerificationLevel":"Demand",
"CommonNameType": "IP",
"Id": "LDAPService",
"LDAPControllers": {
"@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers"
},
"LDAPPort": 389,
"LDAPServerAddress": "",
"LDAPServiceEnabled": false,
"Name": "LDAP Controller Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SSLEncryptionEnabled": false,
"UserDomain": "",
"UserIdentification": "cn"
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the LDAP service resource. |
|
@odata.id |
String |
Link to the LDAP service resource. |
|
@odata.type |
String |
Type of the LDAP service resource. |
|
LDAPServiceEnabled |
Boolean |
Enabling status of the LDAP service. |
|
LDAPControllers |
Object |
Domain controller collection. @odata.id: Link to domain controller collection. |
|
CommonNameType |
String |
Common name type. Only IP and FQDN are supported in the current software version. |
|
LDAPServerAddress |
String |
Server address. |
|
LDAPPort |
Integer |
Port number. |
|
BindDN |
String |
LDAP proxy user identifier. Up to 255 characters. |
|
BindPassword |
String |
LDAP proxy user authentication password. Up to 48 characters. |
|
SSLEncryptionEnabled |
Boolean |
Encryption type. Value false indicates no encryption, and value true indicates SSL encryption. |
|
UserDomain |
String |
User domain for the domain controller. Up to 255 characters. |
|
UserIdentification |
String |
User login attribute. Currently supports only cn and uid. |
|
CertificateVerificationEnabled |
Boolean |
Whether LDAP certificate authentication is enabled. |
|
CertificateVerificationLevel |
String |
LDAP certificate authentication level: · Demand—Not allows login when authentication fails, · Allow—Allows continuing login when authentication fails. |
|
CertificateName |
String |
LDAP certificate name. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the CertificateVerificationEnabled, CertificateVerificationLevel, and CertificateName fields. |
Edit the LDAP service resource
Description
Edit the LDAP service resource.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/AccountService/LDAPService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"LDAPServiceEnabled": true,
"SSLEncryptionEnabled": false,
"CommonNameType": "IP",
"LDAPServerAddress": "192.168.1.2",
"LDAPPort": 635,
"BindDN": "cn=Manager,dc=example,dc=com",
"BindPassword": "test123",
"UserDomain": "cn=Manager,dc=example,dc=com",
"UserIdentification": "cn",
"CertificateVerificationEnabled":true,
"CertificateVerificationLevel":"Allow",
"Oem":{
"Public":{
"RSAEncryptionEnabled": 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. |
|
LDAPServiceEnabled |
Enabling status of the LDAP service. |
Boolean. |
|
CommonNameType |
Common name type. |
String. |
|
LDAPServerAddress |
Server address. |
String. |
|
LDAPPort |
Port number. |
Integer. |
|
BindDN |
LDAP proxy user identifier. |
String. |
|
BindPassword |
LDAP proxy user authentication password. |
String. |
|
SSLEncryptionEnabled |
Encryption type. Value false indicates no encryption, and value true indicates SSL encryption. |
Boolean. |
|
UserDomain |
User domain of the domain controller. |
String. |
|
UserIdentification |
User login attribute. |
String. |
|
CertificateVerificationEnabled |
Whether LDAP certificate authentication is enabled. |
Boolean. |
|
CertificateVerificationLevel |
LDAP certificate authentication level. |
String. |
|
Oem.Public.RSAEncryptionEnabled |
Support for RSA encryption. This field is available only for setting passwords on the webpage. |
Boolean. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/AccountService/LDAPService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"
Request body:
{
"LDAPServiceEnabled": true
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService",
"@odata.id": "/redfish/v1/AccountService/LDAPService",
"@odata.type": "#LDAPService.v1_0_0.LDAPService",
"BindDN": "",
"BindPassword": null,
"CertificateName":"",
"CertificateVerificationEnabled": false,
"CertificateVerificationLevel":"Demand",
"CommonNameType": "IP",
"Id": "LDAPService",
"LDAPControllers": {
"@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers"
},
"LDAPPort": 389,
"LDAPServerAddress": "",
"LDAPServiceEnabled": true,
"Name": "LDAP Controller Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"SSLEncryptionEnabled": false,
"UserDomain": "",
"UserIdentification": "cn"
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain the LDAP service resource."
Change history
|
Version |
Change description |
|
HDM2-1.57 |
Added the CertificateVerificationEnabled and CertificateVerificationLevel fields. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
|
HDM2-1.14 |
Removed the redundant SSLEncryptionEnabled field. |
Import an LDAP CA certificate
Description
Import an LDAP CA certificate.
Privilege module
ConfigureUsers
Request
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
· Local import:
Use this interface after transferring the file to the /tmp/web/ directory. For more information, see "Upload BMC file."
{
"Type":"URI",
"Content": "/tmp/web/filename"
}
· Remote import:
¡ CIFS or SFTP:
{
"Type":"URI",
"Content":"cifs://username:password@ip/filename"
}
¡ HTTP, TFTP, NFS, or HTTPS:
{
"Type":"URI",
"Content":"http://ip/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. |
|
type |
LDAP CA certificate import method. |
URI: Local or remote certificate URI. |
|
Content |
Import path. |
See "Others." |
Examples
Method and URL:
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"@odata.context":"/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id":"/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the task service for importing the LDAP CA certificate file. |
|
@odata.type |
String |
Type of the task service for importing the LDAP CA certificate file. |
|
@odata.id |
String |
Link to the task service for importing the LDAP CA certificate file. |
|
String |
Task link generated by importing the LDAP CA certificate file. |
|
|
Integer |
Number of task links generated by importing LDAP CA certificate files. |
|
|
Name |
String |
Name of the task service for importing the LDAP CA certificate file. |
The server returns status code 202 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.57 |
Added this interface. |
Obtain LDAP domain controller collection resource
Description
Obtain the LDAP domain controller collection resource.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/LDAPService/LDAPControllers
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/LDAPService/LDAPControllers
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService/LDAPControllers/$entity",
"@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers",
"@odata.type": "#LDAPControllersCollection.LDAPControllersCollection",
"Members": [
{
"@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers/1"
}
],
"Members@odata.count": 3,
"Name": "LDAP Controller Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the LDAP domain controller collection resource. |
|
@odata.id |
String |
Link to the LDAP domain controller collection resource. |
|
@odata.type |
String |
Type of the LDAP domain controller collection resource. |
|
Name |
String |
Name of the LDAP domain controller collection resource. |
|
Members |
Array |
LDAP domain controller resource list. |
|
Members@odata.count |
Integer |
Number of LDAP domain controllers. |
The server returns status code 200 for a successful operation.
Obtain the user collection resource in an LDAP domain
Description
Obtain the user collection resource in an LDAP domain.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/LDAPService/LDAPControllers/controllers_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. |
|
controllers_id |
ID of the LDAP controller. |
Only value 1 is supported. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/AccountService/LDAPService/LDAPControllers/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService/LDAPControllers/1/$entity",
"@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers/1",
"@odata.type": "#LdapGroupsCollection.LdapGroupsCollection",
"Id": "1",
"Members": [
{
"@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers/1/1"
}
],
"Members@odata.count": 1,
"Name": "LDAP Groups Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the user collection resource. |
|
@odata.id |
String |
Link to the user collection resource in an LDAP domain. |
|
@odata.type |
String |
Type of the user collection resource in an LDAP domain. |
|
Members |
Object |
LDAP domain user group. |
|
Members@odata.count |
String |
Number of LDAP domain users. |
The server returns status code 200 for a successful operation.
Obtain a single user resource in an LDAP domain
Description
Obtain a single user resource in an LDAP domain.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/LDAPService/LDAPControllers/controllers_id/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. |
|
controllers_id |
ID of the LDAP controller. |
Only value 1 is supported. |
|
user_id |
User ID. |
You can obtain user IDs from an LDAP domain user collection resource. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/AccountService/LDAPService/LDAPControllers/1/3
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService/LDAPControllers/1/1$entity",
"@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers/1/3",
"@odata.type": "#LDAPControllers.v1_0_0.LDAPControllers",
"Description": "LDAP Group Instance",
"GroupName": "test",
"GroupRole": "Administrator",
"Id": "3",
"Name":"LDAPGroupInstance",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RoleGroupDomain": "cn=Manager,dc=example"
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the LDAP domain single user resource. |
|
@odata.id |
String |
Link to the LDAP domain single user resource. |
|
@odata.type |
String |
Type of the user resource in an LDAP domain. |
|
Name |
String |
Name of the user resource in an LDAP domain. |
|
Description |
String |
Description of the user resource in an LDAP domain. |
|
GroupName |
String |
User group name. |
|
RoleGroupDomain |
String |
User group domain. |
|
GroupRole |
String |
User group role. |
|
Id |
String |
Domain user group ID. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.15 |
Added the Name field and changed field MemberId to Id. |
Add an LDAP domain user group
Description
Add a user group in an LDAP domain.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/AccountService/LDAPService/LDAPControllers/controllers_id
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id": "3",
"GroupName": "test",
"RoleGroupDomain": "cn=Manager,dc=example",
"GroupRole": "Administrator"
}
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. |
|
controllers_id |
ID of the LDAP controller. |
Only value 1 is supported. |
|
Id |
User group ID. |
String. |
|
GroupName |
User group name. Up to 255 characters are supported. |
String. |
|
RoleGroupDomain |
User group domain. Up to 255 characters are supported. |
String. |
|
GroupRole |
User group ID. Up to 64 characters are supported. |
String. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/AccountService/LDAPService/LDAPControllers/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id": "1",
"GroupName": "test",
"RoleGroupDomain": "cn=Manager,dc=example",
"GroupRole": "Administrator"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService/LDAPControllers/1/1$entity",
"@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers/1/1",
"@odata.type": "#LDAPControllers.v1_0_0.LDAPControllers",
"Description": "LDAP Group Instance",
"GroupName": "test",
"GroupRole": "Administrator",
"Id": "1",
"Name":"LDAPGroupInstance",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RoleGroupDomain": "cn=Manager,dc=example"
}
Response code: 201
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain a single user resource in an LDAP domain."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Edit an LDAP domain user group resource
Description
Edit an LDAP domain user group resource.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/AccountService/LDAPService/LDAPControllers/controllers_id/user_id
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"GroupName": "test",
"RoleGroupDomain": "cn=Manager,dc=example",
"GroupRole": "Operator"
}
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. |
|
controllers_id |
ID of the LDAP controller. |
Only value 1 is supported. |
|
user_id |
LDAP domain user group ID to be modified. |
Integer. |
|
GroupName |
User group name. Up to 255 characters are supported. |
String. |
|
RoleGroupDomain |
User group domain. Up to 255 characters are supported. |
String. |
|
GroupRole |
User group role. Up to 64 characters are supported. |
String. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/AccountService/LDAPService/LDAPControllers/1/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"
Request body:
{
"GroupName": "test",
"RoleGroupDomain": "cn=Manager,dc=example",
"GroupRole": "Administrator"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/LDAPService/LDAPControllers/1/1$entity",
"@odata.id": "/redfish/v1/AccountService/LDAPService/LDAPControllers/1/1",
"@odata.type": "#LDAPControllers.v1_0_0.LDAPControllers",
"Description": "LDAP Group Instance",
"GroupName": "test",
"GroupRole": "Administrator",
"Id": "1",
"Name":"LDAPGroupInstance",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RoleGroupDomain": "cn=Manager,dc=example"
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain a single user resource in an LDAP domain."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
|
HDM2-1.14 |
Changed LDAP domain user ID to be modified to LDAP domain user group ID to be modified. |
Delete a user group resource in an LDAP domain
Description
Delete a user group resource in an LDAP domain.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
DELETE https://device_ip/redfish/v1/AccountService/LDAPService/LDAPControllers/controllers_id/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. |
|
controllers_id |
ID of the LDAP controller. |
Only value 1 is supported. |
|
user_id |
ID of the LDAP domain user group to be deleted. |
Integer. |
Examples
Method and URL:
DELETE https://192.168.18.18/redfish/v1/AccountService/LDAPService/LDAPControllers/1/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "The account was successfully removed.",
"MessageArgs": [],
"MessageId": "Base.1.8.1.AccountRemoved",
"MessageSeverity": "OK",
"Resolution": "No resolution is required."
}
],
"code":"Base.1.8.1.AccountRemoved",
"message":"The account was successfully removed."
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
|
HDM2-1.14 |
Changed LDAP domain user ID to be deleted to LDAP domain user group ID to be deleted. |
Obtain the AD service resource
Description
Obtain the AD service resources.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/ADService
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/ADService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/ADService",
"@odata.id": "/redfish/v1/AccountService/ADService",
"@odata.type": "#ADService.v1_0_0.ADService",
"ADControllers": {
"@odata.id": "/redfish/v1/AccountService/ADService/ADControllers"
},
"ADServiceEnabled": false,
"DomainControllerAddress1": "",
"DomainControllerAddress2": "",
"DomainControllerAddress3": "",
"Id": "ADService",
"Name": "AD Controller Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"Password": null,
"UserDomain": "",
"UserName": ""
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the AD service resource. |
|
@odata.id |
String |
Link to the AD service resource. |
|
@odata.type |
String |
Type of the AD service resource. |
|
ADServiceEnabled |
Boolean |
Enable status. |
|
UserName |
String |
Confidential username. Up to 64 characters are supported. |
|
Password |
String |
Confidential user password. Up to 96 characters are supported. |
|
UserDomain |
String |
Confidential user domain name. Up to 255 characters are supported. |
|
DomainControllerAddress1 |
String |
AD domain controller server address 1. |
|
DomainControllerAddress2 |
String |
AD domain controller server address 2. |
|
DomainControllerAddress3 |
String |
AD domain controller server address 3. |
|
ADControllers |
Object |
AD domain controller collection: @odata.id: Link to the domain controller collection. |
The server returns status code 200 for a successful operation.
Edit the AD service resource
Description
Edit the AD service resources.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/AccountService/ADService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"ADServiceEnabled": false,
"UserName": "test",
"Password": "PassWord@_",
"UserDomain": "cn=Manager,dc=example,dc=com",
"DomainControllerAddress1": "192.168.1.2",
"DomainControllerAddress2": "192.168.1.3",
"DomainControllerAddress3": "192.168.1.4",
"Oem":{
"Public":{
"RSAEncryptionEnabled": 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. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/AccountService/ADService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"
Request body:
{
"ADServiceEnabled": false,
"UserName": "test",
"Password": "PassWord@_",
"UserDomain": "cn=Manager,dc=example,dc=com",
"DomainControllerAddress1": "192.168.1.2",
"DomainControllerAddress2": "192.168.1.3",
"DomainControllerAddress3": "192.168.1.4"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/ADService",
"@odata.id": "/redfish/v1/AccountService/ADService",
"@odata.type": "#ADService.v1_0_0.ADService",
"ADControllers": {
"@odata.id": "/redfish/v1/AccountService/ADService/ADControllers"
},
"ADServiceEnabled": false,
"DomainControllerAddress1": "192.168.1.2",
"DomainControllerAddress2": "192.168.1.3",
"DomainControllerAddress3": "192.168.1.4",
"Id": "ADService",
"Name": "AD Controller Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"Password": null,
"UserDomain": "cn=Manager,dc=example,dc=com",
"UserName": "test"
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain the AD service resource."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain AD domain controller collection resource
Description
Obtain the AD domain controller collection resource.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/ADService/ADControllers
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/ADService/ADControllers
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/ADService/ADControllers/$entity",
"@odata.id": "/redfish/v1/AccountService/ADService/ADControllers",
"@odata.type": "#ADControllersCollection.ADControllersCollection",
"Members": [
{
"@odata.id": "/redfish/v1/AccountService/ADService/ADControllers/1"
}
],
"Members@odata.count": 1,
"Name": "AD Controller Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the AD domain controller collection resource.. |
|
@odata.id |
String |
Link to the AD domain controller collection resource. |
|
@odata.type |
String |
Type of the AD domain controller collection resource. |
|
Name |
String |
Name of the AD domain controller collection resource. |
|
Members |
Object |
AD domain controller object. |
|
Members@odata.count |
Integer |
Number of AD domain controllers. |
The server returns status code 200 for a successful operation.
Obtain the user collection resource in an AD domain
Description
Obtain the user collection resource in an AD domain.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/ADService/ADControllers/controllers_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. |
|
controllers_id |
ID of the AD controller. |
Only value 1 is supported. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/AccountService/ADService/ADControllers/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/ADService/ADControllers/1/$entity",
"@odata.id": "/redfish/v1/AccountService/ADService/ADControllers/1",
"@odata.type": "#AdGroupsCollection.v1_0_0.AdGroupsCollection",
"Id": "1",
"Members": [
{
"@odata.id": "/redfish/v1/AccountService/ADService/ADControllers/1/1"
}
……
],
"Members@odata.count": 3,
"Name": "AD Groups Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the AD domain user collection resource. |
|
@odata.id |
String |
Link to the AD domain user collection resource. |
|
@odata.type |
String |
Type of the AD domain user collection resource. |
|
Members |
Array |
AD user group. |
|
Members@odata.count |
String |
Number of AD domain users. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.14 |
Changed LDAP to AD in the response. |
Obtain a single user resource in an AD domain
Description
Obtain a single user resource in an AD domain.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/ADService/ADControllers/controllers_id/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. |
|
controllers_id |
ID of the AD controller. |
Only value 1 is supported. |
|
user_id |
ID of the user in the AD domain. |
Integer. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/AccountService/ADService/ADControllers/1/3
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/ADService/ADControllers/1/1$entity",
"@odata.id": "/redfish/v1/AccountService/ADService/ADControllers/1/3",
"@odata.type": "#ADControllers.v1_0_0.ADControllers",
"Description": "AD Group Instance",
"GroupName": "test",
"GroupRole": "Administrator",
"Id": "3",
"Name": "ADGroupInstance",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RoleGroupDomain": "qwert.cn"
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the single user resource in the specified AD domain. |
|
@odata.id |
String |
Link to the single user resource in the specified AD domain. |
|
@odata.type |
String |
Type of the single user resource in the specified AD domain. |
|
Name |
String |
Name of the single user resource in the specified AD domain. |
|
Description |
String |
Description of the single user resource in the specified AD domain. |
|
GroupName |
String |
User group name. |
|
RoleGroupDomain |
String |
User group domain. |
|
GroupRole |
String |
User group role. |
|
Id |
String |
User group number. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.14 |
Changed MemberId field to Id field. |
Add an AD domain user group
Description
Add a user group in an AD domain.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/AccountService/ADService/ADControllers/controllers_id
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id": "3",
"GroupName": "yfq",
"RoleGroupDomain": "qwert.cn",
"GroupRole": "Administrator"
}
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. |
|
controllers_id |
ID of the AD controller. |
Integer. Only value 1 is supported. |
|
Id |
User group ID. |
String. |
|
GroupName |
User group name. Up to 255 characters are supported. |
String. |
|
RoleGroupDomain |
User group domain. Up to 255 characters are supported. |
String. |
|
GroupRole |
User group role. The value range is obtained from the interface for obtaining role names. |
String. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/AccountService/ADService/ADControllers/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id": "1",
"GroupName": "test",
"RoleGroupDomain": "qwert.cn",
"GroupRole": "Administrator"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/ADService/ADControllers/1/1$entity",
"@odata.id": "/redfish/v1/AccountService/ADService/ADControllers/1/1",
"@odata.type": "#ADControllers.v1_0_0.ADControllers",
"Description": "AD Group Instance",
"GroupName": "test",
"GroupRole": "Administrator",
"Id": "1",
"Name": "ADGroupInstance",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RoleGroupDomain": "qwert.cn"
}
Response code: 201
Response field description
The server returns status code 201 for a successful operation.
For information about the response fields, see "Obtain a single user resource in an AD domain."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Edit a user group resource in an AD domain
Description
Edit the information of a user group resource in an AD domain.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/AccountService/ADService/ADControllers/controllers_id/user_id
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"GroupName": "test",
"RoleGroupDomain": "CN=qwert,OU=admin,DC=huawei,DC=com",
"GroupRole": "Administrator"
}
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. |
|
controllers_id |
ID of the AD controller. |
Only value 1 is supported. |
|
user_id |
ID of the AD domain user group to be modified. |
Integer. |
|
GroupName |
User group name. Up to 255 characters are supported. |
String. |
|
RoleGroupDomain |
User group domain. Up to 255 characters are supported. |
String. |
|
GroupRole |
User group role. The value range is obtained from the interface for obtaining role names. |
String. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/AccountService/ADService/ADControllers/1/3
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"
Request body:
{
"GroupName": "test",
"RoleGroupDomain": "qwert.cn",
"GroupRole": "Administrator"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/ADService/ADControllers/1/1$entity",
"@odata.id": "/redfish/v1/AccountService/ADService/ADControllers/1/1",
"@odata.type": "#ADControllers.v1_0_0.ADControllers",
"Description": "AD Group Instance",
"GroupName": "test",
"GroupRole": "Administrator",
"Id": "3",
"Name": "ADGroupInstance",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RoleGroupDomain": "qwert.cn"
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain a single user resource in an AD domain."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
|
HDM2-1.14 |
Changed the description of the user_id field to ID of the AD domain user group to be modified. |
Delete a user group resource in an AD domain
Description
Delete a user group resource in an AD domain.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
DELETE https://device_ip/redfish/v1/AccountService/ADService/ADControllers/controllers_id/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. |
|
controllers_id |
ID of the AD controller. |
Only value 1 is supported. |
|
user_id |
ID of the AD domain user group to be deleted. |
Integer. |
Examples
Method and URL:
DELETE https://192.168.18.18/redfish/v1/AccountService/ADService/ADControllers/1/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "The account was successfully removed.",
"MessageArgs": [],
"MessageId": "Base.1.8.1.AccountRemoved",
"MessageSeverity": "OK",
"Resolution": "No resolution is required."
}
],
"code":"Base.1.8.1.AccountRemoved",
"message":"The account was successfully removed."
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the error message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
|
HDM2-1.14 |
Changed the user_id field to ID of the AD domain user group to be deleted. |
Obtain user certificate management service information
Description
Obtain user certificate management service information.
This interface is not available for X18000 products.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService
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/Oem/Public/CertificateService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService",
"@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService",
"@odata.type": "#CertificateService.v1_0_0.CertificateService",
"Name": "Account CertificateService",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"Accounts": {
"@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/Accounts"
},
"RevokeCheck": false,
"RootCertificate": {
"@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate"
},
"RootCertificateId": "",
"ServiceEnabled": false
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the user certificate management service resource model. |
|
@odata.id |
String |
Link to the user certificate management service resource. |
|
@odata.type |
String |
Type of the user certificate management service resource |
|
ServiceEnabled |
Boolean |
Whether the user certificate management service is enabled. Supported options: · false—Disabled. · true—Enabled. |
|
RootCertificate |
Object |
Obtain the list of root certificates. |
|
RevokeCheck |
Boolean |
Whether certificate revocation check is enabled. Supported options: · false—Disabled. · true—Enabled. |
|
RootCertificateId |
String |
ID of the root certificate that is enabled. |
|
Accounts |
Object |
Obtain the list of users that can be bound to the client certificate. |
The server returns status code 200 for a successful operation.
Set certificate management service information
Description
Set certificate management service information.
This interface is not available for X18000 products.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
PATCH https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"ServiceEnabled": true,
"RevokeCheck":true,
"RootCertificateId":"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. |
|
ServiceEnabled |
Enable or disable the certificate. |
Supported options: · false—Disabled. · true—Enabled. |
|
RevokeCheck |
Enable or disable the certificate revocation check. |
Supported options: · false—Disabled. · true—Enabled. |
|
RootCertificateId |
ID of the root certificate that is enabled. |
String. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"ServiceEnabled": true,
"RevokeCheck":true,
"RootCertificateId":"1"
}
Response:
{
"@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService",
"@odata.id":"/redfish/v1/AccountService/Oem/Public/CertificateService",
"@odata.type":"#CertificateService.v1_0_0.CertificateService",
"Name":"Account CertificateService",
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
},
"Accounts":{
"@odata.id":"/redfish/v1/AccountService/Oem/Public/CertificateService/Accounts"
},
"RevokeCheck":true,
"RootCertificate":{
"@odata.id":"/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate"
},
"RootCertificateId":"1",
"ServiceEnabled":true
}
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 user certificate management service information."
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain user root certificate list
Description
Obtain the user root certificate list.
This interface is not available for X18000 products.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate
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/Oem/Public/CertificateService/RootCertificate
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService/RootCertificate",
"@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate",
"@odata.type": "#RootCertificateCollection.RootCertificateCollection",
"Members": [
{
"@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1"
}
],
"Members@odata.count": 1,
"Name": "RootCertificate Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the user root certificate list resource model. |
|
@odata.id |
String |
Link to the user root certificate list resource. |
|
@odata.type |
String |
Type of the user root certificate list resource. |
|
Name |
String |
Name of the root certificate resource. |
|
Members |
Array |
Obtain root certificates. |
|
Members@odata.count |
Integer |
Number of root certificates. |
The server returns status code 200 for a successful operation.
Obtain information of a specific root certificate
Description
Obtain information of a specific root certificate
This interface is not available for X18000 products.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/rootcertificate_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. |
|
rootcertificate_id |
Root certificate ID. |
You can obtain it from the root certificate list. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService/RootCertificate",
"@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1",
"@odata.type": "#Certificate.v1_2_0.Certificate",
"Actions": {
"#CertificateService.ImportClientCertificate": {
"@odata.id": "/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/1/CertificateService.ImportClientCertificate"
}
},
"CertificateType": "PEM",
"CertificateUsageType": "Web",
"ClientCertificate": {
"@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate"
},
"FileName": "ca.crt",
"Issuer": "emailAddress=111@a.com,CN=root,OU=bmc,O=h3c,L=hangzhou,ST=zhejiang,C=CN",
"Name": "Root Certificate",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RootCertificateEnabled": false,
"RootCertificateId": "1",
"SerialNumber": "2CE5197635DA354AF219FD4E36130CBE12D0C83F",
"Subject": "emailAddress=111@a.com,CN=root,OU=bmc,O=h3c,L=hangzhou,ST=zhejiang,C=CN",
"ValidityDays": "2022-12-24T09:43:13+08:00"
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the root certificate information resource model. |
|
@odata.id |
String |
Link to the root certificate information resource. |
|
@odata.type |
String |
Type of the root certificate information resource. |
|
RootCertificateId |
String |
Root certificate number. |
|
SerialNumber |
String |
Root certificate serial number. |
|
Issuer |
String |
Root certificate user. |
|
ValidityDays |
String |
Root certificate expiration date. |
|
Subject |
String |
Root certificate issuer. |
|
FileName |
String |
Root certificate file name. |
|
Actions#CertificateService.ImportClientCertificate |
Object |
Link to client certificate import. |
|
RootCertificateEnabled |
Boolean |
Enable or disable the root certificate. |
The server returns status code 200 for a successful operation.
Import a root certificate file
Description
Import a root certificate file.
This interface is not available for X18000 products.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/CertificateService.ImportRootCertificate
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
· Local import:
Use this interface after transferring the file to the /tmp/web/ directory. For more information, see "Upload BMC file."
{
"Type":"URI",
"Content": "/tmp/web/filename"
}
· Remote import:
¡ CIFS or SFTP:
{
"Type":"URI",
"Content":"cifs://username:password@ip/filename"
}
¡ HTTP, TFTP, NFS, or HTTPS:
{
"Type":"URI",
"Content":"http://ip/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. |
|
type |
Client certificate import method. |
URI: Local or remote certificate URI. |
|
Content |
Link for the import. |
See "Others." |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/CertificateService.ImportRootCertificate
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Type": "URI",
"Content":"sftp://y17057:y17057@192.168.170.57/ca.crt"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the root certificate file import task service. |
|
@odata.type |
String |
Type of the root certificate file import task service. |
|
@odata.id |
String |
Link to the root certificate file import task service. |
|
Members@odata.id |
String |
Task link generated by importing the root certificate file. |
|
Members@odata.count |
Integer |
Number of task links generated by importing root certificate files. |
|
Name |
String |
Name of the root certificate file import task service. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the root certificate file import task service. |
The server returns status code 202 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Delete a root certificate file
Description
Delete a root certificate file.
This interface is not available for X18000 products.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
DELETE https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/rootcertificate_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. |
|
rootcertificate_id |
ID of the root certificate. |
You can obtain it from the root certificate list. |
Examples
Method and URL:
DELETE https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain the client certificate list bound to a root certificate
Description
Obtain the client certificate list information bound to the specified root certificate.
This interface is not available for X18000 products.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/rootcertificate_id/ClientCertificate
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. |
|
rootcertificate_id |
ID of the root certificate. |
You can obtain it from the root certificate list. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate",
"@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate",
"@odata.type": "#ClientCertificateCollection.ClientCertificateCollection",
"Members": [
{
"@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1"
}
……
],
"Members@odata.count": 2,
"Name": "ClientCertificate Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of client certificate resources bound to the root certificate. |
|
@odata.id |
String |
Link to the client certificate resources bound to the root certificate. |
|
@odata.type |
String |
Type of the client certificate resources bound to the root certificate. |
|
Members |
Array or object |
Link to obtain client certificate information. |
|
Members@odata.count |
String |
Number of client certificates. |
The server returns status code 200 for a successful operation.
Import a client certificate file
Description
Import a client certificate file.
This interface is not available for X18000 products.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/rootcertificate_id/CertificateService.ImportClientCertificate
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
· Local import:
Use this interface after transferring the file to the /tmp/web/ directory. For more information, see "Upload BMC file."
{
"Type":"URI",
"Content": "/tmp/web/filename"
}
· Remote import:
¡ CIFS or SFTP:
{
"Type":"URI",
"Content":"cifs://username:password@ip/filename"
}
¡ HTTP, TFTP, NFS, or HTTPS:
{
"Type":"URI",
"Content":"http://ip/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. |
|
rootcertificate_id |
ID of the root certificate. |
You can obtain it from the root certificate list. |
|
type |
Client certificate import method. |
URI: Local or remote certificate URI. |
|
Content |
Link for the import. |
See "Others." |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/1/CertificateService.ImportClientCertificate
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Type": "URI",
"Content":"sftp://y17057:y17057@192.168.170.57/client.crt"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the client certificate import task service. |
|
@odata.type |
String |
Type of the client certificate import task service. |
|
@odata.id |
String |
Link to the client certificate import task service. |
|
Members@odata.id |
Array or object |
Link to obtain client certificate information. |
|
Members@odata.count |
String |
Number of task links generated by importing client certificates. |
|
Name |
String |
Name of the client certificate import task service. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the client certificate import task service. |
The server returns status code 202 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain information of a client certificate
Description
Obtain information of a specific client certificate.
This interface is not available for X18000 products.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/rootcertificate_id/ClientCertificate/clientcertificate_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. |
|
rootcertificate_id |
ID of the root certificate. |
You can obtain it from the user root certificate list. |
|
clientcertificate_id |
ID of the client certificate. |
You can obtain it from the client certificate list bound to the specified root certificate. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1",
"@odata.id": "/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1",
"@odata.type": "#ClientCertificateInstance.v1_0_0.ClientCertificateInstance",
"Actions": {
"#CertificateService.BindUser": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1/CertificateService.BindUser"
},
"#CertificateService.DeleteUser": {
"target": "/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1/CertificateService.DeleteUser"
}
},
"FileName": "client.crt",
"Fingerprint": "84:53:A3:28:0D:56:83:FC:4A:9F:39:83:73:68:09:7C:E0:70:0C:03",
"Id": "1",
"Name": "ClientCertificate 1",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RoleId": "Administrator",
"UserId": "1",
"UserName": "anonymous"
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the specific client certificate information resource. |
|
@odata.type |
String |
Type of the specific client certificate information resource. |
|
@odata.id |
String |
Link to the specific client certificate information resource. |
|
FileName |
String |
Client certificate filename. |
|
FingerPrint |
String |
Client certificate fingerprint. |
|
UserName |
String |
Username of the user bound to the client certificate. |
|
RoleId |
String |
User privilege name of the user bound to the client certificate. |
The server returns status code 200 for a successful operation.
Delete a client certificate
Description
Delete a client certificate.
This interface is not available for X18000 products.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
DELETE https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/rootcertificate_id/ ClientCertificate/clientcertificate_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. |
|
rootcertificate_id |
ID of the root certificate. |
You can obtain it from the user root certificate list. |
|
clientcertificate_id |
ID for client certificate. |
You can obtain from the client certificate list bound to the specified root certificate. |
Examples
Method and URL:
DELETE https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain the user list bindable to a client certificate
Description
Obtain the user list that can be bound to the client certificate.
This interface is not available for X18000 products.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/Oem/Public/CertificateService/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. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/CertificateService/Accounts
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context":
"/redfish/v1/$metadata#AccountService/Oem/Public/CertificateService/Accounts",
"@odata.id":"/redfish/v1/AccountService/Oem/Public/CertificateService/Accounts",
"@odata.type": "#CertificateService.v1_0_0.CertificateService",
"Name": "Account CertificateService",
"Members":[{
"Id":"2",
"UserName":"test1",
"RoleId":"Administrator",
},
{
"Id":"3",
"UserName":"test2",
"RoleId":"User",
},
] ,
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Date type |
Description |
|
@odata.context |
String |
OData description of the user list resource bindable to the client certificate. |
|
@odata.type |
String |
Type of the user list resource bindable to the client certificate. |
|
@odata.id |
String |
Link to the user list resource bindable to the client certificate. |
|
Members |
object |
Users bindable to the client certificate. |
|
Members.Id |
String |
User ID. |
|
Members.UserName |
String |
Username. |
|
Members.RoleId |
String |
User role. |
The server returns status code 200 for a successful operation.
Bind a user to a client certificate
Description
Bind a user to a client certificate
This interface is not available for X18000 products.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/rootcertificate_id/ClientCertificate/clientcertificate_id/CertificateService.BindUser
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id":"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. |
|
rootcertificate_id |
Root certificate ID. |
String. |
|
clientcertificate_id |
Client certificate ID. |
String. |
|
Id |
User ID. |
String. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1/CertificateService.BindUser
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id":"2"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Unbind a client certificate from a user
Description
Unbind a client certificate from a user.
This interface is not available for X18000 products.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/rootcertificate_id/ClientCertificate/clientcertificate_id/CertificateService.DeleteUser
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id":"2"
}
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. |
|
rootcertificate_id |
Root certificate ID. |
String. |
|
clientcertificate_id |
Client certificate ID. |
String. |
|
Id |
User ID. |
String. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/CertificateService/RootCertificate/1/ClientCertificate/1/CertificateService.DeleteUser
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id":"2"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain SSH public key list information
Description
Obtain SSH public key list information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/Oem/Public/SSHCiphers
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/Oem/Public/SSHCiphers
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Managers/1/Oem/Public/SSHCiphers",
"@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers",
"@odata.type": "#SSHCiphersCollection.SSHCiphersCollection",
"Members": [
{
"@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers/1"
}
],
"Accounts": {
"@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers/Accounts"
},
"Members@odata.count": 1,
"Name": "SSHCiphers Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the SSH public key information resource. |
|
@odata.id |
String |
Link to the SSH public key information resource. |
|
@odata.type |
String |
Type of the SSH public key information resource. |
|
Members |
Array |
Link to the SSH key information resource. |
|
Members@odata.count |
Integer |
Number of SSH keys. |
|
Accounts |
Object |
You can obtain the list of users that can be bound to the SSH public key. |
The server returns status code 200 for a successful operation.
Obtain information of an SSH public key
Description
Obtain the information of an SSH public key.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/Oem/Public/SSHCiphers/SSHCiphers_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. |
|
SSHCiphers_id |
SSH public key ID. |
You can obtain SSH public key IDs from the interface for obtaining the SSH public key list information. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/SSHCiphers/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#Managers/1/Oem/Public/SSHCiphers/1",
"@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers/1",
"@odata.type": "#SSHCiphers.v1_0_0.SSHCiphers",
"FileName": "pubkey.pem",
"Fingerprint": "44:b0:0a:86:0d:a6:3b:d8:3c:ca:46:65:6b:ae:55:dd",
"Id": "1",
"Name": "SSHCiphers Instance",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"Users":[
{
"Id":"2",
"UserName":"test",
"RoleId":"User"
},
{
"Id":"3",
"UserName":"test",
"RoleId":"User"
},
……
]
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the SSH public key information resource. |
|
@odata.id |
String |
Link to the SSH public key information resource. |
|
@odata.type |
String |
Type of the SSH public key information resource. |
|
UserName |
String |
Username. |
|
Id |
String |
User ID. |
|
RoleId |
String |
User permissions. |
|
FileName |
String |
Public key file name. |
|
Fingerprint |
String |
Public key fingerprint. |
The server returns status code 200 for a successful operation.
Import SSH public keys
Description
Import SSH public keys.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.ImportSSHCiphers
Request body:
· Local import:
{ "Type":"URI", "Content": "/tmp/filename" }
· Remote import:
{ "Type":"URI", "Content": "sftp://username:password@10.10.10.191/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. |
|
type |
Client certificate import method. |
URI: Local or remote certificate URI. |
|
value |
Import content. |
Supported options: · Link to the remote certificate. The available file transfer protocols include SFTP, HTTPS, HTTP, NFS, CIFS, and TFTP. · Link to the local certificate. · The meaning of the value field is indicated by the type field. |
|
Content |
Link for the import. |
See "Others." |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.ImportSSHCiphers
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Type": "URI",
"Content":"sftp://y17057:y17057@192.168.170.57/cacert.pem"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/1"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData descriptionof the import SSH public key task service. |
|
@odata.type |
String |
Type of the import SSH public key task service. |
|
@odata.id |
String |
Link to the import SSH public key task service. |
|
Members@odata.id |
String |
Task link generated by the SSH public key import. |
|
Name |
String |
Name of the import SSH public key task service. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID for the import SSH public key task service. |
The server returns status code 202 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Delete an SSH public key
Description
Delete an SSH public key.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
DELETE https://device_ip/redfish/v1/AccountService/Oem/Public/SSHCiphers/SSHCiphers_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. |
|
SSHCiphers _id |
SSH public key ID. |
You can obtain SSH public key IDs from the SSH public key list information. |
Examples
Method and URL:
DELETE https://192.168.18.18/redfish/v1/AccountService/Oem/Public/SSHCiphers/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain the list of SSH public key-bindable users
Description
Obtain the list of users that can be bound to SSH public keys.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/AccountService/Oem/Public/SSHCiphers/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. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/SSHCiphers/Accounts
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/SSHCiphers/Accounts",
"@odata.id": "/redfish/v1/AccountService/Oem/Public/SSHCiphers/Accounts",
"@odata.type": "#SSHCiphers.v1_0_0.SSHCiphers",
"Members": [
{
"Id": "1",
"RoleId": "Administrator",
"UserName": "anonymous"
},
{
"Id": "2",
"RoleId": "Administrator",
"UserName": "test"
}
],
"Name": "SSHCiphers Accounts",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the SSH public key-bindable user list resource. |
|
@odata.id |
String |
Link to the SSH public key-bindable user list resource. |
|
@odata.type |
String |
Type of the SSH public key-bindable user list resource. |
|
Members |
Object |
Users that can be bound to the client. |
|
Members.Id |
String |
User ID. |
|
Members.UserName |
String |
Username. |
|
Members.RoleId |
String |
User role. |
The server returns status code 200 for a successful operation.
Bind an SSH public key to a user
Description
Bind an SSH public key to a user.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.BindUser
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id":"3",
"SSHCiphersId":"2"
}
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 |
User ID. |
You can obtain available user IDs from the user list information query. |
|
SSHCiphersId |
Public key ID. |
You can obtain available public key IDs from the SSH public key list information. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.BindUser
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id":"3",
"SSHCiphersId":"2"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Unbind an SSH public key from a user
Description
Unbind an SSH public key from a user.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.DeleteUser
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id":"3",
"SSHCiphersId":"2"
}
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 |
User ID. |
String. |
|
SSHCiphersId |
SSH public key ID. |
String. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/SSHCiphers/SSHCiphers.DeleteUser
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id":"3",
"SSHCiphersId":"2"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Import a weak password dictionary
Description
Import a weak password dictionary.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ImportWeakPasswordDictionary
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
BMC file system import:
{
"Type":"URI",
"Content": "/tmp/web/filename"
}
Remote import:
· CIFS or SFTP:
{
"Type":"URI",
"Content":"cifs://username:password@ip/filename"
}
· TFTP, NFS, HTTP, or HTTPS:
{
"Type":"URI",
"Content":"nfs://ip/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. |
|
Type |
URI. |
String. |
|
Content |
Link to the file. |
· File transfer protocols: SFTP, HTTPS, HTTP, NFS, CIFS, and TFTP. · Link to the operation, not supporting Chinese characters. · Up to 1024 characters, not supporting Chinese characters. Supported special characters include @!$^&()_+.;[]{}-=~` · Only the /tmp/web/ directory and its subdirectories are supported locally. · The total length of the TFTP protocol directory and file name is up to 240 characters. · Only the .txt file type is supported. · The imported file size cannot exceed 10K. The weak password length of a line cannot exceed 40 characters. The file content supports link breaks, uppercase and lowercase letters, digits, spaces, and special characters `~!@#$%^&*()_+-=[]{}|;':",./<>? Characters that do not comply with the rules or exceed the length limit will be formatted and trimmed. The file content after the format cannot be empty. · The file name length cannot exceed 255 characters. |
Examples
Method and URL:
POST
https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ImportWeakPasswordDictionary
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Type":"URI",
"Content": "nfs://192.168.20.177/Share1/weakpw.txt"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the weak password dictionary import task service. |
|
@odata.type |
String |
Type of the weak password dictionary import task service. |
|
@odata.id |
String |
Link to the weak password dictionary import task service. |
|
Members@odata.id |
Object |
Task link generated by importing the weak password dictionary. |
|
Name |
String |
Name of the weak password dictionary import task service. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the weak password dictionary import task service. |
The server returns status code 202 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Export a weak password dictionary
Description
Export the weak password dictionary.
Privilege module
ConfigureUsers
Request
Method and URL:
POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ExportWeakPasswordDictionary
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
BMC file system export:
{
"Type":"URI",
"Content": "/tmp/web/filename"
}
Remote export:
· CIFS or SFTP:
{
"Type":"URI",
"Content":"cifs://username:password@ip/filename"
}
· TFTP or NFS:
{
"Type":"URI",
"Content":"nfs://ip/filename"
}
¡ HTTP or HTTPS:
{
"Type":"URI",
"Content":"http://ip/filename",
"ScriptName":"1.php"
}
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. |
|
Type |
String. |
URI. |
|
Content |
Link to the file. |
· File transfer protocols: SFTP, HTTPS, HTTP, NFS, CIFS, and TFTP. · Link to the operation, not supporting Chinese characters. · Up to 1024 characters, not supporting Chinese characters. Supported special characters include @!$^&()_+.;[]{}-=~` · Only the /tmp/web/ directory and its subdirectories are supported locally. · The total length of the TFTP protocol directory and file name is up to 240 characters. · Only the .txt file type is supported. · The exported file size cannot exceed 10K. The weak password length of a line cannot exceed 40 characters. The file content supports link breaks, uppercase and lowercase letters, digits, spaces, and special characters `~!@#$%^&*()_+-=[]\{}|;':",./<>? Characters that do not comply with the rules or exceed the length limit will be formatted and trimmed. The file content after the format cannot be empty. · The file name length cannot exceed 255 characters. |
|
ScriptName |
Export script file over HTTP/HTTPS. |
String. |
Examples
Method and URL:
POST
https://192.168.18.18/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ExportWeakPasswordDictionary
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Type":"URI",
"Content": "nfs://192.168.20.177/Share1/weakpw.txt"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the weak password dictionary export task service. |
|
@odata.type |
String |
Type of the weak password dictionary export task service. |
|
@odata.id |
String |
Link to the weak password dictionary export task service. |
|
Members@odata.id |
Object |
Task link generated by exporting the weak password dictionary. |
|
Oem.Public.TaskUniqueID |
String |
Unique ID of the weak password dictionary export task service. |
The server returns status code 202 for a successful operation.
Obtain the Kerberos service resource
Description
Obtain the Kerberos service resource.
This resource is licensed and requires authorization through licensing before use.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService
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/Oem/Public/KerberosService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService",
"@odata.id": "/redfish/v1/AccountService/Oem/Public/KerberosService",
"@odata.type": "#Kerberos.v1_0_0.Kerberos",
"Id": "KerberosService",
"KerberosControllers": {
"@odata.id": "/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers"
},
"Name": "Kerberos Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ServiceEnabled": false
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the Kerberos service resource. |
|
@odata.id |
String |
Link to the Kerberos resource node. |
|
@odata.type |
String |
Type of the Kerberos resource. |
|
Name |
String |
Name of the Kerberos resource. |
|
Id |
String |
Kerberos resource ID. |
|
KerberosControllers |
Object |
Kerberos realm controller collection: @odata.id: Link to the realm controller collection. |
|
ServiceEnabled |
Boolean |
Whether the Kerberos service is enabled. |
The server returns status code 200 for a successful operation.
Edit the Kerberos service resource
Description
Edit the Kerberos service resource.
This resource is licensed and requires authorization through licensing before use.
Privilege module
ConfigureUsers
Request
PATCH https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"ServiceEnabled": 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. |
|
ServiceEnabled |
Boolean |
Whether the Kerberos service is enabled. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/AccountService/Oem/Public/KerberosService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"ServiceEnabled": true
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService",
"@odata.id": "/redfish/v1/AccountService/Oem/Public/KerberosService",
"@odata.type": "#Kerberos.v1_0_0.Kerberos",
"Id": "KerberosService",
"KerberosControllers": {
"@odata.id": "/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers"
},
"Name": "Kerberos Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"ServiceEnabled": true
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain the Kerberos service resource."
Obtain the Kerberos collection resource
Description
Obtain the Kerberos collection resource
This resource is licensed and requires authorization through licensing before use.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers
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/Oem/Public/KerberosService/KerberosControllers
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService/KerberosControllers/$entity",
"@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers",
"@odata.type":"#KerberosCollection.KerberosCollection",
"Members":[
{
"@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1"
}
],
"Members@odata.count":1,
"Name":"Kerberos Controller Collection",
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the Kerberos collection resource. |
|
@odata.id |
String |
Link to the Kerberos collection resource. |
|
@odata.type |
String |
Type of the Kerberos collection resource. |
|
Name |
String |
Name of the Kerberos collection resource. |
|
Members |
Object |
Kerberos collection object. |
|
Members@odata.count |
Integer |
Number of Kerberos collection members. |
The server returns status code 200 for a successful operation.
Obtain the user group collection resource in a Kerberos controller
Description
Obtain the user group collection resource in a Kerberos controller
This resource is licensed and requires authorization through licensing before use.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/controllers_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. |
|
controllers_id |
Kerberos controller ID. |
Only value 1 is supported. |
Examples
Method and URL:
GET https://192.168.18.1/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService/KerberosControllers/1/$entity",
"@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1",
"@odata.type":"#KerberosGroupsCollection.v1_0_0.KerberosGroupsCollection",
"Id":"1",
"Members":[
{
"@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1"
}
],
"Members@odata.count":1,
"Name":"Kerberos Groups Collection",
"ServerAddress":"192.168.1.199",
"Port":88,
"Realm":"IT.SOFTWARE.COM",
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the Kerberos user group collection resource. |
|
@odata.id |
String |
Link to the Kerberos user group collection resource. |
|
@odata.type |
String |
Type of the Kerberos user group collection resource. |
|
Members |
Array |
Kerberos user groups. |
|
Members@odata.count |
String |
Number of Kerberos user groups. |
|
ServerAddress |
String |
Address of the realm controller, which can be an IPv4 or IPv6 address or a domain name. |
|
Port |
Integer |
Port number of the realm control, in the range of 1 to 65535. Default: 88. |
|
Realm |
String |
Realm of the realm controller. The realm name must be in uppercase. |
The server returns status code 200 for a successful operation.
Edit the user group collection resource in a Kerberos controller
Description
Edit the user group collection resource in a Kerberos controller
This resource is licensed and requires authorization through licensing before use.
Privilege module
ConfigureUsers
Request
PATCH https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/controllers_id
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"ServerAddress":"device_ip",
"Port": port,
"Realm": Realm
}
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. |
|
controllers_id |
Kerberos controller ID. |
Only value 1 is supported. |
|
ServerAddress |
Address of the realm controller, which can be an IPv4 or IPv6 address or a domain name. |
String. |
|
Port |
Port number of the realm control, in the range of 1 to 65535. Default: 88. |
Integer. |
|
Realm |
Realm of the realm controller. The realm name must be in uppercase. |
String. |
|
Content |
Path to the keytab file. |
String. |
Examples
Method and URL:
PATCH https://192.168.18.1/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"ServerAddress":"192.168.1.199",
"Port":88,
"Realm":"IT.SOFTWARE.COM"
}
Response:
{
"@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService/KerberosControllers/1/$entity",
"@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1",
"@odata.type":"#KerberosGroupsCollection.v1_0_0.KerberosGroupsCollection",
"Id":"1",
"Members":[
{
"@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1"
}
],
"Members@odata.count":1,
"Name":"Kerberos Groups Collection",
"ServerAddress":"192.168.1.199",
"Port":88,
"Realm":"IT.SOFTWARE.COM",
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain the user group collection resource in a Kerberos controller."
Upload a keytab file
Description
Upload a keytab file.
This resource is licensed and requires authorization through licensing before use.
Privilege module
ConfigureUsers
Request
POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/KerberosService/KerberosControllers/controllers_id/KerberosControllers.ImportKeytab
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
· Local import:
Use this interface after transferring the file to the /tmp/web/ directory. For more information, see "Upload BMC file."
{
"Type":"URI",
"Content":"/tmp/web/Kerberos.keytab"
}
· Remote import:
¡ CIFS or SFTP:
{
"Type":"URI",
"Content":"cifs://username:password@ip/filename"
}
¡ HTTP, TFTP, NFS, or HTTPS:
{
"Type":"URI",
"Content":"http://ip/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. |
|
controllers_id |
Kerberos controller ID. |
Only value 1 is supported. |
|
Type |
Keytab file upload method. |
URI |
|
Content |
See "Others." |
String |
Examples
Method and URL:
POST https://192.168.18.1/redfish/v1/AccountService/Actions/Oem/Public/KerberosService/KerberosControllers/1/KerberosControllers.ImportKeytab
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Type":"URI",
"Content":"/tmp/web/Kerberos.keytab"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/3"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1508470554
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the task service for uploading the keytab file. |
|
@odata.type |
String |
Type of the task service for uploading the keytab file. |
|
@odata.id |
String |
Link to the task service for uploading the keytab file. |
|
Members@odata.id |
String |
Task link generated by uploading the keytab file. |
The server returns status code 202 for a successful operation.
Add a Kerberos user group
Description
Add a user group in a Kerberos controller.
This resource is licensed and requires authorization through licensing before use.
Privilege module
ConfigureUsers
Request
POST https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/controllers_id
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id":"3",
"GroupName":"test",
"GroupSID":SID,
"GroupRole":"Administrator"
}
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. |
|
controllers_id |
Kerberos controller ID. |
Only value 1 is supported. |
|
Id |
User group ID. |
Integer. |
|
GroupName |
User group name. |
String. |
|
GroupSID |
User group SID. |
String. |
|
GroupRole |
User group role. You can obtain the value range for the group role by using the interface for obtaining role names. |
String |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id":"1",
"GroupName":"test",
"GroupSID":"S-1-5-21-174651825-3639122879-2784557100-1105",
"GroupRole":"Administrator"
}
Response:
{
"@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService/KerberosControllers/1/1$entity",
"@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1",
"@odata.type":"#KerberosControllers.v1_0_0.KerberosControllers",
"Description":"Kerberos Groups Instance",
"GroupName":"test",
"GroupRole":"Administrator",
"GroupSID":"S-1-5-21-174651825-3639122879-2784557100-1105",
"Id":"1",
"Name":"Kerberos Controller Collection",
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
}
}
Response code: 201
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the Kerberos user group resource. |
|
@odata.id |
String |
Link to the Kerberos user group resource. |
|
@odata.type |
String |
Type of the Kerberos user group resource. |
|
Id |
String |
User group ID. |
|
Name |
String |
Name of the Kerberos user group resource. |
|
Description |
String |
Description for the Kerberos user group. |
|
GroupName |
String |
User group name. |
|
GroupRole |
String |
User group role. |
|
GroupSID |
String |
User group SID. |
The server returns status code 201 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.62 |
Deleted the Only admin is supported description in the GroupRole feld. |
|
HDM2-1.58 |
Added IdDescription and updated Name and @odata.typeDescription. |
|
HDM2-1.57 |
Deleted the description of not supporting SID. |
Obtain a user group resource from a Kerberos controller
Description
Obtain a user group resource in a Kerberos controller.
This resource is licensed and requires authorization through licensing before use.
Privilege module
Login
Request
GET https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/controllers_id/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. |
|
controllers_id |
Kerberos controller ID. |
Only value 1 is supported. |
|
user_id |
ID of the Kerberos user group. |
Integer. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService/KerberosControllers/1/1$entity",
"@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1",
"@odata.type":"#KerberosControllers.v1_0_0.KerberosControllers",
"Description":"Kerberos Groups Instance",
"GroupName":"test",
"GroupRole":"Administrator",
"GroupSID":"S-1-5-21-174651825-3639122879-2784557100-1105",
"Id":"1",
"Name":"Kerberos Controller Instance",
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the Kerberos user group resource. |
|
@odata.id |
String |
Link to the Kerberos user group resource. |
|
@odata.type |
String |
Type of the Kerberos user group resource. |
|
Id |
String |
User group ID. |
|
Name |
String |
Name of the Kerberos user group resource. |
|
Description |
String |
Description for the Kerberos user group. |
|
GroupName |
String |
User group name. |
|
GroupRole |
String |
User group role. |
|
GroupSID |
String |
User group SID. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.62 |
Deleted the Only admin is supported description in the GroupRole feld. |
|
HDM2-1.58 |
Added IdDescription, and updated Name and @odata.typeDescription. |
|
HDM2-1.57 |
Deleted the description of not supporting SID. |
Edit a user group resource in a Kerberos controller
Description
Edit a user group resource in a Kerberos controller.
This resource is licensed and requires authorization through licensing before use.
Privilege module
ConfigureUsers
Request
PATCH https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/controllers_id/user_id
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"GroupName":"test",
"GroupSID":SID,
"GroupRole":"Administrator"
}
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. |
|
controllers_id |
Kerberos controller ID. |
Only value 1 is supported. |
|
user_id |
ID of the Kerberos user group to be edited. |
Integer. |
|
GroupName |
User group name. |
String. |
|
GroupRole |
User group role. |
String. |
|
GroupSID |
User group SID. |
String. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"
Request body:
{
"GroupName":"test",
"GroupSID":"S-1-5-21-174651825-3639122879-2784557100-1105",
"GroupRole":"Administrator"
}
Response:
{
"@odata.context":"/redfish/v1/$metadata#AccountService/Oem/Public/KerberosService/KerberosControllers/1/1$entity",
"@odata.id":"/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1",
"@odata.type":"#KerberosControllers.v1_0_0.KerberosControllers",
"Description":"Kerberos Groups Instance",
"GroupName":"test",
"GroupRole":"Administrator",
"GroupSID":"S-1-5-21-174651825-3639122879-2784557100-1105",
"Id":"1",
"Name":"Kerberos Controller Collection",
"Oem":{
"Public":{
"CompletionCode":0,
"Description":"Success"
}
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain a user group resource from a Kerberos controller."
Change history
|
Version |
Change description |
|
HDM2-1.62 |
Deleted the Only admin is supported description in the GroupRole feld. |
|
HDM2-1.57 |
Deleted the description of not supporting SID. |
Delete a Kerberos user group resource
Description
Delete a Kerberos user group resource.
This resource is licensed and requires authorization through licensing before use.
Privilege module
ConfigureUsers
Request
DELETE https://device_ip/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/controllers_id/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. |
|
controllers_id |
Kerberos controller ID. |
Only value 1 is supported. |
|
user_id |
ID of the Kerberos user group to be deleted. |
Integer. |
Examples
Method and URL:
DELETE https://192.168.18.18/redfish/v1/AccountService/Oem/Public/KerberosService/KerberosControllers/1/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "The account was successfully removed.",
"MessageArgs": [],
"MessageId": "Base.1.8.1.AccountRemoved",
"MessageSeverity": "OK",
"Resolution": "No resolution is required."
}
],
"code":"Base.1.8.1.AccountRemoved",
"message":"The account was successfully removed."
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Operations on session service resources
Create a Redfish session
Description
Create a session on the server.
Privilege module
Login
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. |
|
UserName |
Username for creating the session. |
HDM user, in plain text. |
|
password |
Password for creating the session. |
Password of the HDM user, in plain text. The password length is 2 to 40 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 20 sessions, and only HTTPS is supported. If both HTTP and HTTPS are enabled, POST requests to create sessions via the HTTP port must be redirected to the HTTPS port.
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/SessionService/Sessions
Request header:
Content-Type:application/json
Request body:
{
"UserName":"name",
"Password":"password"
}
Response:
{
"@odata.context": "/redfish/v1/$metadataSessionService/Sessions",
"@odata.id": "/redfish/v1/SessionService/Sessions/tHNeZ7O293bnX0k2XVBOpnlOCmKElCQd",
"@odata.type": "#Session.v1_3_0.Session",
"ClientOriginIPAddress": "192.168.44.56",
"Description": "Session Service",
"Id": "tHNeZ7O293bnX0k2XVBOpnlOCmKElCQd",
"Name": "admin Session",
"Oem": {
"Public": {
"AssignedPrivileges": [
"ConfigureUsers",
"ConfigureComponents",
"Login",
"ConfigureSelf"
],
"DefaultPasswordModifyPolicy":"NotModify",
"CompletionCode": 0,
"Description": "Success",
"IPMIEnable": true,
"LockTimeSeconds": 0,
"LoginTime": "2017-08-31T07:43:23+08:00",
"OemPrivileges": [
"OemKvm",
"OemVmm",
"OemSecurityMgmt",
"OemPowerControl",
"OemDiagnosis",
"OemSystemAudit"
],
"PasswordExpired": false,
"PasswordModify": true,
"PasswordRemainingSeconds": 0,
"PasswordValidityDays": 0,
"PrivilegeIndex": "1023",
"SessionId": "4",
"UserRole": "Administrator",
"UserType": "LocalUser",
"WebEnable": true,
"X-Auth-Token": "kkdVRFYCaYxqNhrSK5uYd9dbEoCO7Wv0"
}
},
"SessionType": "Redfish",
"UserName": "admin"
}
Response header:
X-Auth-Token:kkdVRFYCaYxqNhrSK5uYd9dbEoCO7Wv0
Location/redfish/v1/SessionService/Sessions/tHNeZ7O293bnX0k2XVBOpnlOCmKElCQd
Strict-Transport-Security:value
X-Frame-Options: DENY
Pragma: no-cache
Cache-Control: no-Store,no-Cache
X-XSS-Protection: nosniff
X-Content-Type-Options: nosniff
Content-Type-application/json
Response code: 201
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. |
|
Description |
String |
Description of the session. |
|
Id |
String |
Session ID. |
|
Name |
String |
Session name. |
|
UserName |
String |
Username. |
|
ClientOriginIPAddress |
String |
User IP. |
|
SessionType |
String |
Session type. Supported options: · Redfish · USB |
|
Oem.Public |
Object |
Custom parameters for the session service. |
|
AssignedPrivileges |
String or array |
User privileges. |
|
DefaultPasswordModifyPolicy |
String |
Default password change policy. Supported options: · NotModify. · ForcedModify. · Optional. |
|
LoginTime |
String |
Session creation time. |
|
OemPrivileges |
String or array |
User-defined privileges. |
|
IPMIEnable |
Boolean |
IPMI enabled. |
|
LockTimeSeconds |
Integer |
Remaining lockout duration (seconds). |
|
PasswordModify |
Boolean |
Whether to modify the password. |
|
PasswordExpired |
Boolean |
Whether the password expired. |
|
PasswordRemainingSeconds |
Integer |
Remaining password validity (seconds). |
|
PasswordValidityDays |
Integer |
Password validity period (days). |
|
PrivilegeIndex |
String |
Privilege index. |
|
SessionId |
String |
Session index. |
|
UserRole |
String |
User role. |
|
UserType |
String |
User type. Options include: · LocalUser. · DomainUser. |
|
WebEnable |
Boolean |
Whether Web is enabled. |
|
X-Auth-Token |
String |
Token value. |
The server returns status code 201 for a successful operation.
Change history
|
Version |
Change description |
|
HDM3-1.19 |
Edited the value for the Id field. |
|
HDM2-2.04 HDM3-2.03 |
Changed the ChangeDefaultPasswordEnabled field to DefaultPasswordModifyPolicy. |
Obtain session collection information
Description
Obtain information about all sessions from the server.
Privilege module
Login
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",
"Description": "Session Collection",
"Members": [
{
"@odata.id": "/redfish/v1/SessionService/Sessions/afQLANTiaGL6yY4aYtsapJWODotcF1sF"
}
],
"Members@odata.count": 1,
"Name": "Session Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
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
Login
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/ rFYBf8FRrmbSXgTXmwEIxAb65AWWlR3q
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/rFYBf8FRrmbSXgTXmwEIxAb65AWWlR3q",
"@odata.type": "#Session.v1_3_0.Session",
"ClientOriginIPAddress": "192.168.170.57",
"Description": "Session Service",
"Id": "rFYBf8FRrmbSXgTXmwEIxAb65AWWlR3q",
"Name": "admin Session",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"LoginTime": "2019-02-16T20:56:59+08:00",
"UserID": 1,
"UserIP": "192.168.170.57",
"UserRole": "User",
"UserTag": "Redfish"
}
},
"Password": null,
"SessionType": "Redfish",
"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. |
|
ClientOriginIPAddress |
String |
Address of the user using the session service. |
|
UserName |
String |
Username of the session service resource. |
|
UserID |
Integer |
ID of the user using the session service. |
|
UserTag |
String |
Interface for the session service. Supported options: · Redfish. · USB. · WebUI. · KVMIP. |
|
LoginTime |
String |
Creation time of the session service. |
|
UserRole |
String |
Role name. |
|
SessionType |
String |
Session type. Supported options: · Redfish. · USB. · WebUI. · KVMIP. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM3-1.19 |
Edited the value for the Id field. |
Delete a session
Description
Delete a specific session.
Privilege module
OemSecurityMgmt/ConfigureSelf
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/kkdVRFYCaYxqNhrSK5uYd9dbEoCO7Wv0
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Changed the ChangeDefaultPasswordEnabled field to DefaultPasswordModifyPolicy. |
Obtain Redfish session information
Description
Obtain information about the current Redfish session from the server.
Privilege module
Login
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_8.SessionService",
"Description": "Session Service",
"Id": "SessionService",
"Name": "Session Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"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 Redfish session settings
Description
Edit Redfish session settings for the server.
Privilege module
OemSecurityMgmt
Locking type of the associated system
BMC configuration locking
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. Disabling the session service is not supported. If the specified field is false, ignore the specified value. |
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#SessionService.SessionService",
"@odata.id": "/redfish/v1/SessionService/",
"@odata.type": "#SessionService.v1_1_8.SessionService",
"Description": "Session Service",
"Id": "SessionService",
"Name": "Session Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"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 |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Operations on update service resources
Obtain update service information
Description
Obtain information about the current update service from the server.
Privilege module
Login
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. |
Usage guidelines
Configuration management, import/export, SSL certificate upload, firmware updates, and other similar operations require upgrade status query.
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",
"@odata.id": "/redfish/v1/UpdateService",
"@odata.type": "#UpdateService.v1_9_0.UpdateService",
"Actions": {
"#UpdateService.SimpleUpdate": {
"target": "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate"
},
"Oem": {
"Public": {
"#MirrorPool.DeleteImage": {
"target": "/redfish/v1/UpdateService/Actions/Oem/Public/MirrorPool.DeleteImage"
},
"#UpdateService.DumpBIOS": {
"target": "/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.DumpBIOS"
},
"#UpdateService.UninstallPackage": {
"PackageType@Redfish.AllowableValues": [
"PATCH",
"FEATURE"
],
"target": "/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.UninstallPackage"
}
}
}
},
"Description": "Service for Software Update",
"FirmwareInventory": {
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"
},
"HttpPushUri": "/redfish/v1/UpdateService",
"Id": "UpdateService",
"MaxImageSizeBytes": 471859200,
"Name": "Update Service",
"Oem": {
"Public": {
"BIOSFirmwareRestoreEnabled": true,
"BMCFirmwareRestoreEnabled": true,
"CompletionCode": 0,
"Description": "Success",
"FirmwareList": {
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList"
},
"InstalledPackages": {
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/InstalledPackages"
},
"MirrorPool": {
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/MirrorPool"
},
"UpgradeState": null
"UpgradeTaskRestoreEnabled": true
}
},
"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.UpdateService.SimpleUpdate |
Object |
Update the firmware. |
|
Actions.Oem.Public.MirrorPool.DeleteImage |
Object |
Delete an image from the image pool. |
|
Actions.Oem.Public.UpdateService.UninstallPackage |
Object |
Uninstall a specific firmware package. |
|
Actions.Oem.Public.UpdateService.UninstallPackage |
Object |
Export BIOS firmware. |
|
Name |
String |
Name of the update service resource. |
|
MaxImageSizeBytes |
Integer |
Maximum firmware size. |
|
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. |
|
Oem.Public.UpgradeState |
String |
Current update status. Supported options: · Upgrading—The update is in progress. · null—The update is not in progress . |
|
Oem.Public.FirmwareList |
Object |
Link to the firmware list that can be updated. |
|
Oem.Public.MirrorPool |
Object |
Image pool list |
|
Oem.Public.InstalledPackages |
Object |
Obtain firmware package collection information. |
|
Oem.Public.BMCFirmwareRestoreEnabled |
Boolean |
Whether BMC firmware restoration is enabled. |
|
Oem.Public.BIOSFirmwareRestoreEnabled |
Boolean |
Whether BIOS firmware restoration is enabled. |
|
Oem.Public.UpgradeTaskRestoreEnabled |
Boolean |
Whether update task restoration is enabled. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.56 |
Added the Oem.Public.BMCFirmwareRestoreEnabled, Oem.Public.BIOSFirmwareRestoreEnabled, and Oem.Public.UpgradeTaskRestoreEnabled fields. |
Configure update service information
Description
Configure update service information of the server.
Privilege module
OemDiagnosis
Request
PATCH https://device_ip/redfish/v1/UpdateService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Oem": {
"Public":{
"BMCFirmwareRestoreEnabled": false,
"BIOSFirmwareRestoreEnabled": false,
"UpgradeTaskRestoreEnabled": false
}
}
}
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. |
|
Oem.Public.BMCFirmwareRestoreEnabled |
Boolean |
Whether BMC firmware restoration is enabled. |
|
Oem.Public.BIOSFirmwareRestoreEnabled |
Boolean |
Whether BIOS firmware restoration is enabled. |
|
Oem.Public.UpgradeTaskRestoreEnabled |
Boolean |
Whether update task restoration is enabled. |
Examples
Method and URL:
PATCH https://192.168.18.18/redfish/v1/UpdateService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Oem": {
"Public":{
"BMCFirmwareRestoreEnabled": false,
"BIOSFirmwareRestoreEnabled": false,
"UpgradeTaskRestoreEnabled": false
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#UpdateService",
"@odata.id": "/redfish/v1/UpdateService",
"@odata.type": "#UpdateService.v1_9_0.UpdateService",
"Actions": {
"#UpdateService.SimpleUpdate": {
"target": "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate"
},
"Oem": {
"Public": {
"#MirrorPool.DeleteImage": {
"target": "/redfish/v1/UpdateService/Actions/Oem/Public/MirrorPool.DeleteImage"
},
"#UpdateService.DumpBIOS": {
"target": "/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.DumpBIOS"
},
"#UpdateService.UninstallPackage": {
"PackageType@Redfish.AllowableValues": [
"PATCH",
"FEATURE"
],
"target": "/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.UninstallPackage"
}
}
}
},
"Description": "Service for Software Update",
"FirmwareInventory": {
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"
},
"HttpPushUri": "/redfish/v1/UpdateService",
"Id": "UpdateService",
"MaxImageSizeBytes": 471859200,
"Name": "Update Service",
"Oem": {
"Public": {
"BIOSFirmwareRestoreEnabled": false,
"BMCFirmwareRestoreEnabled": false,
"CompletionCode": 0,
"Description": "Success",
"FirmwareList": {
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList"
},
"InstalledPackages": {
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/InstalledPackages"
},
"MirrorPool": {
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/MirrorPool"
},
"UpgradeState": null,
"UpgradeTaskRestoreEnabled": false
}
},
"ServiceEnabled": true,
"Status": {
"Health": "OK",
"State": "Enabled"
}
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain update service information."
Change history
|
Version |
Change description |
|
HDM2-1.56 |
Added this interface. |
Obtain firmware inventory collection information
Description
Obtain information about all firmware inventories from the server.
Privilege module
Login
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/BIOS"
}
],
"Members@odata.count": 2,
"Name": "Firmware Inventory Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
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
Login
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. |
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_3_0.SoftwareInventory",
"BuildDate": "2022-06-08T09:55:43+08:00",
"Id": "HDM",
"Name": "HDM",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Managers/1"
}
],
"SoftwareId": "HDM",
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"State": "Enabled"
},
"Updateable": true,
"Version": "0.00.10"
}
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.HealthRollup |
String |
Overall health status of firmware inventory resources |
|
Status. State |
String |
Enabling status of the firmware. |
|
SoftwareId |
String |
Firmware type. |
|
Updateable |
Boolean |
Firmware validity. |
|
BuildDate |
String |
Version compilation time. |
|
Version |
String |
Firmware version. |
The server returns status code 200 for a successful operation.
Obtain image pool list
Description
Obtain the image pool list, including images that already exist on the SD card.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/UpdateService/Oem/Public/MirrorPool
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/Oem/Public/MirrorPool
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#MirrorPool/MirrorPool/Members/$entity",
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/MirrorPool",
"@odata.type": "#MirrorPool.v1_0_0.MirrorPool",
"FreeSpace": 427757568,
"MirrorPool": [
{
"BackupFileName": "BMC_R4900-G6_0.00.02.ima",
"FileSizeByte": 42678545,
"ImageType": "BMC",
"SubImageType": "R4900 G6",
"Version": "0.00.02"
}
],
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"UsedSpace": 42678545
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the image pool list resource model. |
|
@odata.id |
String |
Link to the image pool list resource node. |
|
@odata.type |
String |
Type of the image pool list resource. |
|
MirrorPool |
Array |
Image pool information. |
|
BackupFileName |
String |
Backup file name. |
|
ImageType |
String |
Image type. |
|
FileSizeByte |
Integer |
Image size. |
|
SubImageType |
String |
Image subtype. Some firmware has an image subtype. If a firmware does not have a subtype, this field displays null. |
|
Version |
String |
Firmware version. If no version information is available, this field displays null. |
|
FreeSpace |
Integer |
Maximum file size that can be uploaded for the image pool. |
|
UsedSpace |
Integer |
Used space in the image pool. |
The server returns status code 200 for a successful operation.
Delete an image in an image pool
Description
Delete an image in an image pool.
Privilege module
OemDiagnosis
Request
Method and URL:
POST https://device_ip/redfish/v1/UpdateService/Actions/Oem/Public/MirrorPool.DeleteImage
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"BackupFileName":fliename
}
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. |
|
BackupFileName |
Backup file name. |
You can obtained backup file name from the image pool list |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/UpdateService/Actions/Oem/Public/MirrorPool.DeleteImage
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"BackupFileName":"BMC_R4900-G6_0.00.02.ima"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Update firmware
Description
Update the firmware of the server.
Privilege module
OemDiagnosis
Locking type of the associated system
Firmware version locking
BIOS configuration locking (for BIOS update except for only ME update)
BMC configuration locking (for BMC update)
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, TFTP, NFS, or HTTPS:
{
"ImageURI":" tftp://IP/image.bin",
"Oem": {
"Public": {
"Preserve": preserve,
"RebootMode":reboot_mode,
"Backup":backup,
"BiosFlash": BiosFlash,
"ImageMd5URI":"tftp://IP/MD5.txt",
"Date": date,
"UpgradeType":upgrade_type
}
}
}
CIFS or SFTP:
{
"ImageURI":"sftp://username:passwd@IP/image.bin",
"Oem": {
"Public": {
"Preserve": preserve,
"RebootMode":reboot_mode,
"Backup":backup,
"BiosFlash": BiosFlash,
"ImageMd5URI":"sftp://username:passwd@IP/MD5.txt",
"Date": date,
"UpgradeType":upgrade_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. |
|
ImageURI |
Link to the update image. |
String. |
|
Oem.Public.Preserve |
Mode for preserving the existing configuration. |
String. Supported options: · Retain. · Restore. · ForceRestore. |
|
Oem.Public.RebootMode |
Reboot mode. |
String. Supported options: · Auto. · Manual. |
|
Oem.Public.Backup |
Whether to back up firmware. |
Boolean. Supported options: · true. · false. |
|
Oem.Public.BiosFlash |
Both BIOS primary and backup partitions upgrade at the same time. |
String. Supported options: · FLash1 ——Upgrade the primary BIOS partition. · FLash2 ——Upgrade the backup BIOS partition. |
|
Oem.Public.Reboot |
Server reboot status. |
Boolean. Supported options: · true—Reboot. · false—Not reboot. |
|
Oem.Public.Date |
Task delay time. |
String. |
|
Oem.Public.UpgradeType |
Type of the firmware to update. |
String. Supported options: BIOS: · all—Update the BIOS and ME. · bios—Update the BIOS only. · me—Update ME only. SEAMLESS: · all—Update the BIOS, ME, and Microcode. · bios—Update the BIOS only. · me—Update ME only. · microcode—Update Microcode only. · bios+me—Update the BIOS and ME only. · bios+microcode—Update BIOS and Microcode only. · me+microcode—Update ME and Microcode only. |
|
Oem.Public.ImageMd5URI |
(Optional.) Path of the MD5 value of the update image package. |
N/A. |
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":"tftp://192.168.21.21/BMC.bin",
"Oem": {
"Public": {
"Preserve":"Retain",
"RebootMode":"Auto"
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the firmware update task service. |
|
@odata.type |
String |
Type of the firmware update task service. |
|
Name |
String |
Name of the firmware update . |
|
Members@odata.count |
Integer |
Number of tasks generated by firmware update. |
|
Members |
Array |
Task link collection generated by the firmware update. |
|
@odata.id |
String |
Task link generated by the firmware update. |
|
Oem.Public.TaskUniqueID |
Array |
Unique ID of the firmware update task service. |
The server returns status code 202 for a successful operation.
Change history
|
Version |
Change description |
|
HDM3-1.06 |
Added the Oem.Public.BiosFlash field in the request body. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Obtain firmware inventory information
Description
Obtain firmware inventory information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/UpdateService/Oem/Public/FirmwareList
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/Oem/Public/FirmwareList
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#FirmwareListCollection.FirmwareListCollection",
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList",
"@odata.type": "#FirmwareListCollection.FirmwareListCollection",
"Members": [
{
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/BMCP"
},
{
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/BMCS"
},
{
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/BMCCPLD"
},
{
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/CPLD1"
},
{
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/CPLD2"
},
{
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/BIOS"
},
{
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/RC"
},
{
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/ME"
},
{
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/MICROCODE"
},
{
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/PSU1"
},
{
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/PSU2"
},
{
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/PFRCPLD"
}
],
"Members@odata.count": 12,
"Name": "Firmware List Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the server firmware inventory. |
|
@odata.id |
String |
Link to the server firmware inventory node. |
|
@odata.type |
String |
Type of the server firmware inventory collection resource. |
|
Members |
Array |
Firmware inventory name. |
|
Members@odata.count |
Integer |
Number of firmware inventories. |
|
Name |
String |
Name of firmware inventory collection resource. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.60 |
Changed the firmware names CPLD and SCPLD to CPLD1 and CPLD2, respectively. CPLD and SCPLD are still compatible. |
Obtain information of a firmware inventory
Description
Obtain information of a firmware inventory.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/UpdateService/Oem/Public/FirmwareList/firmware_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. |
|
firmware_id |
Firmware name. |
You can obtain it from the firmware inventory information. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/UpdateService/Oem/Public/FirmwareList/BMCP
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#UpdateService/FirmwareList/Members/$entity",
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/FirmwareList/BMCP",
"@odata.type": "#FirmwareList.v1_0_0.FirmwareList",
"FirmwareName": "HDM",
"Location": "bmc card",
"Model": "-",
"Name": "BMCP",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"Version": "1.12"
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the firmware inventory. |
|
@odata.id |
String |
Link to the firmware inventory node. |
|
@odata.type |
String |
Type of the firmware inventory resource. |
|
FirmwareName |
String |
Firmware name. |
|
Version |
String |
Firmware version number. |
|
Location |
String |
Firmware location. |
|
Model |
String |
Device model. |
|
Name |
String |
Name of the firmware inventory resource. |
The server returns status code 200 for a successful operation.
Obtain firmware package collection information
Description
Obtain firmware package collection information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/UpdateService/Oem/Public//InstalledPackages
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/Oem/Public/InstalledPackages
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#InstalledPackages.InstalledPackages",
"@odata.id": "/redfish/v1/UpdateService/Oem/Public/InstalledPackages",
"@odata.type": "#InstalledPackages.v1_0_0.InstalledPackages",
"Name": "Installed Packages Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"Packages": [
{
"ExternalVersion": "0.00.02",
"Id": "2",
"InternalVersion": "V100R001B01BBIT02",
"Name": "Diag",
"PackageType": "FEATURE"
}
],
"Packages@odata.count": 1
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the server firmware inventory. |
|
@odata.id |
String |
Link to the server firmware inventory node. |
|
@odata.type |
String |
Type of the server firmware inventory resource. |
|
Packages |
Array |
Package details. |
|
Id |
String |
Package ID. |
|
Name |
String |
Package name. |
|
PackageType |
String |
Package type. Supported options: · PATCH patch package. · FEATURE feature package. |
|
InternalVersion |
String |
Internal version number. |
|
ExternalVersion |
String |
External version number. |
|
Packages@odata.count |
Integer |
Number of packages. |
The server returns status code 200 for a successful operation.
Uninstall a firmware package
Description
Uninstall a firmware package.
Privilege module
OemDiagnosis
Locking type of the associated system
Firmware version locking
Request
Method and URL:
POST https://device_ip/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.UninstallPackage
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id": id,
"PackageType":package_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. |
|
Id |
Package ID. |
You can obtain available package IDs from the firmware package collection interface. |
|
PackageType |
Package type. |
Supported options: · PATCH patch package. · FEATURE feature package. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.UninstallPackage
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Id": "1",
"PackageType":" PATCH"
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system. |
Export BIOS firmware
Description
Export BIOS firmware.
Privilege module
OemDiagnosis
Request
Method and URL:
POST https://device_ip/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.DumpBIOS
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
· Remote export:
¡ CIFS or SFTP:
{
"Type":"URI",
"Content":"cifs://username:password@ip/filename"
}
¡ HTTP, TFTP, NFS, or HTTPS:
{
"Type":"URI",
"Content":"http://ip/filename",
"ScriptName":"1.php"
}
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. |
|
Type |
Method to export the BIOS firmware. |
URI. You can obtain it from the firmware package collection interface. |
|
Content |
Path to export the BIOS firmware. |
See "Others." |
|
ScriptName |
Script file name. |
String. This field is required if you use HTTP or HTTPS to export the file. |
Examples
Method and URL:
POST https://192.168.188.188/redfish/v1/UpdateService/Actions/Oem/Public/UpdateService.DumpBIOS
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Type":"URI",
"Content":"nfs://192.168.8.7/Share1/aaa.bin"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the task service resource Model. |
|
@odata.type |
String |
Type of the task service resource. |
|
Name |
String |
Name of the task collection resource. |
|
Members@odata.count |
Integer |
Number of currently running tasks. |
|
Members |
Task resource list. |
|
|
@odata.id |
String |
Link to the specified task. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the specified task. |
The server returns status code 202 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.15 |
Changed request body Oem.Public.ScriptName to ScriptName. |
Operations on task service resources
Obtain task service information
Description
Obtain current information about the task service from the server.
Privilege module
Login
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_5.TaskService",
"CompletedTaskOverWritePolicy": "Oldest",
"DateTime": "2022-02-23T07:19:34+08:00",
"Description": "Task Service",
"Id": "TaskService",
"LifeCycleEventOnTaskStateChange": false,
"Name": "Task Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"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 |
Object. |
|
|
@odata.id |
String |
Link to the task collection resource. |
The server returns status code 200 for a successful operation.
Obtain task collection information
Description
Obtain information about all tasks from the server.
Privilege module
Login
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#TaskService/Tasks/$entity",
"@odata.id": "/redfish/v1/TaskService/Tasks",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/7"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"CountOfCanceledTask": 0,
"CountOfCompletedTask": 0,
"CountOfCurrentTask": 7,
"CountOfDeletedTask": 0,
"CountOfFailedTask": 0,
"DeletedMembers": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/1"
},
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
},
{
"@odata.id": "/redfish/v1/TaskService/Tasks/3"
},
{
"@odata.id": "/redfish/v1/TaskService/Tasks/4"
},
{
"@odata.id": "/redfish/v1/TaskService/Tasks/5"
},
{
"@odata.id": "/redfish/v1/TaskService/Tasks/6"
}
],
"DeletedMembers@odata.count": 6,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
Integer |
Number of current running tasks. |
|
Members |
Object. |
|
|
@odata.id |
String |
Link to a specific task resource. |
|
Oem.Public.CountOfCanceledTask |
Integer |
Number of tasks cancelled. |
|
Oem.Public.CountOfCompletedTask |
Integer |
Number of successful tasks. |
|
Oem.Public.CountOfCurrentTask |
Integer |
Number of current tasks. |
|
Oem.Public.CountOfDeletedTask |
Integer |
Number of tasks deleted. |
|
Oem.Public.CountOfFailedTask |
Integer |
Number of failed tasks. |
|
DeletedMembers |
Integer |
Tasks to be deleted. |
|
DeletedMembers@odata.count |
Integer |
Number of tasks to be deleted. |
The server returns status code 200 for a successful operation.
Obtain task inforamtion
Description
Obtain information about a specific task from the server.
Privilege module
Login
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/7
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
"@odata.id": "/redfish/v1/TaskService/Tasks/7",
"@odata.type": "#Task.v1_5_0.Task",
"EndTime": "",
"Id": "7",
"Messages": {
"Message": "",
"MessageArgs": [
""
],
"MessageId": "",
"RelatedProperties": [
""
],
"Resolution": "",
"Severity": "",
"Trigger Condition": ""
},
"Name": "Task 7",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Upgrade management",
"TaskDescription": "Upgrade management",
"TaskPercentage": "70%",
"TaskUniqueID": 1678656297
}
},
"StartTime": "2022-02-23T07:22:12+08:00",
"TaskState": "Running",
"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. · Pending. · Completed. · Cancelled. · Exception. |
|
StartTime |
String |
Start time of the task. |
|
EndTime |
String |
End time of the task. |
|
TaskStatus |
String |
Running status of the task. Supported options: · OK. |
|
Messages.MessageId |
String |
Message ID. |
|
Messages.RelatedProperties |
Array |
Related properties for the message. |
|
Messages.Message |
String |
Details of the message. |
|
Messages.MessageArgs |
Array |
Message arguments. |
|
Messages.Resolution |
String |
Recommended actions for the error. |
|
Messages.Severity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Messages.Trigger Condition |
String |
Trigger condition. Supported options: · BMC Reset. · OS Reset. · OS Power Off. · Automatic. · Power Cycle. · PSU Reset. · Take Effect Immediately. |
|
Oem.Public.TaskDescription |
String |
Task description. |
|
Oem.Public.TaskPercentage |
String |
Task completion progress, in percent. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the specified task. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.15 |
Corrected the description for the Messages.Trigger Condition field. |
Delete a task
Description
Delete a task resource in pending status.
Privilege module
OemDiagnosis
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:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Obtain server scheduled task list information
Description
Obtain server scheduled task list information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/TaskService/Oem/Public/TimedTasks
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/Oem/Public/TimedTasks
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#TimedTasksCollection.TimedTasksCollection",
"@odata.id": "/redfish/v1/TaskService/Oem/Public/TimedTasks",
"@odata.type": "#TimedTasksCollection.TimedTasksCollection",
"Id": "TimedTasksCollection",
"Name": "TimedTasksCollection",
"Members":[
{
"@odata.id": "/redfish/v1/TaskService/Oem/Public/TimedTasks/1"
},
{
"@odata.id": "/redfish/v1/TaskService/Oem/Public/TimedTasks/2"
},
],
"Members@odata.count": 2,
"Oem": {
"Public":{
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members |
String |
Link to scheduled task list information. |
|
Members@odata.count |
String |
Number of scheduled tasks. |
The server returns status code 200 for a successful operation.
Obtain information of a server scheduled task
Description
Obtain information of a server scheduled task.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/TaskService/Oem/Public/TimedTasks/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 |
Scheduled task resource ID. |
You can obtain available task resource IDs from server scheduled task list information. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/TaskService/Oem/Public/TimedTasks/2
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskService.TimedTasks",
"@odata.id": "/redfish/v1/TaskService/Oem/Public/TimedTask/2",
"@odata.type": "#TimedTasksInstance.v1_0_0.TimedTasksInstance",
"Id": "2",
"Name": "TimedTasks Instance",
"TaskType":"Firmware Update",
"TaskState":"Executed",
"Clock":{
"ClockType":"Single",
"ExecuteTime":{
"Year":2023,
"Month":11,
"Day":18,
"Hour":16,
"Minute":44,
"Week":null
}
},
"TaskDescription":"Uploading Version 2.17",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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 service resource. |
|
TaskType |
String |
Scheduled task type. |
|
TaskState |
String |
Scheduled task execution status. Supported options: · New—Creating a new scheduled task. · Completed—The scheduled task has been executed. · Exception—An exception occurs on the execution of a scheduled task. |
|
TaskDescription |
Boolean |
Description of the scheduled task. |
|
Clock |
Object |
Clock. |
|
Clock.ClockType |
String |
Clock types. Supported options: · Monthly. · Weekly. · Daily. · Hourly. · Minutely. · Single. This field only supports setting the one-time clock in the current software version. |
|
Clock.ExecuteTime.Year |
Integer |
Year. |
|
Clock.ExecuteTime.Month |
Integer |
Month. |
|
Clock.ExecuteTime.Day |
Integer |
Day. |
|
Clock.ExecuteTime.Hour |
Integer |
Hour. |
|
Clock.ExecuteTime.Minute |
Integer |
Minute. |
|
Clock.ExecuteTime.Week |
String |
Week. |
The server returns status code 200 for a successful operation.
Edit a server scheduled task
Description
Edit a server scheduled task.
Privilege module
OemDiagnosis
Request
Method and URL:
PATCH https://device_ip/redfish/v1/TaskService/Oem/Public/TimedTasks/task_id
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"Clock":{
"ClockType":"Single",
"ExecuteTime":{
"Year":2023,
"Month":11,
"Day":18,
"Hour":16,
"Minute":44,
"Week":"Monday"
}
}
}
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 |
Scheduled task resource ID. |
You can obtain available task resource IDs from server scheduled task list information. |
|
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. |
|
Clock.ClockType |
Clock Types. |
String. Supported options: · Monthly. · Weekly. · Daily. · Hourly. · Minutely. · Single. This field only supports setting the one-time clock in the current software version. |
|
Clock.ExecuteTime.Year |
Year. |
Integer |
|
Clock.ExecuteTime.Month |
Month. |
Integer |
|
Clock.ExecuteTime.Day |
Day. |
Integer |
|
Clock.ExecuteTime.Hour |
Hour. |
Integer |
|
Clock.ExecuteTime.Minute |
Minute. |
Integer |
|
Clock.ExecuteTime.Week |
Week. |
String |
Examples
Method and URL:
patch https://192.168.30.151/redfish/v1/TaskService/Oem/Public/TimedTasks/2
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"
Request body:
{
"Clock":{
"ClockType":"Single",
"ExecuteTime":{
"Year":2023,
"Month":11,
"Day":18,
"Hour":16,
"Minute":44,
"Week":"Monday"
}
}
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskService.TimedTasks",
"@odata.id": "/redfish/v1/TaskService/TimedTasks",
"@odata.type": "#TimedTasksInstance.v1_0_0.TimedTasksInstance",
"Id": "2",
"Name": "TimedTasks Instance",
"TaskType":"Firmware Update",
"TaskState":"Executed",
"Clock":{
"ClockType":"Single",
"ExecuteTime":{
"Year":2023,
"Month":11,
"Day":18,
"Hour":16,
"Minute":44,
"Week":null
}
},
"Description":"Uploading Version 2.17",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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 scheduled task list information."
Operations on event service resources
Obtain event collection information
Description
Obtain information about all events from the server.
Privilege module
Login
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_7_2.EventService",
"Actions": {
"#EventService.SubmitTestEvent": {
"@Redfish.ActionInfo": "/redfish/v1/EventService/SubmitTestEventActionInfo",
"target": "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent"
}
},
"DeliveryRetryAttempts": 1,
"DeliveryRetryIntervalSeconds": 3,
"Description": "Event Service",
"EventTypesForSubscription": [
"StatusChange",
"ResourceUpdated",
"ResourceAdded",
"ResourceRemoved",
"Alert"
],
"Id": "EventService",
"Name": "Event Service",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"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. |
|
|
#EventService.SubmitTestE vent |
Object |
Send test events. |
|
@Redfish.ActionInfo |
String |
Send the information obtaining link for test event actions. |
|
target |
String |
Link to simulate the reporting of test events. |
|
DeliveryRetryAttempts |
Integer |
Maximum retransmission attempts for event subscription messages. |
|
DeliveryRetryIntervalSeconds |
Integer |
Event subscription retransmission interval. |
|
Description |
String |
Description of the event service resources. |
|
EventTypesForSubscription |
Array |
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.
Create an event subscription
Description
Create an event subscription.
Privilege module
ConfigureComponents
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. |
|
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, if 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://192.168.25.11",
"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": [{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans"
}
]
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#EventDestination.EventDestination",
"@odata.id": "/redfish/v1/EventService/Subscriptions/5",
"@odata.type": "#EventDestination.v1_9_0.EventDestination",
"Context": "event subscription context string",
"Description": "Event Subscription Instance",
"Destination": "https://192.168.25.11",
"EventTypes": [
"Alert",
"ResourceUpdated",
"StatusChange"
],
"HttpHeaders": null,
"Id": "5",
"MessageIds": [],
"Name": "Event Destination 5",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"OriginResources": [
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans"
}
],
"OriginResources@odata.count": 1,
"Protocol": "Redfish",
"SubscriptionType": "RedfishEvent"
}
Response code: 201
Response field description
The server returns status code 201 for a successful operation.
For information about the response fields, see "Obtain event subscription information."
Obtain event subscription collection information
Description
Obtain information about all event subscriptions from the server.
Privilege module
Login
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"
}
],
"Members@odata.count": 2,
"Name": "Event Subscriptions Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
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. |
|
Members@odata.count |
Integer |
Number of event subscription resources. |
|
Members |
Event subscription resource list. |
|
|
@odata.id |
String |
Link to an event subscription resource. |
Obtain event subscription information
Description
Obtain information about a specific event subscription from the server.
Privilege module
Login
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/5
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/5",
"@odata.type": "#EventDestination.v1_9_0.EventDestination",
"Context": "event subscription context string",
"Description": "Event Subscription Instance",
"Destination": "https://192.168.25.11",
"EventTypes": [
"Alert",
"ResourceUpdated",
"StatusChange"
],
"HttpHeaders": null,
"Id": "5",
"MessageIds": [
"EventLog.1.0.FanEventSufficient"
],
"Name": "Event Destination 5",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"OriginResources": [
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans"
}
],
"OriginResources@odata.count": 1,
"Protocol": "Redfish",
"SubscriptionType": "RedfishEvent"
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData description of the event subscription resource model. |
|
@odata.id |
String |
Link to the event subscription resource. |
|
@odata.type |
String |
Type of the event subscription resource. |
|
Description |
String |
Description of the event subscription resource. |
|
Id |
String |
ID of the event subscription resource. |
|
Name |
String |
Name of the event subscription resource. |
|
Destination |
String |
URI of the destination event service. |
|
EventTypes |
Array |
Types of events to be sent. Supported options: · ResourceRemoved. · ResourceAdded. · StatusChange. · ResourceUpdated. · Alert. |
|
HttpHeaders |
Object |
HTTP header carried in messages for event report. |
|
Protocol |
String |
Event subscription protocol. Only Redfish is available. |
|
Context |
String |
String provided by the client to be stored together with the subscribed event. |
|
MessageIds |
Array |
Event subscription message ID matching list |
|
OriginResources |
Array |
Event subscription event source matching list |
|
OriginResources@odata.count |
Integer |
Number of the event origin resources. |
|
SubscriptionType |
String |
Type of the subscribed event. |
Edit an event subscription
Description
Edit an event subscription.
Privilege module
ConfigureComponents
Request
Method and URL:
PATCH https://device_ip/redfish/v1/EventService/Subscriptions/id
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match:ifmatch_value
Request body:
{
"HttpHeaders": http_headers,
"Context":"abcdefg"
}
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. |
|
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. |
|
HttpHeaders |
HTTP header information. |
Object. |
|
Context |
Event subscription context information. |
String. |
Examples
Method and URL:
PATCH https://192.168.30.151/redfish/v1/EventService/Subscriptions/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"
Request body:
{
"HttpHeaders": [{
"Content-Type": "application/json",
"OData-Version": "4.0",
"X-Auth-Token":"2e751b825163447d30d3021c98116221"
}],
"Context":" Event Subscription Instance 5"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#EventDestination.EventDestination",
"@odata.id": "/redfish/v1/EventService/Subscriptions/5",
"@odata.type": "#EventDestination.v1_9_0.EventDestination",
"Context": "Event Subscription Instance 5",
"Description": "Event Subscription Instance",
"Destination": "https://192.168.25.11",
"EventTypes": [
"Alert",
"ResourceUpdated",
"StatusChange"
],
"HttpHeaders": null,
"Id": "5",
"MessageIds": [
"EventLog.1.0.FanEventSufficient"
],
"Name": "Event Destination 5",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"OriginResources": [
{
"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans"
}
],
"OriginResources@odata.count": 1,
"Protocol": "Redfish",
"SubscriptionType": "RedfishEvent"
}
Response code: 200
Response field description
The server returns status code 200 for a successful operation.
For information about the response fields, see "Obtain event subscription information."
Delete an event subscription
Description
Delete an event subscription.
Privilege module
ConfigureComponents
Request
Method and URL:
DELETE 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:
DELETE https://192.168.30.151/redfish/v1/EventService/Subscriptions/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Message extended information. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Extended human-readable error message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level of the error. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Report error alarms
Description
Report error alarms and parse the message.
It is not a Redfish interface.
Example report
headers:
IOrderedDict([
('User-Agent', 'LuaSocket 3.0-rc1'),
('TE', 'trailers'),
('Content-Length', '800'),
('Connection', 'close, TE'),
('Content-Type', 'application/json'),
('Host', '192.168.25.11')
])
bodydata:
{
"@odata.context":"/redfish/v1/$metadata#Event.Event",
"@odata.id":"/redfish/v1/EventService/Events/7",
"@odata.type":"#Event.v1_6_0.Event",
"Context":"Public",
"Events":[{
"EventId":"26",
"EventTimestamp":"2020-05-08T17:58:05+08:00",
"EventType":"Alert",
"MemberId":"26",
"Message":"Drive(Drive Slot/Bay): Drive fault --- Bay Slot: 0, HDD Slot: 0",
"MessageArgs":[],
"MessageId":"EventLog.1.0.0.Alert",
"Oem":{
"Public":{
"AddInfo":"",
"alarmStatus":"Asserted",
"locationInfo":"Drive",
"neName":"(none)",
"neType":"server",
"neUID":"210200A00QH17C000001",
"objectName":"Drive",
"objectType":"Drive Slot/Bay",
"objectUID":"",
"specificProblem":"Drive fault",
"specificProblemID":"0x0d6f0100",
"EventAssertedSeverity": "Major"
}
},
"OriginOfCondition":{
"@odata.id":"/redfish/v1/Chassis/1/Drives"
},
"Severity":"Major"
}],
"Events@odata.count":1,
"Id":"7",
"Name":"Event Array"
}
Field description
|
Field |
Data type |
Description |
|
headers |
Message header. |
|
|
User-Agent |
String. |
User agent. |
|
TE |
String. |
Encoding type used by the user agent for transmission. |
|
Content-Length |
String. |
Length of the transmitted HTTP message content. |
|
Connection |
String. |
Whether a persistent connection is required. |
|
Content-Type |
String. |
MIME type. |
|
Host |
String. |
Server domain and port number. The port number depends on the destination address specified at subscription creation. |
|
bodydata |
Body information. |
|
|
@odata.context |
String |
OData description of the message registry. |
|
@odata.id |
String |
Link to the message registry. The last level in the URL matches the displayed ID on the page. |
|
@odata.type |
String |
Type of the message registry. |
|
Context |
String |
Event subscription context. |
|
Events |
Array |
Event information |
|
EventId |
String |
Alarm event ID and the serial number of the alarm event. The same component and the same type of event alarms have the same EventId when the alarms are generated continuously. An alarm generation event has the same alarm EventId as the corresponding alarm clearance event. |
|
EventTimestamp |
String |
Time at which the alarm occurred. |
|
EventType |
String |
Event type. Supported options: · StatusChange. · ResourceUpdated. · ResourceAdded. · ResourceRemoved. · Alert. |
|
MemberId |
String |
Member ID of the alarm message, consistent with the displayed ID on the page. |
|
Message |
String |
Alarm message or message headline. |
|
MessageArgs |
String |
Message arguments. |
|
MessageId |
String |
Message ID. |
|
Oem.Public.AddInfo |
String |
Alarm addition information or alarm details. A key and its value are separated with a colon (:) and two key-value pairs are separated with a semicolon (;). Keys and key values cannot contain colons (:) or semicolons (;). |
|
Oem.Public.alarmStatus |
String |
Alarm status. Supported options: · Asserted—Active. · Deasserted—Cleared. |
|
Oem.Public.locationInfo |
String |
Location information. |
|
Oem.Public.neName |
String |
Asset number of the server on which the alarm occurred. |
|
Oem.Public.neType |
String |
Alarm device type. Supported options: · server. |
|
Oem.Public.neUID |
String |
Serial number of the server on which the alarm occurred. |
|
Oem.Public.objectName |
String |
Name of the component on which the alarm occurred. |
|
Oem.Public.objectType |
String |
Type of the component on which the alarm occurred. |
|
Oem.Public.objectUID |
String |
ID of the component on which the alarm occurred. |
|
Oem.Public.specificProblem |
String |
Alarm description. |
|
Oem.Public.specificProblemID |
String |
Alarm ID. |
|
Oem.Public.EventAssertedSeverity |
String |
Alarm severity. Supported options: · 1—Critical. · 2—Major. · 3—Minor. · 4—Warning. · 5—Info. |
|
OriginOfCondition |
Object |
Link to the origin of condition. |
|
Severity |
String |
Alarm severity. Supported options: · 1—Critical. · 2—Major. · 3—Minor. · 4—Warning. · 5—Info. |
|
Events@odata.count |
Integer |
Number of alarms. |
|
Id |
String |
Alarm ID, consistent with the displayed ID on the page. |
|
Name |
String |
Name of the alarm report interface. |
Change history
|
Version |
Change description |
|
HDM2-2.02 |
Changed the field description of the EventId, Oem.Public.specificProblem, Oem.Public.specificProblemID, Oem.Public.EventAssertedSeverity, and Severity fields. |
Simulate reporting test events
Description
Simulate reporting test events.
Privilege module
ConfigureComponents
Request
Method and URL:
POST https://device_ip/redfish/v1/EventService/Actions/EventService.SubmitTestEvent
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. |
|
id |
Event subscription resource ID. |
You can obtain available event subscription resource IDs from event subscription collection information. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/EventService/Actions/EventService.SubmitTestEvent
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Message extended information. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageId |
String |
Message ID. |
|
Resolution |
String |
Recommended actions for the error. |
|
Severity |
String |
Severity level of the error. Supported options: · OK. · Warning. · Critical. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
Operations on license service resources
Obtain license service information
Description
Obtain license service information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/LicenseService
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/LicenseService
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.context": "@odata.type": "#LicenseService.v1_0_0.LicenseService",
"Name": "License Service",
"ServiceEnabled": true,
"Actions": {
"#LicenseService.Install": {
"target": "/redfish/v1/LicenseService/Actions/LicenseService.Install",
"@Redfish.ActionInfo": "/redfish/v1/LicenseService/InstallActionInfo"
},
"Oem": {
"Public":{
"#LicenseService.Export": {
"target": "/redfish/v1/LicenseService/Actions/Oem/Public/LicenseService.Export",
"@Redfish.ActionInfo": "/redfish/v1/LicenseService/Oem/Public/ExportActionInfo"
},
"#LicenseService.Uninstall ": {
"target": "/redfish/v1/LicenseService/Actions/Oem/Public/LicenseService.Uninstall ",
"@Redfish.ActionInfo": "/redfish/v1/LicenseService/Oem/Public/ UninstallActionInfo"
}
}
}
},
"LicenseExpirationWarningDays":10,
"Licenses": {
"@odata.id": "/redfish/v1/LicenseService/Licenses"
},
"Oem": {
"Public": {
"DeviceID" :"1B45F9365F95737DBA154EDE3C6C9C9A7BBC94F2",
"CompletionCode": 0,
"Description": "Success"
}
},
"@odata.id": "/redfish/v1/LicenseService"
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.id |
String |
Link to the license service resource. |
|
@odata.type |
String |
Type of the license service resource. |
|
Name |
String |
Name of the license service resource. |
|
Actions |
Executable actions for License service resources. |
|
|
LicenseService.Uninstall |
Object |
License certificate uninstallation. |
|
LicenseService.Export |
Object |
License certificate export. |
|
LicenseExpirationWarningDays |
Integer |
Time to send alarm messages before certificate expiration. |
|
Licenses |
Object |
Link to license certificate collection resource. |
|
ServiceEnabled |
Boolean |
Enabling status of the license service. |
|
Oem.Public.DeviceID |
String |
DID code of the specified device. |
The server returns status code 200 for a successful operation.
Obtain license resource collection information
Description
Obtain license resource collection information.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/LicenseService/Licenses
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/LicenseService/Licenses
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.id": "/redfish/v1/LicenseService/Licenses",
"@odata.type": "#LicenseCollection.LicenseCollection",
"Name": "License Collection",
"Members": [
{
"@odata.id": "/redfish/v1/LicenseService/Licenses/1"
}
],
"Members@odata.count": 1,
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.id |
String |
Link to the license collection resource. |
|
@odata.type |
String |
Type of the license collection resource. |
|
Name |
String |
Name of the license collection resource. |
|
Members@odata.count |
Integer |
Number of the license collection resource. |
|
Members |
Task resource list. |
Navigation link to the specified license resource. |
The server returns status code 200 for a successful operation.
Obtain information of a license resource
Description
Obtain information of the specified license resource.
Privilege module
Login
Request
Method and URL:
GET https://device_ip/redfish/v1/LicenseService/Licenses/license_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. |
|
license_id |
License ID. |
You can obtain license IDs by license resource collection information. |
Examples
Method and URL:
GET https://192.168.18.18/redfish/v1/LicenseService/Licenses/1
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
N/A
Response:
{
"@odata.id": "/redfish/v1/LicenseService/Licenses/1",
"@odata.type": "#License.v1_0_0.License",
"Id": "1",
"Name": "License 1",
"Status": {
"State": "Enabled",
"Health": "OK" ,
"Oem": {
"Public": {
"LicenseStatus":"Using"
}
}
},
"LicenseType": "Trial",
"SerialNumber": "1errefde1111",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"LicenseRemainingHours":null,
"LicenseTimeType":""
}
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
@odata.id |
String |
Link to the license collection resource. |
|
@odata.type |
String |
Type of the license collection resource. |
|
Name |
String |
Name of the license resource. |
|
Id |
String |
ID of the license resource. |
|
Status |
Object |
License resource status. Supported options: · Health—Health state of the license resource · State—Enbaling status of the license resource. · License status: ¡ Using. ¡ Expired. ¡ Unavailable. ¡ Expiring. ¡ Uninstalled. |
|
LicenseType |
String |
License type. Supported options: · Trial—Temporary. · Production—Official. |
|
SerialNumber |
String |
Serial number. |
|
Oem.Public.LicenseRemainingHours |
String |
Remaining validity time. |
|
Oem.Public.LicenseTimeType |
String |
Authorization time type. Supported options: · Permanent. · Relative. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.14 |
Changed Trial to Production in License Type filed. |
Install the license activation file
Description
Install the license activation file.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/LicenseService/Actions/LicenseService.Install
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
· Installation via local import:
{
"Type":"URI",
"Content": "/tmp/web/Licensefiefile"
}
· Installation via remote import:
¡ CIFS or SFTP:
{
"Type":"URI",
"Content": "sftp://username:password@10.10.10.191/usr/Licensefiefile"
}
¡ HTTP, TFTP, NFS, or HTTPS:
{
"Type":"URI",
"Content":"http://ip/Licensefiefile "
}
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. |
|
Type |
URI. |
String. |
|
Content |
Link to the license file. |
· File transfer protocols: SFTP, HTTPS, HTTP, NFS, CIFS, and TFTP. · Operation path, which does not support Chinese characters. · Up to 1024 characters. Chinese characters are not supported and the following special characters are supported: @!$^&()_+.;[]{}-=~` · Only the /tmp/web/ directory and its subdirectories are supported locally. · The total length of the TFTP protocol directory and file name is up to 240 characters. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/LicenseService/Actions/LicenseService.Install
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
{
"Type":"URI",
"Content": "sftp://username:password@10.10.10.191/usr/Licensefiefile.xml"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData Description of the task service for installing the license activation file. |
|
@odata.type |
String |
Type of the task service for installing the license activation file. |
|
@odata.id |
String |
Link to the task service for installing the license activation file. |
|
Members@odata.id |
Object |
Task link generated from license activation file installation. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the task service for installing the license activation file. |
The server returns status code 202 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-1.53 |
Added the locking type of the associated system.. |
Export a license file
Description
Export a license activation or uninstallation file. This interface needs to be used in conjunction with the interface for downloading the BMC file. Execute this interface before executing the interface for downloading the BMC file in "Upload BMC file."
Privilege module
ConfigureUsers
Request
Method and URL:
POST https://device_ip/redfish/v1/LicenseService/Actions/Oem/Public/LicenseService.Export
Request header:
X-Auth-Token:TOKEN
Content-Type: application/json
Request body:
· Remote export:
¡ CIFS or SFTP:
{
"Type":"URI",
"Content": "sftp://username:password@10.10.10.191/usr/Licensefile",
"LicenseFileType":"Activation"
}
¡ NFS or TFTP:
{
"Type":"URI",
"Content":"http://ip/Licensefile",
"LicenseFileType":"Activation"
}
¡ HTTP or HTTPS:
{
"Type":"URI",
"Content":"http://ip/Licensefile",
"LicenseFileType":"Activation",
"ScriptName":"1.php"
}
· Local export:
{
"Type":"URI",
"Content": "/tmp/web/filename",
"LicenseFileType":"Activation"
}
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. |
|
Type |
String. |
URI. |
|
Content |
Link to the license file. |
· File transfer protocols: SFTP, HTTPS, HTTP, NFS, CIFS, and TFTP. · Operation path, which does not support Chinese characters. · Up to 1024 characters. Chinese characters are not supported and the following special characters are supported: @!$^&()_+.;[]{}-=~` · Only the /tmp/web/ directory and its subdirectories are supported locally. · The total length of the TFTP protocol directory and file name is up to 240 characters. For local export, make sure this path is consistent with the path for BMC file downloading. |
|
LicenseFileType |
File type: · Activation—Activation file. · Uninstall—Uninstallation file. |
String. |
|
ScriptName |
Script file name. |
String. This field is required if you use HTTP or HTTPS to export the file. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/LicenseService/Actions/Oem/Public/LicenseService.Export
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
"Type":"URI",
"Content": "nfs://192.168.20.177/Share1/LicenseBackup.xml",
"LicenseFileType":"Activation"
}
Response:
{
"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",
"@odata.type": "#TaskCollection.TaskCollection",
"Members": [
{
"@odata.id": "/redfish/v1/TaskService/Tasks/2"
}
],
"Members@odata.count": 1,
"Name": "Task Collection",
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success",
"TaskUniqueID": 1678656297
}
}
}
Response code: 202
Response field description
|
Field |
Data type |
Description |
|
@odata.context |
String |
OData Description of the task service for exporting the license activation file. |
|
@odata.type |
String |
Type of the task service for exporting the license activation file. |
|
@odata.id |
String |
Link to the task service for exporting the license activation file. |
|
Members@odata.id |
Object |
Task link generated from exporting the license activation file. |
|
Oem.Public.TaskUniqueID |
Integer |
Unique ID of the task service for exporting the license activation file for exporting the license activation file. |
The server returns status code 202 for a successful operation.
Uninstall the license activation file
Description
Uninstall the installed license activation file.
Privilege module
ConfigureUsers
Locking type of the associated system
BMC configuration locking
Request
Method and URL:
POST https://device_ip/redfish/v1/LicenseService/Actions/Oem/Public/LicenseService.Uninstall
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. |
Examples
Method and URL:
POST https://192.168.18.18/redfish/v1/LicenseService/Actions/Oem/Public/LicenseService.Uninstall
Request header:
X-Auth-Token:TOKEN
Content-Type:application/json
Request body:
{
}
Response:
{
"Oem": {
"Public": {
"CompletionCode": 0,
"Description": "Success"
}
},
"error": {
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_1_1.Message",
"Message": "Successfully Completed Request",
"MessageArgs": [],
"MessageId": "Base.1.8.1.Success",
"MessageSeverity": "OK",
"Resolution": "None"
}
],
"code":"Base.1.8.1.Success",
"message":"Successfully Completed Request"
}
}
Response code: 200
Response field description
|
Field |
Data type |
Description |
|
code |
String |
String of a specific message ID in the message registry. |
|
message |
String |
Readable error message corresponding to the message in the message registry. |
|
@Message.ExtendedInfo |
Extended information of the message. |
|
|
@odata.type |
String |
OData description of the message resource. |
|
MessageId |
String |
Message ID. |
|
Message |
String |
Details of the message. |
|
MessageArgs |
Array |
Message arguments. |
|
MessageSeverity |
String |
Severity level. Supported options: · OK. · Warning. · Critical. |
|
Resolution |
String |
Recommended actions for the error. |
The server returns status code 200 for a successful operation.
Change history
|
Version |
Change description |
|
HDM2-2.04 |
Added the error node before Message.ExtendedInfo and added the code and message fields under the error node. |
|
HDM2-1.53 |
Added the locking type of the associated system.. |
Examples
Use Postman to obtain information about Redfish root service resources
1. Use Postman to create a new request by clicking + in the address bar, and then select GET.
2. Enter the URL to access the Redfish service.
3. Select Basic Auth from the Authentication tab.
4. Enter an HDM username and password.
5. Click Send.
Appendix
Parameters
The client can add query parameters during GET operations to quickly obtain target resource information from the server. The supported parameters are shown in Table 4. Unimplemented parameters return status code 501.
|
Parameter |
Description |
Example |
|
$skip |
Integer. Indicates the number of members in the resource collection to skip before obtaining the first resource. |
http://resourcecollection?$skip=5 |
|
$top |
Integer. Indicates the number of members to include in the response, with a minimum of 1. The default is to return all members in the resource collection. |
http://resourcecollection?$top=30 |
|
$expand |
Expands the hyperlinked resources in the current response based on the expand value. |
http://resource?$expand=*($levels=1) |
|
$select |
List of fields to obtain. |
https://resource?$select=Id |
Perform filtering and pagination ($skip, $top)
Description
This command is suitable for obtaining collection resources with multiple members. When the GET operation returns too many members, you can use Redfish's filtering and pagination features for convenient searching.
Request
Operation type: GET
URL: https://device_ip/redfish/v1/Managers/1/LogServices/?$skip=skip_num&$top=top_num
or
URL: https://device_ip/redfish/v1/Managers/1/LogServices/?$top=top_num&$skip=skip_num
or
URL: https://device_ip/redfish/v1/Managers/1/LogServices/?$skip=skip_num
or
URL: https://device_ip/redfish/v1/Managers/1/LogServices/?$top=top_num
Expand hyperlinks ($expand)
Description
This command is suitable for viewing resources containing hyperlinks. When the GET operation returns information with specific hyperlinked resources, you can expand these links, including the linked resource information in the current request. The $expand parameter reduces the number of requests when the resource link is unknown. The special hyperlinks that can be expanded must meet the following conditions:
· An attribute value is a JSON object containing only one property named @odata_id with a valid hyperlink as its value.
· An attribute value is a collection of JSON objects, each containing only one property named @odata_id with a valid hyperlink as its value.
This command currently supports expanding only one level of hyperlinks, and does not expand the next level of links within the expanded information. Additionally, the $expand parameter can be used in combination with the $skip and $top parameters from the previous section.
Request
For example: GET
URL: https://device_ip/redfish/v1/Chassis?$expand=*($levels=levels_num)
or
URL: https://device_ip/redfish/v1/Chassis/?$top=top_num&$skip=skip_num&$expand=*($levels=levels_num)
Obtain the list of fields ($select)
Description
This command is suitable for viewing operations and filtering information as needed.
Request
Operation type: GET
The following URL only returns the Id attribute of all obtained information:
https://IP/redfish/v1/Chassis/1/PCIeDevices/2?$select=Id
The following URL only returns the Chassis attribute in the Links field of all obtained information:
https://IP/redfish/v1/Chassis/1/PCIeDevices/2?$select=Links/Chassis
