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

GET InventoryDetails

It provides an aggregated view of all the available inventory information for the device.

Since Product Version: 1.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

Resource URL

/webacs/api/v4/data/InventoryDetails

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

Updated

Since v4 version:
  • Type of module.equipmentId attribute is long.
  • Type of ethernetInterface.macAddress is MacAddress.
  • Type of ipInterface.ipAddress is InetAddress. New ipInterface.prefixLegth attribute has been introduced.
  • Representation of cdpNeighbor.capabilitiese has been changed for better readability.

Response Parameters

Attribute Description

cdpNeighbor Arrow image CDPNeighborV4[]

This nested field provides information on the CDP neighbors for this device.

chassis Arrow image Chassis[]

This nested field provides a listing of the chassis associated with this device.

etherChannel Arrow image EtherChannel[]

This nested field provides information about the ether channels associated with this device.

ethernetInterface Arrow image EthernetInterfaceV4[]

This nested field provides information on the ethernet interfaces associated with this device.

fan Arrow image FanV3[]

This nested field provides information about the fans associated with this device

ipInterface Arrow image IpInterfaceV4[]

This nested field provides information about the ip interfaces associated with this device.

module Arrow image DeviceModuleV4[]

This nested field provides a listing of the modules associated with this device

physicalPort Arrow image PhysicalPortV3[]

This nested field provides information about the physical ports associated with this device.

powerSupply Arrow image PowerSupplyV3[]

This nested field provides information about the power supplies associated with this device.

sensor Arrow image DeviceSensor[]

This nested field provides information about the sensors associated with this device.

summary Arrow image SummaryV3

A nested field that provides an inventory summary

udf Arrow image UDFValue[]

This nested field provides the user defined fields for this device.

vlanInterface Arrow image VlanInterfaceV3[]

This nested field provides information about the vlan interfaces associated with this 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://10.64.88.203/webacs/api/v4/data/InventoryDetails/15

