Skip to content

Commit

Permalink
Refined README, added __init__.py for management
Browse files Browse the repository at this point in the history
and management/commands folders
  • Loading branch information
Reimann, Timo committed Sep 29, 2021
1 parent 5dd4243 commit cea87ad
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 6 deletions.
35 changes: 30 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,45 @@
# NetBox Cisco Support API Plugin
[NetbBx](https://github.com/netbox-community/netbox) plugin using Cisco Support APIs to gather EoX and Contract coverage information for Cisco devices.
[NetBox](https://github.com/netbox-community/netbox) plugin using Cisco Support APIs to gather EoX and Contract coverage information for Cisco devices.

## Compatibility
This plugin in compatible with [NetBox](https://netbox.readthedocs.org/) 2.11 and later.
This plugin in compatible with [NetBox](https://netbox.readthedocs.org/) 3.0.3 and later.

## Installation
The plugin is available as a Python package in pypi and can be installed with pip

```
pip install netbox-cisco-support
$ source /opt/netbox/venv/bin/activate
(venv) $ pip install netbox-cisco-support
```
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:

Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`:

```
# Enable installed plugins. Add the name of each plugin to the list.
PLUGINS = ['netbox_cisco_support']
# 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_cisco_support': {
'cisco_client_id': 'bar', # Client ID of your plugin installation. Generate it inside Cisco API Console
'cisco_client_secret': 'bazz' # Client Secret of your plugin installation. Generate it inside Cisco API Console
}
}
```

Restart NetBox and add `netbox-cisco-support` to your `local_requirements.txt`

```
(venv) $ cd /opt/netbox/netbox/
(venv) $ python3 manage.py migrate
# sudo systemctl restart netbox
```

Sync Cisco EoX data for the first time
```
Restart NetBox and add `netbox-cisco-support` to your local_requirements.txt
(venv) $ cd /opt/netbox/netbox/
(venv) $ python3 manage.py migrate
## Configuration
The following options are available:
Expand Down
2 changes: 1 addition & 1 deletion netbox_cisco_support/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ class CiscoSupportConfig(PluginConfig):
author = 'Timo Reimann'
author_email = 'timo@goebelmeier.de'
base_url = 'cisco-support'
min_version = '2.11.1'
min_version = '3.0.3'
required_settings = []
default_settings = {
'device_ext_page': 'right'
Expand Down
Empty file.
Empty file.

0 comments on commit cea87ad

Please sign in to comment.