The NPDR Service consists of the following API call:
The getNPDRDetails API will return all devices in an inventory upload that are not processed by PSS.
| Parameter | Required | Type | Description |
|---|---|---|---|
| customerID | Yes | string | This parameter is returned in the API service call getCustomersInventoryIds. customerId is the ID of the Entitlement Company. |
| inventoryId | Yes | string | This parameter was returned in the API service call getCustomersInventoryIds. inventoryId identifies the inventory whose data will be accessed for the chassis & card level details. |
| applianceID | No | string | When not providing the applianceID, the API will return a full collection of data for that given InventoryID, for that given CustomerId, of that given PartyGUID; If no data is passed in applianceID then the latest uploaded collection is used to get data. |
| uploadDateAndTime | No | string | The Date and Time of the uploaded collection, in the format 2013-08-14T00:00:00.000-07:00. If the uploadedDateAndTime field is NULL, and applianceID is passed, then the corresponding latest uploaded collection for the applianceID is used to get data. If uploadDateAndTime is passed, and applianceID is NULL, then the collection for the matching Date and Time will be returned. If uploadDateAndTime is NULL, and applianceID is NULL, then the latest collection for the inventory is returned. If date is passed in uploadedDateAndTime and applianceID is passed, then that collection is used to get data. |
| pageStart | Yes | string | The number of pages to be returned. The first time this API is called, this value should always be 1. |
| Parameter | Type | Length | Description |
|---|---|---|---|
| Entitled Company Name | string | 4000 | Name of the entitlement company. |
| Inventory Name | string | 4000 | Name of the inventory. |
| Appliance ID | string | 255 | ID of the appliance. |
| Report Date | string | 255 | Date the report is made. |
| Upload Date And Time | date | DATE | Date and Time of the last database upload. |
| Parameter | Type | Length | Description |
|---|---|---|---|
| Device ID | string | 22 | The ID of the device(s) being returned. |
| Host Name | string | 4000 | Host name of the device. |
| IP Address | string | 255 | IP address of the device. |
| System Object ID | string | 255 | The vendor's identification of the network management subsystem contained in the entity. |
| System Description | string | 4000 | A textual description of the entity. |
| Manufacturer Name | string | 4000 | Name of the device manufacturer. |
| Serial Number/MAC Address |
string | 255 | Serial number/MAC address of the device(s) being returned. |
| Product ID | string | 4000 | The product ID for the device. |
| Product Family | string | 255 | The product Family for the device. |
| Product Model | string | NA* | This field is currently not being utilized. It is in place for future use. |
| Parameter | Type | Length | Description |
|---|---|---|---|
| Card ID | string | 22 | ID of the card on the device. |
| Host Name | string | 4000 | Host name of the device. |
| IP Address | string | 255 | IP address of the device. |
| System Object ID | string | 255 | The vendor's identification of the network management subsystem contained in the entity. |
| Manufacturer Name | string | 4000 | Name of the device manufacturer. |
| Serial Number/MAC Address |
string | 255 | Serial number/MAC address of the device(s) being returned. |
| Product ID | string | 4000 | The product ID for the device. |
| Product Family | string | 255 | The product Family for the device. |
| Product Model | string | NA* | This field is currently not being utilized. It is in place for future use. |
message
| Parameter | Type | Length | Description |
|---|---|---|---|
| See Message Format section for more details. | |||
| messageType | string | 255 | |
| messageDetail | string | 255 | |
| ResponseTimestamp | date | DATE |
Pages
| Parameter | Type | Length | Description |
|---|---|---|---|
| pageSize | string | 5 | The chunk size for each response returned. |
| pageCurrent | string | 5 | The current page being returned. |
| pageTotal | string | 5 | The total number of pages which can be returned. |
| recordCount | string | 6 | The total number of records returned by this request. |
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:npd="http://www.cisco.com/NPDRService"›
‹soapenv:Header/›
‹soapenv:Body›
‹npd:NPDRRequest›
‹npd:customerId›79954‹/npd:customerId›
‹npd:inventoryId›84625‹/npd:inventoryId›
‹npd:applianceID›4679‹/npd:applianceID›
‹npd:uploadDateAndTime›‹/npd:uploadDateAndTime›
‹npd:pageStart›1‹/npd:pageStart›
‹/npd:NPDRRequest›
‹/soapenv:Body›
‹/soapenv:Envelope›
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹npd:NPDRResponse xmlns:npd="http://www.cisco.com/NPDRService"
xmlns:fn="http://www.cisco.com/FNAlertService"
xmlns:hweox="http://www.cisco.com/HwEoxAlertService"
xmlns:inv="http://www.cisco.com/InventoryService"
xmlns:sweox="http://www.cisco.com/SwEoxAlertService"
xmlns:w3c="http://www.w3.org/2001/XMLSchema-instance"
xmlns:is="http://www.cisco.com/ISAlertService"
xmlns:psirt="http://www.cisco.com/PSIRTAlertService"
xmlns:con="http://www.cisco.com/ContractService"›
‹npd:pages›
‹npd:pageCurrent›1‹/npd:pageCurrent›
‹npd:pageTotal›1‹/npd:pageTotal›
‹npd:recordCount›26‹/npd:recordCount›
‹npd:pageSize›500‹/npd:pageSize›
‹/npd:pages›
‹npd:collections›
‹npd:collection applianceID="4679"›
‹npd:summaryInfo›
‹npd:EntitledCompany›OTICON INC‹/npd:EntitledCompany›
‹npd:InventoryName›cdtltiws‹/npd:InventoryName›
‹npd:ApplianceID›4679‹/npd:ApplianceID›
‹npd:ReportDate›2013-11-20‹/npd:ReportDate›
‹npd:UploadDateTime/›
‹/npd:summaryInfo›
‹npd:chassis/›
‹npd:card›
‹npd:cardDetail›
‹npd:CardID›22144379‹/npd:CardID›
‹npd:HostName/›
‹npd:IPAddress›213.140.46.193‹/npd:IPAddress›
‹npd:SystemObjID›1.3.6.1.4.1.9.12.3.1.9.16.2‹/npd:SystemObjID›
‹npd:ManufacturerOrVendorName›cisco‹/npd:ManufacturerOrVendorName›
‹npd:SerialNumberOrMACAddress›JUT084901ND‹/npd:SerialNumberOrMACAddress›
‹npd:ProductID›GLC-SX-MM,WS-G5484,SFP-GE-S,JGBR12SY02318‹/npd:ProductID›
‹npd:ProductFamily›Transceiver Modules‹/npd:ProductFamily›
‹/npd:cardDetail›
‹npd:cardDetail›
‹npd:CardID›22144381‹/npd:CardID›
‹npd:HostName/›
‹npd:IPAddress›213.140.46.193‹/npd:IPAddress›
‹npd:SystemObjID›1.3.6.1.4.1.9.12.3.1.9.16.2‹/npd:SystemObjID›
‹npd:ManufacturerOrVendorName›cisco‹/npd:ManufacturerOrVendorName›
‹npd:SerialNumberOrMACAddress›JUT084901FD‹/npd:SerialNumberOrMACAddress›
‹npd:ProductID›GLC-SX-MM,WS-G5484,SFP-GE-S,JGBR12SY02318‹/npd:ProductID›
‹npd:ProductFamily›Transceiver Modules‹/npd:ProductFamily›
‹/npd:cardDetail›
. . .
‹/npd:cardDetail›
‹/npd:card›
‹/npd:collection›
‹/npd:collections›
‹npd:responseTimestamp›2013-11-20T22:16:26.677-05:00‹/npd:responseTimestamp›
‹npd:message›
‹npd:messageType›SUCCESS‹/npd:messageType›
‹npd:messageDetail›Request processed successfully. Returning 26 of 26 records.‹/npd:messageDetail›
‹/npd:message›
‹/npd:NPDRResponse›
‹/soapenv:Body›
‹/soapenv:Envelope›
Response from NPDR API might have the card details without the card ID as shown below for the devices which were not profiled:
‹npd:cardDetail›
‹npd:CardID/›
‹npd:HostName›CRS-B‹/npd:HostName›
‹npd:IPAddress›172.18.104.14‹/npd:IPAddress›
‹npd:SystemObjID/›
‹npd:ManufacturerOrVendorName/›
‹npd:SerialNumberOrMACAddress›SAD092406FX‹/npd:SerialNumberOrMACAddress›
‹npd:ProductID/›
‹npd:ProductFamily/›
‹/npd:cardDetail›
©2016 Cisco Systems, Inc. · All Rights Reserved · This site is Cisco Confidential. For Cisco Field and Channel Partner use only. Not for public distribution.