ResourceDefinition

uris

/redfish/v1/PowerEquipment/RackPDUs/power_distribution_id

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	机架配电单元资源模型的OData描述信息
@odata.id	string	true	-	资源OID
@odata.type	string	true	-	资源类型
Id	string	true	-	资源ID
Name	string	true	-	资源名称
AssetTag	string	false	-	资产标签
Branches {	object	true	-	-
Branches.@odata.id	string	true	-	Branches子资源链接
}
EquipmentType	string	true	-	设备类型
FirmwareVersion	string	true	-	固件版本
Links {	object	true	-	-
Links.Chassis [ {	array	true	-	关联的Chassis链接
Links.Chassis[].@odata.id	string	true	-	-
} ]
Links.ManagedBy [ {	array	true	-	管理者链接
Links.ManagedBy[].@odata.id	string	true	-	-
} ]
}
Location {	object	true	-	-
Location.PartLocation {	object	true	-	-
Location.PartLocation.ServiceLabel	string	true	-	部件位置服务标签
Location.PartLocation.LocationOrdinalValue	number	true	-	部件位置序号
Location.PartLocation.LocationType	string	true	-	位置类型
Location.PartLocation.Orientation	string	true	-	方向
Location.PartLocation.Reference	string	true	-	参考点
}
}
Mains {	object	true	-	-
Mains.@odata.id	string	true	-	Mains子资源链接
}
Manufacturer	string	true	-	制造商
Metrics {	object	true	-	-
Metrics.@odata.id	string	true	-	Metrics子资源链接
}
Model	string	true	-	型号
PartNumber	string	true	-	部件号
PowerCapacityVA	number	true	-	视在功率容量(VA)
ProductionDate	string	true	-	生产日期
SerialNumber	string	true	-	序列号
Status {	object	true	-	-
Status.State	string	true	-	资源状态
Status.Health	string	true	-	健康状态
}
TransferConfiguration {	object	true	-	-
TransferConfiguration.ActiveMainsId	string	false	-	当前活跃的主路ID
TransferConfiguration.AutoTransferEnabled	boolean	false	-	是否启用自动切换
TransferConfiguration.ClosedTransitionAllowed	boolean	false	-	是否允许闭环切换
TransferConfiguration.ClosedTransitionTimeoutSeconds	number	false	-	闭环切换超时时间(秒)
TransferConfiguration.PreferredMainsId	string	false	-	首选主路ID
TransferConfiguration.RetransferDelaySeconds	number	false	-	回切延迟时间(秒)
TransferConfiguration.RetransferEnabled	boolean	false	-	是否启用回切
TransferConfiguration.TransferDelaySeconds	number	false	-	切换延迟时间(秒)
TransferConfiguration.TransferInhibit	boolean	false	-	是否禁止切换
}
TransferCriteria {	object	true	-	-
TransferCriteria.OverNominalFrequencyHz	number	false	-	过频阈值(Hz)
TransferCriteria.OverVoltageRMSPercentage	number	false	-	过压百分比
TransferCriteria.TransferSensitivity	string	false	-	切换灵敏度
TransferCriteria.UnderNominalFrequencyHz	number	false	-	欠频阈值(Hz)
TransferCriteria.UnderVoltageRMSPercentage	number	false	-	欠压百分比
}
UserLabel	string	false	-	用户标签
UUID	string	true	-	通用唯一标识符
Version	string	true	-	版本信息
Actions {	object	true	-	-
Actions.#PowerDistribution.TransferControl {	object	true	-	-
Actions.#PowerDistribution.TransferControl.target	string	true	-	TransferControl操作目标
Actions.#PowerDistribution.TransferControl.@Redfish.ActionInfo	string	true	-	TransferControl操作信息链接
}
}

supported_methods

GET
PATCH
POST

HTTP methods

GET

命令功能

查询单个机架配电单元资源信息。

命令格式

