Skip to main content

No project description provided

Project description

Netbox Software Plugin

A plugin designed to faciliate the storage of site, circuit, device type and device specific software within NetBox

Features

  • Store software against the following NetBox models:

    • Circuits
    • Devices
    • Device Types
    • Sites
  • Upload software to your NetBox media/ folder or other Django supported storage method e.g. S3

  • Supports a wide array of common file types (bmp, gif, jpeg, jpg, png, pdf, txt, doc, docx, xls, xlsx, xlsm)

  • Store links to external URL's to save duplication of remote software

Compatibility

NetBox Version Plugin Version
3.2+ 0.2.4

Installation

A working installation of Netbox 3.2+ is required. 3.4+ is recommended.

Package Installation from PyPi

Activate your virtual env and install via pip:

$ source /opt/netbox/venv/bin/activate
(venv) $ pip install netbox-systems

To ensure the Netbox software plugin is automatically re-installed during future upgrades, add the package to your local_requirements.txt :

# echo netbox-systems >> local_requirements.txt

Enable the Plugin

In the Netbox configuration.py configuration file add or update the PLUGINS parameter, adding netbox_systems:

PLUGINS = [
    'netbox_systems',
]

(Optional) Add or update a PLUGINS_CONFIG parameter in configuration.py to configure plugin settings. Options shown below are the configured defaults:

PLUGINS_CONFIG = {
     'netbox_systems': {
         # Enable the management of device specific software (True/False)
         'enable_device_software': True,
         # Location to inject the software widget in the device view (left/right
         'device_software_location': 'left',
     }
}

(Optional) Add or replace the built-in software Type choices via Netbox's FIELD_CHOICES configuration parameter:

The colours that can be used are listed in the Netbox CSS netbox-light.css:

(https://github.com/netbox-community/netbox/blob/develop/netbox/project-static/dist/netbox-light.css)

The bg- must not be specified in the configuration. Here are a few examples from the CSS:

  • bg-indigo = #6610f2 --> 'indigo'
  • bg-blue = #0d6efd --> 'blue'
  • bg-purple = #6f42c1 --> 'purple'
  • bg-pink = #d63384 --> 'pink'
  • bg-red = #dc3545 --> 'red'
  • bg-orange = #fd7e14 --> 'orange'
  • bg-yellow = #ffc107 --> 'yellow'
  • bg-green = #198754 --> 'green'
  • bg-teal = #20c997 --> 'teal'
  • bg-cyan = #0dcaf0 --> 'cyan'
  • bg-gray = #adb5bd --> 'gray'
  • bg-black = #000 --> 'black'
  • bg-white --> 'white'
FIELD_CHOICES = {
    'netbox_systems.DocTypeChoices.device+': (
        ('mysoftware', 'My Custom Device software Type', 'green'),
    )
}

Apply Database Migrations

Apply database migrations with Netbox manage.py:

(venv) $ python manage.py migrate

Restart Netbox

Restart the Netbox service to apply changes:

sudo systemctl restart netbox

Re-index Netbox search index (Upgrade to 3.4 only)

If you are upgrading from Netbox 3.2 or above to Netbox 3.4, any previously inserted software may not show up in the new search feature. To resolve this, re-index the plugin:

(venv) $ python manage.py reindex netbox_systems

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netbox_counterparties-0.1.1.tar.gz (18.8 kB view details)

Uploaded Source

Built Distribution

netbox_counterparties-0.1.1-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

Details for the file netbox_counterparties-0.1.1.tar.gz.

File metadata

  • Download URL: netbox_counterparties-0.1.1.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/5.15.0-91-generic

File hashes

Hashes for netbox_counterparties-0.1.1.tar.gz
Algorithm Hash digest
SHA256 977962e73b1d6165599c4ef9ea9770a633f491385d923f027766390bf8107d5a
MD5 bb2a954c189e803e823d91e983d3525c
BLAKE2b-256 34145e479cd6e45182d28b4f94f795d8e5fbfb4841323427526dffb230dc2eab

See more details on using hashes here.

File details

Details for the file netbox_counterparties-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_counterparties-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c467b6092604cbec1e38c49bfd0ff6b75626f6e3fe096936e890c49aa36d4b8c
MD5 60acb54499a9ed8cc25012dbc239a34e
BLAKE2b-256 b8285711615ce93b998f2ba62daae6f1e7df6037db6a0981521ef05f95db2274

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page