OpenManage Enterprise Power Manager RESTful API Guide version 3.1

POST method for Editing Policy

This method edits a power policy.

Description

Edits a power policy

Privilege

DEVICE_CONFIGURATION

HTTP response codes

200

Example

Input to edit static power policy:
{
	"Id": 30,
	"Name": "Group Policy",
	"Description": "Updated policy on group",
	"Enabled": true,
	"Schedule": {
		"StartTime": "",
		"EndTime": "",
		"StartDate": "2019-06-1",
		"EndDate": "2019-07-28",
		"DaysOfTheWeek": ["MON", "TUE", "WED", "FRI", "THU", "SAT", "SUN"]
	},
	"Targets": [
		{
			"Id": 10132,
			"PowerCapValue": 16663
		},
		{
			"Id": 10070,
			"PowerCapValue": 16663
		}
	]
}

Input to edit temperature-triggered policy:
	{
		"Id": 3,
		"Name": "Edited Temp Policy",
		"Description": "Edited Description",
		"Enabled": false,
		"Targets": [
        {
            "Id": 10189,
            "TemperatureThreshold": 30
        }
		]
	}


Output:
{
    "Id": 30
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute name	Description
Id	ID of the power policy
Name	Name associated with the policy.
Description	Description associated with the policy
Enabled	Indicates if the policy is enabled or disabled.
Schedule	Indicates when the policy is enabled
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.
Targets	Target device or group of the policy.
Id	ID of the target device or group
PowerCapValue	Power cap value for the device or group.

Table 2. Output AttributesThe following table shows output attributes.
Attribute name	Description
Id	ID of the power policy

NOTE All targets and corresponding power cap must be passed in the payload.

NOTE If you are editing power policy on a group, the Targets field must be an array containing the group Id and group power cap as first value, followed by device id and power cap value of each member device.

NOTE StartTime and EndTime must be left empty for policy which is active entire day.

NOTE DaysOfTheWeek must be set as empty array for policy which is active on every day.

Welcome

Welcome to Dell

OpenManage Enterprise Power Manager RESTful API Guide version 3.1

POST method for Editing Policy

Rate this content