URL: https://device_ip/redfish/v1/PowerEquipment/RackPDUs/power_distribution_id

请求头:

X-Auth-Token: 123456789***********************

请求消息体: 无

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
power_distribution_id	配电单元Id	在查询配电单元列表的返回信息中包含各配电单元Id
auth_value	执行该GET请求时，必须在“Headers”中携带“X-Auth-Token”值用于鉴权。	可通过/redfish/v1/SessionService/Sessions创建会话时获得。

使用指南

BMC300 5.14.0.1及以上版本支持（仅RM310支持）

使用实例

请求样例：

http

GET https://device_ip/redfish/v1/PowerEquipment/RackPDUs/1

请求头：

X-Auth-Token: 123456789***********************

请求消息体：无

响应样例：

json

{  
   "@odata.context": "/redfish/v1/$metadata#PowerDistribution.PowerDistribution",  
   "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1",  
   "@odata.type": "#PowerDistribution.v1_5_0.PowerDistribution",  
   "Id": "1",  
   "Name": "RackPDU 1",  
   "AssetTag": "", 
   "Branches": { 
      "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Branches" 
    }, 
   "EquipmentType": "RackPDU", 
   "FirmwareVersion": "", 
   "Links": { 
       "Chassis": [ 
           { 
              "@odata.id": "/redfish/v1/Chassis/1" 
            } 
        ], 
        "ManagedBy": [ 
            { 
               "@odata.id": "/redfish/v1/Managers/1" 
            } 
        ] 
    }, 
    "Location": { 
        "PartLocation": { 
             "ServiceLabel": "", 
             "LocationOrdinalValue": null, 
             "LocationType": null, 
             "Orientation": null, 
             "Reference": null 
         } 
    }, 
    "Mains": { 
        "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Mains" 
    }, 
    "Manufacturer": "", 
    "Metrics": { 
         "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Metrics" 
    }, 
    "Model": "", 
    "PartNumber": "", 
    "PowerCapacityVA": null, 
    "ProductionDate": "", 
    "SerialNumber": "", 
    "Status": { 
         "State": "Enabled", 
         "Health": "OK" 
    }, 
    "TransferConfiguration": { 
         "ActiveMainsId": "", 
         "AutoTransferEnabled": false, 
         "ClosedTransitionAllowed": false, 
         "ClosedTransitionTimeoutSeconds": null, 
         "PreferredMainsId": "", 
         "RetransferDelaySeconds": null, 
         "RetransferEnabled": false, 
         "TransferDelaySeconds": null, 
         "TransferInhibit": false 
    }, 
    "TransferCriteria": { 
         "OverNominalFrequencyHz": 0, 
         "OverVoltageRMSPercentage": null, 
         "TransferSensitivity": null, 
         "UnderNominalFrequencyHz": 0, 
         "UnderVoltageRMSPercentage": null 
    }, 
    "UserLabel": "", 
    "UUID": "", 
    "Version": "", 
    "Actions": { 
         "#PowerDistribution.TransferControl": { 
                 "target": "/redfish/v1/PowerEquipment/RackPDUs/1/Actions/PowerDistribution.TransferControl", 
                 "@Redfish.ActionInfo": "/redfish/v1/PowerEquipment/RackPDUs/1/TransferControlActionInfo" 
          } 
    } 
 }

响应码：200

PATCH

命令功能

修改单个机架配电单元资源信息。

命令格式

URL: https://device_ip/redfish/v1/PowerEquipment/RackPDUs/power_distribution_id

请求头:

X-Auth-Token: 123456789***********************
Content-Type: header_type 
If-Match: ifmatch_value

请求消息体:

json

