
Cisco
Network Management- Overview
- Setup
- Data & mappings
- Operations & API
- Changelog
The Cisco connector integrates with the Cisco Smart Net Total Care (SNTC) platform via the Cisco Customer Experience (CX) Cloud API. It synchronizes network device inventory, hardware and software details, security advisories, and end-of-life (EoL) information into the Brinqa platform. The connector pulls data from the /cs/api/v1 REST API endpoints covering inventory and product-alert domains.
Data retrieved from Ciscoโ
| Connector Object | Required | Maps to Data Model |
|---|---|---|
| ๐ฆ Device | Yes | HOST |
| ๐ฆ Hardware | Yes | HOST |
| ๐ฆ Software | Yes | PACKAGE |
| ๐ฆ Software Install | Yes | INSTALLED_PACKAGE |
| โ ๏ธ Security Alert | Yes | VULNERABILITY |
| ๐ Security Bulletin | Yes | VULNERABILITY_DEFINITION |
| ๐ Hardware EoL | Yes | Hardware Eo L |
| ๐ Hardware EoL Bulletin | Yes | EOL_ADVISORY |
| ๐ Software EoL | Yes | Software Eo L |
| ๐ Software EoL Bulletin | Yes | EOL_ADVISORY |
Model relationshipsโ
For detailed steps on how to view the data retrieved from Cisco in the Brinqa Platform, see How to view your data.
Connection settingsโ
When setting up a data integration, select Cisco from the Connector dropdown and provide the following:
| Setting | Required | Default | Description |
|---|---|---|---|
| API URL | Yes | https://apx.cisco.com | API URL |
| Login URL | No | โ | URL for authentication |
| Client ID | No | โ | API client id |
| Client Secret | No | โ | API client secret |
| Customer ID | No | โ | API customer ID |
| Page size | No | 100 | Maximum number of records to get per API request |
| Parallel requests | No | min(4, availableProcessors) | Maximum number of parallel API requests |
Authenticationโ
The connector authenticates using OAuth 2.0 Client Credentials grant.
Endpointโ
| Method | URL |
|---|---|
POST | https://cloudsso.cisco.com/as/token.oauth2 |
Request Headersโ
| Header | Value |
|---|---|
Content-Type | application/x-www-form-urlencoded |
X-Requested-With | brinqa |
Request Bodyโ
client_id=<your-client-id>&client_secret=<your-client-secret>&grant_type=client_credentials
Sample Responseโ
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer"
}
Response Fieldsโ
| Field | Type | Description |
|---|---|---|
access_token | String | The OAuth 2.0 bearer token for authorizing API calls |
token_type | String | Token type, always Bearer |
Usageโ
Once authenticated, all subsequent API requests include the bearer token:
Authorization: Bearer <access_token>
Accept: application/json
The token is obtained once per sync operation and reused across all API requests during that sync.
How to obtain Cisco credentials
Obtain Cisco CX Cloud API credentialsโ
For the connector to use the Cisco CX Cloud API, you must provide an OAuth 2.0 client ID and client secret. To obtain these credentials, follow these steps:
-
Log in to the Cisco API Console.
-
Navigate to My Apps & Keys.
-
Click Register a New App.
-
Enter a name and description for the application.
-
Under OAuth 2.0 Credentials, select Client Credentials as the grant type.
-
Select the required API scopes for Smart Net Total Care access.
-
Click Register.
Your client ID and client secret display. Copy and save them to a secure location.
Note: If you do not have the permissions to create API credentials, contact your Cisco administrator. For additional information, see Cisco Developer documentation.
Attribute mappingsโ
Expand the sections below to view the mappings between the source and the Brinqa data model attributes:
๐ฆ Device
| Source Field Name | SDM Attribute |
|---|---|
NetworkDevice.bootstrapVersion | BOOTSTRAP_VERSION |
NetworkDevice.createDate | SOURCE_CREATED_DATE |
NetworkDevice.hostname | HOSTNAMES |
NetworkDevice.imageName | IMAGE_NAME |
NetworkDevice.inventoryCollectionDate | COLLECTION_DATE |
NetworkDevice.inventoryName | INVENTORY |
NetworkDevice.ipAddress | IP_ADDRESSES |
NetworkDevice.lastReset | LAST_RESET |
NetworkDevice.macAddress | MAC_ADDRESSES |
NetworkDevice.managementAddress | MANAGEMENT_ADDRESS |
NetworkDevice.neInstanceId | UID |
NetworkDevice.neInstanceId | INSTANCE_ID |
NetworkDevice.productFamily | PRODUCT_FAMILY |
NetworkDevice.productId | PRODUCT_ID |
NetworkDevice.productType | PRODUCT_TYPE |
NetworkDevice.reachabilityStatus | REACHABLE_STATUS |
NetworkDevice.resetReason | RESET_REASON |
NetworkDevice.swType | SW_TYPE |
NetworkDevice.swVersion | SW_VERSION |
NetworkDevice.sysDescr | DESCRIPTION |
NetworkDevice.sysLocation | LOCATION |
๐ฆ Hardware
| Source Field Name | SDM Attribute |
|---|---|
HardwareDevice.collectedSerialNumber | COLLECTED_SN |
HardwareDevice.hwInstanceId | UID |
HardwareDevice.hwName | NAME |
HardwareDevice.hwType | HARDWARE_TYPE |
HardwareDevice.inventoryName | INVENTORY |
HardwareDevice.neInstanceId | INSTANCE_ID |
HardwareDevice.productDescription | PRODUCT_DESC |
HardwareDevice.productFamily | PRODUCT_FAMILY |
HardwareDevice.productId | PRODUCT_ID |
HardwareDevice.productName | PRODUCT_NAME |
HardwareDevice.productSubtype | PRODUCT_SUBTYPE |
HardwareDevice.productType | PRODUCT_TYPE |
HardwareDevice.serialNumber | SERIAL_NUMBER |
HardwareDevice.swVersion | SW_VERSION |
๐ฆ Software
| Source Field Name | SDM Attribute |
|---|---|
MD5(inventoryName, swType, swVersion, swMajorVersion, swCategory, swName) | UID |
Software.inventoryName | INVENTORY |
Software.swCategory | CATEGORIES |
Software.swMajorVersion | MAJOR_VERSION |
Software.swName | NAME |
Software.swType | SOFTWARE_TYPE |
Software.swVersion | SOFTWARE_VERSION |
๐ฆ Software Install
| Source Field Name | SDM Attribute |
|---|---|
MD5(customerId, managedNeInstanceId, inventoryName, swType, swVersion, swMajorVersion, swCategory, swName) | UID |
MD5(inventoryName, swType, swVersion, swMajorVersion, swCategory, swName) | TYPE |
Software.managedNeInstanceId | TARGETS |
Software.swStatus | STATUS |
โ ๏ธ Security Alert
| Source Field Name | SDM Attribute |
|---|---|
(declared in schema) | STATUS_CATEGORY |
MD5(neInstanceId, managedNeInstanceId, hwInstanceId, securityAdvisoryInstanceId) | UID |
SecurityAdvisory.hwInstanceId | HARDWARE_ID |
SecurityAdvisory.neInstanceId | TARGETS |
SecurityAdvisory.neInstanceId | DEVICE_ID |
SecurityAdvisory.securityAdvisoryInstanceId | BULLETIN_ID |
SecurityAdvisory.vulnerabilityReason | REASON |
SecurityAdvisory.vulnerabilityStatus (normalized) | STATUS |
SecurityAdvisory.vulnerabilityStatus / status category | SOURCE_STATUS |
| โ | TYPE |
๐ Security Bulletin
| Source Field Name | SDM Attribute |
|---|---|
SecurityAdvisoryBulletin.advisoryId | ADVISORY_ID |
SecurityAdvisoryBulletin.alertAutomationCaveat | AUTOMATION_CAVEAT |
SecurityAdvisoryBulletin.bulletinFirstPublished | PUBLISHED_DATE |
SecurityAdvisoryBulletin.bulletinLastUpdated | SOURCE_LAST_MODIFIED |
SecurityAdvisoryBulletin.bulletinSummary | SUMMARY |
SecurityAdvisoryBulletin.bulletinTitle | DESCRIPTION |
SecurityAdvisoryBulletin.bulletinVersion | BULLETIN_VERSION |
SecurityAdvisoryBulletin.ciscoBugIds | CISCO_BUG_ID |
SecurityAdvisoryBulletin.cveId | CVE_IDS |
SecurityAdvisoryBulletin.cveId | CVE_RECORDS |
SecurityAdvisoryBulletin.cvssBaseScore | CVSS_V2_BASE_SCORE |
SecurityAdvisoryBulletin.cvssTemporalScore | CVSS_V2_TEMPORAL_SCORE |
SecurityAdvisoryBulletin.securityAdvisoryInstanceId | UID |
SecurityAdvisoryBulletin.securityImpactRating | RATING |
SecurityAdvisoryBulletin.url | URL |
๐ Hardware EoL
| Source Field Name | SDM Attribute |
|---|---|
HwEoL.currentHwEolMilestone | CURRENT_EOL_MILESTONE |
HwEoL.currentHwEolMilestoneDate | CURRENT_EOL_MILESTONE_DATE |
HwEoL.hostname | HOSTNAMES |
HwEoL.hwEolInstanceId | BULLETIN_ID |
HwEoL.hwInstanceId | HARDWARE_ID |
HwEoL.hwType | HARDWARE_TYPE |
HwEoL.inventoryName | INVENTORY_NAME |
HwEoL.neInstanceId | INSTANCE_ID |
HwEoL.nextHwEolMilestone | NEXT_EOL_MILESTONE |
HwEoL.nextHwEolMilestoneDate | NEXT_EOL_MILESTONE_DATE |
HwEoL.productId | PRODUCT_ID |
MD5(neInstanceId, managedNeInstanceId, hwInstanceId, productId, hwEolInstanceId) | UID |
๐ Hardware EoL Bulletin
| Source Field Name | SDM Attribute |
|---|---|
HwEoLBulletin.bulletinNumber | BULLETIN_ID |
HwEoLBulletin.bulletinProductId | PRODUCT_ID |
HwEoLBulletin.bulletinTitle | BULLETIN_TITLE |
HwEoLBulletin.eoLifeAnnouncementDate | EOL_ANNOUNCEMENT_DATE |
HwEoLBulletin.eoNewServiceAttachmentDate | EO_NEW_SERVICE_ATTACHMENT_DATE |
HwEoLBulletin.eoRoutineFailureAnalysisDate | EO_ROUTINE_FAILURE_ANALYSIS_DATE |
HwEoLBulletin.eoSaleDate | EOS_DATE |
HwEoLBulletin.eoSwMaintenanceReleasesDate | EO_SW_MAINTENANCE_RELEASES_DATE |
HwEoLBulletin.eoVulnerabilitySecuritySupport | EO_VULNERABILITY_SECURITY_SUPPORT |
HwEoLBulletin.hwEolInstanceId | UID |
HwEoLBulletin.lastDateOfSupport | LAST_DATE_OF_SUPPORT |
HwEoLBulletin.lastShipDate | LAST_SHIP_DATED |
HwEoLBulletin.url | URL |
๐ Software EoL
| Source Field Name | SDM Attribute |
|---|---|
MD5(neInstanceId, managedNeInstanceId, swType, swVersion, swEolInstanceId) | UID |
SwEoL.currentSwEolMilestone | CURRENT_EOL_MILESTONE |
SwEoL.currentSwEolMilestoneDate | CURRENT_EOL_MILESTONE_DATE |
SwEoL.hostname | HOSTNAMES |
SwEoL.inventoryName | INVENTORY_NAME |
SwEoL.neInstanceId | INSTANCE_ID |
SwEoL.nextSwEolMilestone | NEXT_EOL_MILESTONE |
SwEoL.nextSwEolMilestoneDate | NEXT_EOL_MILESTONE_DATE |
SwEoL.swEolInstanceId | BULLETIN_ID |
SwEoL.swType | SOFTWARE_TYPE |
SwEoL.swVersion | SOFTWARE_VERSION |
๐ Software EoL Bulletin
| Source Field Name | SDM Attribute |
|---|---|
SwEoLBulletin.bulletinNumber | BULLETIN_NUMBER |
SwEoLBulletin.bulletinTitle | BULLETIN_TITLE |
SwEoLBulletin.eoLifeAnnouncementDate | EOL_ANNOUNCEMENT_DATE |
SwEoLBulletin.eoSaleDate | EOS_DATE |
SwEoLBulletin.eoSwMaintenanceReleasesDate | EO_SW_MAINTENANCE_RELEASES_DATE |
SwEoLBulletin.eoVulnerabilitySecuritySupport | EO_VULNERABILITY_SECURITY_SUPPORT |
SwEoLBulletin.inventoryName | INVENTORY |
SwEoLBulletin.lastDateOfSupport | LAST_DATE_OF_SUPPORT |
SwEoLBulletin.swEolInstanceId | UID |
SwEoLBulletin.swMaintenanceVersion | SW_MAINTENANCE_VERSION |
SwEoLBulletin.swMajorVersion | SW_VERSION |
SwEoLBulletin.swTrain | SOFTWARE_TRAIN |
SwEoLBulletin.swType | SOFTWARE_TYPE |
SwEoLBulletin.url | URL |
Operations & APIโ
Expand each connector object to see its operation options, delta-sync behavior, and the API it uses. See connector operation options for how to apply operation options (keys and values are case-sensitive).
๐ฆ Device
Operation options
This object does not support any operation options.
Delta sync
The connector README does not document sync behavior for this object.
API
- Type: REST endpoint ยท Endpoint:
GET /cs/api/v1/inventory/network-elements
๐ฆ Hardware
Operation options
This object does not support any operation options.
Delta sync
The connector README does not document sync behavior for this object.
API
- Type: REST endpoint ยท Endpoint:
GET /cs/api/v1/inventory/hardware
๐ฆ Software
Operation options
This object does not support any operation options.
Delta sync
The connector README does not document sync behavior for this object.
API
- Type: REST endpoint ยท Endpoint:
GET /cs/api/v1/inventory/software
๐ฆ Software Install
Operation options
This object does not support any operation options.
Delta sync
The connector README does not document sync behavior for this object.
API
- Type: REST endpoint ยท Endpoint:
GET /cs/api/v1/inventory/software
โ ๏ธ Security Alert
Operation options
This object does not support any operation options.
Delta sync
The connector README does not document sync behavior for this object.
API
- Type: REST endpoint ยท Endpoint:
GET /cs/api/v1/product-alerts/security-advisories - Default filters:
vulnerabilityStatus=Vulnerable
๐ Security Bulletin
Operation options
This object does not support any operation options.
Delta sync
The connector README does not document sync behavior for this object.
API
- Type: REST endpoint ยท Endpoint:
GET /cs/api/v1/product-alerts/security-advisory-bulletins
๐ Hardware EoL
Operation options
This object does not support any operation options.
Delta sync
The connector README does not document sync behavior for this object.
API
- Type: REST endpoint ยท Endpoint:
GET /cs/api/v1/product-alerts/hardware-eol
๐ Hardware EoL Bulletin
Operation options
This object does not support any operation options.
Delta sync
The connector README does not document sync behavior for this object.
API
- Type: REST endpoint ยท Endpoint:
GET /cs/api/v1/product-alerts/hardware-eol-bulletins
๐ Software EoL
Operation options
This object does not support any operation options.
Delta sync
The connector README does not document sync behavior for this object.
API
- Type: REST endpoint ยท Endpoint:
GET /cs/api/v1/product-alerts/software-eol
๐ Software EoL Bulletin
Operation options
This object does not support any operation options.
Delta sync
The connector README does not document sync behavior for this object.
API
- Type: REST endpoint ยท Endpoint:
GET /cs/api/v1/product-alerts/software-eol-bulletins
Changelogโ
The Cisco connector has undergone the following changes:
| Version | Description | Migration Steps |
|---|---|---|
| 3.0.1 | Improvements - Connector-sourced attribute values now take precedence over non-connector data channels (manual edits, bulk imports, UI input) when the platform consolidates records, so Cisco data is no longer overridden by lower-priority sources. - Attribute values are now written through the platform's shared, type-validating attribute helper, so values are validated against the declared schema type at write time instead of being stored with the wrong type. Bug Fixes - Corrected the End-of-Life date attributes to be stored as proper timestamps. The Hardware and Software EoL and EoL Bulletin models were storing these dates as numbers (epoch milliseconds) instead of timestamps, which does not match the connector schema. Affected attributes: "Current EoL milestone date", "Next EoL milestone date", "EoL announcement date", "EoS date", "Last ship date", "End of SW maintenance releases date", "End of routine failure analysis date", "End of new service attachment date", "Last date of support", and "End of vulnerability/security support". | โข Hardware EoL, Software EoL, Hardware EoL Bulletin, and Software EoL Bulletin: the date attributes listed above changed from numbers to timestamps. Re-sync the Cisco connector to repopulate these records with the corrected type. |
| 3.0.0 | Overview The Cisco connector integrates with Cisco to synchronize network device and software inventory, security advisories and their associated findings, and end-of-life lifecycle information for both hardware and software. Category: Network Management Models | N/A |