netbox-metatype-importer

Easily import Device and Module types from GitHub repo


Keywords
netbox, netbox-plugin
License
Apache-2.0
Install
pip install netbox-metatype-importer==0.3.2

Documentation

Netbox DeviceType/ModuleType Import Plugin

NetBox plugin for easy import DeviceType and ModuleType from NetBox Device Type Library. This is the continuation of the Netbox DeviceType Import Plugin app.

Description

The plugin uses GitHub GraphQL API to load DeviceType and ModuleType from NetBox Device Type Library. The plugin loads only file tree representation from 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. How to create the token, see "Creating a personal access token."

Compatibility

NetBox Version Plugin Version
3.4.x 0.0.x
3.5.x 0.1.x
3.6.x 0.2.x
3.7.x 0.3.x

Installation

  • Install NetBox as per NetBox documentation
  • Add to local_requirements.txt:
    • netbox-metatype-importer
  • Install requirements: ./venv/bin/pip install -r local_requirements.txt
  • Add to PLUGINS in NetBox configuration:
    • 'netbox_metatype_importer',
  • Run migration: ./venv/bin/python netbox/manage.py migrate

Configuration

The following options are available in the configuration file:

  • branch
    • Type: String
    • Description: Branch of the NetBox Device Type Library repo
    • Default: master
  • github_token
    • Type: String
    • Description: GitHub personal access token
  • repo
    • Type: String
    • Description: Name of the NetBox Device Type Library repo
    • Default: devicetype-library
  • repo_owner
    • Type: String
    • Description: Owner of the NetBox Device Type Library repo
    • Default: netbox-community