Skip to main content

Load initial data into Netbox

Project description

Netbox Initializers Plugin

Load data from YAML files into Netbox


First activate your virtual environment where Netbox is installed, the install the plugin version correspondig to your Netbox version.

pip install "netbox-initializers==3.6.*"

Then you need to add the plugin to the PLUGINS array in the Netbox configuration.


Getting started

At first you need to start with writing the YAML files that contain the initial data. To make that easier the plugin includes example files for all supported initializers. To access those examples you can copy them into a directory of your choosing and edit them there. To copy the files run the following command (in your Netbox directory):

./ copy_initializers_examples --path /path/for/example/files

After you filled in the data you want to import, the import can be started with this command:

./ load_initializer_data --path /path/for/example/files

Netbox Docker image

The initializers where a part of the Docker image and where then extracted into a Netbox plugin. This was done to split the release cycle of the initializers and the image. To use the new plugin in a the Netbox Docker image, it musst be installad into the image. To this, the following example can be used as a starting point:

FROM netboxcommunity/netbox:v3.6
RUN /opt/netbox/venv/bin/pip install "netbox-initializers==3.6.*"

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_initializers-3.6.0.tar.gz (29.3 kB view hashes)

Uploaded source

Built Distribution

netbox_initializers-3.6.0-py3-none-any.whl (65.4 kB view hashes)

Uploaded py3

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