Skip to main content

NetBox plugin to group IPAM objects (IP Addresses, Prefixes, IP Ranges) and assign them to Applications with ownership-scoped editing.

Project description

NetBox IPAM Grouping and Applications

A NetBox plugin that lets you group IPAM objects (IP Addresses, Prefixes, IP Ranges) into named Groups and assign them to Applications, with ownership-scoped editing based on NetBox's native Ownership model (introduced in NetBox 4.5).

Features

  • Applications — standalone entities with a name, slug, and owner. Used to represent systems or services that own IPAM resources.
  • Groups — named collections of IP Addresses, Prefixes, and IP Ranges, linked to an Application and an Owner.
  • Ownership scoping — non-admin users can only see and edit Groups and Applications belonging to Owners they are members of.
  • IPAM object scoping — when editing a Group, the IP Address / Prefix / IP Range pickers are filtered to objects the user owns (via the ipam_application custom field).
  • Native NetBox Ownership — uses users.Owner (NetBox 4.5+) rather than raw Django users/groups.

Requirements

  • NetBox >= 4.5.0
  • Python >= 3.10

Installation

pip install netbox-ipam-grouping

Add the plugin to your NetBox configuration.py:

PLUGINS = [
    "netbox_ipam_grouping",
]

Run migrations:

python netbox/manage.py migrate netbox_ipam_grouping

Custom Field Setup

This plugin expects a custom field named ipam_application of type Object pointing to netbox_ipam_grouping | application, assigned to:

  • ipam | ip address
  • ipam | prefix
  • ipam | ip range

Create this in NetBox under Customization → Custom Fields before using the IPAM object pickers in Groups.

Navigation

The plugin registers a Firewall Management top-level menu with two sections:

  • Applications — list, add, view, edit, delete Applications
  • Groups — list, add, view, edit, delete Groups

Note: NetBox's plugin API does not currently expose a public mechanism to inject items into the built-in IPAM navigation menu. The plugin therefore registers its own top-level menu entry.

Permissions

Grant the following NetBox object permissions to non-admin users/groups as needed:

Model Permissions
netbox_ipam_grouping | application view, add, change, delete
netbox_ipam_grouping | group view, add, change, delete

Development

git clone https://github.com/your-org/netbox-ipam-grouping
cd netbox-ipam-grouping
pip install -e ".[dev]"

Publishing to PyPI

pip install build twine
python -m build
twine upload dist/*

License

Apache 2.0 — see LICENSE.

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_ipam_grouping-1.0.0.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netbox_ipam_grouping-1.0.0-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

Details for the file netbox_ipam_grouping-1.0.0.tar.gz.

File metadata

  • Download URL: netbox_ipam_grouping-1.0.0.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for netbox_ipam_grouping-1.0.0.tar.gz
Algorithm Hash digest
SHA256 7968a9e2701a70699318b3260435ed3d822fc2bf722d9700446efc4dc3b38ded
MD5 559bf93f4aa0e7d56c4fd8b1a9d940bf
BLAKE2b-256 73d284af8fcc62367265bd694ec6168687cefba82cb625eb4b41993f0a690b4f

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_ipam_grouping-1.0.0.tar.gz:

Publisher: python-publish.yml on bogdan-iot/netbox-ipam-grouping

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file netbox_ipam_grouping-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_ipam_grouping-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d60d3727eecbc19f68982de909e2eae9457a3a299a595c66f3bb3acc6afabfdf
MD5 d509ddcb8217ddbab3ca38db98625bca
BLAKE2b-256 8162d1960addca4d2c8a7e2fc2b17ce29bdb55a44b46fa367bb7fe4664df49ac

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_ipam_grouping-1.0.0-py3-none-any.whl:

Publisher: python-publish.yml on bogdan-iot/netbox-ipam-grouping

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page