<?xml version="1.0" ?>
<queryResponse type="InventoryDetails" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/InventoryDetails/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
  <entity dtoType="inventoryDetailsDTO" type="InventoryDetails" url="https://10.64.88.203/webacs/api/v4/data/InventoryDetails/15">
    <inventoryDetailsDTO displayName="String value" id="15" uuid="String value">
      <cdpNeighbors>
        <cdpNeighbor>
          <duplexMode>UNKNOWN</duplexMode>
          <farEndInterface>String value</farEndInterface>
          <interfaceIndex>1</interfaceIndex>
          <nearEndInterface>String value</nearEndInterface>
          <neighborCapabilities>String value</neighborCapabilities>
          <neighborDeviceName>String value</neighborDeviceName>
          <neighborDevicePlatformType>String value</neighborDevicePlatformType>
          <neighborCapabilities>String value</neighborCapabilities>
        </cdpNeighbor>
        <cdpNeighbor>
          <duplexMode>HALF_DUPLEX</duplexMode>
          <farEndInterface>Another string value</farEndInterface>
          <interfaceIndex>11</interfaceIndex>
          <nearEndInterface>Another string value</nearEndInterface>
          <neighborCapabilities>Another string value</neighborCapabilities>
          <neighborDeviceName>Another string value</neighborDeviceName>
          <neighborDevicePlatformType>Another string value</neighborDevicePlatformType>
          <neighborCapabilities>Another string value</neighborCapabilities>
        </cdpNeighbor>
      </cdpNeighbors>
      <chassis>
        <chassis>
          <description>String value</description>
          <entPhysicalIndex>String value</entPhysicalIndex>
          <modelNr>String value</modelNr>
          <name>String value</name>
          <productId>String value</productId>
          <serialNr>String value</serialNr>
          <versionId>String value</versionId>
        </chassis>
        <chassis>
          <description>Another string value</description>
          <entPhysicalIndex>Another string value</entPhysicalIndex>
          <modelNr>Another string value</modelNr>
          <name>Another string value</name>
          <productId>Another string value</productId>
          <serialNr>Another string value</serialNr>
          <versionId>Another string value</versionId>
        </chassis>
      </chassis>
      <etherChannels>
        <etherChannel>
          <actorAdminKey>15</actorAdminKey>
          <channelGroupId>1</channelGroupId>
          <controlMethod>MANUAL</controlMethod>
          <name>String value</name>
          <numberOfMembers>1</numberOfMembers>
        </etherChannel>
        <etherChannel>
          <actorAdminKey>25</actorAdminKey>
          <channelGroupId>11</channelGroupId>
          <controlMethod>LACP</controlMethod>
          <name>Another string value</name>
          <numberOfMembers>11</numberOfMembers>
        </etherChannel>
      </etherChannels>
      <ethernetInterfaces>
        <ethernetInterface>
          <accessVlan>15</accessVlan>
          <adminStatus>UNKNOWN</adminStatus>
          <allowedVlanIds>String value</allowedVlanIds>
          <channelGroupId>15</channelGroupId>
          <description>String value</description>
          <desiredTrunkingEncapsulation>UNKOWN</desiredTrunkingEncapsulation>
          <desiredVlanMode>UNKNOWN</desiredVlanMode>
          <duplexMode>UNKNOWN</duplexMode>
          <mtu>15</mtu>
          <name>String value</name>
          <nativeVlan>15</nativeVlan>
          <operationalStatus>NOT_APPLICABLE</operationalStatus>
          <operationalTrunkEncapsulation>UNKOWN</operationalTrunkEncapsulation>
          <operationalVlanMode>UNKNOWN</operationalVlanMode>
          <pruneEligibleVlanIds>String value</pruneEligibleVlanIds>
          <trunkingEncapsulationNegotiation>true</trunkingEncapsulationNegotiation>
          <macAddress>
            <octets>000a959d6816</octets>
          </macAddress>
          <speed>15</speed>
        </ethernetInterface>
        <ethernetInterface>
          <accessVlan>25</accessVlan>
          <adminStatus>UP</adminStatus>
          <allowedVlanIds>Another string value</allowedVlanIds>
          <channelGroupId>25</channelGroupId>
          <description>Another string value</description>
          <desiredTrunkingEncapsulation>OTHER</desiredTrunkingEncapsulation>
          <desiredVlanMode>OTHER</desiredVlanMode>
          <duplexMode>HALFDUPLEX</duplexMode>
          <mtu>25</mtu>
          <name>Another string value</name>
          <nativeVlan>25</nativeVlan>
          <operationalStatus>UP</operationalStatus>
          <operationalTrunkEncapsulation>OTHER</operationalTrunkEncapsulation>
          <operationalVlanMode>OTHER</operationalVlanMode>
          <pruneEligibleVlanIds>Another string value</pruneEligibleVlanIds>
          <trunkingEncapsulationNegotiation>false</trunkingEncapsulationNegotiation>
          <macAddress>
            <octets>000a959d6817</octets>
          </macAddress>
          <speed>25</speed>
        </ethernetInterface>
      </ethernetInterfaces>
      <fans>
        <fan>
          <description>String value</description>
          <name>String value</name>
          <operationalStatus>String value</operationalStatus>
          <productId>String value</productId>
          <serialNumber>String value</serialNumber>
          <vendorEquipmentType>String value</vendorEquipmentType>
          <versionId>String value</versionId>
        </fan>
        <fan>
          <description>Another string value</description>
          <name>Another string value</name>
          <operationalStatus>Another string value</operationalStatus>
          <productId>Another string value</productId>
          <serialNumber>Another string value</serialNumber>
          <vendorEquipmentType>Another string value</vendorEquipmentType>
          <versionId>Another string value</versionId>
        </fan>
      </fans>
      <ipInterfaces>
        <ipInterface>
          <adminStatus>UNKNOWN</adminStatus>
          <name>String value</name>
          <operationalStatus>NOT_APPLICABLE</operationalStatus>
          <ipAddress>
            <address>192.168.115.243</address>
          </ipAddress>
          <prefixLength>String value</prefixLength>
        </ipInterface>
        <ipInterface>
          <adminStatus>UP</adminStatus>
          <name>Another string value</name>
          <operationalStatus>UP</operationalStatus>
          <ipAddress>
            <address>192.168.115.244</address>
          </ipAddress>
          <prefixLength>Another string value</prefixLength>
        </ipInterface>
      </ipInterfaces>
      <modules>
        <module>
          <description>String value</description>
          <equipmentType>OTHER</equipmentType>
          <firmwareVersion>String value</firmwareVersion>
          <operationStatus>String value</operationStatus>
          <physicalLocation>String value</physicalLocation>
          <productId>String value</productId>
          <productName>String value</productName>
          <slotNumber>String value</slotNumber>
          <softwareVersion>String value</softwareVersion>
          <vendorType>String value</vendorType>
          <equipmentId>2</equipmentId>
          <nrPorts>15</nrPorts>
          <serialNr>String value</serialNr>
          <versionId>String value</versionId>
        </module>
        <module>
          <description>Another string value</description>
          <equipmentType>UNKNOWN</equipmentType>
          <firmwareVersion>Another string value</firmwareVersion>
          <operationStatus>Another string value</operationStatus>
          <physicalLocation>Another string value</physicalLocation>
          <productId>Another string value</productId>
          <productName>Another string value</productName>
          <slotNumber>Another string value</slotNumber>
          <softwareVersion>Another string value</softwareVersion>
          <vendorType>Another string value</vendorType>
          <equipmentId>12</equipmentId>
          <nrPorts>25</nrPorts>
          <serialNr>Another string value</serialNr>
          <versionId>Another string value</versionId>
        </module>
      </modules>
      <physicalPorts>
        <physicalPort>
          <description>String value</description>
          <equipmentId>2</equipmentId>
          <name>String value</name>
          <residingModule>String value</residingModule>
          <vendorEquipmentType>String value</vendorEquipmentType>
        </physicalPort>
        <physicalPort>
          <description>Another string value</description>
          <equipmentId>12</equipmentId>
          <name>Another string value</name>
          <residingModule>Another string value</residingModule>
          <vendorEquipmentType>Another string value</vendorEquipmentType>
        </physicalPort>
      </physicalPorts>
      <powerSupplies>
        <powerSupply>
          <description>String value</description>
          <manufacturerName>String value</manufacturerName>
          <name>String value</name>
          <operationalStatus>String value</operationalStatus>
          <productId>String value</productId>
          <serialNumber>String value</serialNumber>
          <vendorEquipmentType>String value</vendorEquipmentType>
          <versionId>String value</versionId>
        </powerSupply>
        <powerSupply>
          <description>Another string value</description>
          <manufacturerName>Another string value</manufacturerName>
          <name>Another string value</name>
          <operationalStatus>Another string value</operationalStatus>
          <productId>Another string value</productId>
          <serialNumber>Another string value</serialNumber>
          <vendorEquipmentType>Another string value</vendorEquipmentType>
          <versionId>Another string value</versionId>
        </powerSupply>
      </powerSupplies>
      <sensors>
        <sensor>
          <description>String value</description>
          <entPhysicalIndex>String value</entPhysicalIndex>
          <equipmentName>String value</equipmentName>
          <name>String value</name>
          <precision>15</precision>
          <status>OK</status>
          <type>OTHER</type>
          <vendorSensorType>String value</vendorSensorType>
        </sensor>
        <sensor>
          <description>Another string value</description>
          <entPhysicalIndex>Another string value</entPhysicalIndex>
          <equipmentName>Another string value</equipmentName>
          <name>Another string value</name>
          <precision>25</precision>
          <status>UNAVAILABLE</status>
          <type>UNKNOWN</type>
          <vendorSensorType>Another string value</vendorSensorType>
        </sensor>
      </sensors>
      <summary>
        <lazyLoadedEntities>
          <entry>
            <key>Another string value</key>
            <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>
          </entry>
          <entry>
            <key>String value</key>
            <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>
          </entry>
        </lazyLoadedEntities>
        <ciscoIdentityCapable>true</ciscoIdentityCapable>
        <contact>String value</contact>
        <deviceId>15</deviceId>
        <deviceName>String value</deviceName>
        <deviceType>String value</deviceType>
        <ipAddress>String value</ipAddress>
        <location>String value</location>
        <locationCapable>true</locationCapable>
        <productFamily>String value</productFamily>
        <reachability>UNKNOWN</reachability>
        <softwareVersion>String value</softwareVersion>
        <systemTime>1986-07-24T00:00:00+05:30</systemTime>
        <upTime>15</upTime>
      </summary>
      <udfs>
        <udf>
          <name>String value</name>
          <value>String value</value>
        </udf>
        <udf>
          <name>Another string value</name>
          <value>Another string value</value>
        </udf>
      </udfs>
      <vlanInterfaces>
        <vlanInterface>
          <adminStatus>UNKNOWN</adminStatus>
          <maxSpeed>15</maxSpeed>
          <mtu>15</mtu>
          <operationalStatus>NOT_APPLICABLE</operationalStatus>
          <portName>String value</portName>
          <portType>OTHER</portType>
          <vlanId>1</vlanId>
        </vlanInterface>
        <vlanInterface>
          <adminStatus>UP</adminStatus>
          <maxSpeed>25</maxSpeed>
          <mtu>25</mtu>
          <operationalStatus>UP</operationalStatus>
          <portName>Another string value</portName>
          <portType>REGULAR1822</portType>
          <vlanId>11</vlanId>
        </vlanInterface>
      </vlanInterfaces>
    </inventoryDetailsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/InventoryDetails/15.json

