Skip to content

k01ek/netbox-devicetype-importer

Repository files navigation

Netbox DeviceType Import Plugin

NetBox plugin for easy import DeviceType from NetBox Device Type Library

Description

The plugin uses GitHub GraphQL API to load DeviceType 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. You don't need to grant any permissions to the token.
How to create the token, see "Creating a personal access token."

Compatibility

This plugin in compatible with NetBox 3.0 and later

Installation

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

pip install netbox-devicetype-importer

Enable the plugin in NetBox Configuration

PLUGINS = ['netbox_devicetype_importer']

Configuration

Put your GitHub personal access token to NetBox plugins config

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

Screenshots

Future

  • Import device images from GitHub repo
  • Add a GitHub REST API client that allows this plugin to be used without the GitHub token