Skip to main content

OpenManage Enterprise 3.10 RESTful API Guide

PDF

POST method for Jobs

Description
Configures the SNMP configuration for incoming alerts.
Privilege
JOB_MANAGEMENT
HTTP response codes
200
Example Request Body
{
   "Id": <JobId>,// Refer task api to get the jobId for this Job name.
   "JobName": "SNMP Listener Configuration",
   "JobDescription": "SNMP Listener Task created from Alert Settings",
   "Schedule": "startnow",
   "State": "Enabled",
   "JobType": {
      "Id": 9,
      "Name": "ListenerConfiguration_Task"
   },
   "Params": [
      {
         "JobId": 0,
         "Key": "snmpCredentials",
         "Value": {
            "securityName": "root",
            "authenticationProtocol": "NONE",
            "authenticationPassphrase": "",
            "privacyProtocol": "NONE",
            "privacyPassphrase": "",
            "localizationEngineID": null,
            "community": "OpenManage Enterprise",
            "port": 162,
            "enableV3": true,
            "enableV1V2": false,
            "retries": 3,
            "timeout": 3
         }
      },
      {
         "JobId": 0,
         "Key": "protocolType",
         "Value": "SNMP"
      },
      {
         "JobId": 0,
         "Key": "enableV1",
         "Value": "true"
      },
      {
         "JobId": 0,
         "Key": "enableV2",
         "Value": "true"
      },
      {
         "JobId": 0,
         "Key": "enableV3",
         "Value": "true"
      },
      {
         "JobId": 0,
         "Key": "alertPort",
         "Value": "162"
      },
      {
         "JobId": 0,
         "Key": "communityString",
         "Value": "OpenManage Enterprise"
      },
      {
         "JobId": 0,
         "Key": "overwriteUSM",
         "Value": "true"
      }
   ]
}


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: <>()\