{
  "queryResponse" : {
    "@type" : "InventoryDetails",
    "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/InventoryDetails/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
    "entity" : [ {
      "@dtoType" : "inventoryDetailsDTO",
      "@type" : "InventoryDetails",
      "@url" : "https://10.64.88.203/webacs/api/v4/data/InventoryDetails/15",
      "inventoryDetailsDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "cdpNeighbors" : {
          "cdpNeighbor" : [ {
            "duplexMode" : "UNKNOWN",
            "farEndInterface" : "String value",
            "interfaceIndex" : 1,
            "nearEndInterface" : "String value",
            "neighborCapabilities" : "String value",
            "neighborDeviceName" : "String value",
            "neighborDevicePlatformType" : "String value"
          }, {
            "duplexMode" : "HALF_DUPLEX",
            "farEndInterface" : "Another string value",
            "interfaceIndex" : 11,
            "nearEndInterface" : "Another string value",
            "neighborCapabilities" : "Another string value",
            "neighborDeviceName" : "Another string value",
            "neighborDevicePlatformType" : "Another string value"
          } ]
        },
        "chassis" : {
          "chassis" : [ {
            "description" : "String value",
            "entPhysicalIndex" : "String value",
            "modelNr" : "String value",
            "name" : "String value",
            "productId" : "String value",
            "serialNr" : "String value",
            "versionId" : "String value"
          }, {
            "description" : "Another string value",
            "entPhysicalIndex" : "Another string value",
            "modelNr" : "Another string value",
            "name" : "Another string value",
            "productId" : "Another string value",
            "serialNr" : "Another string value",
            "versionId" : "Another string value"
          } ]
        },
        "etherChannels" : {
          "etherChannel" : [ {
            "actorAdminKey" : 15,
            "channelGroupId" : 1,
            "controlMethod" : "MANUAL",
            "name" : "String value",
            "numberOfMembers" : 1
          }, {
            "actorAdminKey" : 25,
            "channelGroupId" : 11,
            "controlMethod" : "LACP",
            "name" : "Another string value",
            "numberOfMembers" : 11
          } ]
        },
        "ethernetInterfaces" : {
          "ethernetInterface" : [ {
            "accessVlan" : 15,
            "adminStatus" : "UNKNOWN",
            "allowedVlanIds" : "String value",
            "channelGroupId" : 15,
            "description" : "String value",
            "desiredTrunkingEncapsulation" : "UNKOWN",
            "desiredVlanMode" : "UNKNOWN",
            "duplexMode" : "UNKNOWN",
            "macAddress" : {
              "octets" : "000a959d6816"
            },
            "mtu" : 15,
            "name" : "String value",
            "nativeVlan" : 15,
            "operationalStatus" : "NOT_APPLICABLE",
            "operationalTrunkEncapsulation" : "UNKOWN",
            "operationalVlanMode" : "UNKNOWN",
            "pruneEligibleVlanIds" : "String value",
            "speed" : 15,
            "trunkingEncapsulationNegotiation" : true
          }, {
            "accessVlan" : 25,
            "adminStatus" : "UP",
            "allowedVlanIds" : "Another string value",
            "channelGroupId" : 25,
            "description" : "Another string value",
            "desiredTrunkingEncapsulation" : "OTHER",
            "desiredVlanMode" : "OTHER",
            "duplexMode" : "HALFDUPLEX",
            "macAddress" : {
              "octets" : "000a959d6817"
            },
            "mtu" : 25,
            "name" : "Another string value",
            "nativeVlan" : 25,
            "operationalStatus" : "UP",
            "operationalTrunkEncapsulation" : "OTHER",
            "operationalVlanMode" : "OTHER",
            "pruneEligibleVlanIds" : "Another string value",
            "speed" : 25,
            "trunkingEncapsulationNegotiation" : false
          } ]
        },
        "fans" : {
          "fan" : [ {
            "description" : "String value",
            "name" : "String value",
            "operationalStatus" : "String value",
            "productId" : "String value",
            "serialNumber" : "String value",
            "vendorEquipmentType" : "String value",
            "versionId" : "String value"
          }, {
            "description" : "Another string value",
            "name" : "Another string value",
            "operationalStatus" : "Another string value",
            "productId" : "Another string value",
            "serialNumber" : "Another string value",
            "vendorEquipmentType" : "Another string value",
            "versionId" : "Another string value"
          } ]
        },
        "ipInterfaces" : {
          "ipInterface" : [ {
            "adminStatus" : "UNKNOWN",
            "ipAddress" : {
              "address" : "192.168.115.243"
            },
            "name" : "String value",
            "operationalStatus" : "NOT_APPLICABLE",
            "prefixLength" : "String value"
          }, {
            "adminStatus" : "UP",
            "ipAddress" : {
              "address" : "192.168.115.244"
            },
            "name" : "Another string value",
            "operationalStatus" : "UP",
            "prefixLength" : "Another string value"
          } ]
        },
        "modules" : {
          "module" : [ {
            "description" : "String value",
            "equipmentId" : 2,
            "equipmentType" : "OTHER",
            "firmwareVersion" : "String value",
            "nrPorts" : 15,
            "operationStatus" : "String value",
            "physicalLocation" : "String value",
            "productId" : "String value",
            "productName" : "String value",
            "serialNr" : "String value",
            "slotNumber" : "String value",
            "softwareVersion" : "String value",
            "vendorType" : "String value",
            "versionId" : "String value"
          }, {
            "description" : "Another string value",
            "equipmentId" : 12,
            "equipmentType" : "UNKNOWN",
            "firmwareVersion" : "Another string value",
            "nrPorts" : 25,
            "operationStatus" : "Another string value",
            "physicalLocation" : "Another string value",
            "productId" : "Another string value",
            "productName" : "Another string value",
            "serialNr" : "Another string value",
            "slotNumber" : "Another string value",
            "softwareVersion" : "Another string value",
            "vendorType" : "Another string value",
            "versionId" : "Another string value"
          } ]
        },
        "physicalPorts" : {
          "physicalPort" : [ {
            "description" : "String value",
            "equipmentId" : 2,
            "name" : "String value",
            "residingModule" : "String value",
            "vendorEquipmentType" : "String value"
          }, {
            "description" : "Another string value",
            "equipmentId" : 12,
            "name" : "Another string value",
            "residingModule" : "Another string value",
            "vendorEquipmentType" : "Another string value"
          } ]
        },
        "powerSupplies" : {
          "powerSupply" : [ {
            "description" : "String value",
            "manufacturerName" : "String value",
            "name" : "String value",
            "operationalStatus" : "String value",
            "productId" : "String value",
            "serialNumber" : "String value",
            "vendorEquipmentType" : "String value",
            "versionId" : "String value"
          }, {
            "description" : "Another string value",
            "manufacturerName" : "Another string value",
            "name" : "Another string value",
            "operationalStatus" : "Another string value",
            "productId" : "Another string value",
            "serialNumber" : "Another string value",
            "vendorEquipmentType" : "Another string value",
            "versionId" : "Another string value"
          } ]
        },
        "sensors" : {
          "sensor" : [ {
            "description" : "String value",
            "entPhysicalIndex" : "String value",
            "equipmentName" : "String value",
            "name" : "String value",
            "precision" : 15,
            "status" : "OK",
            "type" : "OTHER",
            "vendorSensorType" : "String value"
          }, {
            "description" : "Another string value",
            "entPhysicalIndex" : "Another string value",
            "equipmentName" : "Another string value",
            "name" : "Another string value",
            "precision" : 25,
            "status" : "UNAVAILABLE",
            "type" : "UNKNOWN",
            "vendorSensorType" : "Another string value"
          } ]
        },
        "summary" : {
          "ciscoIdentityCapable" : true,
          "contact" : "String value",
          "deviceId" : 15,
          "deviceName" : "String value",
          "deviceType" : "String value",
          "ipAddress" : "String value",
          "location" : "String value",
          "locationCapable" : true,
          "productFamily" : "String value",
          "reachability" : "UNKNOWN",
          "softwareVersion" : "String value",
          "systemTime" : "1986-07-23T18:30:00.000Z",
          "upTime" : 15
        },
        "udfs" : {
          "udf" : [ {
            "name" : "String value",
            "value" : "String value"
          }, {
            "name" : "Another string value",
            "value" : "Another string value"
          } ]
        },
        "vlanInterfaces" : {
          "vlanInterface" : [ {
            "adminStatus" : "UNKNOWN",
            "maxSpeed" : 15,
            "mtu" : 15,
            "operationalStatus" : "NOT_APPLICABLE",
            "portName" : "String value",
            "portType" : "OTHER",
            "vlanId" : 1
          }, {
            "adminStatus" : "UP",
            "maxSpeed" : 25,
            "mtu" : 25,
            "operationalStatus" : "UP",
            "portName" : "Another string value",
            "portType" : "REGULAR1822",
            "vlanId" : 11
          } ]
        }
      }
    } ]
  }
}