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.3.tar.gz (19.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.3-py3-none-any.whl (27.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netbox_ipam_grouping-1.0.3.tar.gz
  • Upload date:
  • Size: 19.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.3.tar.gz
Algorithm Hash digest
SHA256 a3b0226240c97c7dba08ec7da69d09ffabf5710e40e8514e3d35cea27ce991c2
MD5 b3463817974245030061d0bdaccd9f6b
BLAKE2b-256 375be6e8822159b390fe7f8837cea2165622ae4b864d049e50d6d696d58e8ff4

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for netbox_ipam_grouping-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6ac2a108e247f7cc62e2ee70c3239d4ff29bcf3e6fa44ed8b5ccce9747ff7765
MD5 8e8e9c1ca886a286254de8f1b75ecbb8
BLAKE2b-256 dce4f9a47b42f2de68689beee827f6251e0209dfce1d9e2424569881398b8ee0

See more details on using hashes here.

Provenance

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