It provides an aggregated view of all the available inventory information for the device.
Resource URL
/webacs/api/v1/data/InventoryDetailsSince : 1.2
Response Parameters
| Type | Attribute Name | Description |
|---|---|---|
|
|
cdpNeighbor |
This nested field provides information on the CDP neighbors for this device. |
|
Long |
deviceId |
An internal id for the device |
|
|
etherChannel |
This nested field provides information about the ether channels associated with this device. |
|
|
ethernetInterface |
This nested field provides information on the ethernet interfaces associated with this device. |
|
|
fan |
This nested field provides information about the fans associated with this device |
|
|
ipInterface |
This nested field provides information about the ip interfaces associated with this device. |
|
|
module |
This nested field provides a listing of the modules associated with this device |
|
|
physicalPort |
This nested field provides information about the physical ports associated with this device. |
|
|
powerSupply |
This nested field provides information about the power supplies associated with this device. |
|
|
sensor |
This nested field provides information about the sensors associated with this device. |
|
|
summary |
A nested field that provides an inventory summary |
|
|
udiDetail |
This nested field provides a listing of the Unique Device Identifier's associated with this device. |
|
|
vlanInterface |
This nested field provides information about the vlan interfaces associated with this device. |
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://192.168.116.207/webacs/api/v1/data/InventoryDetails/42
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/InventoryDetails/42" responseType="getEntity">
<entity url="/webacs/data/className/15" type="className" dtoType="inventoryDetailsDTO_$$_javassist_5166">
<inventoryDetailsDTO id="15" displayName="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>
</cdpNeighbor>
</cdpNeighbors>
<deviceId>15</deviceId>
<etherChannels>
<etherChannel>
<actorAdminKey>15</actorAdminKey>
<channelGroupId>1</channelGroupId>
<controlMethod>MANUAL</controlMethod>
<name>String value</name>
<numberOfMembers>1</numberOfMembers>
</etherChannel>
</etherChannels>
<ethernetInterfaces>
<ethernetInterface>
<accessVlan>15</accessVlan>
<adminStatus>UP</adminStatus>
<allowedVlanIds>String value</allowedVlanIds>
<desiredTrunkingEncapsulation>UNKOWN</desiredTrunkingEncapsulation>
<desiredVlanMode>UNKNOWN</desiredVlanMode>
<duplexMode>HALFDUPLEX</duplexMode>
<macAddress>String value</macAddress>
<mtu>15</mtu>
<name>String value</name>
<nativeVlan>15</nativeVlan>
<operationalStatus>UP</operationalStatus>
<operationalTrunkEncapsulation>UNKOWN</operationalTrunkEncapsulation>
<operationalVlanMode>UNKNOWN</operationalVlanMode>
<pruneEligibleVlanIds>String value</pruneEligibleVlanIds>
<speed>
<instanceId>2</instanceId>
<instanceVersion>1</instanceVersion>
<units>String value</units>
<longAmount>2</longAmount>
</speed>
<trunkingEncapsulationNegotiation>true</trunkingEncapsulationNegotiation>
</ethernetInterface>
</ethernetInterfaces>
<fans>
<fan>
<description>String value</description>
<name>String value</name>
<operationalStatus>String value</operationalStatus>
<serialNumber>String value</serialNumber>
<vendorEquipmentType>String value</vendorEquipmentType>
</fan>
</fans>
<ipInterfaces>
<ipInterface>
<ipAddress>String value</ipAddress>
<name>String value</name>
</ipInterface>
</ipInterfaces>
<modules>
<module>
<description>String value</description>
<equipmentId>String value</equipmentId>
<equipmentType>OTHER</equipmentType>
<firmwareVersion>String value</firmwareVersion>
<isInlinePowerCapable>true</isInlinePowerCapable>
<nrPorts>String value</nrPorts>
<operationStatus>String value</operationStatus>
<physicalLocation>String value</physicalLocation>
<productName>String value</productName>
<slotNumber>String value</slotNumber>
<softwareVersion>String value</softwareVersion>
<vendorType>String value</vendorType>
</module>
</modules>
<physicalPorts>
<physicalPort>
<description>String value</description>
<deviceId>2</deviceId>
<equipmentId>2</equipmentId>
<name>String value</name>
<residingModule>String value</residingModule>
<vendorEquipmentType>String value</vendorEquipmentType>
</physicalPort>
</physicalPorts>
<powerSupplies>
<powerSupply>
<description>String value</description>
<manufacturerName>String value</manufacturerName>
<name>String value</name>
<operationalStatus>String value</operationalStatus>
<vendorEquipmentType>String value</vendorEquipmentType>
</powerSupply>
</powerSupplies>
<sensors>
<sensor>
<description>String value</description>
<equipmentName>String value</equipmentName>
<name>String value</name>
<precision>15</precision>
<status>OK</status>
<type>OTHER</type>
<vendorSensorType>String value</vendorSensorType>
</sensor>
</sensors>
<summary>
<ciscoIdentityCapable>true</ciscoIdentityCapable>
<contact>String value</contact>
<deviceId>String value</deviceId>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<ipAddress>String value</ipAddress>
<location>String value</location>
<locationCapable>true</locationCapable>
<nrPortsDown>2</nrPortsDown>
<nrPortsUp>2</nrPortsUp>
<productFamily>String value</productFamily>
<reachability>UNKNOWN</reachability>
<softwareVersion>String value</softwareVersion>
<systemTime>2013-07-02T18:07:35.321-07:00</systemTime>
<upTime>String value</upTime>
</summary>
<udiDetails>
<udiDetail>
<description>String value</description>
<modelNr>String value</modelNr>
<name>String value</name>
<productId>String value</productId>
<udiSerialNr>String value</udiSerialNr>
<versionId>String value</versionId>
</udiDetail>
</udiDetails>
<vlanInterfaces>
<vlanInterface>
<adminStatus>UP</adminStatus>
<maxSpeed>
<instanceId>2</instanceId>
<instanceVersion>1</instanceVersion>
<units>String value</units>
<longAmount>2</longAmount>
</maxSpeed>
<mtu>15</mtu>
<operationalStatus>UP</operationalStatus>
<portName>String value</portName>
<portType>OTHER</portType>
<vlanId>1</vlanId>
</vlanInterface>
</vlanInterfaces>
</inventoryDetailsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://192.168.116.207/webacs/api/v1/data/InventoryDetails/42.json
{
"queryResponse" : {
"@rootUrl" : "\/webacs\/data",
"@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/InventoryDetails\/42",
"@responseType" : "getEntity",
"entity" : {
"@url" : "\/webacs\/data\/className\/15",
"@type" : "className",
"@dtoType" : "inventoryDetailsDTO_$$_javassist_5166",
"inventoryDetailsDTO" : {
"@id" : "15",
"@displayName" : "String value",
"cdpNeighbors" : {
"cdpNeighbor" : {
"duplexMode" : "UNKNOWN",
"farEndInterface" : "String value",
"interfaceIndex" : 1,
"nearEndInterface" : "String value",
"neighborCapabilities" : "String value",
"neighborDeviceName" : "String value",
"neighborDevicePlatformType" : "String value"
}
},
"deviceId" : 15,
"etherChannels" : {
"etherChannel" : {
"actorAdminKey" : 15,
"channelGroupId" : 1,
"controlMethod" : "MANUAL",
"name" : "String value",
"numberOfMembers" : 1
}
},
"ethernetInterfaces" : {
"ethernetInterface" : {
"accessVlan" : 15,
"adminStatus" : "UP",
"allowedVlanIds" : "String value",
"desiredTrunkingEncapsulation" : "UNKOWN",
"desiredVlanMode" : "UNKNOWN",
"duplexMode" : "HALFDUPLEX",
"macAddress" : "String value",
"mtu" : 15,
"name" : "String value",
"nativeVlan" : 15,
"operationalStatus" : "UP",
"operationalTrunkEncapsulation" : "UNKOWN",
"operationalVlanMode" : "UNKNOWN",
"pruneEligibleVlanIds" : "String value",
"speed" : {
"instanceId" : 2,
"instanceVersion" : 1,
"units" : "String value",
"longAmount" : 2
},
"trunkingEncapsulationNegotiation" : true
}
},
"fans" : {
"fan" : {
"description" : "String value",
"name" : "String value",
"operationalStatus" : "String value",
"serialNumber" : "String value",
"vendorEquipmentType" : "String value"
}
},
"ipInterfaces" : {
"ipInterface" : {
"ipAddress" : "String value",
"name" : "String value"
}
},
"modules" : {
"module" : {
"description" : "String value",
"equipmentId" : "String value",
"equipmentType" : "OTHER",
"firmwareVersion" : "String value",
"isInlinePowerCapable" : true,
"nrPorts" : "String value",
"operationStatus" : "String value",
"physicalLocation" : "String value",
"productName" : "String value",
"slotNumber" : "String value",
"softwareVersion" : "String value",
"vendorType" : "String value"
}
},
"physicalPorts" : {
"physicalPort" : {
"description" : "String value",
"deviceId" : 2,
"equipmentId" : 2,
"name" : "String value",
"residingModule" : "String value",
"vendorEquipmentType" : "String value"
}
},
"powerSupplies" : {
"powerSupply" : {
"description" : "String value",
"manufacturerName" : "String value",
"name" : "String value",
"operationalStatus" : "String value",
"vendorEquipmentType" : "String value"
}
},
"sensors" : {
"sensor" : {
"description" : "String value",
"equipmentName" : "String value",
"name" : "String value",
"precision" : 15,
"status" : "OK",
"type" : "OTHER",
"vendorSensorType" : "String value"
}
},
"summary" : {
"ciscoIdentityCapable" : true,
"contact" : "String value",
"deviceId" : "String value",
"deviceName" : "String value",
"deviceType" : "String value",
"ipAddress" : "String value",
"location" : "String value",
"locationCapable" : true,
"nrPortsDown" : 2,
"nrPortsUp" : 2,
"productFamily" : "String value",
"reachability" : "UNKNOWN",
"softwareVersion" : "String value",
"systemTime" : "2013-07-02T18 : 07 : 35.379-07 : 00",
"upTime" : "String value"
},
"udiDetails" : {
"udiDetail" : {
"description" : "String value",
"modelNr" : "String value",
"name" : "String value",
"productId" : "String value",
"udiSerialNr" : "String value",
"versionId" : "String value"
}
},
"vlanInterfaces" : {
"vlanInterface" : {
"adminStatus" : "UP",
"maxSpeed" : {
"instanceId" : 2,
"instanceVersion" : 1,
"units" : "String value",
"longAmount" : 2
},
"mtu" : 15,
"operationalStatus" : "UP",
"portName" : "String value",
"portType" : "OTHER",
"vlanId" : 1
}
}
}
}
}
}