netbox-nsm 0.0.1__tar.gz

netbox_nsm-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Andy Wilson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

netbox_nsm-0.0.1/PKG-INFO

@@ -0,0 +1,246 @@
+Metadata-Version: 2.4
+Name: netbox-nsm
+Version: 0.0.1
+Summary: A NetBox plugin for network security management, including object groups and security policies
+Author: Christian Burmeister
+Project-URL: Homepage, https://github.com/christianbur/netbox-nsm
+Project-URL: Documentation, https://github.com/christianbur/netbox-nsm/blob/main/README.md
+Project-URL: Repository, https://github.com/christianbur/netbox-nsm
+Project-URL: Issues, https://github.com/christianbur/netbox-nsm/issues
+Keywords: netbox,netbox-plugin,security
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# netbox-nsm — Network Security Management Plugin for NetBox
+
+> **⚠️ Work in Progress — do not use in production.**
+
+A [NetBox](https://github.com/netbox-community/netbox) plugin for managing network security objects, security policies, and object groups.
+
+This plugin was inspired by [netbox-security](https://github.com/andy-shady-org/netbox-security) by andy-shady-org. After working with it, I decided to write a new plugin from scratch that better fits my workflow and requirements.
+
+The goal is a **modular, vendor-agnostic plugin** that can be used with any kind of firewall or policy system — including traditional firewalls, Cisco TrustSec, and label-based micro-segmentation platforms such as Illumio. Instead of hard-coding object types, the plugin lets you define your own types and fields to match whatever your environment requires.
+
+This plugin was developed using my own hands-on experience in network security, combined with ideas and concepts shaped with the help of AI.
+
+---
+
+## Features
+
+### Custom Object Types
+Define your own object types with configurable fields — for example **Addresses**, **Networks**, **Services**, **NAT-Pools**, or anything your network requires.
+
+- **Area-based classification**: each type belongs to one of four areas:
+  - `Source/Destination` — objects used as traffic sources or destinations
+  - `Services` — port/protocol definitions and similar
+  - `Action` — actions applied to matching traffic (permit, deny, log, policer …)
+  - `Info` — informational objects attached to rules (install dates, comments …)
+- **Configurable field definitions**: JSON list of typed fields per type (`text`, `number`, `boolean`, `url`, `date`, `markdown`, `object_ref`, `multi_object_ref`)
+- **Display template**: format string (`{name} ({port}/{protocol})`) that controls how instances are displayed throughout the UI
+- **MDI icon**: assign an icon from [pictogrammers.com](https://pictogrammers.com/library/mdi/)
+- **Built-in type catalog**: a set of ready-made types (Action, Filter, Log, Policer, Comment, InstalledOn, InstallDate, …) that can be installed with one click
+
+### Custom Objects
+Instances of a Custom Type — the actual objects referenced in security rules.
+
+- Dynamic form fields generated from the type's field definitions
+- Optional `object_ref` fields that link to any NetBox model (IP prefix, device, …)
+- Optional key/value table (`table_data`) for arbitrary extra metadata
+- Comments field with template variable substitution (`{name}`, field data keys)
+- Full CRUD, bulk-edit, bulk-delete, bulk-import via CSV
+- REST API with filterable endpoint (`/api/plugins/netbox-nsm/object-custom-objects/`)
+
+### Custom Object Assignments
+Assign any Custom Object to any NetBox object (Device, VM, Interface, IP Address, Prefix, …).
+
+- Generic foreign key — no model restrictions
+- Comment field per assignment
+- Assignment list tab on every Custom Object detail page
+
+### Object Groups
+Named groups that aggregate Custom Objects and/or other groups of the same area.
+
+- Supports nested sub-groups (arbitrary depth)
+- Area validation: only objects/groups of the same area can be combined
+- Parent-group back-reference shown in group detail view
+- Used directly in security rules as `source_groups`, `destination_groups`, etc.
+
+### Security Policies (Rulebooks)
+Named policy containers holding an ordered list of security rules.
+
+- `rulebook_type` choice field (currently: *Security Rules*)
+- **Rule comment template**: Markdown template pre-filled when adding new rules (`{rule_name}`, `{index}`, `{rulebook}`)
+- Assign policies to **Devices**, **Virtual Machines**, and **Virtual Device Contexts** via Rulebook Assignments
+- Bulk-assign a policy to multiple devices at once
+- Policy visualization view (rule table with source / destination / service / action columns rendered as linked pill badges)
+
+### Security Rules
+Individual firewall/security rules inside a policy.
+
+| Field | Description |
+|---|---|
+| `index` | Rule order (numeric) |
+| `enabled` | Enable / disable the rule |
+| `name` | Unique name within the rulebook |
+| `policy_action` | `permit` / `deny` / `log` / `count` / `reject` |
+| `custom_srcdst_objects` | Source custom objects (area: srcdst) |
+| `source_groups` | Source object groups (area: srcdst) |
+| `destination_custom_objects` | Destination custom objects (area: srcdst) |
+| `destination_groups` | Destination object groups (area: srcdst) |
+| `custom_service_objects` | Service custom objects (area: services) |
+| `service_groups` | Service object groups (area: services) |
+| `custom_action_objects` | Action custom objects (area: action) |
+| `action_groups` | Action object groups (area: action) |
+| `source_users` / `destination_users` | NetBox user references |
+| `log_enabled` | Enable logging |
+
+Rule edit form groups fields into **Source / Destination / Service / Action** sections with a live type/value table showing currently selected objects.
+
+### YAML Bundle Export / Import
+Transfer Custom Types and their objects between NetBox instances.
+
+- **Export**: select one or more Custom Types → download a `.yaml` bundle file
+- **Import**: paste YAML or upload a file, with optional update-existing mode
+- `object_ref` fields are serialized as `{__model: …, __str: …}` and resolved on import via natural keys
+- Bundle format: `apiVersion: nsm/v1`, `kind: Bundle/CustomType/CustomObject`
+
+### Device / VM Matching Rules
+Find all security rules that reference the labels (Custom Object Assignments) of a specific device or VM.
+
+- Accessible from the device/VM detail page
+- Separate result tables for rules where the device appears as source vs. destination
+
+### Security Tab on IPAM Objects
+A **Security** tab is added to IP Address, Prefix, and IP Range detail pages showing every Object Group chain that references the object — including inherited matches via containing prefixes for IP addresses.
+
+### NSM Object Builder *(advanced)*
+A second, more flexible object type system (`NsmObjectType` / `NsmObjectTypeField` / `NsmObject`) for scenarios that require strongly-typed, validated fields with weights and grouping.
+
+### REST API
+All models are fully accessible via NetBox's REST API framework:
+
+| Endpoint | Model |
+|---|---|
+| `/api/plugins/netbox-nsm/object-custom-types/` | ObjectCustomType |
+| `/api/plugins/netbox-nsm/object-custom-objects/` | ObjectCustomObject |
+| `/api/plugins/netbox-nsm/object-custom-object-assignments/` | ObjectCustomObjectAssignment |
+| `/api/plugins/netbox-nsm/object-groups/` | ObjectGroup |
+| `/api/plugins/netbox-nsm/security-zone-policy-rulebooks/` | SecurityZonePolicyRulebook |
+| `/api/plugins/netbox-nsm/security-zone-policy-rules/` | SecurityZonePolicyRule |
+| `/api/plugins/netbox-nsm/security-zone-policy-rulebook-assignments/` | SecurityZonePolicyRulebookAssignment |
+
+All endpoints support filtering, searching, and pagination.
+
+---
+
+## Compatibility
+
+| NetBox Version | Plugin Version |
+|---|---|
+| 4.5.x | 0.0.1 |
+| 4.6.x | 0.0.1 |
+
+---
+
+## Installation
+
+```bash
+pip install netbox-nsm
+```
+
+Enable the plugin in your NetBox `configuration.py`:
+
+```python
+PLUGINS = ["netbox_nsm"]
+```
+
+Run database migrations:
+
+```bash
+cd /opt/netbox
+source venv/bin/activate
+python netbox/manage.py migrate netbox_nsm
+python netbox/manage.py reindex netbox_nsm
+```
+
+Restart NetBox (gunicorn / uwsgi).
+
+---
+
+## Configuration
+
+Add plugin settings in `configuration.py` (all optional):
+
+```python
+PLUGINS_CONFIG = {
+    "netbox_nsm": {
+        # Show plugin menu as top-level entry (default: True)
+        "top_level_menu": True,
+
+        # Show assignments sub-menu item (default: False)
+        "assignments_menu": False,
+
+        # Position of the NSM panel on Virtual Machine detail pages
+        # Options: "left", "right", "full_width", "" (disabled)
+        "virtual_ext_page": "left",
+
+        # Position of the NSM panel on Interface detail pages
+        "interface_ext_page": "full_width",
+
+        # Position of the NSM panel on IP Address/Prefix detail pages
+        "address_ext_page": "right",
+    }
+}
+```
+
+---
+
+## Screenshots
+
+### Navigation & Object Management
+![Navigation](docs/img/01-navigation.png)
+![Custom Object Types](docs/img/02-object-types.png)
+![Object Type Detail](docs/img/03-object-type-detail.png)
+![Object List](docs/img/04-object-list.png)
+![Object Detail](docs/img/05-object-detail.png)
+
+### Object Groups
+![Object Groups](docs/img/06-object-groups.png)
+![Object Group Detail](docs/img/07-object-group-detail.png)
+
+### Built-in Types & YAML Bundle
+![Built-in Type Installer](docs/img/08-builtin-types.png)
+![YAML Bundle Export/Import](docs/img/09-yaml-bundle.png)
+
+### Security Policies
+![Security Policy — Address-based Rules](docs/img/10-security-policy-address.png)
+![Security Rule Detail](docs/img/11-security-rule-detail.png)
+![Security Policy — Label-based Rules (Illumio-style)](docs/img/12-security-policy-labels.png)
+
+### Object Assignments & Device Integration
+![Custom Object Assignments](docs/img/13-custom-object-assignments.png)
+![Device Security Panel](docs/img/14-device-security-panel.png)
+
+### Security on IPAM Objects
+![Prefix Security Tab](docs/img/15-prefix-security-tab.png)
+![IP Address Security Tab (inherited via subnet)](docs/img/16-ipaddress-security-tab.png)
+
+---
+
+## Quick Start
+
+1. **Install built-in types** — go to *Security → Objects → Object-Builder → Install Defaults* and select the types you need (Addresses, Networks, Ports, …).
+2. **Create custom objects** — navigate to the matching area tab (Source/Destination, Services, Action) and add objects.
+3. **Create object groups** *(optional)* — group related objects under *Security → Objects → Groups*.
+4. **Create a Security Policy** — under *Security → Security Policy*.
+5. **Add rules** — open the policy and add rules, selecting objects and groups for each column.
+6. **Assign the policy to a device** — open a Device and use the *Assign Rulebook* action, or use the bulk-assign view on the policy.
+
+---
+
+## License
+
+[Apache 2.0](LICENSE)

netbox_nsm-0.0.1/README.md

@@ -0,0 +1,230 @@
+# netbox-nsm — Network Security Management Plugin for NetBox
+
+> **⚠️ Work in Progress — do not use in production.**
+
+A [NetBox](https://github.com/netbox-community/netbox) plugin for managing network security objects, security policies, and object groups.
+
+This plugin was inspired by [netbox-security](https://github.com/andy-shady-org/netbox-security) by andy-shady-org. After working with it, I decided to write a new plugin from scratch that better fits my workflow and requirements.
+
+The goal is a **modular, vendor-agnostic plugin** that can be used with any kind of firewall or policy system — including traditional firewalls, Cisco TrustSec, and label-based micro-segmentation platforms such as Illumio. Instead of hard-coding object types, the plugin lets you define your own types and fields to match whatever your environment requires.
+
+This plugin was developed using my own hands-on experience in network security, combined with ideas and concepts shaped with the help of AI.
+
+---
+
+## Features
+
+### Custom Object Types
+Define your own object types with configurable fields — for example **Addresses**, **Networks**, **Services**, **NAT-Pools**, or anything your network requires.
+
+- **Area-based classification**: each type belongs to one of four areas:
+  - `Source/Destination` — objects used as traffic sources or destinations
+  - `Services` — port/protocol definitions and similar
+  - `Action` — actions applied to matching traffic (permit, deny, log, policer …)
+  - `Info` — informational objects attached to rules (install dates, comments …)
+- **Configurable field definitions**: JSON list of typed fields per type (`text`, `number`, `boolean`, `url`, `date`, `markdown`, `object_ref`, `multi_object_ref`)
+- **Display template**: format string (`{name} ({port}/{protocol})`) that controls how instances are displayed throughout the UI
+- **MDI icon**: assign an icon from [pictogrammers.com](https://pictogrammers.com/library/mdi/)
+- **Built-in type catalog**: a set of ready-made types (Action, Filter, Log, Policer, Comment, InstalledOn, InstallDate, …) that can be installed with one click
+
+### Custom Objects
+Instances of a Custom Type — the actual objects referenced in security rules.
+
+- Dynamic form fields generated from the type's field definitions
+- Optional `object_ref` fields that link to any NetBox model (IP prefix, device, …)
+- Optional key/value table (`table_data`) for arbitrary extra metadata
+- Comments field with template variable substitution (`{name}`, field data keys)
+- Full CRUD, bulk-edit, bulk-delete, bulk-import via CSV
+- REST API with filterable endpoint (`/api/plugins/netbox-nsm/object-custom-objects/`)
+
+### Custom Object Assignments
+Assign any Custom Object to any NetBox object (Device, VM, Interface, IP Address, Prefix, …).
+
+- Generic foreign key — no model restrictions
+- Comment field per assignment
+- Assignment list tab on every Custom Object detail page
+
+### Object Groups
+Named groups that aggregate Custom Objects and/or other groups of the same area.
+
+- Supports nested sub-groups (arbitrary depth)
+- Area validation: only objects/groups of the same area can be combined
+- Parent-group back-reference shown in group detail view
+- Used directly in security rules as `source_groups`, `destination_groups`, etc.
+
+### Security Policies (Rulebooks)
+Named policy containers holding an ordered list of security rules.
+
+- `rulebook_type` choice field (currently: *Security Rules*)
+- **Rule comment template**: Markdown template pre-filled when adding new rules (`{rule_name}`, `{index}`, `{rulebook}`)
+- Assign policies to **Devices**, **Virtual Machines**, and **Virtual Device Contexts** via Rulebook Assignments
+- Bulk-assign a policy to multiple devices at once
+- Policy visualization view (rule table with source / destination / service / action columns rendered as linked pill badges)
+
+### Security Rules
+Individual firewall/security rules inside a policy.
+
+| Field | Description |
+|---|---|
+| `index` | Rule order (numeric) |
+| `enabled` | Enable / disable the rule |
+| `name` | Unique name within the rulebook |
+| `policy_action` | `permit` / `deny` / `log` / `count` / `reject` |
+| `custom_srcdst_objects` | Source custom objects (area: srcdst) |
+| `source_groups` | Source object groups (area: srcdst) |
+| `destination_custom_objects` | Destination custom objects (area: srcdst) |
+| `destination_groups` | Destination object groups (area: srcdst) |
+| `custom_service_objects` | Service custom objects (area: services) |
+| `service_groups` | Service object groups (area: services) |
+| `custom_action_objects` | Action custom objects (area: action) |
+| `action_groups` | Action object groups (area: action) |
+| `source_users` / `destination_users` | NetBox user references |
+| `log_enabled` | Enable logging |
+
+Rule edit form groups fields into **Source / Destination / Service / Action** sections with a live type/value table showing currently selected objects.
+
+### YAML Bundle Export / Import
+Transfer Custom Types and their objects between NetBox instances.
+
+- **Export**: select one or more Custom Types → download a `.yaml` bundle file
+- **Import**: paste YAML or upload a file, with optional update-existing mode
+- `object_ref` fields are serialized as `{__model: …, __str: …}` and resolved on import via natural keys
+- Bundle format: `apiVersion: nsm/v1`, `kind: Bundle/CustomType/CustomObject`
+
+### Device / VM Matching Rules
+Find all security rules that reference the labels (Custom Object Assignments) of a specific device or VM.
+
+- Accessible from the device/VM detail page
+- Separate result tables for rules where the device appears as source vs. destination
+
+### Security Tab on IPAM Objects
+A **Security** tab is added to IP Address, Prefix, and IP Range detail pages showing every Object Group chain that references the object — including inherited matches via containing prefixes for IP addresses.
+
+### NSM Object Builder *(advanced)*
+A second, more flexible object type system (`NsmObjectType` / `NsmObjectTypeField` / `NsmObject`) for scenarios that require strongly-typed, validated fields with weights and grouping.
+
+### REST API
+All models are fully accessible via NetBox's REST API framework:
+
+| Endpoint | Model |
+|---|---|
+| `/api/plugins/netbox-nsm/object-custom-types/` | ObjectCustomType |
+| `/api/plugins/netbox-nsm/object-custom-objects/` | ObjectCustomObject |
+| `/api/plugins/netbox-nsm/object-custom-object-assignments/` | ObjectCustomObjectAssignment |
+| `/api/plugins/netbox-nsm/object-groups/` | ObjectGroup |
+| `/api/plugins/netbox-nsm/security-zone-policy-rulebooks/` | SecurityZonePolicyRulebook |
+| `/api/plugins/netbox-nsm/security-zone-policy-rules/` | SecurityZonePolicyRule |
+| `/api/plugins/netbox-nsm/security-zone-policy-rulebook-assignments/` | SecurityZonePolicyRulebookAssignment |
+
+All endpoints support filtering, searching, and pagination.
+
+---
+
+## Compatibility
+
+| NetBox Version | Plugin Version |
+|---|---|
+| 4.5.x | 0.0.1 |
+| 4.6.x | 0.0.1 |
+
+---
+
+## Installation
+
+```bash
+pip install netbox-nsm
+```
+
+Enable the plugin in your NetBox `configuration.py`:
+
+```python
+PLUGINS = ["netbox_nsm"]
+```
+
+Run database migrations:
+
+```bash
+cd /opt/netbox
+source venv/bin/activate
+python netbox/manage.py migrate netbox_nsm
+python netbox/manage.py reindex netbox_nsm
+```
+
+Restart NetBox (gunicorn / uwsgi).
+
+---
+
+## Configuration
+
+Add plugin settings in `configuration.py` (all optional):
+
+```python
+PLUGINS_CONFIG = {
+    "netbox_nsm": {
+        # Show plugin menu as top-level entry (default: True)
+        "top_level_menu": True,
+
+        # Show assignments sub-menu item (default: False)
+        "assignments_menu": False,
+
+        # Position of the NSM panel on Virtual Machine detail pages
+        # Options: "left", "right", "full_width", "" (disabled)
+        "virtual_ext_page": "left",
+
+        # Position of the NSM panel on Interface detail pages
+        "interface_ext_page": "full_width",
+
+        # Position of the NSM panel on IP Address/Prefix detail pages
+        "address_ext_page": "right",
+    }
+}
+```
+
+---
+
+## Screenshots
+
+### Navigation & Object Management
+![Navigation](docs/img/01-navigation.png)
+![Custom Object Types](docs/img/02-object-types.png)
+![Object Type Detail](docs/img/03-object-type-detail.png)
+![Object List](docs/img/04-object-list.png)
+![Object Detail](docs/img/05-object-detail.png)
+
+### Object Groups
+![Object Groups](docs/img/06-object-groups.png)
+![Object Group Detail](docs/img/07-object-group-detail.png)
+
+### Built-in Types & YAML Bundle
+![Built-in Type Installer](docs/img/08-builtin-types.png)
+![YAML Bundle Export/Import](docs/img/09-yaml-bundle.png)
+
+### Security Policies
+![Security Policy — Address-based Rules](docs/img/10-security-policy-address.png)
+![Security Rule Detail](docs/img/11-security-rule-detail.png)
+![Security Policy — Label-based Rules (Illumio-style)](docs/img/12-security-policy-labels.png)
+
+### Object Assignments & Device Integration
+![Custom Object Assignments](docs/img/13-custom-object-assignments.png)
+![Device Security Panel](docs/img/14-device-security-panel.png)
+
+### Security on IPAM Objects
+![Prefix Security Tab](docs/img/15-prefix-security-tab.png)
+![IP Address Security Tab (inherited via subnet)](docs/img/16-ipaddress-security-tab.png)
+
+---
+
+## Quick Start
+
+1. **Install built-in types** — go to *Security → Objects → Object-Builder → Install Defaults* and select the types you need (Addresses, Networks, Ports, …).
+2. **Create custom objects** — navigate to the matching area tab (Source/Destination, Services, Action) and add objects.
+3. **Create object groups** *(optional)* — group related objects under *Security → Objects → Groups*.
+4. **Create a Security Policy** — under *Security → Security Policy*.
+5. **Add rules** — open the policy and add rules, selecting objects and groups for each column.
+6. **Assign the policy to a device** — open a Device and use the *Assign Rulebook* action, or use the bulk-assign view on the policy.
+
+---
+
+## License
+
+[Apache 2.0](LICENSE)

netbox_nsm-0.0.1/netbox_nsm/__init__.py

@@ -0,0 +1,28 @@
+from django.utils.translation import gettext_lazy as _
+from netbox.plugins import PluginConfig
+from .version import __version__
+
+
+class SecurityConfig(PluginConfig):
+    name = "netbox_nsm"
+    verbose_name = _("NetBox NSM - Network Security Management")
+    description = _("A NetBox plugin for network security management, including object groups and security policies.")
+    version = __version__
+    author = "Christian Burmeister"
+    author_email = ""
+    base_url = "netbox-nsm"
+    required_settings = []
+    min_version = "4.5.0"
+    default_settings = {
+        "top_level_menu": True,
+        "assignments_menu": False,
+        "virtual_ext_page": "left",
+        "interface_ext_page": "full_width",
+        "address_ext_page": "right",
+    }
+
+    def ready(self):
+        super().ready()
+
+
+config = SecurityConfig  # noqa

netbox_nsm-0.0.1/netbox_nsm/api/serializers.py

@@ -0,0 +1,5 @@
+from .serializers_.security_zone_policy_rulebook import *
+from .serializers_.object_custom_type import *
+from .serializers_.object_custom_object import *
+from .serializers_.object_custom_object_assignment import *
+from .serializers_.object_group import *

netbox_nsm-0.0.1/netbox_nsm/api/serializers_/nsm_object.py

@@ -0,0 +1,39 @@
+from rest_framework.serializers import HyperlinkedIdentityField
+
+from netbox.api.serializers import PrimaryModelSerializer
+
+from netbox_nsm.api.serializers_.nsm_object_type import NsmObjectTypeSerializer
+from netbox_nsm.models import NsmObject
+
+
+class NsmObjectSerializer(PrimaryModelSerializer):
+    url = HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_nsm-api:nsmobject-detail"
+    )
+    nsm_object_type = NsmObjectTypeSerializer(nested=True)
+
+    class Meta:
+        model = NsmObject
+        fields = (
+            "id",
+            "url",
+            "display",
+            "nsm_object_type",
+            "name",
+            "object_data",
+            "source_model",
+            "source_pk",
+            "description",
+            "comments",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "nsm_object_type",
+            "name",
+        )

netbox_nsm-0.0.1/netbox_nsm/api/serializers_/nsm_object_type.py

@@ -0,0 +1,37 @@
+from rest_framework.serializers import HyperlinkedIdentityField
+
+from netbox.api.serializers import PrimaryModelSerializer
+
+from netbox_nsm.models import NsmObjectType
+
+
+class NsmObjectTypeSerializer(PrimaryModelSerializer):
+    url = HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_nsm-api:nsmobjecttype-detail"
+    )
+
+    class Meta:
+        model = NsmObjectType
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "verbose_name",
+            "verbose_name_plural",
+            "slug",
+            "group_name",
+            "description",
+            "comments",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "slug",
+        )

netbox_nsm-0.0.1/netbox_nsm/api/serializers_/nsm_object_type_field.py

@@ -0,0 +1,44 @@
+from rest_framework.serializers import HyperlinkedIdentityField
+
+from netbox.api.serializers import PrimaryModelSerializer
+
+from netbox_nsm.api.serializers_.nsm_object_type import NsmObjectTypeSerializer
+from netbox_nsm.models import NsmObjectTypeField
+
+
+class NsmObjectTypeFieldSerializer(PrimaryModelSerializer):
+    url = HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_nsm-api:nsmobjecttypefield-detail"
+    )
+    nsm_object_type = NsmObjectTypeSerializer(nested=True)
+
+    class Meta:
+        model = NsmObjectTypeField
+        fields = (
+            "id",
+            "url",
+            "display",
+            "nsm_object_type",
+            "name",
+            "label",
+            "type",
+            "group_name",
+            "required",
+            "unique",
+            "default",
+            "weight",
+            "description",
+            "comments",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "nsm_object_type",
+            "name",
+            "type",
+        )