{  
   "AssetTag": AssetTag_value, 
   "UserLabel": UserLabel_value, 
   "TransferConfiguration": { 
         "ActiveMainsId": ActiveMainsId_value, 
         "AutoTransferEnabled": AutoTransferEnabled_value, 
         "ClosedTransitionAllowed": ClosedTransitionAllowed_value, 
         "ClosedTransitionTimeoutSeconds": ClosedTransitionTimeoutSeconds_value, 
         "PreferredMainsId": PreferredMainsId_value, 
         "RetransferDelaySeconds": RetransferDelaySeconds_value, 
         "RetransferEnabled": RetransferEnabled_value, 
         "TransferDelaySeconds": TransferDelaySeconds_value, 
         "TransferInhibit": TransferInhibit_value 
    }, 
    "TransferCriteria": { 
         "OverNominalFrequencyHz": OverNominalFrequencyHz_value, 
         "OverVoltageRMSPercentage": OverVoltageRMSPercentage_value, 
         "TransferSensitivity": TransferSensitivity_value, 
         "UnderNominalFrequencyHz": UnderNominalFrequencyHz_value, 
         "UnderVoltageRMSPercentage": UnderVoltageRMSPercentage_value 
    } 
 }

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
power_distribution_id	配电单元Id	在查询配电单元列表的返回信息中包含各配电单元Id
auth_value	执行该GET请求时，必须在“Headers”中携带“X-Auth-Token”值用于鉴权。	可通过/redfish/v1/SessionService/Sessions创建会话时获得。
AssetTag	修改资产标签	字符串
UserLabel	修改用户标签	字符串
ActiveMainsId	修改当前活跃的主路ID	字符串
AutoTransferEnabled	修改是否启用自动切换	布尔
ClosedTransitionAllowed	修改是否允许闭环切换	布尔
ClosedTransitionTimeoutSeconds	修改闭环切换超时时间(秒)	数字
PreferredMainsId	修改首选主路ID	字符串
RetransferDelaySeconds	修改回切延迟时间(秒)	数字
RetransferEnabled	修改是否启用回切	布尔
TransferDelaySeconds	修改切换延迟时间(秒)	数字
TransferInhibit	修改是否禁止切换	布尔
OverNominalFrequencyHz	修改过频阈值(Hz)	数字
OverVoltageRMSPercentage	修改过压百分比	数字
TransferSensitivity	修改切换灵敏度	枚举值： ● High 高 ● Medium 中 ● Low 低
UnderNominalFrequencyHz	修改欠频阈值(Hz)	数字
UnderVoltageRMSPercentage	修改欠压百分比	数字

使用指南

BMC300 5.14.0.1及以上版本支持（仅RM310支持）

使用实例

请求样例：

http

PATCH https://device_ip/redfish/v1/PowerEquipment/RackPDUs/1

请求头：

X-Auth-Token: 123456789***********************   
 Content-Type: application/json   
 If-Match: W/"3d607e36"

请求消息体：

{   
   "AssetTag": "Test", 
   "UserLabel": "Test", 
   "TransferConfiguration": { 
         "ActiveMainsId": "Test", 
         "AutoTransferEnabled": true, 
         "ClosedTransitionAllowed": true, 
         "ClosedTransitionTimeoutSeconds": 33, 
         "PreferredMainsId": "Test", 
         "RetransferDelaySeconds": 33, 
         "RetransferEnabled": true, 
         "TransferDelaySeconds": 33, 
         "TransferInhibit": true 
    }, 
    "TransferCriteria": { 
         "OverNominalFrequencyHz": 33, 
         "OverVoltageRMSPercentage": 33, 
         "TransferSensitivity": "High", 
         "UnderNominalFrequencyHz": 33, 
         "UnderVoltageRMSPercentage": 33 
    } 
 }

响应样例：

json

