https://github.com/k01ek/netbox-devicetype-importer

Easy import DeviceTypes from github repo
https://github.com/k01ek/netbox-devicetype-importer

netbox netbox-plugin

Last synced: about 1 month ago
JSON representation

Easy import DeviceTypes from github repo

• Host: GitHub
• URL: https://github.com/k01ek/netbox-devicetype-importer
• Owner: k01ek
• License: apache-2.0
• Created: 2021-12-17T06:09:01.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-09-16T12:57:17.000Z (over 2 years ago)
• Last Synced: 2024-04-24T13:55:07.705Z (8 months ago)
• Topics: netbox, netbox-plugin
• Language: Python
• Homepage:
• Size: 466 KB
• Stars: 68
• Watchers: 4
• Forks: 10
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Netbox DeviceType Import Plugin

[NetBox](https://github.com/netbox-community/netbox) plugin for easy import DeviceType from [NetBox Device Type Library](https://github.com/netbox-community/devicetype-library)

## Description

The plugin uses [GitHub GraphQL API](https://docs.github.com/en/graphql) to load DeviceType from [NetBox Device Type Library](https://github.com/netbox-community/devicetype-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."](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)

## Compatibility

This plugin in compatible with [NetBox](https://netbox.readthedocs.org/) 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](https://netbox.readthedocs.io/en/stable/configuration/)

```

PLUGINS = ['netbox_devicetype_importer']

```

## Configuration

Put your GitHub personal access token to [NetBox plugins config](https://netbox.readthedocs.io/en/stable/configuration/optional-settings/#plugins_config)  

```

PLUGINS_CONFIG = {

    'netbox_devicetype_importer': {

        'github_token': ''

    }

}

```

## Screenshots

![](docs/img/import.gif) 

## Future 

* Import device images from GitHub repo

* Add a GitHub REST API client that allows this plugin to be used without the GitHub token