netbox-endpoints 0.1.0__tar.gz

netbox_endpoints-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 sieteunoseis
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

netbox_endpoints-0.1.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: netbox-endpoints
+Version: 0.1.0
+Summary: NetBox plugin for managing wireless and wired endpoints (badges, phones, IoT devices)
+Author-email: sieteunoseis <jeremy.worden@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/sieteunoseis/netbox-endpoints
+Project-URL: Repository, https://github.com/sieteunoseis/netbox-endpoints
+Project-URL: Documentation, https://github.com/sieteunoseis/netbox-endpoints/wiki
+Project-URL: Changelog, https://github.com/sieteunoseis/netbox-endpoints/blob/main/CHANGELOG.md
+Keywords: netbox,netbox-plugin,endpoints
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Dynamic: license-file
+
+# NetBox Endpoints Plugin
+
+A NetBox plugin for managing wireless and wired endpoints (badges, phones, IoT devices) that don't fit the traditional Device model.
+
+![NetBox Version](https://img.shields.io/badge/NetBox-4.0+-blue)
+![Python Version](https://img.shields.io/badge/Python-3.10+-green)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![PyPI](https://img.shields.io/pypi/v/netbox-endpoints)](https://pypi.org/project/netbox-endpoints/)
+
+## Overview
+
+The Endpoints plugin provides dedicated models for mobile/endpoint devices that don't fit the traditional NetBox Device model:
+
+- **Vocera badges** - Wireless communication badges
+- **Cisco IP phones** - Desk phones, wireless phones
+- **IoT devices** - Sensors, controllers, etc.
+- **Tablets/mobile devices** - iPads, scanners, etc.
+
+Unlike Devices, Endpoints:
+- Don't require rack locations
+- Have MAC address as primary identifier
+- Support wireless (SSID) and wired (switch port) connections
+- Track connection type and status independently
+
+## Features
+
+- **Endpoint Types** - Define endpoint models (like DeviceType but for endpoints)
+- **Endpoints** - Track individual endpoint devices with:
+  - MAC address (required, unique)
+  - Name, serial number, asset tag
+  - Site and location
+  - Primary IPv4/IPv6 (FK to IPAddress)
+  - Connection type (wireless/wired)
+  - SSID (wireless) or connected interface (wired)
+  - Tenant, contact, platform
+  - Status (active, offline, staged, decommissioned)
+  - Full tag and custom field support
+- **Plugin Integration** - Other plugins can add tabs to endpoint detail pages
+- **REST API** - Full API access at `/api/plugins/netbox-endpoints/`
+
+## Requirements
+
+- NetBox 4.0 or higher
+- Python 3.10+
+
+## Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install netbox-endpoints
+```
+
+### From Source
+
+```bash
+git clone https://github.com/sieteunoseis/netbox-endpoints.git
+cd netbox-endpoints
+pip install -e .
+```
+
+### Docker Installation
+
+Add to your NetBox Docker requirements file:
+
+```bash
+# requirements-extra.txt
+netbox-endpoints
+```
+
+## Configuration
+
+Add the plugin to your NetBox configuration:
+
+```python
+# configuration.py or plugins.py
+
+PLUGINS = [
+    'netbox_endpoints',
+]
+
+PLUGINS_CONFIG = {
+    'netbox_endpoints': {
+        # No configuration required - endpoints are stored in NetBox
+    }
+}
+```
+
+## Usage
+
+### Creating Endpoint Types
+
+1. Navigate to **Plugins > Endpoints > Endpoint Types**
+2. Click **Add**
+3. Select manufacturer and enter model name
+4. Optionally set default platform
+
+### Creating Endpoints
+
+1. Navigate to **Plugins > Endpoints > Endpoints**
+2. Click **Add**
+3. Enter MAC address (required)
+4. Select endpoint type, site, and other details
+5. Set connection type (wireless/wired)
+6. For wireless: enter SSID
+7. For wired: select connected interface
+
+### API Access
+
+```bash
+# List endpoints
+curl -X GET "https://netbox.example.com/api/plugins/netbox-endpoints/endpoints/" \
+  -H "Authorization: Token $TOKEN"
+
+# Create endpoint
+curl -X POST "https://netbox.example.com/api/plugins/netbox-endpoints/endpoints/" \
+  -H "Authorization: Token $TOKEN" \
+  -H "Content-Type: application/json" \
+  -d '{"mac_address": "00:11:22:33:44:55", "endpoint_type": 1, "site": 1}'
+```
+
+## Plugin Integration
+
+Other plugins (like netbox-catalyst-center) can register tabs on Endpoint detail pages using the standard NetBox `@register_model_view` decorator.
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/sieteunoseis/netbox-endpoints.git
+cd netbox-endpoints
+pip install -e ".[dev]"
+```
+
+### Code Style
+
+```bash
+black netbox_endpoints/
+isort netbox_endpoints/
+flake8 netbox_endpoints/
+```
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for release history.
+
+## Support
+
+If you find this plugin helpful, consider supporting development:
+
+[![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-support-yellow?style=flat&logo=buy-me-a-coffee)](https://buymeacoffee.com/automatebldrs)
+
+## License
+
+Apache License 2.0 - See [LICENSE](LICENSE) for details.
+
+## Author
+
+sieteunoseis

netbox_endpoints-0.1.0/README.md

@@ -0,0 +1,160 @@
+# NetBox Endpoints Plugin
+
+A NetBox plugin for managing wireless and wired endpoints (badges, phones, IoT devices) that don't fit the traditional Device model.
+
+![NetBox Version](https://img.shields.io/badge/NetBox-4.0+-blue)
+![Python Version](https://img.shields.io/badge/Python-3.10+-green)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![PyPI](https://img.shields.io/pypi/v/netbox-endpoints)](https://pypi.org/project/netbox-endpoints/)
+
+## Overview
+
+The Endpoints plugin provides dedicated models for mobile/endpoint devices that don't fit the traditional NetBox Device model:
+
+- **Vocera badges** - Wireless communication badges
+- **Cisco IP phones** - Desk phones, wireless phones
+- **IoT devices** - Sensors, controllers, etc.
+- **Tablets/mobile devices** - iPads, scanners, etc.
+
+Unlike Devices, Endpoints:
+- Don't require rack locations
+- Have MAC address as primary identifier
+- Support wireless (SSID) and wired (switch port) connections
+- Track connection type and status independently
+
+## Features
+
+- **Endpoint Types** - Define endpoint models (like DeviceType but for endpoints)
+- **Endpoints** - Track individual endpoint devices with:
+  - MAC address (required, unique)
+  - Name, serial number, asset tag
+  - Site and location
+  - Primary IPv4/IPv6 (FK to IPAddress)
+  - Connection type (wireless/wired)
+  - SSID (wireless) or connected interface (wired)
+  - Tenant, contact, platform
+  - Status (active, offline, staged, decommissioned)
+  - Full tag and custom field support
+- **Plugin Integration** - Other plugins can add tabs to endpoint detail pages
+- **REST API** - Full API access at `/api/plugins/netbox-endpoints/`
+
+## Requirements
+
+- NetBox 4.0 or higher
+- Python 3.10+
+
+## Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install netbox-endpoints
+```
+
+### From Source
+
+```bash
+git clone https://github.com/sieteunoseis/netbox-endpoints.git
+cd netbox-endpoints
+pip install -e .
+```
+
+### Docker Installation
+
+Add to your NetBox Docker requirements file:
+
+```bash
+# requirements-extra.txt
+netbox-endpoints
+```
+
+## Configuration
+
+Add the plugin to your NetBox configuration:
+
+```python
+# configuration.py or plugins.py
+
+PLUGINS = [
+    'netbox_endpoints',
+]
+
+PLUGINS_CONFIG = {
+    'netbox_endpoints': {
+        # No configuration required - endpoints are stored in NetBox
+    }
+}
+```
+
+## Usage
+
+### Creating Endpoint Types
+
+1. Navigate to **Plugins > Endpoints > Endpoint Types**
+2. Click **Add**
+3. Select manufacturer and enter model name
+4. Optionally set default platform
+
+### Creating Endpoints
+
+1. Navigate to **Plugins > Endpoints > Endpoints**
+2. Click **Add**
+3. Enter MAC address (required)
+4. Select endpoint type, site, and other details
+5. Set connection type (wireless/wired)
+6. For wireless: enter SSID
+7. For wired: select connected interface
+
+### API Access
+
+```bash
+# List endpoints
+curl -X GET "https://netbox.example.com/api/plugins/netbox-endpoints/endpoints/" \
+  -H "Authorization: Token $TOKEN"
+
+# Create endpoint
+curl -X POST "https://netbox.example.com/api/plugins/netbox-endpoints/endpoints/" \
+  -H "Authorization: Token $TOKEN" \
+  -H "Content-Type: application/json" \
+  -d '{"mac_address": "00:11:22:33:44:55", "endpoint_type": 1, "site": 1}'
+```
+
+## Plugin Integration
+
+Other plugins (like netbox-catalyst-center) can register tabs on Endpoint detail pages using the standard NetBox `@register_model_view` decorator.
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/sieteunoseis/netbox-endpoints.git
+cd netbox-endpoints
+pip install -e ".[dev]"
+```
+
+### Code Style
+
+```bash
+black netbox_endpoints/
+isort netbox_endpoints/
+flake8 netbox_endpoints/
+```
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for release history.
+
+## Support
+
+If you find this plugin helpful, consider supporting development:
+
+[![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-support-yellow?style=flat&logo=buy-me-a-coffee)](https://buymeacoffee.com/automatebldrs)
+
+## License
+
+Apache License 2.0 - See [LICENSE](LICENSE) for details.
+
+## Author
+
+sieteunoseis

netbox_endpoints-0.1.0/netbox_endpoints/__init__.py

@@ -0,0 +1,33 @@
+"""
+NetBox Endpoints Plugin
+
+Manage wireless and wired endpoints (badges, phones, IoT devices) in NetBox.
+Provides a dedicated model for mobile/endpoint devices that don't fit the
+traditional Device model (no rack location, dynamic IPs, etc.).
+"""
+
+from netbox.plugins import PluginConfig
+
+__version__ = "0.1.0"
+
+
+class EndpointsConfig(PluginConfig):
+    """Plugin configuration for NetBox Endpoints."""
+
+    name = "netbox_endpoints"
+    verbose_name = "Endpoints"
+    description = "Manage wireless and wired endpoints (badges, phones, IoT devices)"
+    version = __version__
+    author = "sieteunoseis"
+    author_email = "jeremy.worden@gmail.com"
+    base_url = "endpoints"
+    min_version = "4.0.0"
+
+    # Required settings
+    required_settings = []
+
+    # Default configuration values
+    default_settings = {}
+
+
+config = EndpointsConfig

netbox_endpoints-0.1.0/netbox_endpoints/api/__init__.py

@@ -0,0 +1 @@
+"""API package for NetBox Endpoints plugin."""

netbox_endpoints-0.1.0/netbox_endpoints/api/serializers.py

@@ -0,0 +1,79 @@
+"""API serializers for NetBox Endpoints plugin."""
+
+from dcim.api.serializers import (
+    InterfaceSerializer,
+    LocationSerializer,
+    ManufacturerSerializer,
+    PlatformSerializer,
+    SiteSerializer,
+)
+from ipam.api.serializers import IPAddressSerializer
+from netbox.api.serializers import NetBoxModelSerializer
+from rest_framework import serializers
+from tenancy.api.serializers import ContactSerializer, TenantSerializer
+
+from ..models import Endpoint, EndpointType
+
+
+class EndpointTypeSerializer(NetBoxModelSerializer):
+    """Serializer for EndpointType."""
+
+    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:netbox_endpoints-api:endpointtype-detail")
+    endpoint_count = serializers.IntegerField(read_only=True)
+
+    class Meta:
+        model = EndpointType
+        fields = [
+            "id",
+            "url",
+            "display",
+            "manufacturer",
+            "model",
+            "part_number",
+            "default_platform",
+            "description",
+            "comments",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+            "endpoint_count",
+        ]
+        brief_fields = ["id", "url", "display", "manufacturer", "model"]
+
+
+class EndpointSerializer(NetBoxModelSerializer):
+    """Serializer for Endpoint."""
+
+    url = serializers.HyperlinkedIdentityField(view_name="plugins-api:netbox_endpoints-api:endpoint-detail")
+
+    class Meta:
+        model = Endpoint
+        fields = [
+            "id",
+            "url",
+            "display",
+            "mac_address",
+            "name",
+            "endpoint_type",
+            "serial",
+            "asset_tag",
+            "site",
+            "location",
+            "primary_ip4",
+            "primary_ip6",
+            "connection_type",
+            "connected_interface",
+            "ssid",
+            "tenant",
+            "contact",
+            "platform",
+            "status",
+            "description",
+            "comments",
+            "tags",
+            "custom_fields",
+            "created",
+            "last_updated",
+        ]
+        brief_fields = ["id", "url", "display", "mac_address", "name", "endpoint_type"]

netbox_endpoints-0.1.0/netbox_endpoints/api/urls.py

@@ -0,0 +1,11 @@
+"""API URL configuration for NetBox Endpoints plugin."""
+
+from netbox.api.routers import NetBoxRouter
+
+from . import views
+
+router = NetBoxRouter()
+router.register("endpoint-types", views.EndpointTypeViewSet)
+router.register("endpoints", views.EndpointViewSet)
+
+urlpatterns = router.urls