OpenManage Enterprise Power Manager RESTful API Guide version 2.0

GET method for Policies(<PolicyId>)/PolicyDetails of a specific policy

Description

Returns details of a power policy.

Privilege

VIEW

HTTP response codes

200

Example

Input: None
 
Output:
{
    "@odata.context": "/api/$metadata#PowerService.PowerPolicyModel",
    "@odata.type": "#PowerService.PowerPolicyModel",
    "@odata.id": "/api/PowerService/Policies(30)/PolicyDetails",
    "PolicyId": 30,
    "Name": "Group Policy",
    "Type": 1,
    "Description": "Power policy created on group",
    "Enabled": true,
    "Schedule": {
        "StartTime": "",
        "EndTime": "",
        "StartDate": "",
        "EndDate": "",
        "DaysOfTheWeek": []
    },
    "Devices": [
        {
            "Id": 10070,
            "DeviceName": "100.96.25.126",
            "Type": 2000,
            "ServiceTag": "D89RG52",
            "PowerCapValue": 16670,
            "Ip": null
        }
    ],
    "Group": {
        "Id": 10132,
        "PowerCapValue": 16670,
        "TemperatureThreshold": 45, 
        "Name": "DeviceGroup",
        "Description": ""
    }
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute name	Description
PolicyId	ID of power policy.
Name	Name associated with the policy.
Type	Type of policy.
Description	Description associated with the policy.
Enabled	Indicates if the policy is enabled or disabled.
Schedule	Indicates when the policy will be active.
StartTime	Time at which the policy interval starts.
EndTime	Time at which the policy interval ends.
StartDate	Date from which the policy is active.
EndDate	Date until which the policy is active.
DaysOfTheWeek	Days of week in which the policy is active.

Devices	Target devices of the policy.
Devices.Id	ID of the target device.
Devices.DeviceName	Name of the device.
Devices.Type	Type of the device.
Devices.ServiceTag	Service tag of the device.
Devices.PowerCapValue	Power cap value for the device.
Devices.Ip	IP address of the device.

Group	Target group of the policy (if applicable).
Group.Id	ID of the group.
Group.PowerCapValue	Power cap value for the group.
Group.TemperatureThreshold	Temperature threshold value for the group.
Group.Name	Name of the group.
Group.Description	Description of the group.

NOTE The output Group object will have data only when the policy is created for group.

Welcome

Welcome to Dell

OpenManage Enterprise Power Manager RESTful API Guide version 2.0

GET method for Policies(<PolicyId>)/PolicyDetails of a specific policy

Rate this content