
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

- Jump To

- 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

API version v1 is deprecated

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

## Resource URL

/webacs/api/v1/data/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

## Response Parameters

Attribute | Description
--- | ---
cdpNeighbor CDPNeighbor[] | This nested field provides information on the CDP neighbors for this device.
Attribute | Description
--- | ---
duplexMode CDPDuplexMode | The duplex mode between the local device and the neighbor. Allowed values UNKNOWN HALF_DUPLEX FULL_DUPLEX
farEndInterface String | The interface on the neighbor device connected to the local device.
interfaceIndex int | The index of the local interface.
nearEndInterface String | The interface on the local device connected to the neighbor device.
neighborCapabilities String | Neighbor capabilities as reported by SNMP. Set of neighbor capabilities is stored like string which starts with "S-" and then a list of numbers separated by ':'. Example: "S-1:4:6". Each number means a certain neighbor capability: 1 - ROUTER, 2 - TB_BRIDGE, 3 - SR_BRIDGE, 4 - SWITCH, 5 - HOST, 6 - IGMP_CONDITIONAL_FILTERING, 7 - REPEATER, 8 - VOIP_PHONE.
neighborDeviceName String | The neighbor device's name.
neighborDevicePlatformType String | The neighbor device's platform type.
deviceId Long | An internal id for the device
etherChannel EtherChannel[] | This nested field provides information about the ether channels associated with this device.
Attribute | Description
--- | ---
actorAdminKey Integer | The current administrative value of the 16-bit Key for the Aggregator (Actor). The administrative Key value may differ from the operational Key value for reasons discussed in the IEEE 802.3ad document, Section 43.6.2. The meaning of particular Key values is of local significance MIB.IEEE|IEEE8023-LAG-MIB.dot3adAggActorAdminKey.
channelGroupId int | The value of this property is the group ID assigned to the aggregation. Note that this is needed for configuring EtherChannel in Cisco devices but it is not part of the 802.3ad standard (i.e., it is not the same as the LAG ID in 802.3ad).
controlMethod LAGControlProtocolEnum | Enumeration attribute to indicate how aggregation is controlled. Allowed values MANUAL LACP PAGP
name String | The name of this Ethernet Channel.
numberOfMembers int | The number of ProtocolEndpoint's that list this EtherChannel as their lagEndName.
ethernetInterface EthernetInterface[] | This nested field provides information on the ethernet interfaces associated with this device.
Attribute | Description
--- | ---
accessVlan Integer | The VLAN id for an "access" or "tunnel" interface. For trunks, this is the VLAN to be used if the interface stops trunking.
adminStatus IfAdminStatusEnum | Represents the desired state of the interface. Allowed values UNKNOWN UP DOWN TESTING NOT_APPLICABLE
allowedVlanIds String | VLANs in this list MAY be trunked on this port.
channelGroupId Integer | Number of a port-channel logical interface that is bound with the current physical interface.
description String | The ethernet interface description.
desiredTrunkingEncapsulation VLANEncapsulationEnum | The requested encapsulation for the trunk. Allowed values UNKOWN OTHER NOT_APPLICABLE CISCO_ISL _8021Q NEGOTIATE_OR_BEING_NEGOTIATED
desiredVlanMode VLANModeEnum | The desired VLAN mode that is requested for use. Allowed values UNKNOWN OTHER ACCESS DYNAMIC_AUTO DYNAMIC_DESIRABLE TRUNK DOT1Q_TUNNEL PVLAN_HOST PVLAN_TRUNK PVLAN_PROMISCUOUS DOWN HYBRID
duplexMode DuplexEnum | Duplex mode for the ethernet interface. Allowed values UNKNOWN HALFDUPLEX FULLDUPLEX DISAGREE AUTO_NEGOTIATE NOT_APPLICABLE
macAddress String | Represents media- or physical-level addresses. This is the interface's address at its protocol sublayer. For example, for an 802.x interface, this object normally contains a MAC address. The interface's media-specific MIB must define the bit and byte ordering and the format of the value of this object. For interfaces that do nothave such an address (such as a serial line), this object should contain an octet string of zero length.
mtu Integer | Represents the size in octests of the largest packet that can be sent/recieved on the interface. For interfaces that are used for transmitting network diagrams, this is the size of the largest network datagram that can be sent on the interface.
name String | The ethernet interface name.
nativeVlan Integer | VLAN Id that is used to tag untagged traffic received on a trunked interface.
operationalStatus IfOperStatusEnum | Represents the current operation state of the interface. Allowed values NOT_APPLICABLE UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWERLAYERDOWN
operationalTrunkEncapsulation VLANEncapsulationEnum | The type of VLAN encapsulation in use on a trunking interface/port. Allowed values UNKOWN OTHER NOT_APPLICABLE CISCO_ISL _8021Q NEGOTIATE_OR_BEING_NEGOTIATED
operationalVlanMode VLANModeEnum | The configuration mode for the VLAN interface. Allowed values UNKNOWN OTHER ACCESS DYNAMIC_AUTO DYNAMIC_DESIRABLE TRUNK DOT1Q_TUNNEL PVLAN_HOST PVLAN_TRUNK PVLAN_PROMISCUOUS DOWN HYBRID
pruneEligibleVlanIds String | VLANs in this list MAY be pruned on this trunk port.
speed LongQuantity | Specifies an estimate of the interface's current bandwidth in bits per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this should contain the nominal bandwidth. For a sublayer that has no concept of bandwidth, this object should be zero.
Attribute | Description
--- | ---
longAmount long |
units String |
trunkingEncapsulationNegotiation Boolean | A Boolean attribute that indicates whether or not the interface supports negotiation of the trunk encapsulation.
fan Fan[] | This nested field provides information about the fans associated with this device
Attribute | Description
--- | ---
description String | The description of the fan.
name String | The name of the fan.
operationalStatus String | The operational status of the fan.
serialNumber String | The serial number of the fan.
vendorEquipmentType String | The vendor equipment type of the fan.
ipInterface IpInterface[] | This nested field provides information about the ip interfaces associated with this device.
Attribute | Description
--- | ---
adminStatus IfAdminStatusEnum | Represents the desired state of the interface. Allowed values UNKNOWN UP DOWN TESTING NOT_APPLICABLE
ipAddress String | Specifies the IP address with a prefix assigned to this IP endpoint. It consists of the IP address followed by a slash and then by the number of bits in the prefix.
name String | The name of this IP endpoint.
operationalStatus IfOperStatusEnum | Represents the current operation state of the interface. Allowed values NOT_APPLICABLE UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWERLAYERDOWN
module DeviceModule[] | This nested field provides a listing of the modules associated with this device
Attribute | Description
--- | ---
description String | A description provided for this module.
equipmentId String | An internal id for the module.
equipmentType EquipmentTypeEnum | An indication of the general hardware type of the physical entity. This should be set to the standard enumeration value that most accurately indicates the general class of the physical entity or the primary class if there is more than one. If no appropriate standard registration identifier exists for this physical entity, then the value "other" is returned. Allowed values OTHER UNKNOWN CHASSIS BACKPLANE POWERSUPPLY FAN MODULE RACK PROCESSOR DISK MEMORY_MODULE COMPUTE_BLADE CHASSIS_EXTENDER MOTHERBOARD IP_PHONE WIRELESS_AP PLUGGABLE_TRANSCEIVER
firmwareVersion String | The firmware version of this module.
isInlinePowerCapable Boolean | Indicates whether a module is capable of providing inline power through its ports.
nrPorts String | The no. of ports available in this module.
operationStatus String | The operational status of this module.
physicalLocation String | The physical location of this module. For e.g. Ten GigabitEthernet Container.
productId String | The product ID associated with this module.
productName String | The name associated with this module. This is the official name given to a product. For example, Cisco 12000 Six-port DS3 Line card.
slotNumber String | The slot number on the equipment holder where this module is inserted if available.
softwareVersion String | The version of the software installed on this module.
vendorType String | An indication of the vendor-specific hardware type of the physical entity. Represents an independently extensible type identification value. It can, for example, indicate a particular subtree with further MIB definitions, or define a particular type of protocol or hardware (for example, 1.3.6.1.4.1.9.12.3.1.9.3.131). See CISCO-ENTITY-VENDORTYPE-OID-MIB.
physicalPort PhysicalPort[] | This nested field provides information about the physical ports associated with this device.
Attribute | Description
--- | ---
description String | The port description (i.e. Fast Ethernet Port, etc.).
deviceId long | An internal id to recognize the device, which is the id of the associated management network element associated with this device.
equipmentId long | The ID of the equipment object that this port is contained in.
name String | The name of the port.
residingModule String | The module that contains the port.
vendorEquipmentType String | The vendor equipment type.
powerSupply PowerSupply[] | This nested field provides information about the power supplies associated with this device.
Attribute | Description
--- | ---
description String | A description of the power supply.
manufacturerName String | The name of the manufacturer of the power supply
name String | The name of the power supply
operationalStatus String | The operational status of the power supply
serialNumber String | The serial number of the power supply.
vendorEquipmentType String | The vendor equipment type of the power supply equipment.
sensor DeviceSensor[] | This nested field provides information about the sensors associated with this device.
Attribute | Description
--- | ---
description String | A description of the sensor.
entPhysicalIndex String | Entity physical index.
equipmentName String | The name of the equipment associated with this sensor.
name String | The name of the sensor
precision Integer | The number of decimal places of precision in the sensor value.
status SensorStatusEnum | The present operational status of the sensor. Allowed values OK UNAVAILABLE NONOPERATIONAL
type SensorDataTypeEnum | The type of data reported by the Sensor. Allowed values OTHER UNKNOWN VOLTSAC VOLTSDC AMPERES WATTS HERTZ CELSIUS PERCENTRH RPM CMM TRUTHVALUE SPECIALENUM DBM OPTICAL_TX_DBM OPTICAL_RX_DBM OPTICAL_LASER_BIAS_CURRENT
vendorSensorType String | An indication of the vendor-specific hardware type of the physical entity. For example: 1.3.6.1.4.1.9.12.3.1.9.3.131 See CISCO-ENTITY-VENDORTYPE-OID-MIB
summary Summary | A nested field that provides an inventory summary
Attribute | Description
--- | ---
ciscoIdentityCapable Boolean | Indicates whether the device is Cisco identity capable.
contact String | Details about the contact person for this device.
deviceId String | An internal id for the device.
deviceName String | The name of the device.
deviceType String | The type of the device. For eg. Cisco 3750 Stackable switches.
ipAddress String | The ip address of the device.
location String | The physical location of the device.
locationCapable Boolean | Indicates whether the device is location capable.
nrPortsDown long | The number of ports that are not in the "UP" status. Note that this field is not supported for Third Party Controllers, which will always show zero.
nrPortsUp long | The number of ports in the "UP" status. Note that this field is not supported for Third Party Controllers, which will always show zero.
productFamily String | The product family of this device.
reachability ReachabilityStateEnum | Indicates management availability or reachability of the managed network element. It can indicate the availability or reachability of the management agent serving as a proxy for the network element. Allowed values UNKNOWN REACHABLE UNREACHABLE AGENT_UNREACHABLE AGENT_UNLOADED PING_REACHABLE PING_UNREACHABLE
softwareVersion String | The version of the software installed on the device.
systemTime Date | The current timestamp of the system.
upTime String | The duration the device is up from the last boot time. Formatted as +{days} {hours}:{minutes}:{seconds}.{fractions of a second}.
udf UDFValue[] | This nested field provides the user defined fields for this device.
Attribute | Description
--- | ---
name String | The name of the user defined field.
value String | The value of the user defined field.
udiDetail UDIDetail[] | This nested field provides a listing of the Unique Device Identifier's associated with this device.
Attribute | Description
--- | ---
description String | The unique device identifier's description.
modelNr String | The unique device identifier's model number.
name String | The unique device identifier's name.
productId String | The unique device identifier's product Id.
udiSerialNr String | The unique device identifier's serial number.
versionId String | The unique device identifier's version Id.
vlanInterface VlanInterface[] | This nested field provides information about the vlan interfaces associated with this device.
Attribute | Description
--- | ---
adminStatus IfAdminStatusEnum | Represents the desired state of the interface. Allowed values UNKNOWN UP DOWN TESTING NOT_APPLICABLE
maxSpeed LongQuantity | Specifies an estimate of the interface's current bandwidth in bits per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this should contain the nominal bandwidth. For a sublayer that has no concept of bandwidth, this object should be zero.
Attribute | Description
--- | ---
longAmount long |
units String |
mtu Integer | The MTU size to be set across the VLAN.
operationalStatus IfOperStatusEnum | Represents the current operation state of the interface. Allowed values NOT_APPLICABLE UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWERLAYERDOWN
portName String | The name of this VLAN port.
portType IFTypeEnum | Allowed values OTHER REGULAR1822 HDH1822 DDNX25 RFC877X25 ETHERNETCSMACD ISO88023CSMACD ISO88024TOKENBUS ISO88025TOKENRING ISO88026MAN STARLAN PROTEON10MBIT PROTEON80MBIT HYPERCHANNEL FDDI LAPB SDLC DS1 E1 BASICISDN PRIMARYISDN PROPPOINTTOPOINTSERIAL PPP SOFTWARELOOPBACK EON ETHERNET3MBIT NSIP SLIP ULTRA DS3 SIP FRAMERELAY RS232 PARA ARCNET ARCNETPLUS ATM MIOX25 SONET X25PLE ISO88022LLC LOCALTALK SMDSDXI FRAMERELAYSERVICE V35 HSSI HIPPI MODEM AAL5 SONETPATH SONETVT SMDSICIP PROPVIRTUAL PROPMULTIPLEXOR IEEE80212 FIBRECHANNEL HIPPIINTERFACE FRAMERELAYINTERCONNECT AFLANE8023 AFLANE8025 CCTEMUL FASTETHER ISDN V11 V36 G703AT64K G703AT2MB QLLC FASTETHERFX CHANNEL IEEE80211 IBM370PARCHAN ESCON DLSW ISDNS ISDNU LAPD IPSWITCH RSRB ATMLOGICAL DS0 DS0BUNDLE BSC ASYNC CNR ISO88025DTR EPLRS ARAP PROPCNLS HOSTPAD TERMPAD FRAMERELAYMPI X213 ADSL RADSL SDSL VDSL ISO88025CRFPINT MYRINET VOICEEM VOICEFXO VOICEFXS VOICEENCAP VOICEOVERIP ATMDXI ATMFUNI ATMIMA PPPMULTILINKBUNDLE IPOVERCDLC IPOVERCLAW STACKTOSTACK VIRTUALIPADDRESS MPC IPOVERATM ISO88025FIBER TDLC GIGABITETHERNET HDLC LAPF V37 X25MLP X25HUNTGROUP TRANSPHDLC INTERLEAVE FAST IP DOCSCABLEMACLAYER DOCSCABLEDOWNSTREAM DOCSCABLEUPSTREAM A12MPPSWITCH TUNNEL COFFEE CES ATMSUBINTERFACE L2VLAN L3IPVLAN L3IPXVLAN DIGITALPOWERLINE MEDIAMAILOVERIP DTM DCN IPFORWARD MSDSL IEEE1394 IF_GSN DVBRCCMACLAYER DVBRCCDOWNSTREAM DVBRCCUPSTREAM ATMVIRTUAL MPLSTUNNEL SRP VOICEOVERATM VOICEOVERFRAMERELAY IDSL COMPOSITELINK SS7SIGLINK PROPWIRELESSP2P FRFORWARD RFC1483 USB IEEE8023ADLAG BGPPOLICYACCOUNTING FRF16MFRBUNDLE H323GATEKEEPER H323PROXY MPLS MFSIGLINK HDSL2 SHDSL DS1FDL POS DVBASIIN DVBASIOUT PLC NFAS TR008 GR303RDT GR303IDT ISUP PROPDOCSWIRELESSMACLAYER PROPDOCSWIRELESSDOWNSTREAM PROPDOCSWIRELESSUPSTREAM HIPERLAN2 PROPBWAP2MP SONETOVERHEADCHANNEL DIGITALWRAPPEROVERHEADCHANNEL AAL2 RADIOMAC ATMRADIO IMT MVL REACHDSL FRDLCIENDPT ATMVCIENDPT OPTICALCHANNEL OPTICALTRANSPORT PROPATM VOICEOVERCABLE INFINIBAND TELINK Q2931 VIRTUALTG SIPTG SIPSIG DOCSCABLEUPSTREAMCHANNEL ECONET PON155 PON622 BRIDGE LINEGROUP VOICEEMFGD VOICEFGDEANA VOICEDID MPEGTRANSPORT SIXTOFOUR GTP PDNETHERLOOP1 PDNETHERLOOP2 OPTICALCHANNELGROUP HOMEPNA GFP CISCOISLVLAN ACTELISMETALOOP FCIPLINK RPR QAM LMP CBLVECTASTAR DOCSCABLEMCMTSDOWNSTREAM ADSL2 MACSECCONTROLLEDIF MACSECUNCONTROLLEDIF AVICIOPTICALETHER ATMBOND VOICEFGDOS MOCAVERSION1 IEEE80216WMAN ADSL2PLUS DVBRCSMACLAYER DVBTDM DVBRCSTDMA X86LAPS WWANPP WWANPP2 VOICEEBS IFPWTYPE ILAN PIP ALUELP GPON VDSL2 CAPWAPDOT11PROFILE CAPWAPDOT11BSS CAPWAPWTPVIRTUALRADIO BITS DOCS_CABLE_UPSTREAM_RF_PORT CABLE_DOWNSTREAM_RF_PORT VMWAREVIRTUALNIC IEEE802154 OTNODU OTNOTU IFVFITYPE G9981 G9982 G9983 ALUEPON ALUEPONONU ALUEPONPHYSICALUNI ALUEPONLOGICALLINK ALUGPONONU ALUGPONPHYSICALUNI VMWARENICTEAM DOCSOFDMDOWNSTREAM DOCSOFDMAUPSTREAM GFAST SDCI XBOXWIRELESS FASTDSL DOCSCABLESCTE55D1FWDOOB DOCSCABLESCTE55D1RETOOB DOCSCABLESCTE55D2DSOOB DOCSCABLESCTE55D2USOOB DOCSCABLENDF DOCSCABLENDR PTM GHN OTNOTSI OTNOTUC OTNODUC OTNOTSIG MICROWAVECARRIERTERMINATION MICROWAVERADIOLINKTERMINAL
vlanId int | A VLAN ID for the VLAN Interface.

