Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

PUT vd

Updates existing virtual domain. Fully qualified domain name is used to identify the domain to be edited

Since Product Version: 3.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Credential

HTTP Methods

PUT

Resource URL

/webacs/api/v4/op/vd

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

domainFQN String

query

Required

Fully qualified name of the virtual domain to be edited

Request Payload Parameters

Attribute Description

accessPointsAdded Long[]

IDs of access points to be associated with the virtual domain. Optional.

accessPointsRemoved Long[]

IDs of access points to be removed from the virtual domain. Optional.

description String

Description of the virtual domain. Optional.

devicesAdded Long[]

IDs of devices to be associated with the virtual domain. Optional.

devicesRemoved Long[]

IDs of devices to be removed from the virtual domain. Optional.

domainName String

Name of the virtual domain. Optional.

dynamicGroupsAdded String[]

FQNs of groups that have to be associated with the virtual domain. Devices assigned to these groups will be associated with the virtual domain as well. Optional.

dynamicGroupsRemoved String[]

FQNs of groups that have to be removed from the virtual domain. Devices assigned to these groups will be removed from the virtual domain as well. Optional.

email String

Email address for sending alarms notifications. Optional.

groupsAdded String[]

FQNs of groups to be associated with the virtual domain. Optional.

groupsRemoved String[]

FQNs of groups to be removed from the virtual domain. Optional.

siteMapsAdded Long[]

IDs of site maps to be associated with the virtual domain. Optional.

siteMapsRemoved Long[]

IDs of site maps to be removed from the virtual domain. Optional.

timezone String

Time zone of the virtual domain. Optional.

virtualElementsAdded Long[]

IDs of virtual elements to be associated with the virtual domain. Optional.

virtualElementsRemoved Long[]

IDs of virtual elements to be removed with the virtual domain. Optional.

Response Parameters

Attribute Description

warning String

An error message in case if any error occurred

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Request Payload

https://10.64.80.159/webacs/api/v4/op/vd?domainFQN=ROOT-DOMAIN/Domain

<?xml version="1.0" ?>
<vdUpdateDTO>
  <accessPointsAdded>
    <accessPointsAdded>15</accessPointsAdded>
    <accessPointsAdded>25</accessPointsAdded>
  </accessPointsAdded>
  <accessPointsRemoved>
    <accessPointsRemoved>15</accessPointsRemoved>
    <accessPointsRemoved>25</accessPointsRemoved>
  </accessPointsRemoved>
  <description>String value</description>
  <devicesAdded>
    <devicesAdded>15</devicesAdded>
    <devicesAdded>25</devicesAdded>
  </devicesAdded>
  <devicesRemoved>
    <devicesRemoved>15</devicesRemoved>
    <devicesRemoved>25</devicesRemoved>
  </devicesRemoved>
  <domainName>String value</domainName>
  <dynamicGroupsAdded>
    <dynamicGroupsAdded>String value</dynamicGroupsAdded>
    <dynamicGroupsAdded>Another string value</dynamicGroupsAdded>
  </dynamicGroupsAdded>
  <dynamicGroupsRemoved>
    <dynamicGroupsRemoved>String value</dynamicGroupsRemoved>
    <dynamicGroupsRemoved>Another string value</dynamicGroupsRemoved>
  </dynamicGroupsRemoved>
  <email>String value</email>
  <groupsAdded>
    <groupsAdded>String value</groupsAdded>
    <groupsAdded>Another string value</groupsAdded>
  </groupsAdded>
  <groupsRemoved>
    <groupsRemoved>String value</groupsRemoved>
    <groupsRemoved>Another string value</groupsRemoved>
  </groupsRemoved>
  <siteMapsAdded>
    <siteMapsAdded>15</siteMapsAdded>
    <siteMapsAdded>25</siteMapsAdded>
  </siteMapsAdded>
  <siteMapsRemoved>
    <siteMapsRemoved>15</siteMapsRemoved>
    <siteMapsRemoved>25</siteMapsRemoved>
  </siteMapsRemoved>
  <timezone>String value</timezone>
  <virtualElementsAdded>
    <virtualElementsAdded>15</virtualElementsAdded>
    <virtualElementsAdded>25</virtualElementsAdded>
  </virtualElementsAdded>
  <virtualElementsRemoved>
    <virtualElementsRemoved>15</virtualElementsRemoved>
    <virtualElementsRemoved>25</virtualElementsRemoved>
  </virtualElementsRemoved>
</vdUpdateDTO>

Sample JSON Request Payload

https://10.64.80.159/webacs/api/v4/op/vd.json?domainFQN=ROOT-DOMAIN/Domain

{
  "vdUpdateDTO" : {
    "accessPointsAdded" : {
      "accessPointsAdded" : [ 15, 25 ]
    },
    "accessPointsRemoved" : {
      "accessPointsRemoved" : [ 15, 25 ]
    },
    "description" : "String value",
    "devicesAdded" : {
      "devicesAdded" : [ 15, 25 ]
    },
    "devicesRemoved" : {
      "devicesRemoved" : [ 15, 25 ]
    },
    "domainName" : "String value",
    "dynamicGroupsAdded" : {
      "dynamicGroupsAdded" : [ "String value", "Another string value" ]
    },
    "dynamicGroupsRemoved" : {
      "dynamicGroupsRemoved" : [ "String value", "Another string value" ]
    },
    "email" : "String value",
    "groupsAdded" : {
      "groupsAdded" : [ "String value", "Another string value" ]
    },
    "groupsRemoved" : {
      "groupsRemoved" : [ "String value", "Another string value" ]
    },
    "siteMapsAdded" : {
      "siteMapsAdded" : [ 15, 25 ]
    },
    "siteMapsRemoved" : {
      "siteMapsRemoved" : [ 15, 25 ]
    },
    "timezone" : "String value",
    "virtualElementsAdded" : {
      "virtualElementsAdded" : [ 15, 25 ]
    },
    "virtualElementsRemoved" : {
      "virtualElementsRemoved" : [ 15, 25 ]
    }
  }
}

Sample XML Response Payload

https://10.64.80.159/webacs/api/v4/op/vd?domainFQN=ROOT-DOMAIN/Domain

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.80.159/webacs/api/v4/op/vd?domainFQN=ROOT-DOMAIN/Domain" rootUrl="https://10.64.80.159/webacs/api/v4/op">
  <vdopResultDTO>
    <warning>String value</warning>
  </vdopResultDTO>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.80.159/webacs/api/v4/op/vd.json?domainFQN=ROOT-DOMAIN/Domain

{
  "mgmtResponse" : {
    "@requestUrl" : "https://10.64.80.159/webacs/api/v4/op/vd?domainFQN=ROOT-DOMAIN/Domain",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.80.159/webacs/api/v4/op",
    "vdopResultDTO" : [ {
      "warning" : "String value"
    } ]
  }
}