OpenManage Enterprise 3.10 RESTful API Guide

PDF

PUT method for DiscoveryConfigGroups(groupId)

This method edits a discovery task.

Description

Edits a discovery task.

Privilege

DISCOVERY_MANAGEMENT

HTTP response codes

200

Example request body

{  
 "DiscoveryConfigGroupId":11,
 "DiscoveryConfigGroupName":"Discovery-2018022611572222",
 "DiscoveryConfigGroupDescription":"null",
  "DiscoveryConfigModels": [{
         "DiscoveryConfigId": 331105536,
         "DiscoveryConfigDescription": "",
         "DiscoveryConfigStatus": "",
         "DiscoveryConfigTargets": [{
          "DiscoveryConfigTargetId": 0,
          "NetworkAddressDetail": "xx.xx.xx.xx-xx.xx.xx.xx",
          "AddressType": 30,
          "Disabled": false,
          "Exclude": false
         }],
         "ConnectionProfile":"{\"profileName\":\"\",\"profileDescription\":\"\",\"type\":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type\":\"REDFISH\",\"authType\":\"Basic\",\"modified\":false,\"credentials\":{\"username\":\"root\",\"password\":\"calvin\",\"caCheck\":false,\"cnCheck\":false,\"port\":443,\"retries\":2,\"timeout\":4,\"isHttp\":false,\"keepAlive\":false}}]}",
         "DeviceType": [
          1000
         ]
        }],
  "DiscoveryConfigTaskParam": [],
        "DiscoveryConfigTasks": [],
        "Schedule": {
         "RunNow": true,
         "RunLater": false,
         "Cron": "startnow"
       
        },
        "CreateGroup":true,
        "TrapDestination":false
}

Example response body

{
    "DiscoveryConfigGroupId": 11,
    "DiscoveryConfigGroupName": "Discovery-2018022611572222-updated",
    "DiscoveryConfigGroupDescription": "Discovery-2018022611572222-updated",
    "DiscoveryStatusEmailRecipient": null,
    "DiscoveryConfigParentGroupId": 0,
    "CreateGroup": true,
    "DiscoveryConfigModels": [
        {
            "DiscoveryConfigId": 331105536,
            "DiscoveryConfigDescription": "",
            "DiscoveryConfigStatus": "",
            "DiscoveryConfigTargets": [
                {
                    "DiscoveryConfigTargetId": 0,
                    "NetworkAddressDetail": "xx.xx.xx.xx-xx.xx.xx.xx",
                    "SubnetMask": null,
                    "AddressType": 1,
                    "Disabled": false,
                    "Exclude": false
                }
            ],
            "ConnectionProfileId": 0,
            "ConnectionProfile": "{\"profileName\":\"\",\"profileDescription\":\"\",\"type\":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type\":\"REDFISH\",\"authType\":\"Basic\",\"modified\":false,\"credentials\":{\"username\":\"root\",\"password\":\"calvin\",\"caCheck\":false,\"cnCheck\":false,\"port\":443,\"retries\":2,\"timeout\":4,\"isHttp\":false,\"keepAlive\":false}}]}",
            "DeviceType": [
                1000
            ]
        }
    ],
    "DiscoveryConfigTaskParam": [
        {
            "TaskId": 25281,
            "TaskTypeId": 0,
            "ExecutionSequence": 0
        }
    ],
    "DiscoveryConfigTasks": [],
    "Schedule": {
        "RunNow": false,
        "RunLater": false,
        "Recurring": null,
        "Cron": "startnow",
        "StartTime": null,
        "EndTime": null
    },
    "TrapDestination": false,
    "ChassisIdentifier": null
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute name	Description
GroupId	Group Id
DiscoveryName	Discovery Name
Description	Definition for discovery Task
Schedule	Discovery job schedule information
TaskId	Id of the job
ConnectionProfileId	Connection profile Id
DeviceTypeList	List of all device types
DiscoveryConfiglist	Config details