Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET VDAssociatedDynamicGroups

Represents a Location or User Defined group assigned to a current virtual domain. Network devices assigned to dynamic groups will be associated with the virtual domain automatically. This API is not intended for ROOT-DOMAIN, for ROOT-DOMAIN the API returns all groups including Device Type groups.

Since Product Version: 3.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v3/data/VDAssociatedDynamicGroups

Unmodified

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

Response Parameters

Attribute Description

hierarchyName String

Group hierarchical name

instanceOrigin InstanceOriginEnum

Allowed values:

  • UNCONCERNED
  • APPLICATION
  • NETWORK

instanceTenantId Integer

This is a tenant id for this instance.

name String

Group name

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 Payload

https://localhost/webacs/api/v3/data/VDAssociatedDynamicGroups/15

<?xml version="1.0" ?>
<queryResponse type="VDAssociatedDynamicGroups" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/VDAssociatedDynamicGroups/15" rootUrl="https://localhost/webacs/api/v3/data">
  <entity dtoType="vDAssociatedDynamicGroupsDTO" type="VDAssociatedDynamicGroups" url="https://localhost/webacs/api/v3/data/VDAssociatedDynamicGroups/15">
    <vdAssociatedDynamicGroupsDTO displayName="String value" id="15" instanceTenantId="String value" uuid="String value">
      <hierarchyName>String value</hierarchyName>
      <name>String value</name>
    </vdAssociatedDynamicGroupsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v3/data/VDAssociatedDynamicGroups/15.json

{
  "queryResponse" : {
    "@type" : "VDAssociatedDynamicGroups",
    "@requestUrl" : "https://localhost/webacs/api/v3/data/VDAssociatedDynamicGroups/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v3/data",
    "entity" : [ {
      "@dtoType" : "vDAssociatedDynamicGroupsDTO",
      "@type" : "VDAssociatedDynamicGroups",
      "@url" : "https://localhost/webacs/api/v3/data/VDAssociatedDynamicGroups/15",
      "vdAssociatedDynamicGroupsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@instanceTenantId" : "String value",
        "@uuid" : "String value",
        "hierarchyName" : "String value",
        "name" : "String value"
      }
    } ]
  }
}