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

GET statisticsService/vms

Deprecated

Data Center support has been deprecated. Use DCNM for NXOS deployments and ACI for ACI-mode Deployments for data-center devices.

Fetches the details of VMs

Since Product Version: 3.1

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v2/op/statisticsService/vms

Request Parameters

Attribute Source Description

datacenter String

query

Optional

Pattern to match the Datacenter name. If you do not specify any, all the Datacenters are considered.

cluster String

query

Optional

Pattern to match the Cluster name. If you do not specify any, all the Clusters are considered.

host String

query

Optional

Pattern to match the Hypervisor name. If you do not specify any, all the Clusters are considered.

vm String

query

Optional

Pattern to match the VM name. If you do not specify any, all the Clusters are considered.

children Boolean

query

Optional

Not Applicable for VMs

Range String

query

Optional

firstResult Integer

query

Optional

TBD

maxResults Integer

query

Optional

TBD

sort String

query

Optional

Response Parameters

Attribute Description

resources Arrow image ResourceDetailsDTO[]

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 Response Payload

https://10.64.88.203/webacs/api/v2/op/statisticsService/vms?datacenter="DC1"&cluster="CL1"&host="HOST1"&vm="VM1"&firstResult=0&maxResults=10&sort=-vm

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v2/op/statisticsService/vms?datacenter=&amp;quot;DC1&amp;quot;&amp;amp;cluster=&amp;quot;CL1&amp;quot;&amp;amp;host=&amp;quot;HOST1&amp;quot;&amp;amp;vm=&amp;quot;VM1&amp;quot;&amp;amp;firstResult=0&amp;amp;maxResults=10&amp;amp;sort=-vm
					" rootUrl="https://10.64.88.203/webacs/api/v2/op">
  <resourcesDTO>
    <resources>
      <resources>
        <childrenLink>String value</childrenLink>
        <description>String value</description>
        <details>
          <item key="Another string value">
            <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
          </item>
          <item key="String value">
            <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
          </item>
        </details>
        <metricsLink>String value</metricsLink>
        <name>String value</name>
        <type>String value</type>
      </resources>
      <resources>
        <childrenLink>Another string value</childrenLink>
        <description>Another string value</description>
        <details>
          <item key="Another string value">
            <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Another string value</value>
          </item>
          <item key="String value">
            <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
          </item>
        </details>
        <metricsLink>Another string value</metricsLink>
        <name>Another string value</name>
        <type>Another string value</type>
      </resources>
    </resources>
  </resourcesDTO>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.88.203/webacs/api/v2/op/statisticsService/vms.json?datacenter="DC1"&cluster="CL1"&host="HOST1"&vm="VM1"&firstResult=0&maxResults=10&sort=-vm

{
  "mgmtResponse" : {
    "@requestUrl" : "https://10.64.88.203/webacs/api/v2/op/statisticsService/vms?datacenter=&quot;DC1&quot;&amp;cluster=&quot;CL1&quot;&amp;host=&quot;HOST1&quot;&amp;vm=&quot;VM1&quot;&amp;firstResult=0&amp;maxResults=10&amp;sort=-vm\n\t\t\t\t\t",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.64.88.203/webacs/api/v2/op",
    "resourcesDTO" : [ {
      "resources" : {
        "resources" : [ {
          "childrenLink" : "String value",
          "description" : "String value",
          "details" : [ {
            "@key" : "Another string value",
            "value" : "Another string value"
          }, {
            "@key" : "String value",
            "value" : "String value"
          } ],
          "metricsLink" : "String value",
          "name" : "String value",
          "type" : "String value"
        }, {
          "childrenLink" : "Another string value",
          "description" : "Another string value",
          "details" : [ {
            "@key" : "Another string value",
            "value" : "Another string value"
          }, {
            "@key" : "String value",
            "value" : "String value"
          } ],
          "metricsLink" : "Another string value",
          "name" : "Another string value",
          "type" : "Another string value"
        } ]
      }
    } ]
  }
}