Metadata-Version: 2.1
Name: netbox-cisco-support
Version: 0.5
Summary: Implementing Cisco Support APIs into NetBox
Home-page: https://github.com/goebelmeier/netbox-cisco-support
Author: Timo Reimann
Author-email: timo@goebelmeier.de
License: Apache 2.0
Project-URL: Bug Tracker, https://github.com/goebelmeier/netbox-cisco-support/issues
Description: # NetBox Cisco Support API Plugin
        [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/) 3.0.3 and later.
        
        ## Installation
        The plugin is available as a Python package in pypi and can be installed with pip
        
        ```
        $ source /opt/netbox/venv/bin/activate
        (venv) $ pip install netbox-cisco-support
        ```
        
        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
        ```
        (venv) $ cd /opt/netbox/netbox/
        (venv) $ python3 manage.py sync_eox_data
        ````
        
        To periodically refresh EoX data create a cronjob which calls `sync_eox_data` periodically
        ```
        $ cat /etc/cron.d/netbox_sync_eox_data
        
        # Update Cisco EoX Data every Saturday at 14:03
        MAILTO="mail@example.com"
        3 14 * * 6 /opt/netbox/venv/bin/python3 /opt/netbox/netbox/manage.py sync_eox_data
        ```
        
        or log into /tmp file
        ```
        $ cat /etc/cron.d/netbox_sync_eox_data
        
        # Update Cisco EoX Data every Saturday at 14:03
        3 14 * * 6 /opt/netbox/venv/bin/python3 /opt/netbox/netbox/manage.py sync_eox_data > /tmp/netbox_sync_eox_data
        ```
        
        ## Configuration
        The following options are available:
        * `cisco_client_id`: String - Client ID of your plugin installation. Generate it inside [Cisco API Console](https://apiconsole.cisco.com/)
        * `cisco_client_secret`: String - Client Secret of your plugin installation. Generate it inside [Cisco API Console](https://apiconsole.cisco.com/)
        
        ## Screenshots
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Systems Administration
Description-Content-Type: text/markdown
