Skip to content

Home

NetBox AWS VPC Plugin

NetBox plugin for modeling AWS VPCs in NetBox

Features

This plugin provides the following models in NetBox:

  • AWS VPC
  • AWS Subnet
  • AWS Account

Compatibility

NetBox Version Plugin Version
4.0 - 4.4.x >= 0.0.1, <= 0.0.8
4.5 + >= 0.1.0

Installing

For adding to a NetBox Docker setup see the general instructions for using netbox-docker with plugins.

The plugin is available as a Python package on PyPi and can be installed with pip

pip install netbox-aws-vpc-plugin

or by adding to your local_requirements.txt or plugin_requirements.txt (netbox-docker):

netbox-aws-vpc-plugin

Enable the plugin in /opt/netbox/netbox/netbox/configuration.py, or if you use netbox-docker, your /configuration/plugins.py file :

PLUGINS = [
    'netbox_aws_vpc_plugin'
]

PLUGINS_CONFIG = {
    "netbox_aws_vpc_plugin": {},
}

Developement

To locally work on developing this plugin, clone the repo to your local machine.

It is suggested to create a VirtualEnv decicated to the repo, for example:

python3 -m venv venv
source source venv/bin/activate

Once activated, install the development packages:

pip install -U -r requirements_dev.txt

Alternatively, you can use the provided devcontainer which will provide NetBox and the required development packages.

Credits

Based on the NetBox plugin tutorial:

This package was created with Cookiecutter and the netbox-community/cookiecutter-netbox-plugin project template.