netbox-device-module-type-importer 0.0.3

A Netbox plugin for importing device and module types from the device type library.

NetBox Device Type Importer Plugin

Netbox plugin for easy import DeviceType/ModuleType from NetBox Device Type Library.

[!WARNING]

Importing Device/Module Type definitions uses Async IO and can take some time (10 to 20 mins) to complete.

The plugin uses GitHub GraphQL API to load DeviceType or ModuleType from NetBox Device Type Library.

The plugin loads only file tree representation from a Github repo and shows it as a table with vendor and model columns.

DeviceType definitions files are loaded when you try to import selected models.

So, if you have a lot of models in the repo, it can take a lot of time to load them all.

Please be patient and don't refresh the page while the plugin is loading data from Github.

Description

The plugin uses GitHub GraphQL API to load DeviceType or ModuleType from NetBox Device Type Library. The plugin loads only file tree representation from a Github repo and shows it as a table with vendor and model columns. DeviceType definitions files are loaded when you try to import selected models.

To use GraphQL API you need to set GitHub personal access token in plugin settings. You don't need to grant any permissions to the token.
How to create the token, see "Creating a personal access token."

Compatibility

NetBox Version	NetBox Device Type Importer Version
NetBox 4.5	>= 0.0.1

Installation

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

pip install netbox-device-module-type-importer

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

PLUGINS = ['netbox_device_module_type_importer',]

Restart NetBox and add netbox-device-module-type-importer to your local_requirements.txt

Perform database migrations:

cd /opt/netbox
source venv/bin/activate
python ./netbox/manage.py migrate netbox_device_module_type_importer

Full documentation on using plugins with NetBox: Using Plugins - NetBox Documentation

Configuration

Put your GitHub personal access token to NetBox plugins config

Minimum configuration

PLUGINS_CONFIG = {
    'netbox_device_module_type_importer': {
        "github_token": "<YOUR-GITHUB-TOKEN>"
    }
}

Additional configuration

You can configure the plugin to use different GitHub GraphQL API endpoint, batch size, and concurrency settings.

PLUGINS_CONFIG = {
    'netbox_device_module_type_importer': {
        "repo_owner": "netbox-community",
        "repo": "devicetype-library",
        "github_url": "https://api.github.com/graphql",
        "batch_size": 50,
        "max_concurrent_requests": 20,
        "max_concurrent_vendors": 20,
    }
}

Benchmarking using AsyncIO versus SyncIO

Note that based on benchmark tests, all connectivity to GitHub is done synchronously. The plugin uses AsyncIO to load DeviceType definitions from GitHub in parallel, which significantly reduces the time it takes to load all models from the repo.

Configuration	Time (s)	Files/s	Speedup
Synchronous	360.65s	14.7	1.00×
Async (req=10, vendors=5)	88.56s	59.9	4.07×
Async (req=15, vendors=10)	57.71s	91.9	6.25×
Async (req=20, vendors=20)	31.39s	169.0	11.49×

Contribute

Contributions are always welcome! Please see the Contribution Guidelines

Screenshots

Future

• Import device images from GitHub repo
• Add support for Gitlab repositories

Credits

• Thanks to Nikolay Yuzefovich for providing the original version of DeviceType Importer.