netbox-device-support-plugin
Advanced tools
Cisco device support, device type support, and software release information with the Cisco support APIs
This README.md documentation contains the following sections:
This NetBox tracks with the data from the Cisco support APIs the device support status, the device type EoX status as well as the recommended software release. Each Cisco device and Cisco device type have a detail view with all data. There is also a list view with filter options for all devices or device types. All data can also be received and updated over the NetBox REST API.
There is a Python script calles sync_cisco_support_data which can be used as below to update all fields
which contains data from the Cisco support APIs. This script can be executed for example inside a Azure
DevOps Build Pipeline once a day as these data don't change that often.
The Python script sync_cisco_support_data will do requests to the Cisco support APIs to update the following fields:
Model CiscoDeviceTypeSupport:
:warning: Verbose model field names listed
Model properties are not documented as they can't be edited
*:warning: Overwritten by custom model save() function
Model CiscoDeviceSupport:
:warning: Verbose model field names listed
Model properties are not documented as they can't be edited
*:warning: Overwritten by custom model save() function
There are some view fields which provide additional information which can't be updated directly with the help of the Cisco support APIs. These fields should be updated with a external script over the NetBox REST API (for example with a Azure DevOps Build Pipeline).
The following fields can't be updated directly by the Python script sync_cisco_support_data.
Model CiscoDeviceSupport:
:warning: Verbose model field names listed
Model properties are not documented as they can't be edited
*:warning: Overwritten by custom model save() function
No Edit Views
Manual edit of fields only in the NetBox Django admin portal At the moment there are no edit views to edit field of any data model of this plugin. The because the idea of this plugin is not to change fields manually (only automated by Python or REST API). If you want to change field manually, at the moment this can only be done in the NetBox Django admin portal.
In Development
The device support coverage of Fortinet is in development
In Development
The device support coverage of Pure Storage is in development
:warning: NetBox 4.0: The latest release of this plugin is for NetBox 4.0
This plugin is compatible with NetBox 3.5.0 and later.
| NetBox Version | Plugin Version |
|---|---|
| 3.5 | 0.0.1 |
| 4.0 | 1.0.3 |
The installation and configuration steps are for the NetBox-Docker installation. To install this plugin make sure you followed the prerequisites for using NetBox plugins with NetBox-Docker: Using Netbox Plugins
The plugin is available as a Python package in pypi and can be installed with pip.
pip install netbox_device_support_plugin
Add the plugin to the plugin_requirements.txt or requirements.txt of your NetBox-Docker project.
# Netbox Cisco Support Plugin
netbox-device-support-plugin
Enable the netbox-device-support-plugin plugin in /netbox-docker/configuration/plugins.py and add the
plugin configuration also in the same file.
# Enable installed plugins. Add the name of each plugin to the list.
PLUGINS = [
"netbox_device_support_plugin",
]
Fortinet and Pure Storage in Development
The section plugin configuration describes only the vendor Cisco as Fortinet and Pure Storage are still in development
In order to get valid API response data, several requirements must be fulfilled:
A Cisco API ID and secret (with access to the APIs "EoX V5 API",
"Serial Number to Information API Version 2" and "Software Suggestion") must have been created and
configured inside plugins.py
The following plugin configuration options are mandatory for the Cisco support API.
CISCO_SUPPORT_API_CLIENT_ID: String - Client ID of your plugin installation.
Generate it inside Cisco API ConsoleCISCO_SUPPORT_API_CLIENT_SECRET: String - Client Secret of your plugin installation.
Generate it inside Cisco API ConsoleAdd the netbox-device-support-plugin plugin configuration in /netbox-docker/configuration/plugins.py.
# Plugins configuration settings. These settings are used by various plugins that the user may have installed.
# Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings.
PLUGINS_CONFIG = {
"netbox_device_support_plugin": {
"CISCO_SUPPORT_API_CLIENT_ID": environ.get("CISCO_SUPPORT_API_CLIENT_ID", ""),
"CISCO_SUPPORT_API_CLIENT_SECRET": environ.get("CISCO_SUPPORT_API_CLIENT_SECRET", ""),
},
}
A manufacturer called Cisco, must have been configured inside NetBox. If your manufacturer is named
differently, change it inside the plugin configuration in plugins.py:
PLUGINS_CONFIG = {
"netbox_device_support_plugin": {
...,
"MANUFACTURER": "Cisco Systems" # Optional setting for definiing the manufacturer
}
}
Optional the TEMPLATE_EXTENSION_PLACEMENT can be changed inside the plugin configuration in plugins.py:
PLUGINS_CONFIG = {
"netbox_device_support_plugin": {
...,
"TEMPLATE_EXTENSION_PLACEMENT": "left" # Optional setting render the content on the left or right side
}
}
Delete the NetBox-Docker project completly.
docker compose down -v
Rebuild the NetBox-Docker project to install the new added plugin.
docker compose build --no-cache
docker compose up -d
Restore the database and run the Django database migration to your existing NetBox database.
python3 manage.py migrate
In order that sync_cisco_support_data works correctly, several requirements must be fulfilled:
All devices types for manufacturer Cisco must have filled the optional Part number field inside NetBox
with the correct Base PID for that Cisco product.
All devices with devices types from manufacturer Cisco must have filled the Serial Number field inside
NetBox with a valid Cisco serial number for that Cisco product.
If you want full visibility, the support contracts for all your devices needs to be associated with the CCO ID which has been used for created the API ID and secret. Otherwise you will only get a coverage true/false answer, but no detailed information regarding end of support contract coverage.
Run the previously described Python script the first time to sync all Cisco support API data.
python3 manage.py sync_cisco_support_data.py
Execute a Azure DevOps Build Pipeline which runs sync_cisco_support_data.py to periodically refresh the
data or create a cronjob which to the same a bit more old school.
Calling the sync_cisco_support_data method will catch all device types for the configured manufacturer.
Each device types Part number will be send to Cisco EoX API. API answer will be saved inside a
CiscoDeviceTypeSupport model. One CiscoDeviceTypeSupport per device type.
Afterwards all devices for the configured manufacturer will be gathered.
Each devices Serial number will be send to Cisco SN2Info coverage API. API answer will be saved inside
a CiscoDeviceSupport model. One CiscoDeviceSupport per device.
The device type template will be extended to display this data. Information will be shown, if a
CiscoDeviceTypeSupport object for that device type exists.
The device template will be exteneded to display device and device type information. Information will be
shown, if a CiscoDeviceSupport object for that device exists. Additionally device type information will be
shown, if a CiscoDeviceTypeSupport object for the parent device type exists.
Field Coloring: Expired timestamps or no data will be colored red, timestamps which will expire in the next calendar year will be colored yellow for planning or forecast reasons.
Progress Bar: The progress bars will visualize the timestamps duration to the expiration date. The progress bar color will be green until the timestamp will expire in the next calendar year. Then the color will change to yellow. The color will finally change to red when the timestamp expire within 60 days.
In Development
The device support coverage of Fortinet is in development
In Development
The device support coverage of Fortinet is in development
FAQs
Cisco device support, device type support, and software release information with the Cisco support APIs
We found that netbox-device-support-plugin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.