It provides an aggregated view of all the available inventory information for the device.
Since Product Version: 1.2
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (5)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- CLI Template Configuration (12)
- Clients (7)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (6)
- Device Operations (9)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (6)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Plug and Play (11)
- Rate Limits Management Service (2)
- Report Service (4)
- Software Updates (2)
- Statistics (91)
- System Settings (26)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- v1
- v2
- v3
- v4
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 |
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/InventoryDetailsTo 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 | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This nested field provides information on the CDP neighbors for this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
deviceId Long |
An internal id for the device |
||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the ether channels associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information on the ethernet interfaces associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the fans associated with this device |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
instanceOrigin InstanceOriginEnum |
Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
instanceTenantId Integer |
This is a tenant id for this instance. |
||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the ip interfaces associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides a listing of the modules associated with this device |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the physical ports associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the power supplies associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the sensors associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
A nested field that provides an inventory summary |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides the user defined fields for this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides a listing of the Unique Device Identifier's associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
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://localhost/webacs/api/v1/data/InventoryDetails/15
<?xml version="1.0" ?>
<queryResponse type="InventoryDetails" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/InventoryDetails/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="inventoryDetailsDTO" type="InventoryDetails" url="https://localhost/webacs/api/v1/data/InventoryDetails/15">
<inventoryDetailsDTO displayName="String value" id="15" instanceTenantId="String value" 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>
</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>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>String value</macAddress>
<speed>
<lazyLoadedEntities>
<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>
<instanceId>2</instanceId>
<instanceTenantId>15</instanceTenantId>
<instanceUuid>String value</instanceUuid>
<instanceVersion>1</instanceVersion>
<units>String value</units>
<longAmount>2</longAmount>
</speed>
</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>
<adminStatus>UNKNOWN</adminStatus>
<name>String value</name>
<operationalStatus>NOT_APPLICABLE</operationalStatus>
<ipAddress>String value</ipAddress>
</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>String value</equipmentId>
<isInlinePowerCapable>true</isInlinePowerCapable>
<nrPorts>String value</nrPorts>
</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>
<serialNumber>String value</serialNumber>
<vendorEquipmentType>String value</vendorEquipmentType>
</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>
</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>2018-12-21T12:09:26.368+07:00</systemTime>
<upTime>String value</upTime>
</summary>
<udfs>
<udf>
<name>String value</name>
<value>String value</value>
</udf>
</udfs>
<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>UNKNOWN</adminStatus>
<maxSpeed>
<lazyLoadedEntities>
<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>
<instanceId>2</instanceId>
<instanceTenantId>15</instanceTenantId>
<instanceUuid>String value</instanceUuid>
<instanceVersion>1</instanceVersion>
<units>String value</units>
<longAmount>2</longAmount>
</maxSpeed>
<mtu>15</mtu>
<operationalStatus>NOT_APPLICABLE</operationalStatus>
<portName>String value</portName>
<portType>OTHER</portType>
<vlanId>1</vlanId>
</vlanInterface>
</vlanInterfaces>
</inventoryDetailsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/InventoryDetails/15.json
{
"queryResponse" : {
"@type" : "InventoryDetails",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/InventoryDetails\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "inventoryDetailsDTO",
"@type" : "InventoryDetails",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/InventoryDetails\/15",
"inventoryDetailsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@instanceTenantId" : "String value",
"@uuid" : "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" : "UNKNOWN",
"allowedVlanIds" : "String value",
"channelGroupId" : 15,
"description" : "String value",
"desiredTrunkingEncapsulation" : "UNKOWN",
"desiredVlanMode" : "UNKNOWN",
"duplexMode" : "UNKNOWN",
"mtu" : 15,
"name" : "String value",
"nativeVlan" : 15,
"operationalStatus" : "NOT_APPLICABLE",
"operationalTrunkEncapsulation" : "UNKOWN",
"operationalVlanMode" : "UNKNOWN",
"pruneEligibleVlanIds" : "String value",
"trunkingEncapsulationNegotiation" : true,
"macAddress" : "String value",
"speed" : {
"lazyLoadedEntities" : {
"entry" : {
"key" : "String value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "String value"
}
}
},
"instanceId" : 2,
"instanceTenantId" : 15,
"instanceUuid" : "String value",
"instanceVersion" : 1,
"units" : "String value",
"longAmount" : 2
}
}
},
"fans" : {
"fan" : {
"description" : "String value",
"name" : "String value",
"operationalStatus" : "String value",
"serialNumber" : "String value",
"vendorEquipmentType" : "String value"
}
},
"ipInterfaces" : {
"ipInterface" : {
"adminStatus" : "UNKNOWN",
"name" : "String value",
"operationalStatus" : "NOT_APPLICABLE",
"ipAddress" : "String value"
}
},
"modules" : {
"module" : {
"description" : "String value",
"equipmentType" : "OTHER",
"firmwareVersion" : "String value",
"operationStatus" : "String value",
"physicalLocation" : "String value",
"productId" : "String value",
"productName" : "String value",
"slotNumber" : "String value",
"softwareVersion" : "String value",
"vendorType" : "String value",
"equipmentId" : "String value",
"isInlinePowerCapable" : true,
"nrPorts" : "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",
"serialNumber" : "String value",
"vendorEquipmentType" : "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"
}
},
"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" : "2018-12-21T12 : 09 : 26.368+07 : 00",
"upTime" : "String value"
},
"udfs" : {
"udf" : {
"name" : "String value",
"value" : "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" : "UNKNOWN",
"maxSpeed" : {
"lazyLoadedEntities" : {
"entry" : {
"key" : "String value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "String value"
}
}
},
"instanceId" : 2,
"instanceTenantId" : 15,
"instanceUuid" : "String value",
"instanceVersion" : 1,
"units" : "String value",
"longAmount" : 2
},
"mtu" : 15,
"operationalStatus" : "NOT_APPLICABLE",
"portName" : "String value",
"portType" : "OTHER",
"vlanId" : 1
}
}
}
}
}
}
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/v2/data/InventoryDetailsTo filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
UnmodifiedThis resource has not been modified since the previous API version.
Response Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This nested field provides information on the CDP neighbors for this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
deviceId Long |
An internal id for the device |
||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the ether channels associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information on the ethernet interfaces associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the fans associated with this device |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
instanceOrigin InstanceOriginEnum |
Allowed values:
|
||||||||||||||||||||||||||||||||||||||||||||||||
instanceTenantId Integer |
This is a tenant id for this instance. |
||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the ip interfaces associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides a listing of the modules associated with this device |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the physical ports associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the power supplies associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the sensors associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
A nested field that provides an inventory summary |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides the user defined fields for this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
This nested field provides a listing of the Unique Device Identifier's associated with this device. |
|||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
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://localhost/webacs/api/v2/data/InventoryDetails/15
<?xml version="1.0" ?>
<queryResponse type="InventoryDetails" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/InventoryDetails/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="inventoryDetailsDTO" type="InventoryDetails" url="https://localhost/webacs/api/v2/data/InventoryDetails/15">
<inventoryDetailsDTO displayName="String value" id="15" instanceTenantId="String value" 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>
</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>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>String value</macAddress>
<speed>
<lazyLoadedEntities>
<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>
<instanceId>2</instanceId>
<instanceTenantId>15</instanceTenantId>
<instanceUuid>String value</instanceUuid>
<instanceVersion>1</instanceVersion>
<units>String value</units>
<longAmount>2</longAmount>
</speed>
</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>
<adminStatus>UNKNOWN</adminStatus>
<name>String value</name>
<operationalStatus>NOT_APPLICABLE</operationalStatus>
<ipAddress>String value</ipAddress>
</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>String value</equipmentId>
<isInlinePowerCapable>true</isInlinePowerCapable>
<nrPorts>String value</nrPorts>
</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>
<serialNumber>String value</serialNumber>
<vendorEquipmentType>String value</vendorEquipmentType>
</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>
</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>2018-12-21T12:09:26.407+07:00</systemTime>
<upTime>String value</upTime>
</summary>
<udfs>
<udf>
<name>String value</name>
<value>String value</value>
</udf>
</udfs>
<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>UNKNOWN</adminStatus>
<maxSpeed>
<lazyLoadedEntities>
<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>
<instanceId>2</instanceId>
<instanceTenantId>15</instanceTenantId>
<instanceUuid>String value</instanceUuid>
<instanceVersion>1</instanceVersion>
<units>String value</units>
<longAmount>2</longAmount>
</maxSpeed>
<mtu>15</mtu>
<operationalStatus>NOT_APPLICABLE</operationalStatus>
<portName>String value</portName>
<portType>OTHER</portType>
<vlanId>1</vlanId>
</vlanInterface>
</vlanInterfaces>
</inventoryDetailsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/InventoryDetails/15.json
{
"queryResponse" : {
"@type" : "InventoryDetails",
"@requestUrl" : "https://localhost/webacs/api/v2/data/InventoryDetails/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "inventoryDetailsDTO",
"@type" : "InventoryDetails",
"@url" : "https://localhost/webacs/api/v2/data/InventoryDetails/15",
"inventoryDetailsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@uuid" : "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" : "UNKNOWN",
"allowedVlanIds" : "String value",
"channelGroupId" : 15,
"description" : "String value",
"desiredTrunkingEncapsulation" : "UNKOWN",
"desiredVlanMode" : "UNKNOWN",
"duplexMode" : "UNKNOWN",
"macAddress" : "String value",
"mtu" : 15,
"name" : "String value",
"nativeVlan" : 15,
"operationalStatus" : "NOT_APPLICABLE",
"operationalTrunkEncapsulation" : "UNKOWN",
"operationalVlanMode" : "UNKNOWN",
"pruneEligibleVlanIds" : "String value",
"speed" : {
"longAmount" : 2,
"units" : "String value"
},
"trunkingEncapsulationNegotiation" : true
} ]
},
"fans" : {
"fan" : [ {
"description" : "String value",
"name" : "String value",
"operationalStatus" : "String value",
"serialNumber" : "String value",
"vendorEquipmentType" : "String value"
} ]
},
"ipInterfaces" : {
"ipInterface" : [ {
"adminStatus" : "UNKNOWN",
"ipAddress" : "String value",
"name" : "String value",
"operationalStatus" : "NOT_APPLICABLE"
} ]
},
"modules" : {
"module" : [ {
"description" : "String value",
"equipmentId" : "String value",
"equipmentType" : "OTHER",
"firmwareVersion" : "String value",
"isInlinePowerCapable" : true,
"nrPorts" : "String value",
"operationStatus" : "String value",
"physicalLocation" : "String value",
"productId" : "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",
"serialNumber" : "String value",
"vendorEquipmentType" : "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"
} ]
},
"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" : 1545368966407,
"upTime" : "String value"
},
"udfs" : {
"udf" : [ {
"name" : "String value",
"value" : "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" : "UNKNOWN",
"maxSpeed" : {
"longAmount" : 2,
"units" : "String value"
},
"mtu" : 15,
"operationalStatus" : "NOT_APPLICABLE",
"portName" : "String value",
"portType" : "OTHER",
"vlanId" : 1
} ]
}
}
} ]
}
}
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/v3/data/InventoryDetailsTo filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Updated- The summary.upTime field has a new format in milliseconds.
- The deviceId field was renamed to summary.deviceId.
- The port.deviceId field was removed as redundant.
This version has been deprecated. Please use v4.
Response Parameters
Attribute | Description | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This nested field provides information on the CDP neighbors for this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides a listing of the chassis associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the ether channels associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides information on the ethernet interfaces associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the fans associated with this device |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
instanceOrigin InstanceOriginEnum |
Allowed values:
|
|||||||||||||||||||||||||||||||||||||||
instanceTenantId Integer |
This is a tenant id for this instance. |
|||||||||||||||||||||||||||||||||||||||
This nested field provides information about the ip interfaces associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides a listing of the modules associated with this device |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the physical ports associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the power supplies associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the sensors associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
A nested field that provides an inventory summary |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides the user defined fields for this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
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://localhost/webacs/api/v3/data/InventoryDetails/15
<?xml version="1.0" ?>
<queryResponse type="InventoryDetails" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/InventoryDetails/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="inventoryDetailsDTO" type="InventoryDetails" url="https://localhost/webacs/api/v3/data/InventoryDetails/15">
<inventoryDetailsDTO displayName="String value" id="15" instanceTenantId="String value" 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>
</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>
</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>String value</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>Another string value</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>String value</ipAddress>
</ipInterface>
<ipInterface>
<adminStatus>UP</adminStatus>
<name>Another string value</name>
<operationalStatus>UP</operationalStatus>
<ipAddress>Another string value</ipAddress>
</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>String value</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>Another string value</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>2018-12-21T12:09:26.436+07:00</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://localhost/webacs/api/v3/data/InventoryDetails/15.json
{
"queryResponse" : {
"@type" : "InventoryDetails",
"@requestUrl" : "https://localhost/webacs/api/v3/data/InventoryDetails/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "inventoryDetailsDTO",
"@type" : "InventoryDetails",
"@url" : "https://localhost/webacs/api/v3/data/InventoryDetails/15",
"inventoryDetailsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@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" : "String value",
"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" : "Another string value",
"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" : "String value",
"name" : "String value",
"operationalStatus" : "NOT_APPLICABLE"
}, {
"adminStatus" : "UP",
"ipAddress" : "Another string value",
"name" : "Another string value",
"operationalStatus" : "UP"
} ]
},
"modules" : {
"module" : [ {
"description" : "String value",
"equipmentId" : "String value",
"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" : "Another string value",
"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" : "2018-12-21T05:09:26.436Z",
"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
} ]
}
}
} ]
}
}
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/InventoryDetailsTo filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters
Updated- 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 | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This nested field provides information on the CDP neighbors for this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides a listing of the chassis associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the ether channels associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides information on the ethernet interfaces associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the fans associated with this device |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
instanceOrigin InstanceOriginEnum |
Allowed values:
|
|||||||||||||||||||||||||||||||||||||||
instanceTenantId Integer |
This is a tenant id for this instance. |
|||||||||||||||||||||||||||||||||||||||
This nested field provides information about the ip interfaces associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides a listing of the modules associated with this device |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the physical ports associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the power supplies associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides information about the sensors associated with this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
A nested field that provides an inventory summary |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
This nested field provides the user defined fields for this device. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
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://localhost/webacs/api/v4/data/InventoryDetails/15
<?xml version="1.0" ?>
<queryResponse type="InventoryDetails" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/InventoryDetails/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="inventoryDetailsDTO" type="InventoryDetails" url="https://localhost/webacs/api/v4/data/InventoryDetails/15">
<inventoryDetailsDTO displayName="String value" id="15" instanceTenantId="String value" 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>2018-12-21T12:09:26.462+07:00</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://localhost/webacs/api/v4/data/InventoryDetails/15.json
{
"queryResponse" : {
"@type" : "InventoryDetails",
"@requestUrl" : "https://localhost/webacs/api/v4/data/InventoryDetails/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "inventoryDetailsDTO",
"@type" : "InventoryDetails",
"@url" : "https://localhost/webacs/api/v4/data/InventoryDetails/15",
"inventoryDetailsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@instanceTenantId" : "String value",
"@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" : "2018-12-21T05:09:26.462Z",
"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
} ]
}
}
} ]
}
}