Inventory
Chassis Ldos API
Chassis Ldos API returns the number of chassis that have passed their Last Day of Support to give an overall indication of the extent to which the network needs to be upgraded. Other APIs are provided to get more detail.
Request URL
GET : https://apx.cisco.com/cs/api/v1/inventory/chassis-ldos
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not Applicable |
| groupName | STRING | No | The groupName value indicates the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameter | Data Type | Description |
|---|---|---|
| chassisLdos | STRING | This indicates the number of chassis that have passed their Last Day of Support to give an overall indication of the extent to which the network needs to be upgraded. |
Sample JSON Response
{
"data": [
{
"chassisLdos": "62"
}
]
}Config Register Warnings API
Config Register Warnings API returns the number of devices in the network that have invalid configuration register. For now, users would have to access the BCI portal to get the list of devices having invalid config registers.
Request URL
GET : https://apx.cisco.com/cs/api/v1/inventory/config-register-warnings
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not Applicable |
| groupName | STRING | No | The groupName value indicatess the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameter | Data Type | Description |
|-----------------------|:------------:|:-----------:|--------:|
| configRegisterWarningNetworkElements | STRING | This indicates the number of devices in the network that have invalid configuration register. |
Sample JSON Response
{
"data": [
{
"configRegisterWarningNetworkElements": "0"
}
]
}Crash Network Elements API
Crash Network Elements API returns the number of devices that reloaded in the last 30 days unexpectedly due to a failure.
Request URL
GET : https://apx.cisco.com/cs/api/v1/inventory/crash-network-elements
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not Applicable |
| groupName | STRING | No | The groupName value indicatess the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameter | Data Type | Description |
|---|---|---|
| crashNetworkElements | STRING | This indicates the number of devices that reloaded in the last 30 days unexpectedly due to a failure. |
| ### Sample JSON Response | ||
| ``` | ||
| { | ||
| "data": [ | ||
| { | ||
| "crashNetworkElements": "0" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
| ## Reloaded Network Elements API |
Reloaded Network Elements API returns the number of devices that were re-loaded gracefully in the last 30 days. In other words, these devices were shut down and reloaded for maintenance or some other reason rather than getting crashed and reloaded.
Request URL
GET : https://apx.cisco.com/cs/api/v1/inventory/reloaded-network-elements
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not Applicable |
| groupName | STRING | No | The groupName value indicatess the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameter | Data Type | Description |
|---|---|---|
| reloadedNetworkElement | STRING | This indicates the the number of devices that were re-loaded gracefully in the last 30 days. |
Sample JSON Response
{
"data": [
{
"reloadedNetworkElement": "33"
}
]
}Hardware Summary By Product Family API
Hardware Summary By Product Family API provides a list of the Product Families and the count of each Product Family. Only the top 10 highest count Product Families are provided.
Request URL
GET : https://apx.cisco.com/cs/api/v1/inventory/hardware-summary-by-product-family
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not Applicable |
| groupName | STRING | No | The groupName value indicatess the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameter | Data Type | Description |
|---|---|---|
| productFamily | STRING | This represents the platform or product family. |
| hwCount | STRING | This represents the hardware count for a specific product family. |
Sample JSON Response
{
"data": [
{
"productFamily": "Cisco Unified IP Phone 7900 Series",
"hwCount": "19742"
},
{
"productFamily": "Cisco IP Phone 7800 Series",
"hwCount": "12162"
},
{
"productFamily": "Cisco Catalyst 2960-X Series Switches",
"hwCount": "8474"
}
]
}Hardware Summary By Product Id API
Hardware Summary By Product Id API provides the list of 10 highest number of products for a given hardware type. It returns the Product ID and the count of each. The hardware type, which could be Chassis, Module, Power Supply, Fan or Transceiver is as an input parameter to the API.
Request URL
GET : https://apx.cisco.com/cs/api/v1/inventory/hardware-summary-by-product-id
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not Applicable |
| groupName | STRING | No | The unique, generated ID of the network element group | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
| hwType | STRING | No | hwType could be one of chassis, module, fan, power supplies,transceivers and the response got is based on the hwType provided as input | All |
Response Parameters
| Parameter | Data Type | Description |
|---|---|---|
| productId | STRING | This represents the product id |
| hwCount | STRING | This represents the hardware count for the specific product Id |
Sample JSON Response
{
"data": [
{
"productId": "CP-7962G",
"hwCount": "17539"
},
{
"productId": "FAN-T1=",
"hwCount": "9670"
}
]
}Network Element Summary By Product Family API
Network Element Summary By Product Family API returns the list of 15 highest number of device (network elements) product families returning the name and count of each.
Request URL
GET : https://apx.cisco.com/cs/api/v1/inventory/network-element-summary-by-product-family
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not Applicable |
| groupName | STRING | No | The groupName value indicatess the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
| hwType | STRING | No | hwType could be one of chassis, module, fan, power supplies,transceivers and the response got is based on the hwType provided as input | All |
Response Parameters
| Parameter | Data Type | Description |
|---|---|---|
| productFamily | STRING | This represents the platform or product family. |
| neCount | STRING | This represents the network element count |
Sample JSON Response
{
"data": [
{
"productFamily": "Cisco Catalyst 2960-X Series Switches",
"neCount": "8184"
},
{
"productFamily": "Cisco Catalyst 2960 Series Switches",
"neCount": "3823"
}
]
}Network Element Count API
Network Element Count API returns the total number of devices in the network for which inventory should be collected.
Request URL
GET : https://apx.cisco.com/cs/api/v1/inventory/network-element-count
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | 0 |
| groupName | STRING | No | The groupName value indicatess the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameter | Data Type | Description |
|---|---|---|
| networkElementCount | STRING | This represents the total number of devices in the network for which inventory should be collected. |
Sample JSON Response
{
"data": [
{
"networkElementCount": "22636"
}
]
}SNMP Pass Network Elements API
SNMP Pass Network Elements API returns the number of devices that could be reached using the SNMP protocol. If this number is less than the number of devices in the network then there is some issue in reaching the devices.
Request URL
GET : https://apx.cisco.com/cs/api/v1/inventory/snmp-pass-network-elements
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not Applicable |
| groupName | STRING | No | The groupName value indicatess the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameter | Data Type | Description |
|---|---|---|
| snmpPassNetworkElements | STRING | This indicates the number of devices that could be reached using the SNMP protocol. |
Sample JSON Response
{
"data": [
{
"snmpPassNetworkElements": "21980"
}
]
}Network Element Reachability API
Network Element Reachability API provides a metric on how many devices could be reached through SNMP. The output is a percentage of the reachable devices in relation to all the devices listed in the seed file. It will return 100 in a network where all the devices are reachable.
Request URL
GET : https://apx.cisco.com/cs/api/v1/inventory/network-element-reachability
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not Applicable |
| groupName | STRING | No | The groupName value indicatess the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameter | Data Type | Description |
|---|---|---|
| networkElementReachabilityPercent | STRING | This metric indicates how many devices could be reached through SNMP. This is a percentage of the reachable devices in relation to all the devices listed in the seed file. It will return 100 in a network where all the devices are reachable |
Sample JSON Response
{
"data": [
{
"networkElementReachabilityPercent": "97"
}
]
}New Network Elements API
New Network Elements API returns the number of new devices that were added to the network in the last 7 days.
Request URL
GET : https://apx.cisco.com/cs/api/v1/inventory/new-network-elements
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not Applicable |
| groupName | STRING | No | The unique, generated ID of the network element group. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameter | Data Type | Description |
|---|---|---|
| newNetworkElements | STRING | This indicates the number of new devices that were added to the network in the last 7 days. |
Sample JSON Response
{
"data": [
{
"newNetworkElements": 1
}
]
}SW Changed Network Elements API
SW Changed Network Elements API returns the number of devices where the software was updated in the last 7 days.
Request URL
GET : https://apx.cisco.com/cs/api/v1/inventory/sw-changed-network-elements
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not Applicable |
| groupName | STRING | No | The groupName value indicatess the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameter | Data Type | Description |
|---|---|---|
| swChangedNetworkElements | STRING | This indicates the number of devices where the software was updated in the last 7 days. |
Sample JSON Response
{
"data": [
{
"swChangedNetworkElements": "3"
}
]
}