## 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://172.20.127.108/webacs/api/v1/data/InventoryDetails/15

    <?xml version="1.0" ?>
    <queryResponse type="InventoryDetails" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v1/data/InventoryDetails/15" rootUrl="https://172.20.127.108/webacs/api/v1/data">
      <entity dtoType="inventoryDetailsDTO" type="InventoryDetails" url="https://172.20.127.108/webacs/api/v1/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>
            </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>
          <deviceId>15</deviceId>
          <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>
                <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>
                <instanceId>2</instanceId>
                <instanceUuid>String value</instanceUuid>
                <instanceVersion>1</instanceVersion>
                <units>String value</units>
                <longAmount>2</longAmount>
              </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>
                <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>
                <instanceId>12</instanceId>
                <instanceUuid>Another string value</instanceUuid>
                <instanceVersion>11</instanceVersion>
                <units>Another string value</units>
                <longAmount>12</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>
            <fan>
              <description>Another string value</description>
              <name>Another string value</name>
              <operationalStatus>Another string value</operationalStatus>
              <serialNumber>Another string value</serialNumber>
              <vendorEquipmentType>Another string value</vendorEquipmentType>
            </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>
              <isInlinePowerCapable>true</isInlinePowerCapable>
              <nrPorts>String value</nrPorts>
            </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>
              <isInlinePowerCapable>false</isInlinePowerCapable>
              <nrPorts>Another 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>
            <physicalPort>
              <description>Another string value</description>
              <deviceId>12</deviceId>
              <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>
              <serialNumber>String value</serialNumber>
              <vendorEquipmentType>String value</vendorEquipmentType>
            </powerSupply>
            <powerSupply>
              <description>Another string value</description>
              <manufacturerName>Another string value</manufacturerName>
              <name>Another string value</name>
              <operationalStatus>Another string value</operationalStatus>
              <serialNumber>Another string value</serialNumber>
              <vendorEquipmentType>Another 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>
            <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>
            <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>1986-07-24T00:00:00Z</systemTime>
            <upTime>String value</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>
          <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>
            <udiDetail>
              <description>Another string value</description>
              <modelNr>Another string value</modelNr>
              <name>Another string value</name>
              <productId>Another string value</productId>
              <udiSerialNr>Another string value</udiSerialNr>
              <versionId>Another string value</versionId>
            </udiDetail>
          </udiDetails>
          <vlanInterfaces>
            <vlanInterface>
              <adminStatus>UNKNOWN</adminStatus>
              <maxSpeed>
                <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>
                <instanceId>2</instanceId>
                <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>
            <vlanInterface>
              <adminStatus>UP</adminStatus>
              <maxSpeed>
                <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>
                <instanceId>12</instanceId>
                <instanceUuid>Another string value</instanceUuid>
                <instanceVersion>11</instanceVersion>
                <units>Another string value</units>
                <longAmount>12</longAmount>
              </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://172.20.127.108/webacs/api/v1/data/InventoryDetails/15.json

    {
      "queryResponse" : {
        "@type" : "InventoryDetails",
        "@responseType" : "getEntity",
        "@requestUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data\/InventoryDetails\/15",
        "@rootUrl" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/data",
        "entity" : {
          "@dtoType" : "inventoryDetailsDTO",
          "@type" : "InventoryDetails",
          "@url" : "https : \/\/172.20.127.108\/webacs\/api\/v1\/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"
              }]
            },
            "deviceId" : 15,
            "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",
                "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" : "Another string value",
                      "value" : {
                        "@xsi.type" : "xs : string",
                        "$" : "Another string value"
                      }
                    },
                    {
                      "key" : "String value",
                      "value" : {
                        "@xsi.type" : "xs : string",
                        "$" : "String value"
                      }
                    }]
                  },
                  "instanceId" : 2,
                  "instanceUuid" : "String value",
                  "instanceVersion" : 1,
                  "units" : "String value",
                  "longAmount" : 2
                }
              },
              {
                "accessVlan" : 25,
                "adminStatus" : "UP",
                "allowedVlanIds" : "Another string value",
                "channelGroupId" : 25,
                "description" : "Another string value",
                "desiredTrunkingEncapsulation" : "OTHER",
                "desiredVlanMode" : "OTHER",
                "duplexMode" : "HALFDUPLEX",
                "mtu" : 25,
                "name" : "Another string value",
                "nativeVlan" : 25,
                "operationalStatus" : "UP",
                "operationalTrunkEncapsulation" : "OTHER",
                "operationalVlanMode" : "OTHER",
                "pruneEligibleVlanIds" : "Another string value",
                "trunkingEncapsulationNegotiation" : false,
                "macAddress" : "Another string value",
                "speed" : {
                  "lazyLoadedEntities" : {
                    "entry" : [{
                      "key" : "Another string value",
                      "value" : {
                        "@xsi.type" : "xs : string",
                        "$" : "Another string value"
                      }
                    },
                    {
                      "key" : "String value",
                      "value" : {
                        "@xsi.type" : "xs : string",
                        "$" : "String value"
                      }
                    }]
                  },
                  "instanceId" : 12,
                  "instanceUuid" : "Another string value",
                  "instanceVersion" : 11,
                  "units" : "Another string value",
                  "longAmount" : 12
                }
              }]
            },
            "fans" : {
              "fan" : [{
                "description" : "String value",
                "name" : "String value",
                "operationalStatus" : "String value",
                "serialNumber" : "String value",
                "vendorEquipmentType" : "String value"
              },
              {
                "description" : "Another string value",
                "name" : "Another string value",
                "operationalStatus" : "Another string value",
                "serialNumber" : "Another string value",
                "vendorEquipmentType" : "Another string value"
              }]
            },
            "ipInterfaces" : {
              "ipInterface" : [{
                "adminStatus" : "UNKNOWN",
                "name" : "String value",
                "operationalStatus" : "NOT_APPLICABLE",
                "ipAddress" : "String value"
              },
              {
                "adminStatus" : "UP",
                "name" : "Another string value",
                "operationalStatus" : "UP",
                "ipAddress" : "Another 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"
              },
              {
                "description" : "Another string value",
                "equipmentType" : "UNKNOWN",
                "firmwareVersion" : "Another string value",
                "operationStatus" : "Another string value",
                "physicalLocation" : "Another string value",
                "productId" : "Another string value",
                "productName" : "Another string value",
                "slotNumber" : "Another string value",
                "softwareVersion" : "Another string value",
                "vendorType" : "Another string value",
                "equipmentId" : "Another string value",
                "isInlinePowerCapable" : false,
                "nrPorts" : "Another string value"
              }]
            },
            "physicalPorts" : {
              "physicalPort" : [{
                "description" : "String value",
                "deviceId" : 2,
                "equipmentId" : 2,
                "name" : "String value",
                "residingModule" : "String value",
                "vendorEquipmentType" : "String value"
              },
              {
                "description" : "Another string value",
                "deviceId" : 12,
                "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",
                "serialNumber" : "String value",
                "vendorEquipmentType" : "String value"
              },
              {
                "description" : "Another string value",
                "manufacturerName" : "Another string value",
                "name" : "Another string value",
                "operationalStatus" : "Another string value",
                "serialNumber" : "Another string value",
                "vendorEquipmentType" : "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" : "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" : "1986-07-24T00 : 00 : 00Z",
              "upTime" : "String value"
            },
            "udfs" : {
              "udf" : [{
                "name" : "String value",
                "value" : "String value"
              },
              {
                "name" : "Another string value",
                "value" : "Another string value"
              }]
            },
            "udiDetails" : {
              "udiDetail" : [{
                "description" : "String value",
                "modelNr" : "String value",
                "name" : "String value",
                "productId" : "String value",
                "udiSerialNr" : "String value",
                "versionId" : "String value"
              },
              {
                "description" : "Another string value",
                "modelNr" : "Another string value",
                "name" : "Another string value",
                "productId" : "Another string value",
                "udiSerialNr" : "Another string value",
                "versionId" : "Another string value"
              }]
            },
            "vlanInterfaces" : {
              "vlanInterface" : [{
                "adminStatus" : "UNKNOWN",
                "maxSpeed" : {
                  "lazyLoadedEntities" : {
                    "entry" : [{
                      "key" : "Another string value",
                      "value" : {
                        "@xsi.type" : "xs : string",
                        "$" : "Another string value"
                      }
                    },
                    {
                      "key" : "String value",
                      "value" : {
                        "@xsi.type" : "xs : string",
                        "$" : "String value"
                      }
                    }]
                  },
                  "instanceId" : 2,
                  "instanceUuid" : "String value",
                  "instanceVersion" : 1,
                  "units" : "String value",
                  "longAmount" : 2
                },
                "mtu" : 15,
                "operationalStatus" : "NOT_APPLICABLE",
                "portName" : "String value",
                "portType" : "OTHER",
                "vlanId" : 1
              },
              {
                "adminStatus" : "UP",
                "maxSpeed" : {
                  "lazyLoadedEntities" : {
                    "entry" : [{
                      "key" : "Another string value",
                      "value" : {
                        "@xsi.type" : "xs : string",
                        "$" : "Another string value"
                      }
                    },
                    {
                      "key" : "String value",
                      "value" : {
                        "@xsi.type" : "xs : string",
                        "$" : "String value"
                      }
                    }]
                  },
                  "instanceId" : 12,
                  "instanceUuid" : "Another string value",
                  "instanceVersion" : 11,
                  "units" : "Another string value",
                  "longAmount" : 12
                },
                "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/v2/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

Unmodified

This resource has not been modified since the previous API version.

## Response Parameters

Attribute | Description
--- | ---
cdpNeighbor CDPNeighbor[] | This nested field provides information on the CDP neighbors for this device.
Attribute | Description
--- | ---
duplexMode CDPDuplexMode | The duplex mode between the local device and the neighbor. Allowed values UNKNOWN HALF_DUPLEX FULL_DUPLEX
farEndInterface String | The interface on the neighbor device connected to the local device.
interfaceIndex int | The index of the local interface.
nearEndInterface String | The interface on the local device connected to the neighbor device.
neighborCapabilities String | Neighbor capabilities as reported by SNMP. Set of neighbor capabilities is stored like string which starts with "S-" and then a list of numbers separated by ':'. Example: "S-1:4:6". Each number means a certain neighbor capability: 1 - ROUTER, 2 - TB_BRIDGE, 3 - SR_BRIDGE, 4 - SWITCH, 5 - HOST, 6 - IGMP_CONDITIONAL_FILTERING, 7 - REPEATER, 8 - VOIP_PHONE.
neighborDeviceName String | The neighbor device's name.
neighborDevicePlatformType String | The neighbor device's platform type.
deviceId Long | An internal id for the device
etherChannel EtherChannel[] | This nested field provides information about the ether channels associated with this device.
Attribute | Description
--- | ---
actorAdminKey Integer | The current administrative value of the 16-bit Key for the Aggregator (Actor). The administrative Key value may differ from the operational Key value for reasons discussed in the IEEE 802.3ad document, Section 43.6.2. The meaning of particular Key values is of local significance MIB.IEEE|IEEE8023-LAG-MIB.dot3adAggActorAdminKey.
channelGroupId int | The value of this property is the group ID assigned to the aggregation. Note that this is needed for configuring EtherChannel in Cisco devices but it is not part of the 802.3ad standard (i.e., it is not the same as the LAG ID in 802.3ad).
controlMethod LAGControlProtocolEnum | Enumeration attribute to indicate how aggregation is controlled. Allowed values MANUAL LACP PAGP
name String | The name of this Ethernet Channel.
numberOfMembers int | The number of ProtocolEndpoint's that list this EtherChannel as their lagEndName.
ethernetInterface EthernetInterface[] | This nested field provides information on the ethernet interfaces associated with this device.
Attribute | Description
--- | ---
accessVlan Integer | The VLAN id for an "access" or "tunnel" interface. For trunks, this is the VLAN to be used if the interface stops trunking.
adminStatus IfAdminStatusEnum | Represents the desired state of the interface. Allowed values UNKNOWN UP DOWN TESTING NOT_APPLICABLE
allowedVlanIds String | VLANs in this list MAY be trunked on this port.
channelGroupId Integer | Number of a port-channel logical interface that is bound with the current physical interface.
description String | The ethernet interface description.
desiredTrunkingEncapsulation VLANEncapsulationEnum | The requested encapsulation for the trunk. Allowed values UNKOWN OTHER NOT_APPLICABLE CISCO_ISL _8021Q NEGOTIATE_OR_BEING_NEGOTIATED
desiredVlanMode VLANModeEnum | The desired VLAN mode that is requested for use. Allowed values UNKNOWN OTHER ACCESS DYNAMIC_AUTO DYNAMIC_DESIRABLE TRUNK DOT1Q_TUNNEL PVLAN_HOST PVLAN_TRUNK PVLAN_PROMISCUOUS DOWN HYBRID
duplexMode DuplexEnum | Duplex mode for the ethernet interface. Allowed values UNKNOWN HALFDUPLEX FULLDUPLEX DISAGREE AUTO_NEGOTIATE NOT_APPLICABLE
macAddress String | Represents media- or physical-level addresses. This is the interface's address at its protocol sublayer. For example, for an 802.x interface, this object normally contains a MAC address. The interface's media-specific MIB must define the bit and byte ordering and the format of the value of this object. For interfaces that do nothave such an address (such as a serial line), this object should contain an octet string of zero length.
mtu Integer | Represents the size in octests of the largest packet that can be sent/recieved on the interface. For interfaces that are used for transmitting network diagrams, this is the size of the largest network datagram that can be sent on the interface.
name String | The ethernet interface name.
nativeVlan Integer | VLAN Id that is used to tag untagged traffic received on a trunked interface.
operationalStatus IfOperStatusEnum | Represents the current operation state of the interface. Allowed values NOT_APPLICABLE UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWERLAYERDOWN
operationalTrunkEncapsulation VLANEncapsulationEnum | The type of VLAN encapsulation in use on a trunking interface/port. Allowed values UNKOWN OTHER NOT_APPLICABLE CISCO_ISL _8021Q NEGOTIATE_OR_BEING_NEGOTIATED
operationalVlanMode VLANModeEnum | The configuration mode for the VLAN interface. Allowed values UNKNOWN OTHER ACCESS DYNAMIC_AUTO DYNAMIC_DESIRABLE TRUNK DOT1Q_TUNNEL PVLAN_HOST PVLAN_TRUNK PVLAN_PROMISCUOUS DOWN HYBRID
pruneEligibleVlanIds String | VLANs in this list MAY be pruned on this trunk port.
speed LongQuantity | Specifies an estimate of the interface's current bandwidth in bits per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this should contain the nominal bandwidth. For a sublayer that has no concept of bandwidth, this object should be zero.
Attribute | Description
--- | ---
longAmount long |
units String |
trunkingEncapsulationNegotiation Boolean | A Boolean attribute that indicates whether or not the interface supports negotiation of the trunk encapsulation.
fan Fan[] | This nested field provides information about the fans associated with this device
Attribute | Description
--- | ---
description String | The description of the fan.
name String | The name of the fan.
operationalStatus String | The operational status of the fan.
serialNumber String | The serial number of the fan.
vendorEquipmentType String | The vendor equipment type of the fan.
ipInterface IpInterface[] | This nested field provides information about the ip interfaces associated with this device.
Attribute | Description
--- | ---
adminStatus IfAdminStatusEnum | Represents the desired state of the interface. Allowed values UNKNOWN UP DOWN TESTING NOT_APPLICABLE
ipAddress String | Specifies the IP address with a prefix assigned to this IP endpoint. It consists of the IP address followed by a slash and then by the number of bits in the prefix.
name String | The name of this IP endpoint.
operationalStatus IfOperStatusEnum | Represents the current operation state of the interface. Allowed values NOT_APPLICABLE UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWERLAYERDOWN
module DeviceModule[] | This nested field provides a listing of the modules associated with this device
Attribute | Description
--- | ---
description String | A description provided for this module.
equipmentId String | An internal id for the module.
equipmentType EquipmentTypeEnum | An indication of the general hardware type of the physical entity. This should be set to the standard enumeration value that most accurately indicates the general class of the physical entity or the primary class if there is more than one. If no appropriate standard registration identifier exists for this physical entity, then the value "other" is returned. Allowed values OTHER UNKNOWN CHASSIS BACKPLANE POWERSUPPLY FAN MODULE RACK PROCESSOR DISK MEMORY_MODULE COMPUTE_BLADE CHASSIS_EXTENDER MOTHERBOARD IP_PHONE WIRELESS_AP PLUGGABLE_TRANSCEIVER
firmwareVersion String | The firmware version of this module.
isInlinePowerCapable Boolean | Indicates whether a module is capable of providing inline power through its ports.
nrPorts String | The no. of ports available in this module.
operationStatus String | The operational status of this module.
physicalLocation String | The physical location of this module. For e.g. Ten GigabitEthernet Container.
productId String | The product ID associated with this module.
productName String | The name associated with this module. This is the official name given to a product. For example, Cisco 12000 Six-port DS3 Line card.
slotNumber String | The slot number on the equipment holder where this module is inserted if available.
softwareVersion String | The version of the software installed on this module.
vendorType String | An indication of the vendor-specific hardware type of the physical entity. Represents an independently extensible type identification value. It can, for example, indicate a particular subtree with further MIB definitions, or define a particular type of protocol or hardware (for example, 1.3.6.1.4.1.9.12.3.1.9.3.131). See CISCO-ENTITY-VENDORTYPE-OID-MIB.
physicalPort PhysicalPort[] | This nested field provides information about the physical ports associated with this device.
Attribute | Description
--- | ---
description String | The port description (i.e. Fast Ethernet Port, etc.).
deviceId long | An internal id to recognize the device, which is the id of the associated management network element associated with this device.
equipmentId long | The ID of the equipment object that this port is contained in.
name String | The name of the port.
residingModule String | The module that contains the port.
vendorEquipmentType String | The vendor equipment type.
powerSupply PowerSupply[] | This nested field provides information about the power supplies associated with this device.
Attribute | Description
--- | ---
description String | A description of the power supply.
manufacturerName String | The name of the manufacturer of the power supply
name String | The name of the power supply
operationalStatus String | The operational status of the power supply
serialNumber String | The serial number of the power supply.
vendorEquipmentType String | The vendor equipment type of the power supply equipment.
sensor DeviceSensor[] | This nested field provides information about the sensors associated with this device.
Attribute | Description
--- | ---
description String | A description of the sensor.
entPhysicalIndex String | Entity physical index.
equipmentName String | The name of the equipment associated with this sensor.
name String | The name of the sensor
precision Integer | The number of decimal places of precision in the sensor value.
status SensorStatusEnum | The present operational status of the sensor. Allowed values OK UNAVAILABLE NONOPERATIONAL
type SensorDataTypeEnum | The type of data reported by the Sensor. Allowed values OTHER UNKNOWN VOLTSAC VOLTSDC AMPERES WATTS HERTZ CELSIUS PERCENTRH RPM CMM TRUTHVALUE SPECIALENUM DBM OPTICAL_TX_DBM OPTICAL_RX_DBM OPTICAL_LASER_BIAS_CURRENT
vendorSensorType String | An indication of the vendor-specific hardware type of the physical entity. For example: 1.3.6.1.4.1.9.12.3.1.9.3.131 See CISCO-ENTITY-VENDORTYPE-OID-MIB
summary Summary | A nested field that provides an inventory summary
Attribute | Description
--- | ---
ciscoIdentityCapable Boolean | Indicates whether the device is Cisco identity capable.
contact String | Details about the contact person for this device.
deviceId String | An internal id for the device.
deviceName String | The name of the device.
deviceType String | The type of the device. For eg. Cisco 3750 Stackable switches.
ipAddress String | The ip address of the device.
location String | The physical location of the device.
locationCapable Boolean | Indicates whether the device is location capable.
nrPortsDown long | The number of ports that are not in the "UP" status. Note that this field is not supported for Third Party Controllers, which will always show zero.
nrPortsUp long | The number of ports in the "UP" status. Note that this field is not supported for Third Party Controllers, which will always show zero.
productFamily String | The product family of this device.
reachability ReachabilityStateEnum | Indicates management availability or reachability of the managed network element. It can indicate the availability or reachability of the management agent serving as a proxy for the network element. Allowed values UNKNOWN REACHABLE UNREACHABLE AGENT_UNREACHABLE AGENT_UNLOADED PING_REACHABLE PING_UNREACHABLE
softwareVersion String | The version of the software installed on the device.
systemTime Date | The current timestamp of the system.
upTime String | The duration the device is up from the last boot time. Formatted as +{days} {hours}:{minutes}:{seconds}.{fractions of a second}.
udf UDFValue[] | This nested field provides the user defined fields for this device.
Attribute | Description
--- | ---
name String | The name of the user defined field.
value String | The value of the user defined field.
udiDetail UDIDetail[] | This nested field provides a listing of the Unique Device Identifier's associated with this device.
Attribute | Description
--- | ---
description String | The unique device identifier's description.
modelNr String | The unique device identifier's model number.
name String | The unique device identifier's name.
productId String | The unique device identifier's product Id.
udiSerialNr String | The unique device identifier's serial number.
versionId String | The unique device identifier's version Id.
vlanInterface VlanInterface[] | This nested field provides information about the vlan interfaces associated with this device.
Attribute | Description
--- | ---
adminStatus IfAdminStatusEnum | Represents the desired state of the interface. Allowed values UNKNOWN UP DOWN TESTING NOT_APPLICABLE
maxSpeed LongQuantity | Specifies an estimate of the interface's current bandwidth in bits per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this should contain the nominal bandwidth. For a sublayer that has no concept of bandwidth, this object should be zero.
Attribute | Description
--- | ---
longAmount long |
units String |
mtu Integer | The MTU size to be set across the VLAN.
operationalStatus IfOperStatusEnum | Represents the current operation state of the interface. Allowed values NOT_APPLICABLE UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWERLAYERDOWN
portName String | The name of this VLAN port.
portType IFTypeEnum | Allowed values OTHER REGULAR1822 HDH1822 DDNX25 RFC877X25 ETHERNETCSMACD ISO88023CSMACD ISO88024TOKENBUS ISO88025TOKENRING ISO88026MAN STARLAN PROTEON10MBIT PROTEON80MBIT HYPERCHANNEL FDDI LAPB SDLC DS1 E1 BASICISDN PRIMARYISDN PROPPOINTTOPOINTSERIAL PPP SOFTWARELOOPBACK EON ETHERNET3MBIT NSIP SLIP ULTRA DS3 SIP FRAMERELAY RS232 PARA ARCNET ARCNETPLUS ATM MIOX25 SONET X25PLE ISO88022LLC LOCALTALK SMDSDXI FRAMERELAYSERVICE V35 HSSI HIPPI MODEM AAL5 SONETPATH SONETVT SMDSICIP PROPVIRTUAL PROPMULTIPLEXOR IEEE80212 FIBRECHANNEL HIPPIINTERFACE FRAMERELAYINTERCONNECT AFLANE8023 AFLANE8025 CCTEMUL FASTETHER ISDN V11 V36 G703AT64K G703AT2MB QLLC FASTETHERFX CHANNEL IEEE80211 IBM370PARCHAN ESCON DLSW ISDNS ISDNU LAPD IPSWITCH RSRB ATMLOGICAL DS0 DS0BUNDLE BSC ASYNC CNR ISO88025DTR EPLRS ARAP PROPCNLS HOSTPAD TERMPAD FRAMERELAYMPI X213 ADSL RADSL SDSL VDSL ISO88025CRFPINT MYRINET VOICEEM VOICEFXO VOICEFXS VOICEENCAP VOICEOVERIP ATMDXI ATMFUNI ATMIMA PPPMULTILINKBUNDLE IPOVERCDLC IPOVERCLAW STACKTOSTACK VIRTUALIPADDRESS MPC IPOVERATM ISO88025FIBER TDLC GIGABITETHERNET HDLC LAPF V37 X25MLP X25HUNTGROUP TRANSPHDLC INTERLEAVE FAST IP DOCSCABLEMACLAYER DOCSCABLEDOWNSTREAM DOCSCABLEUPSTREAM A12MPPSWITCH TUNNEL COFFEE CES ATMSUBINTERFACE L2VLAN L3IPVLAN L3IPXVLAN DIGITALPOWERLINE MEDIAMAILOVERIP DTM DCN IPFORWARD MSDSL IEEE1394 IF_GSN DVBRCCMACLAYER DVBRCCDOWNSTREAM DVBRCCUPSTREAM ATMVIRTUAL MPLSTUNNEL SRP VOICEOVERATM VOICEOVERFRAMERELAY IDSL COMPOSITELINK SS7SIGLINK PROPWIRELESSP2P FRFORWARD RFC1483 USB IEEE8023ADLAG BGPPOLICYACCOUNTING FRF16MFRBUNDLE H323GATEKEEPER H323PROXY MPLS MFSIGLINK HDSL2 SHDSL DS1FDL POS DVBASIIN DVBASIOUT PLC NFAS TR008 GR303RDT GR303IDT ISUP PROPDOCSWIRELESSMACLAYER PROPDOCSWIRELESSDOWNSTREAM PROPDOCSWIRELESSUPSTREAM HIPERLAN2 PROPBWAP2MP SONETOVERHEADCHANNEL DIGITALWRAPPEROVERHEADCHANNEL AAL2 RADIOMAC ATMRADIO IMT MVL REACHDSL FRDLCIENDPT ATMVCIENDPT OPTICALCHANNEL OPTICALTRANSPORT PROPATM VOICEOVERCABLE INFINIBAND TELINK Q2931 VIRTUALTG SIPTG SIPSIG DOCSCABLEUPSTREAMCHANNEL ECONET PON155 PON622 BRIDGE LINEGROUP VOICEEMFGD VOICEFGDEANA VOICEDID MPEGTRANSPORT SIXTOFOUR GTP PDNETHERLOOP1 PDNETHERLOOP2 OPTICALCHANNELGROUP HOMEPNA GFP CISCOISLVLAN ACTELISMETALOOP FCIPLINK RPR QAM LMP CBLVECTASTAR DOCSCABLEMCMTSDOWNSTREAM ADSL2 MACSECCONTROLLEDIF MACSECUNCONTROLLEDIF AVICIOPTICALETHER ATMBOND VOICEFGDOS MOCAVERSION1 IEEE80216WMAN ADSL2PLUS DVBRCSMACLAYER DVBTDM DVBRCSTDMA X86LAPS WWANPP WWANPP2 VOICEEBS IFPWTYPE ILAN PIP ALUELP GPON VDSL2 CAPWAPDOT11PROFILE CAPWAPDOT11BSS CAPWAPWTPVIRTUALRADIO BITS DOCS_CABLE_UPSTREAM_RF_PORT CABLE_DOWNSTREAM_RF_PORT VMWAREVIRTUALNIC IEEE802154 OTNODU OTNOTU IFVFITYPE G9981 G9982 G9983 ALUEPON ALUEPONONU ALUEPONPHYSICALUNI ALUEPONLOGICALLINK ALUGPONONU ALUGPONPHYSICALUNI VMWARENICTEAM DOCSOFDMDOWNSTREAM DOCSOFDMAUPSTREAM GFAST SDCI XBOXWIRELESS FASTDSL DOCSCABLESCTE55D1FWDOOB DOCSCABLESCTE55D1RETOOB DOCSCABLESCTE55D2DSOOB DOCSCABLESCTE55D2USOOB DOCSCABLENDF DOCSCABLENDR PTM GHN OTNOTSI OTNOTUC OTNODUC OTNOTSIG MICROWAVECARRIERTERMINATION MICROWAVERADIOLINKTERMINAL
vlanId int | A VLAN ID for the VLAN Interface.

## 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://172.20.127.108/webacs/api/v2/data/InventoryDetails/15

    <?xml version="1.0" ?>
    <queryResponse type="InventoryDetails" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v2/data/InventoryDetails/15" rootUrl="https://172.20.127.108/webacs/api/v2/data">
      <entity dtoType="inventoryDetailsDTO" type="InventoryDetails" url="https://172.20.127.108/webacs/api/v2/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>
            </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>
          <deviceId>15</deviceId>
          <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>
                <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>
                <instanceId>2</instanceId>
                <instanceUuid>String value</instanceUuid>
                <instanceVersion>1</instanceVersion>
                <units>String value</units>
                <longAmount>2</longAmount>
              </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>
                <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>
                <instanceId>12</instanceId>
                <instanceUuid>Another string value</instanceUuid>
                <instanceVersion>11</instanceVersion>
                <units>Another string value</units>
                <longAmount>12</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>
            <fan>
              <description>Another string value</description>
              <name>Another string value</name>
              <operationalStatus>Another string value</operationalStatus>
              <serialNumber>Another string value</serialNumber>
              <vendorEquipmentType>Another string value</vendorEquipmentType>
            </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>
              <isInlinePowerCapable>true</isInlinePowerCapable>
              <nrPorts>String value</nrPorts>
            </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>
              <isInlinePowerCapable>false</isInlinePowerCapable>
              <nrPorts>Another 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>
            <physicalPort>
              <description>Another string value</description>
              <deviceId>12</deviceId>
              <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>
              <serialNumber>String value</serialNumber>
              <vendorEquipmentType>String value</vendorEquipmentType>
            </powerSupply>
            <powerSupply>
              <description>Another string value</description>
              <manufacturerName>Another string value</manufacturerName>
              <name>Another string value</name>
              <operationalStatus>Another string value</operationalStatus>
              <serialNumber>Another string value</serialNumber>
              <vendorEquipmentType>Another 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>
            <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>
            <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>1986-07-24T00:00:00Z</systemTime>
            <upTime>String value</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>
          <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>
            <udiDetail>
              <description>Another string value</description>
              <modelNr>Another string value</modelNr>
              <name>Another string value</name>
              <productId>Another string value</productId>
              <udiSerialNr>Another string value</udiSerialNr>
              <versionId>Another string value</versionId>
            </udiDetail>
          </udiDetails>
          <vlanInterfaces>
            <vlanInterface>
              <adminStatus>UNKNOWN</adminStatus>
              <maxSpeed>
                <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>
                <instanceId>2</instanceId>
                <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>
            <vlanInterface>
              <adminStatus>UP</adminStatus>
              <maxSpeed>
                <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>
                <instanceId>12</instanceId>
                <instanceUuid>Another string value</instanceUuid>
                <instanceVersion>11</instanceVersion>
                <units>Another string value</units>
                <longAmount>12</longAmount>
              </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://172.20.127.108/webacs/api/v2/data/InventoryDetails/15.json

    {
      "queryResponse" : {
        "@type" : "InventoryDetails",
        "@requestUrl" : "https://172.20.127.108/webacs/api/v2/data/InventoryDetails/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v2/data",
        "entity" : [ {
          "@dtoType" : "inventoryDetailsDTO",
          "@type" : "InventoryDetails",
          "@url" : "https://172.20.127.108/webacs/api/v2/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"
              } ]
            },
            "deviceId" : 15,
            "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" : {
                  "longAmount" : 2,
                  "units" : "String value"
                },
                "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" : {
                  "longAmount" : 12,
                  "units" : "Another string value"
                },
                "trunkingEncapsulationNegotiation" : false
              } ]
            },
            "fans" : {
              "fan" : [ {
                "description" : "String value",
                "name" : "String value",
                "operationalStatus" : "String value",
                "serialNumber" : "String value",
                "vendorEquipmentType" : "String value"
              }, {
                "description" : "Another string value",
                "name" : "Another string value",
                "operationalStatus" : "Another string value",
                "serialNumber" : "Another string value",
                "vendorEquipmentType" : "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",
                "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"
              }, {
                "description" : "Another string value",
                "equipmentId" : "Another string value",
                "equipmentType" : "UNKNOWN",
                "firmwareVersion" : "Another string value",
                "isInlinePowerCapable" : false,
                "nrPorts" : "Another string value",
                "operationStatus" : "Another string value",
                "physicalLocation" : "Another string value",
                "productId" : "Another string value",
                "productName" : "Another string value",
                "slotNumber" : "Another string value",
                "softwareVersion" : "Another string value",
                "vendorType" : "Another string value"
              } ]
            },
            "physicalPorts" : {
              "physicalPort" : [ {
                "description" : "String value",
                "deviceId" : 2,
                "equipmentId" : 2,
                "name" : "String value",
                "residingModule" : "String value",
                "vendorEquipmentType" : "String value"
              }, {
                "description" : "Another string value",
                "deviceId" : 12,
                "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",
                "serialNumber" : "String value",
                "vendorEquipmentType" : "String value"
              }, {
                "description" : "Another string value",
                "manufacturerName" : "Another string value",
                "name" : "Another string value",
                "operationalStatus" : "Another string value",
                "serialNumber" : "Another string value",
                "vendorEquipmentType" : "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" : "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" : 522547200000,
              "upTime" : "String value"
            },
            "udfs" : {
              "udf" : [ {
                "name" : "String value",
                "value" : "String value"
              }, {
                "name" : "Another string value",
                "value" : "Another string value"
              } ]
            },
            "udiDetails" : {
              "udiDetail" : [ {
                "description" : "String value",
                "modelNr" : "String value",
                "name" : "String value",
                "productId" : "String value",
                "udiSerialNr" : "String value",
                "versionId" : "String value"
              }, {
                "description" : "Another string value",
                "modelNr" : "Another string value",
                "name" : "Another string value",
                "productId" : "Another string value",
                "udiSerialNr" : "Another string value",
                "versionId" : "Another string value"
              } ]
            },
            "vlanInterfaces" : {
              "vlanInterface" : [ {
                "adminStatus" : "UNKNOWN",
                "maxSpeed" : {
                  "longAmount" : 2,
                  "units" : "String value"
                },
                "mtu" : 15,
                "operationalStatus" : "NOT_APPLICABLE",
                "portName" : "String value",
                "portType" : "OTHER",
                "vlanId" : 1
              }, {
                "adminStatus" : "UP",
                "maxSpeed" : {
                  "longAmount" : 12,
                  "units" : "Another string value"
                },
                "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/v3/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 v3 version:

- 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.

Deprecated

This version has been deprecated. Please use v4.

## Response Parameters

Attribute | Description
--- | ---
cdpNeighbor CDPNeighbor[] | This nested field provides information on the CDP neighbors for this device.
Attribute | Description
--- | ---
duplexMode CDPDuplexMode | The duplex mode between the local device and the neighbor. Allowed values UNKNOWN HALF_DUPLEX FULL_DUPLEX
farEndInterface String | The interface on the neighbor device connected to the local device.
interfaceIndex int | The index of the local interface.
nearEndInterface String | The interface on the local device connected to the neighbor device.
neighborCapabilities String | Neighbor capabilities as reported by SNMP. Set of neighbor capabilities is stored like string which starts with "S-" and then a list of numbers separated by ':'. Example: "S-1:4:6". Each number means a certain neighbor capability: 1 - ROUTER, 2 - TB_BRIDGE, 3 - SR_BRIDGE, 4 - SWITCH, 5 - HOST, 6 - IGMP_CONDITIONAL_FILTERING, 7 - REPEATER, 8 - VOIP_PHONE.
neighborDeviceName String | The neighbor device's name.
neighborDevicePlatformType String | The neighbor device's platform type.
chassis Chassis[] | This nested field provides a listing of the chassis associated with this device.
Attribute | Description
--- | ---
description String | The chassis description.
entPhysicalIndex String | Entity physical index.
modelNr String | The model number.
name String | The chassis name.
productId String | The product Id.
serialNr String | The serial number.
versionId String | The version Id.
etherChannel EtherChannel[] | This nested field provides information about the ether channels associated with this device.
Attribute | Description
--- | ---
actorAdminKey Integer | The current administrative value of the 16-bit Key for the Aggregator (Actor). The administrative Key value may differ from the operational Key value for reasons discussed in the IEEE 802.3ad document, Section 43.6.2. The meaning of particular Key values is of local significance MIB.IEEE|IEEE8023-LAG-MIB.dot3adAggActorAdminKey.
channelGroupId int | The value of this property is the group ID assigned to the aggregation. Note that this is needed for configuring EtherChannel in Cisco devices but it is not part of the 802.3ad standard (i.e., it is not the same as the LAG ID in 802.3ad).
controlMethod LAGControlProtocolEnum | Enumeration attribute to indicate how aggregation is controlled. Allowed values MANUAL LACP PAGP
name String | The name of this Ethernet Channel.
numberOfMembers int | The number of ProtocolEndpoint's that list this EtherChannel as their lagEndName.
ethernetInterface EthernetInterfaceV3[] | This nested field provides information on the ethernet interfaces associated with this device.
Attribute | Description
--- | ---
accessVlan Integer | The VLAN id for an "access" or "tunnel" interface. For trunks, this is the VLAN to be used if the interface stops trunking.
adminStatus IfAdminStatusEnum | Represents the desired state of the interface. Allowed values UNKNOWN UP DOWN TESTING NOT_APPLICABLE
allowedVlanIds String | VLANs in this list MAY be trunked on this port.
channelGroupId Integer | Number of a port-channel logical interface that is bound with the current physical interface.
description String | The ethernet interface description.
desiredTrunkingEncapsulation VLANEncapsulationEnum | The requested encapsulation for the trunk. Allowed values UNKOWN OTHER NOT_APPLICABLE CISCO_ISL _8021Q NEGOTIATE_OR_BEING_NEGOTIATED
desiredVlanMode VLANModeEnum | The desired VLAN mode that is requested for use. Allowed values UNKNOWN OTHER ACCESS DYNAMIC_AUTO DYNAMIC_DESIRABLE TRUNK DOT1Q_TUNNEL PVLAN_HOST PVLAN_TRUNK PVLAN_PROMISCUOUS DOWN HYBRID
duplexMode DuplexEnum | Duplex mode for the ethernet interface. Allowed values UNKNOWN HALFDUPLEX FULLDUPLEX DISAGREE AUTO_NEGOTIATE NOT_APPLICABLE
macAddress String | Represents media- or physical-level addresses. This is the interface's address at its protocol sublayer. For example, for an 802.x interface, this object normally contains a MAC address. The interface's media-specific MIB must define the bit and byte ordering and the format of the value of this object. For interfaces that do nothave such an address (such as a serial line), this object should contain an octet string of zero length.
mtu Integer | Represents the size in octests of the largest packet that can be sent/recieved on the interface. For interfaces that are used for transmitting network diagrams, this is the size of the largest network datagram that can be sent on the interface.
name String | The ethernet interface name.
nativeVlan Integer | VLAN Id that is used to tag untagged traffic received on a trunked interface.
operationalStatus IfOperStatusEnum | Represents the current operation state of the interface. Allowed values NOT_APPLICABLE UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWERLAYERDOWN
operationalTrunkEncapsulation VLANEncapsulationEnum | The type of VLAN encapsulation in use on a trunking interface/port. Allowed values UNKOWN OTHER NOT_APPLICABLE CISCO_ISL _8021Q NEGOTIATE_OR_BEING_NEGOTIATED
operationalVlanMode VLANModeEnum | The configuration mode for the VLAN interface. Allowed values UNKNOWN OTHER ACCESS DYNAMIC_AUTO DYNAMIC_DESIRABLE TRUNK DOT1Q_TUNNEL PVLAN_HOST PVLAN_TRUNK PVLAN_PROMISCUOUS DOWN HYBRID
pruneEligibleVlanIds String | VLANs in this list MAY be pruned on this trunk port.
speed Long | Specifies an estimate of the interface's current bandwidth in bits per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this should contain the nominal bandwidth. For a sublayer that has no concept of bandwidth, this object should be zero.
trunkingEncapsulationNegotiation Boolean | A Boolean attribute that indicates whether or not the interface supports negotiation of the trunk encapsulation.
fan FanV3[] | This nested field provides information about the fans associated with this device
Attribute | Description
--- | ---
description String | The description of the fan.
name String | The name of the fan.
operationalStatus String | The operational status of the fan.
productId String | The product ID of the fan.
serialNumber String | The serial number of the fan.
vendorEquipmentType String | The vendor equipment type of the fan.
versionId String | The hardware version ID of this fan.
ipInterface IpInterface[] | This nested field provides information about the ip interfaces associated with this device.
Attribute | Description
--- | ---
adminStatus IfAdminStatusEnum | Represents the desired state of the interface. Allowed values UNKNOWN UP DOWN TESTING NOT_APPLICABLE
ipAddress String | Specifies the IP address with a prefix assigned to this IP endpoint. It consists of the IP address followed by a slash and then by the number of bits in the prefix.
name String | The name of this IP endpoint.
operationalStatus IfOperStatusEnum | Represents the current operation state of the interface. Allowed values NOT_APPLICABLE UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWERLAYERDOWN
module DeviceModuleV3[] | This nested field provides a listing of the modules associated with this device
Attribute | Description
--- | ---
description String | A description provided for this module.
equipmentId String | An internal id for the module.
equipmentType EquipmentTypeEnum | An indication of the general hardware type of the physical entity. This should be set to the standard enumeration value that most accurately indicates the general class of the physical entity or the primary class if there is more than one. If no appropriate standard registration identifier exists for this physical entity, then the value "other" is returned. Allowed values OTHER UNKNOWN CHASSIS BACKPLANE POWERSUPPLY FAN MODULE RACK PROCESSOR DISK MEMORY_MODULE COMPUTE_BLADE CHASSIS_EXTENDER MOTHERBOARD IP_PHONE WIRELESS_AP PLUGGABLE_TRANSCEIVER
firmwareVersion String | The firmware version of this module.
nrPorts Long | The no. of ports available in this module.
operationStatus String | The operational status of this module.
physicalLocation String | The physical location of this module. For e.g. Ten GigabitEthernet Container.
productId String | The product ID associated with this module.
productName String | The name associated with this module. This is the official name given to a product. For example, Cisco 12000 Six-port DS3 Line card.
serialNr String | The serial number of this module.
slotNumber String | The slot number on the equipment holder where this module is inserted if available.
softwareVersion String | The version of the software installed on this module.
vendorType String | An indication of the vendor-specific hardware type of the physical entity. Represents an independently extensible type identification value. It can, for example, indicate a particular subtree with further MIB definitions, or define a particular type of protocol or hardware (for example, 1.3.6.1.4.1.9.12.3.1.9.3.131). See CISCO-ENTITY-VENDORTYPE-OID-MIB.
versionId String | The hardware version ID of this module.
physicalPort PhysicalPortV3[] | This nested field provides information about the physical ports associated with this device.
Attribute | Description
--- | ---
description String | The port description (i.e. Fast Ethernet Port, etc.).
equipmentId long | The ID of the equipment object that this port is contained in.
name String | The name of the port.
residingModule String | The module that contains the port.
vendorEquipmentType String | The vendor equipment type.
powerSupply PowerSupplyV3[] | This nested field provides information about the power supplies associated with this device.
Attribute | Description
--- | ---
description String | A description of the power supply.
manufacturerName String | The name of the manufacturer of the power supply.
name String | The name of the power supply.
operationalStatus String | The operational status of the power supply.
productId String | The product ID of the power supply.
serialNumber String | The serial number of the power supply.
vendorEquipmentType String | The vendor equipment type of the power supply equipment.
versionId String | The hardware version ID of the power supply.
sensor DeviceSensor[] | This nested field provides information about the sensors associated with this device.
Attribute | Description
--- | ---
description String | A description of the sensor.
entPhysicalIndex String | Entity physical index.
equipmentName String | The name of the equipment associated with this sensor.
name String | The name of the sensor
precision Integer | The number of decimal places of precision in the sensor value.
status SensorStatusEnum | The present operational status of the sensor. Allowed values OK UNAVAILABLE NONOPERATIONAL
type SensorDataTypeEnum | The type of data reported by the Sensor. Allowed values OTHER UNKNOWN VOLTSAC VOLTSDC AMPERES WATTS HERTZ CELSIUS PERCENTRH RPM CMM TRUTHVALUE SPECIALENUM DBM OPTICAL_TX_DBM OPTICAL_RX_DBM OPTICAL_LASER_BIAS_CURRENT
vendorSensorType String | An indication of the vendor-specific hardware type of the physical entity. For example: 1.3.6.1.4.1.9.12.3.1.9.3.131 See CISCO-ENTITY-VENDORTYPE-OID-MIB
summary SummaryV3 | A nested field that provides an inventory summary
Attribute | Description
--- | ---
ciscoIdentityCapable Boolean | Indicates whether the device is Cisco identity capable.
contact String | Details about the contact person for this device.
deviceId Long | An internal id for the device.
deviceName String | The name of the device.
deviceType String | The type of the device. For eg. Cisco 3750 Stackable switches.
ipAddress String | The ip address of the device.
location String | The physical location of the device.
locationCapable Boolean | Indicates whether the device is location capable.
productFamily String | The product family of this device.
reachability ReachabilityStateEnum | Indicates management availability or reachability of the managed network element. It can indicate the availability or reachability of the management agent serving as a proxy for the network element. Allowed values UNKNOWN REACHABLE UNREACHABLE AGENT_UNREACHABLE AGENT_UNLOADED PING_REACHABLE PING_UNREACHABLE
softwareVersion String | The version of the software installed on the device.
systemTime Date | The current timestamp of the system.
upTime Long | The duration the device is up from the last boot time in milliseconds.
udf UDFValue[] | This nested field provides the user defined fields for this device.
Attribute | Description
--- | ---
name String | The name of the user defined field.
value String | The value of the user defined field.
vlanInterface VlanInterfaceV3[] | This nested field provides information about the vlan interfaces associated with this device.
Attribute | Description
--- | ---
adminStatus IfAdminStatusEnum | Represents the desired state of the interface. Allowed values UNKNOWN UP DOWN TESTING NOT_APPLICABLE
maxSpeed Long | Specifies an estimate of the interface's current bandwidth in bits per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this should contain the nominal bandwidth. For a sublayer that has no concept of bandwidth, this object should be zero.
mtu Integer | The MTU size to be set across the VLAN.
operationalStatus IfOperStatusEnum | Represents the current operation state of the interface. Allowed values NOT_APPLICABLE UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWERLAYERDOWN
portName String | The name of this VLAN port.
portType IFTypeEnum | Allowed values OTHER REGULAR1822 HDH1822 DDNX25 RFC877X25 ETHERNETCSMACD ISO88023CSMACD ISO88024TOKENBUS ISO88025TOKENRING ISO88026MAN STARLAN PROTEON10MBIT PROTEON80MBIT HYPERCHANNEL FDDI LAPB SDLC DS1 E1 BASICISDN PRIMARYISDN PROPPOINTTOPOINTSERIAL PPP SOFTWARELOOPBACK EON ETHERNET3MBIT NSIP SLIP ULTRA DS3 SIP FRAMERELAY RS232 PARA ARCNET ARCNETPLUS ATM MIOX25 SONET X25PLE ISO88022LLC LOCALTALK SMDSDXI FRAMERELAYSERVICE V35 HSSI HIPPI MODEM AAL5 SONETPATH SONETVT SMDSICIP PROPVIRTUAL PROPMULTIPLEXOR IEEE80212 FIBRECHANNEL HIPPIINTERFACE FRAMERELAYINTERCONNECT AFLANE8023 AFLANE8025 CCTEMUL FASTETHER ISDN V11 V36 G703AT64K G703AT2MB QLLC FASTETHERFX CHANNEL IEEE80211 IBM370PARCHAN ESCON DLSW ISDNS ISDNU LAPD IPSWITCH RSRB ATMLOGICAL DS0 DS0BUNDLE BSC ASYNC CNR ISO88025DTR EPLRS ARAP PROPCNLS HOSTPAD TERMPAD FRAMERELAYMPI X213 ADSL RADSL SDSL VDSL ISO88025CRFPINT MYRINET VOICEEM VOICEFXO VOICEFXS VOICEENCAP VOICEOVERIP ATMDXI ATMFUNI ATMIMA PPPMULTILINKBUNDLE IPOVERCDLC IPOVERCLAW STACKTOSTACK VIRTUALIPADDRESS MPC IPOVERATM ISO88025FIBER TDLC GIGABITETHERNET HDLC LAPF V37 X25MLP X25HUNTGROUP TRANSPHDLC INTERLEAVE FAST IP DOCSCABLEMACLAYER DOCSCABLEDOWNSTREAM DOCSCABLEUPSTREAM A12MPPSWITCH TUNNEL COFFEE CES ATMSUBINTERFACE L2VLAN L3IPVLAN L3IPXVLAN DIGITALPOWERLINE MEDIAMAILOVERIP DTM DCN IPFORWARD MSDSL IEEE1394 IF_GSN DVBRCCMACLAYER DVBRCCDOWNSTREAM DVBRCCUPSTREAM ATMVIRTUAL MPLSTUNNEL SRP VOICEOVERATM VOICEOVERFRAMERELAY IDSL COMPOSITELINK SS7SIGLINK PROPWIRELESSP2P FRFORWARD RFC1483 USB IEEE8023ADLAG BGPPOLICYACCOUNTING FRF16MFRBUNDLE H323GATEKEEPER H323PROXY MPLS MFSIGLINK HDSL2 SHDSL DS1FDL POS DVBASIIN DVBASIOUT PLC NFAS TR008 GR303RDT GR303IDT ISUP PROPDOCSWIRELESSMACLAYER PROPDOCSWIRELESSDOWNSTREAM PROPDOCSWIRELESSUPSTREAM HIPERLAN2 PROPBWAP2MP SONETOVERHEADCHANNEL DIGITALWRAPPEROVERHEADCHANNEL AAL2 RADIOMAC ATMRADIO IMT MVL REACHDSL FRDLCIENDPT ATMVCIENDPT OPTICALCHANNEL OPTICALTRANSPORT PROPATM VOICEOVERCABLE INFINIBAND TELINK Q2931 VIRTUALTG SIPTG SIPSIG DOCSCABLEUPSTREAMCHANNEL ECONET PON155 PON622 BRIDGE LINEGROUP VOICEEMFGD VOICEFGDEANA VOICEDID MPEGTRANSPORT SIXTOFOUR GTP PDNETHERLOOP1 PDNETHERLOOP2 OPTICALCHANNELGROUP HOMEPNA GFP CISCOISLVLAN ACTELISMETALOOP FCIPLINK RPR QAM LMP CBLVECTASTAR DOCSCABLEMCMTSDOWNSTREAM ADSL2 MACSECCONTROLLEDIF MACSECUNCONTROLLEDIF AVICIOPTICALETHER ATMBOND VOICEFGDOS MOCAVERSION1 IEEE80216WMAN ADSL2PLUS DVBRCSMACLAYER DVBTDM DVBRCSTDMA X86LAPS WWANPP WWANPP2 VOICEEBS IFPWTYPE ILAN PIP ALUELP GPON VDSL2 CAPWAPDOT11PROFILE CAPWAPDOT11BSS CAPWAPWTPVIRTUALRADIO BITS DOCS_CABLE_UPSTREAM_RF_PORT CABLE_DOWNSTREAM_RF_PORT VMWAREVIRTUALNIC IEEE802154 OTNODU OTNOTU IFVFITYPE G9981 G9982 G9983 ALUEPON ALUEPONONU ALUEPONPHYSICALUNI ALUEPONLOGICALLINK ALUGPONONU ALUGPONPHYSICALUNI VMWARENICTEAM DOCSOFDMDOWNSTREAM DOCSOFDMAUPSTREAM GFAST SDCI XBOXWIRELESS FASTDSL DOCSCABLESCTE55D1FWDOOB DOCSCABLESCTE55D1RETOOB DOCSCABLESCTE55D2DSOOB DOCSCABLESCTE55D2USOOB DOCSCABLENDF DOCSCABLENDR PTM GHN OTNOTSI OTNOTUC OTNODUC OTNOTSIG MICROWAVECARRIERTERMINATION MICROWAVERADIOLINKTERMINAL
vlanId int | A VLAN ID for the VLAN Interface.

## 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://172.20.127.108/webacs/api/v3/data/InventoryDetails/15

    <?xml version="1.0" ?>
    <queryResponse type="InventoryDetails" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v3/data/InventoryDetails/15" rootUrl="https://172.20.127.108/webacs/api/v3/data">
      <entity dtoType="inventoryDetailsDTO" type="InventoryDetails" url="https://172.20.127.108/webacs/api/v3/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>
            </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>1986-07-24T00:00:00Z</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://172.20.127.108/webacs/api/v3/data/InventoryDetails/15.json

    {
      "queryResponse" : {
        "@type" : "InventoryDetails",
        "@requestUrl" : "https://172.20.127.108/webacs/api/v3/data/InventoryDetails/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v3/data",
        "entity" : [ {
          "@dtoType" : "inventoryDetailsDTO",
          "@type" : "InventoryDetails",
          "@url" : "https://172.20.127.108/webacs/api/v3/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" : "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" : "1986-07-24T00:00: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
              } ]
            }
          }
        } ]
      }
    }

### 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 CDPNeighborV4[] | This nested field provides information on the CDP neighbors for this device.
Attribute | Description
--- | ---
duplexMode CDPDuplexMode | The duplex mode between the local device and the neighbor. Allowed values UNKNOWN HALF_DUPLEX FULL_DUPLEX
farEndInterface String | The interface on the neighbor device connected to the local device.
interfaceIndex int | The index of the local interface.
nearEndInterface String | The interface on the local device connected to the neighbor device.
neighborCapabilities String | Neighbor capabilities. Set of neighbor capabilities is stored as a string that contain values separated by ' '. Allowed values: Router, Trans-Bridge, Source-Route-Bridge, Switch, Host, IGMP, Repeater, Phone.
neighborDeviceName String | The neighbor device's name.
neighborDevicePlatformType String | The neighbor device's platform type.
chassis Chassis[] | This nested field provides a listing of the chassis associated with this device.
Attribute | Description
--- | ---
description String | The chassis description.
entPhysicalIndex String | Entity physical index.
modelNr String | The model number.
name String | The chassis name.
productId String | The product Id.
serialNr String | The serial number.
versionId String | The version Id.
etherChannel EtherChannel[] | This nested field provides information about the ether channels associated with this device.
Attribute | Description
--- | ---
actorAdminKey Integer | The current administrative value of the 16-bit Key for the Aggregator (Actor). The administrative Key value may differ from the operational Key value for reasons discussed in the IEEE 802.3ad document, Section 43.6.2. The meaning of particular Key values is of local significance MIB.IEEE|IEEE8023-LAG-MIB.dot3adAggActorAdminKey.
channelGroupId int | The value of this property is the group ID assigned to the aggregation. Note that this is needed for configuring EtherChannel in Cisco devices but it is not part of the 802.3ad standard (i.e., it is not the same as the LAG ID in 802.3ad).
controlMethod LAGControlProtocolEnum | Enumeration attribute to indicate how aggregation is controlled. Allowed values MANUAL LACP PAGP
name String | The name of this Ethernet Channel.
numberOfMembers int | The number of ProtocolEndpoint's that list this EtherChannel as their lagEndName.
ethernetInterface EthernetInterfaceV4[] | This nested field provides information on the ethernet interfaces associated with this device.
Attribute | Description
--- | ---
accessVlan Integer | The VLAN id for an "access" or "tunnel" interface. For trunks, this is the VLAN to be used if the interface stops trunking.
adminStatus IfAdminStatusEnum | Represents the desired state of the interface. Allowed values UNKNOWN UP DOWN TESTING NOT_APPLICABLE
allowedVlanIds String | VLANs in this list MAY be trunked on this port.
channelGroupId Integer | Number of a port-channel logical interface that is bound with the current physical interface.
description String | The ethernet interface description.
desiredTrunkingEncapsulation VLANEncapsulationEnum | The requested encapsulation for the trunk. Allowed values UNKOWN OTHER NOT_APPLICABLE CISCO_ISL _8021Q NEGOTIATE_OR_BEING_NEGOTIATED
desiredVlanMode VLANModeEnum | The desired VLAN mode that is requested for use. Allowed values UNKNOWN OTHER ACCESS DYNAMIC_AUTO DYNAMIC_DESIRABLE TRUNK DOT1Q_TUNNEL PVLAN_HOST PVLAN_TRUNK PVLAN_PROMISCUOUS DOWN HYBRID
duplexMode DuplexEnum | Duplex mode for the ethernet interface. Allowed values UNKNOWN HALFDUPLEX FULLDUPLEX DISAGREE AUTO_NEGOTIATE NOT_APPLICABLE
macAddress MacAddress | Represents media- or physical-level addresses. This is the interface's address at its protocol sublayer. For example, for an 802.x interface, this object normally contains a MAC address. The interface's media-specific MIB must define the bit and byte ordering and the format of the value of this object. For interfaces that do nothave such an address (such as a serial line), this object should contain an octet string of zero length.
mtu Integer | Represents the size in octests of the largest packet that can be sent/recieved on the interface. For interfaces that are used for transmitting network diagrams, this is the size of the largest network datagram that can be sent on the interface.
name String | The ethernet interface name.
nativeVlan Integer | VLAN Id that is used to tag untagged traffic received on a trunked interface.
operationalStatus IfOperStatusEnum | Represents the current operation state of the interface. Allowed values NOT_APPLICABLE UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWERLAYERDOWN
operationalTrunkEncapsulation VLANEncapsulationEnum | The type of VLAN encapsulation in use on a trunking interface/port. Allowed values UNKOWN OTHER NOT_APPLICABLE CISCO_ISL _8021Q NEGOTIATE_OR_BEING_NEGOTIATED
operationalVlanMode VLANModeEnum | The configuration mode for the VLAN interface. Allowed values UNKNOWN OTHER ACCESS DYNAMIC_AUTO DYNAMIC_DESIRABLE TRUNK DOT1Q_TUNNEL PVLAN_HOST PVLAN_TRUNK PVLAN_PROMISCUOUS DOWN HYBRID
pruneEligibleVlanIds String | VLANs in this list MAY be pruned on this trunk port.
speed Long | Specifies an estimate of the interface's current bandwidth in bits per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this should contain the nominal bandwidth. For a sublayer that has no concept of bandwidth, this object should be zero.
trunkingEncapsulationNegotiation Boolean | A Boolean attribute that indicates whether or not the interface supports negotiation of the trunk encapsulation.
fan FanV3[] | This nested field provides information about the fans associated with this device
Attribute | Description
--- | ---
description String | The description of the fan.
name String | The name of the fan.
operationalStatus String | The operational status of the fan.
productId String | The product ID of the fan.
serialNumber String | The serial number of the fan.
vendorEquipmentType String | The vendor equipment type of the fan.
versionId String | The hardware version ID of this fan.
ipInterface IpInterfaceV4[] | This nested field provides information about the ip interfaces associated with this device.
Attribute | Description
--- | ---
adminStatus IfAdminStatusEnum | Represents the desired state of the interface. Allowed values UNKNOWN UP DOWN TESTING NOT_APPLICABLE
ipAddress InetAddress | Specifies the IP address with a prefix assigned to this IP endpoint.
name String | The name of this IP endpoint.
operationalStatus IfOperStatusEnum | Represents the current operation state of the interface. Allowed values NOT_APPLICABLE UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWERLAYERDOWN
prefixLength String | IP address prefix length, in bits.
module DeviceModuleV4[] | This nested field provides a listing of the modules associated with this device
Attribute | Description
--- | ---
description String | A description provided for this module.
equipmentId long | An internal id for the module.
equipmentType EquipmentTypeEnum | An indication of the general hardware type of the physical entity. This should be set to the standard enumeration value that most accurately indicates the general class of the physical entity or the primary class if there is more than one. If no appropriate standard registration identifier exists for this physical entity, then the value "other" is returned. Allowed values OTHER UNKNOWN CHASSIS BACKPLANE POWERSUPPLY FAN MODULE RACK PROCESSOR DISK MEMORY_MODULE COMPUTE_BLADE CHASSIS_EXTENDER MOTHERBOARD IP_PHONE WIRELESS_AP PLUGGABLE_TRANSCEIVER
firmwareVersion String | The firmware version of this module.
nrPorts Long | The no. of ports available in this module.
operationStatus String | The operational status of this module.
physicalLocation String | The physical location of this module. For e.g. Ten GigabitEthernet Container.
productId String | The product ID associated with this module.
productName String | The name associated with this module. This is the official name given to a product. For example, Cisco 12000 Six-port DS3 Line card.
serialNr String | The serial number of this module.
slotNumber String | The slot number on the equipment holder where this module is inserted if available.
softwareVersion String | The version of the software installed on this module.
vendorType String | An indication of the vendor-specific hardware type of the physical entity. Represents an independently extensible type identification value. It can, for example, indicate a particular subtree with further MIB definitions, or define a particular type of protocol or hardware (for example, 1.3.6.1.4.1.9.12.3.1.9.3.131). See CISCO-ENTITY-VENDORTYPE-OID-MIB.
versionId String | The hardware version ID of this module.
physicalPort PhysicalPortV3[] | This nested field provides information about the physical ports associated with this device.
Attribute | Description
--- | ---
description String | The port description (i.e. Fast Ethernet Port, etc.).
equipmentId long | The ID of the equipment object that this port is contained in.
name String | The name of the port.
residingModule String | The module that contains the port.
vendorEquipmentType String | The vendor equipment type.
powerSupply PowerSupplyV3[] | This nested field provides information about the power supplies associated with this device.
Attribute | Description
--- | ---
description String | A description of the power supply.
manufacturerName String | The name of the manufacturer of the power supply.
name String | The name of the power supply.
operationalStatus String | The operational status of the power supply.
productId String | The product ID of the power supply.
serialNumber String | The serial number of the power supply.
vendorEquipmentType String | The vendor equipment type of the power supply equipment.
versionId String | The hardware version ID of the power supply.
sensor DeviceSensor[] | This nested field provides information about the sensors associated with this device.
Attribute | Description
--- | ---
description String | A description of the sensor.
entPhysicalIndex String | Entity physical index.
equipmentName String | The name of the equipment associated with this sensor.
name String | The name of the sensor
precision Integer | The number of decimal places of precision in the sensor value.
status SensorStatusEnum | The present operational status of the sensor. Allowed values OK UNAVAILABLE NONOPERATIONAL
type SensorDataTypeEnum | The type of data reported by the Sensor. Allowed values OTHER UNKNOWN VOLTSAC VOLTSDC AMPERES WATTS HERTZ CELSIUS PERCENTRH RPM CMM TRUTHVALUE SPECIALENUM DBM OPTICAL_TX_DBM OPTICAL_RX_DBM OPTICAL_LASER_BIAS_CURRENT
vendorSensorType String | An indication of the vendor-specific hardware type of the physical entity. For example: 1.3.6.1.4.1.9.12.3.1.9.3.131 See CISCO-ENTITY-VENDORTYPE-OID-MIB
summary SummaryV3 | A nested field that provides an inventory summary
Attribute | Description
--- | ---
ciscoIdentityCapable Boolean | Indicates whether the device is Cisco identity capable.
contact String | Details about the contact person for this device.
deviceId Long | An internal id for the device.
deviceName String | The name of the device.
deviceType String | The type of the device. For eg. Cisco 3750 Stackable switches.
ipAddress String | The ip address of the device.
location String | The physical location of the device.
locationCapable Boolean | Indicates whether the device is location capable.
productFamily String | The product family of this device.
reachability ReachabilityStateEnum | Indicates management availability or reachability of the managed network element. It can indicate the availability or reachability of the management agent serving as a proxy for the network element. Allowed values UNKNOWN REACHABLE UNREACHABLE AGENT_UNREACHABLE AGENT_UNLOADED PING_REACHABLE PING_UNREACHABLE
softwareVersion String | The version of the software installed on the device.
systemTime Date | The current timestamp of the system.
upTime Long | The duration the device is up from the last boot time in milliseconds.
udf UDFValue[] | This nested field provides the user defined fields for this device.
Attribute | Description
--- | ---
name String | The name of the user defined field.
value String | The value of the user defined field.
vlanInterface VlanInterfaceV3[] | This nested field provides information about the vlan interfaces associated with this device.
Attribute | Description
--- | ---
adminStatus IfAdminStatusEnum | Represents the desired state of the interface. Allowed values UNKNOWN UP DOWN TESTING NOT_APPLICABLE
maxSpeed Long | Specifies an estimate of the interface's current bandwidth in bits per second. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this should contain the nominal bandwidth. For a sublayer that has no concept of bandwidth, this object should be zero.
mtu Integer | The MTU size to be set across the VLAN.
operationalStatus IfOperStatusEnum | Represents the current operation state of the interface. Allowed values NOT_APPLICABLE UP DOWN TESTING UNKNOWN DORMANT NOTPRESENT LOWERLAYERDOWN
portName String | The name of this VLAN port.
portType IFTypeEnum | Allowed values OTHER REGULAR1822 HDH1822 DDNX25 RFC877X25 ETHERNETCSMACD ISO88023CSMACD ISO88024TOKENBUS ISO88025TOKENRING ISO88026MAN STARLAN PROTEON10MBIT PROTEON80MBIT HYPERCHANNEL FDDI LAPB SDLC DS1 E1 BASICISDN PRIMARYISDN PROPPOINTTOPOINTSERIAL PPP SOFTWARELOOPBACK EON ETHERNET3MBIT NSIP SLIP ULTRA DS3 SIP FRAMERELAY RS232 PARA ARCNET ARCNETPLUS ATM MIOX25 SONET X25PLE ISO88022LLC LOCALTALK SMDSDXI FRAMERELAYSERVICE V35 HSSI HIPPI MODEM AAL5 SONETPATH SONETVT SMDSICIP PROPVIRTUAL PROPMULTIPLEXOR IEEE80212 FIBRECHANNEL HIPPIINTERFACE FRAMERELAYINTERCONNECT AFLANE8023 AFLANE8025 CCTEMUL FASTETHER ISDN V11 V36 G703AT64K G703AT2MB QLLC FASTETHERFX CHANNEL IEEE80211 IBM370PARCHAN ESCON DLSW ISDNS ISDNU LAPD IPSWITCH RSRB ATMLOGICAL DS0 DS0BUNDLE BSC ASYNC CNR ISO88025DTR EPLRS ARAP PROPCNLS HOSTPAD TERMPAD FRAMERELAYMPI X213 ADSL RADSL SDSL VDSL ISO88025CRFPINT MYRINET VOICEEM VOICEFXO VOICEFXS VOICEENCAP VOICEOVERIP ATMDXI ATMFUNI ATMIMA PPPMULTILINKBUNDLE IPOVERCDLC IPOVERCLAW STACKTOSTACK VIRTUALIPADDRESS MPC IPOVERATM ISO88025FIBER TDLC GIGABITETHERNET HDLC LAPF V37 X25MLP X25HUNTGROUP TRANSPHDLC INTERLEAVE FAST IP DOCSCABLEMACLAYER DOCSCABLEDOWNSTREAM DOCSCABLEUPSTREAM A12MPPSWITCH TUNNEL COFFEE CES ATMSUBINTERFACE L2VLAN L3IPVLAN L3IPXVLAN DIGITALPOWERLINE MEDIAMAILOVERIP DTM DCN IPFORWARD MSDSL IEEE1394 IF_GSN DVBRCCMACLAYER DVBRCCDOWNSTREAM DVBRCCUPSTREAM ATMVIRTUAL MPLSTUNNEL SRP VOICEOVERATM VOICEOVERFRAMERELAY IDSL COMPOSITELINK SS7SIGLINK PROPWIRELESSP2P FRFORWARD RFC1483 USB IEEE8023ADLAG BGPPOLICYACCOUNTING FRF16MFRBUNDLE H323GATEKEEPER H323PROXY MPLS MFSIGLINK HDSL2 SHDSL DS1FDL POS DVBASIIN DVBASIOUT PLC NFAS TR008 GR303RDT GR303IDT ISUP PROPDOCSWIRELESSMACLAYER PROPDOCSWIRELESSDOWNSTREAM PROPDOCSWIRELESSUPSTREAM HIPERLAN2 PROPBWAP2MP SONETOVERHEADCHANNEL DIGITALWRAPPEROVERHEADCHANNEL AAL2 RADIOMAC ATMRADIO IMT MVL REACHDSL FRDLCIENDPT ATMVCIENDPT OPTICALCHANNEL OPTICALTRANSPORT PROPATM VOICEOVERCABLE INFINIBAND TELINK Q2931 VIRTUALTG SIPTG SIPSIG DOCSCABLEUPSTREAMCHANNEL ECONET PON155 PON622 BRIDGE LINEGROUP VOICEEMFGD VOICEFGDEANA VOICEDID MPEGTRANSPORT SIXTOFOUR GTP PDNETHERLOOP1 PDNETHERLOOP2 OPTICALCHANNELGROUP HOMEPNA GFP CISCOISLVLAN ACTELISMETALOOP FCIPLINK RPR QAM LMP CBLVECTASTAR DOCSCABLEMCMTSDOWNSTREAM ADSL2 MACSECCONTROLLEDIF MACSECUNCONTROLLEDIF AVICIOPTICALETHER ATMBOND VOICEFGDOS MOCAVERSION1 IEEE80216WMAN ADSL2PLUS DVBRCSMACLAYER DVBTDM DVBRCSTDMA X86LAPS WWANPP WWANPP2 VOICEEBS IFPWTYPE ILAN PIP ALUELP GPON VDSL2 CAPWAPDOT11PROFILE CAPWAPDOT11BSS CAPWAPWTPVIRTUALRADIO BITS DOCS_CABLE_UPSTREAM_RF_PORT CABLE_DOWNSTREAM_RF_PORT VMWAREVIRTUALNIC IEEE802154 OTNODU OTNOTU IFVFITYPE G9981 G9982 G9983 ALUEPON ALUEPONONU ALUEPONPHYSICALUNI ALUEPONLOGICALLINK ALUGPONONU ALUGPONPHYSICALUNI VMWARENICTEAM DOCSOFDMDOWNSTREAM DOCSOFDMAUPSTREAM GFAST SDCI XBOXWIRELESS FASTDSL DOCSCABLESCTE55D1FWDOOB DOCSCABLESCTE55D1RETOOB DOCSCABLESCTE55D2DSOOB DOCSCABLESCTE55D2USOOB DOCSCABLENDF DOCSCABLENDR PTM GHN OTNOTSI OTNOTUC OTNODUC OTNOTSIG MICROWAVECARRIERTERMINATION MICROWAVERADIOLINKTERMINAL
vlanId int | A VLAN ID for the VLAN Interface.

## 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://172.20.127.108/webacs/api/v4/data/InventoryDetails/15

    <?xml version="1.0" ?>
    <queryResponse type="InventoryDetails" responseType="getEntity" requestUrl="https://172.20.127.108/webacs/api/v4/data/InventoryDetails/15" rootUrl="https://172.20.127.108/webacs/api/v4/data">
      <entity dtoType="inventoryDetailsDTO" type="InventoryDetails" url="https://172.20.127.108/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:00Z</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://172.20.127.108/webacs/api/v4/data/InventoryDetails/15.json

    {
      "queryResponse" : {
        "@type" : "InventoryDetails",
        "@requestUrl" : "https://172.20.127.108/webacs/api/v4/data/InventoryDetails/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://172.20.127.108/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "inventoryDetailsDTO",
          "@type" : "InventoryDetails",
          "@url" : "https://172.20.127.108/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-24T00:00: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
              } ]
            }
          }
        } ]
      }
    }