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.2.tar.gz (18.1 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.2-py3-none-any.whl (25.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netbox_ipam_grouping-1.0.2.tar.gz
  • Upload date:
  • Size: 18.1 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.2.tar.gz
Algorithm Hash digest
SHA256 18dd62d6941bcc66aee24d51e2baae9c72cd5ece27126d28330d28930ee91487
MD5 c768285ae9161e3ffc40e60942f35607
BLAKE2b-256 2ed3fb18e948f9a0c77aec2ca54bfbdb5c81dd140a5649d09d18fa7e4045ab28

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_ipam_grouping-1.0.2.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.2-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_ipam_grouping-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8d46e002166d3a54e82789308ae256358763cc3c554a0892c51c61029cdcd1d2
MD5 91fc1aa749440fa603645364feb013ca
BLAKE2b-256 2cde65182bd6dba03ae00c38b0b9bc6a39f793c3c1fe6a5ee034f7778a134c9f

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_ipam_grouping-1.0.2-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