Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET VDAssociatedDevices

Represents a Network Device associated with a virtual domain.

Since Product Version: 3.2

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Group Filtering?

Yes

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource URL

/webacs/api/v1/data/VDAssociatedDevices

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Response Parameters

Attribute Description

ipAddress String

The ip address of the device. This is the preferred management access address for the device. This is typically an address at which SNMP, telnet, and ssh agents are available

name String

Device name

type String

The type of the device

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/v1/data/VDAssociatedDevices/15

<?xml version="1.0" ?>
<queryResponse type="VDAssociatedDevices" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/VDAssociatedDevices/15" rootUrl="https://localhost/webacs/api/v1/data">
  <entity dtoType="vDAssociatedDevicesDTO" type="VDAssociatedDevices" url="https://localhost/webacs/api/v1/data/VDAssociatedDevices/15">
    <vdAssociatedDevicesDTO displayName="String value" id="15" uuid="String value">
      <ipAddress>String value</ipAddress>
      <name>String value</name>
      <type>String value</type>
    </vdAssociatedDevicesDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v1/data/VDAssociatedDevices/15.json

{
  "queryResponse" : {
    "@type" : "VDAssociatedDevices",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/VDAssociatedDevices\/15",
    "@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "vDAssociatedDevicesDTO",
      "@type" : "VDAssociatedDevices",
      "@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/VDAssociatedDevices\/15",
      "vdAssociatedDevicesDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "ipAddress" : "String value",
        "name" : "String value",
        "type" : "String value"
      }
    }
  }
}