{  
   "@odata.context": "/redfish/v1/$metadata#PowerDistribution.PowerDistribution",  
   "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1",  
   "@odata.type": "#PowerDistribution.v1_5_0.PowerDistribution",  
   "Id": "1",  
   "Name": "RackPDU 1",  
   "AssetTag": "Test", 
   "Branches": { 
      "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Branches" 
    }, 
   "EquipmentType": "RackPDU", 
   "FirmwareVersion": "", 
   "Links": { 
       "Chassis": [ 
           { 
              "@odata.id": "/redfish/v1/Chassis/1" 
            } 
        ], 
        "ManagedBy": [ 
            { 
               "@odata.id": "/redfish/v1/Managers/1" 
            } 
        ] 
    }, 
    "Location": { 
        "PartLocation": { 
             "ServiceLabel": "", 
             "LocationOrdinalValue": null, 
             "LocationType": null, 
             "Orientation": null, 
             "Reference": null 
         } 
    }, 
    "Mains": { 
        "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Mains" 
    }, 
    "Manufacturer": "", 
    "Metrics": { 
         "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Metrics" 
    }, 
    "Model": "", 
    "PartNumber": "", 
    "PowerCapacityVA": null, 
    "ProductionDate": "", 
    "SerialNumber": "", 
    "Status": { 
         "State": "Enabled", 
         "Health": "OK" 
    }, 
    "TransferConfiguration": { 
         "ActiveMainsId": "Test", 
         "AutoTransferEnabled": true, 
         "ClosedTransitionAllowed": true, 
         "ClosedTransitionTimeoutSeconds": 33, 
         "PreferredMainsId": "Test", 
         "RetransferDelaySeconds": 33, 
         "RetransferEnabled": true, 
         "TransferDelaySeconds": 33, 
         "TransferInhibit": true 
    }, 
    "TransferCriteria": { 
         "OverNominalFrequencyHz": 33, 
         "OverVoltageRMSPercentage": 33, 
         "TransferSensitivity": "High", 
         "UnderNominalFrequencyHz": 33, 
         "UnderVoltageRMSPercentage": 33 
    }, 
    "UserLabel": "Test", 
    "UUID": "", 
    "Version": "", 
    "Actions": { 
         "#PowerDistribution.TransferControl": { 
                 "target": "/redfish/v1/PowerEquipment/RackPDUs/1/Actions/PowerDistribution.TransferControl", 
                 "@Redfish.ActionInfo": "/redfish/v1/PowerEquipment/RackPDUs/1/TransferControlActionInfo" 
          } 
    } 
 }

响应码：200

POST (ACTION)

TransferControl

命令功能

控制单个机架配电单元切换。

命令格式

URL: https://device_ip/redfish/v1/PowerEquipment/RackPDUs/power_distribution_id/Actions/PowerDistribution.TransferControl

请求头:

X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体: 无

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
power_distribution_id	配电单元Id	在查询配电单元列表的返回信息中包含各配电单元Id
auth_value	请求消息的鉴权参数	可通过/redfish/v1/SessionService/Sessions创建会话时获得。
header_type	请求消息的格式	支持的消息格式包括： ● application/json ● application/json;charset=utf-8

使用指南

BMC300 5.14.0.1及以上版本支持（仅RM310支持）

使用实例

请求样例：

http

GET https://device_ip/redfish/v1/PowerEquipment/RackPDUs/1/Metrics/Actions/PowerDistributionMetrics.ResetMetrics

请求头：

X-Auth-Token: 123456789***********************  
Content-Type: application/json

请求消息体：无

响应样例：

json

{   
   "error": { 
      "code": "Base.1.0.GeneralError",   
      "message": "A general error has occurred. See ExtendedInfo for more information.",   
      "@Message.ExtendedInfo": [   
      {   
         "@odata.type": "#Message.v1_0_0.Message",   
         "MessageId": "Base.1.0.Success",   
         "RelatedProperties": [],   
         "Message": "Successfully Completed Request",   
         "MessageArgs": [],   
         "Severity": "OK",   
         "Resolution": "None"   
       }   
     ]   
   }  
}

响应码：200

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

POST (ACTION) ​

TransferControl ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

POST (ACTION)

TransferControl