Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

OpenManage Enterprise Version 3.2 and OpenManage Enterprise - Modular Edition Version 1.00.10 RESTful API Guide

PDF

PUT method for AlertPolicies(Id)

This method updates a policy.

Description
Updates a policy.
Privilege
MONITORING_SETUP
HTTP response codes
201
Example
Input: 
{   
    "Id": 4114,
    "Name": "Policy Test 1",
    "Description": "Policy Test 1",
    "Enabled": true,
    "DefaultPolicy": false,
    "PolicyData": {
        "Catalogs": [
            {
                "CatalogName": "iDRAC",
                "Categories": [0],
                "SubCategories": [0]
            },          
            {
                "CatalogName": "Application",
                "Categories": [0],
                "SubCategories": [0]
            }       
        ],
        "Severities": [
            16, 1, 2, 4, 8
        ],
        "Devices": [1914],
        "Groups": [],
        "DeviceTypes": [1000],
        "Schedule": {
      	"StartTime": "2016-06-06 15:02:46.000",
      	"EndTime": "2017-06-06 15:02:46.000",
      	"CronString": "* * * ? * * *"
        },
        "Actions": [
            {
            	"TemplateId": 50,
                "Name": "Email",
                "ParameterDetails": [
                    {
                      "Name": "subject",
                      "Value": "Device Name: $name,  Device IP Address: $ip,  Severity: $severity"
                    },
                    {
                      "Name": "to",
                      "Value": "test@dell.com"
                    },
                    {
                      "Name": "from",
                      "Value": "MCSIApplication@Dell.com"
                    },
                    {
                      "Name": "message",
                      "Value": "Event occurred for Device Name: $name,   Device IP Address: $ip,
                      Service Tag: $identifier,   Time: $time,   Severity: $severity,   $message"
                    }
                ]
            }
        ]
    },
    "State": true
}

Output:
{
  "Id": 4114,
  "Name": "Policy Test1",
  "Description": "Policy Test1",
  "Enabled": true,
  "DefaultPolicy": false,
  "Editable": true,
  "Visible": true,
  "PolicyData": {
    "Catalogs": [
      {
        "CatalogName": "iDRAC",
        "Categories": [
          0
        ],
        "SubCategories": [
          0
        ]
      },
      {
        "CatalogName": "Application",
        "Categories": [
          0
        ],
        "SubCategories": [
          0
        ]
      }
    ],
    "Severities": [
      16,
      1,
      2,
      4,
      8
    ],
    "Devices": [
      1914
    ],
    "DeviceTypes": [
      1000
    ],
    "Groups": [],
    "Schedule": {
      "StartTime": "2016-06-06 15:02:46.000",
      "EndTime": "2017-06-06 15:02:46.000",
      "CronString": "* * * ? * * *"
    },
    "Actions": [
      {
        "Id": 3,
        "Name": "Email",
        "ParameterDetails": [
          {
            "Name": "subject",
            "Value": "Device Name: $name,  Device IP Address: $ip,  Severity: $severity",
            "Type": "string",
            "TypeParams": [
              {
                "Name": "maxLength",
                "Value": "255"
              }
            ]
          },
          {
            "Name": "to",
            "Value": "test@dell.com",
            "Type": "string",
            "TypeParams": [
              {
                "Name": "maxLength",
                "Value": "255"
              }
            ]
          },
          {
            "Name": "from",
            "Value": "MCSIApplication@Dell.com",
            "Type": "string",
            "TypeParams": [
              {
                "Name": "maxLength",
                "Value": "255"
              }
            ]
          },
          {
            "Name": "message",
            "Value": "Event occurred for Device Name: $name,   Device IP Address: $ip,
            Service Tag: $identifier,   Time: $time,   Severity: $severity,   $message",
            "Type": "string",
            "TypeParams": [
              {
                "Name": "maxLength",
                "Value": "255"
              }
            ]
          }
        ],
        "TemplateId": 50
      }
    ]
  },
  "State": true
}
Table 1. AttributesThis table lists the attributes that this method supports.
Attribute nameDescription
ID Event record ID.
Name Name associated with the policy.
Description Description associated with the policy.
Enabled Indicates if the policy is enabled or disabled.
DefaultPolicy Indicates if the policy is the default policy or pre-seeded.
State State associated with the policy.
Visible Indicate if the policy is visible or hidden.
PolicyData
CatalogName Name of the catalogs associated with the policy
Categories Name of the categories associated with the policy. This is validated during policy evaluation.
SubCategories Name of the subcategories associated with the policy. If defined, this field is validated during policy evaluation.
Severities List of severities associated to the policy. This field is validated during policy evaluation.
Devices List of devices associated to the policy. This field is validated during policy evaluation.
DevicesTypes List of devices types associated to the policy.
Groups List of groups associated to the policy. This field is validated during policy evaluation.
Schedule
StartTime Start event-time to verify. This value indicates the start date and time for policy validity. If defined. This field is validated during policy evaluation.
EndTime End event-time to verify. This value indicates the end date and time for policy validity. If defined. This field is validated during policy evaluation.
CronString CRON string associated to the policy. This field indicates a special CRON that can be applied to the policy to indicate values such as the days for which the policy is valid.
Actions
IdID of action.
NameName associated with the action.
ParameterDetailsExtra parameters that can be used for the action.
TemplateIdID of the template associated with the action.
PolicyActionsLink to the list of actions that can be triggered for the policy.
PolicyCriteriaLink to the criteria for the evaluation of the alert contents with the policy contents. This evaluation determines if the policy is valid and if any actions are triggered.

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\