NetBox Cloud Plugin

The NetBox plugin for Cloud (Provider Resources) allows NetBox to document Cloud-specific objects like Providers, Accounts, Regions, Networks, and Subnets.

Status: Pre-Alpha – Interfaces and data models may change.

Documentation: https://pheus.github.io/netbox-cloud/

Table of Contents

• Features
• Compatibility
• Installation
  • Via PyPI
  • Docker
• Configuration
• Status
• Release notes
• Licensing
• Credits
• Contributing
• Security

Features

• Represent core SDN constructs in NetBox:
  • Providers
  • Accounts
  • Regions
  • Networks
  • Subnets
• Consistent UI patterns with NetBox core (tables, filtersets, detail views)
• Ready for automation via NetBox’s REST API
• Designed to coexist with your existing NetBox data model

Compatibility

The following table details the tested plugin versions for each NetBox version:

NetBox Version	Plugin Version
4.3	0.0.1

Installation

Via PyPI

Activate your NetBox virtual environment and install:

source /opt/netbox/venv/bin/activate
pip install netbox-cloud

Important: When using NetBox’s upgrade.sh, the virtual environment is deleted and recreated. To ensure that the Cloud plugin is reinstalled during an upgrade, add it to your local_requirements.txt (for local installations) or plugin_requirements.txt (for container-based installations).

netbox-cloud

Docker

If you deploy NetBox with Docker and use plugin_requirements.txt, add:

netbox-cloud

Rebuild/restart your NetBox container(s) so the plugin is installed and discovered. For more on Docker usage, see the netbox-docker plugin documentation.

Configuration

Enable the plugin by editing the NetBox configuration file. For local installations, update /opt/netbox/netbox/netbox/configuration.py; for Docker setups, modify /configuration/plugins.py:

PLUGINS = [
    "netbox_cloud",
]

PLUGINS_CONFIG = {
    "netbox_cloud": {},
}

Apply database migrations and restart NetBox:

source /opt/netbox/venv/bin/activate
cd /opt/netbox
python3 netbox/manage.py migrate
# restart your NetBox services (e.g., systemd or container restart)

Status

This project is in pre-alpha. While core functionality is usable, bugs and missing features may remain. Use in testing or non‑critical environments; exercise caution in production.

Release notes

See the changelog.

Licensing

Apache License 2.0.

See LICENSE for the full text.

Credits

• Built for the NetBox ecosystem – thanks to the NetBox community.
• Based on the NetBox plugin tutorial:
  • demo repository
  • tutorial

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

Contributing

We follow an issue‑first workflow:

1. Open an issue (bug or feature request).
2. A maintainer triages and accepts it; a contributor is assigned.
3. Open a PR that links the accepted, assigned issue.

See CONTRIBUTING.md and our PR/issue templates for details.

Security

Please do not file public issues for vulnerabilities. See SECURITY.md.