Skip to main content

A NetBox plugin for documenting network security policy: rulebooks, zones, and NSM object links

Project description

netbox-nsm

NetBox-Plugin für Security Policy Dokumentation (Zonen, Rulebooks, Object Links).
Kein Push zu Firewalls — nur Inventar + Policy in NetBox.

Status: WIP · NetBox: 4.5–4.6 · Plugin: 0.4.2 · Abhängigkeit: netbox-custom-objects

Features

  • Security Panel auf Prefix, IP, Device, VM, Custom Objects — + Assign für Zonen/Adressen/…
  • Rulebooks mit flexiblen Spalten (Zonen, Adressen, Labels, …)
  • Rules — Tabelle, Gruppierung, Zone-Matrix
  • IP Analysis — Adressauflösung (Panel-Lupe oder /plugins/netbox-nsm/ip-analysis/)
  • Object Analyzer — Graph aus beliebigem NetBox-Objekt

Installation

pip install netbox-nsm
PLUGINS = ["netbox_custom_objects", "netbox_nsm"]

PLUGINS_CONFIG = {
    "netbox_nsm": {
        "menu_label": "Security",
        "panel_label": "Security",
        "setup_menu": True,
        "setup_allow_destructive_actions": True,  # Demos; in Prod aus
    },
}
./manage.py migrate netbox_custom_objects --no-input
./manage.py migrate netbox_nsm --no-input

Erster Start

Security → Configuration → Setup — Abschnitte 1 → 2 → 3 (Labels, COTs, TypeConfigs), dann optional 4 Starter demo.

Danach: Prefix öffnen → Security Panel → + Assign → Zone. Rulebooks unter Security → Rulebooks.

Details: docs/using_netbox_nsm.md

API

/api/plugins/netbox-nsm/nsm-configs/<slug>/, object-links/, ip-analysis/
Regeln und Policy-Objekte: netbox-custom-objects API.

Demos

Demo Wo Hinweis
Starter Setup §4 Sync, empfohlen — Zone Matrix + Addresses-Schema
Enterprise DC Setup §4 Nur leere IPAM-DB
Addresses Million Scale CLI scripts/create_addresses_million_scale.py Bench, RQ-Worker nötig

Doku

Datei Inhalt
docs/using_netbox_nsm.md Bedienung
docs/DATABASE.md PostgreSQL-Tabellen
docs/RULE_DATA_STORAGE.md Datenmodell UI vs. DB
ARCHITECTURE.md Code für Entwickler
CHANGELOG.md Versionen

Lizenz

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_nsm-0.4.3.tar.gz (436.7 kB view details)

Uploaded Source

Built Distribution

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

netbox_nsm-0.4.3-py3-none-any.whl (575.4 kB view details)

Uploaded Python 3

File details

Details for the file netbox_nsm-0.4.3.tar.gz.

File metadata

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

File hashes

Hashes for netbox_nsm-0.4.3.tar.gz
Algorithm Hash digest
SHA256 2bf11c1604de0882688582c5301328924f9150bcfbbc79ae57c882e6910858fe
MD5 437888410efa68a1a83d7c725cddf9d6
BLAKE2b-256 6bb5ec12ef3cc6af2c886a10d18ef6927fcdfc9c5cb7dab04ae784c3098f3c04

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_nsm-0.4.3.tar.gz:

Publisher: publish.yml on christianbur/netbox-nsm

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_nsm-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: netbox_nsm-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 575.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for netbox_nsm-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fe8fa98a466d2a6bd8fddddb8316e8f93b7ae8b54df9d70bfe9d0c9af2e9a5aa
MD5 fb3a7410dcfed5bafe61f8457a55653c
BLAKE2b-256 7e96930668ab639b0f68102672f8646c2099204629abf88f5fff2fb0094fd0d6

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_nsm-0.4.3-py3-none-any.whl:

Publisher: publish.yml on christianbur/netbox-nsm

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