netbox-endpoints 0.2.0

NetBox plugin for managing wireless and wired endpoints (badges, phones, IoT devices)

NetBox Endpoints Plugin

A NetBox plugin for managing wireless and wired endpoints (badges, phones, IoT devices) that don't fit the traditional Device model.

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)

pip install netbox-endpoints

From Source

git clone https://github.com/sieteunoseis/netbox-endpoints.git
cd netbox-endpoints
pip install -e .

Docker Installation

Add to your NetBox Docker requirements file:

# requirements-extra.txt
netbox-endpoints

Configuration

Add the plugin to your NetBox configuration:

# 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

# 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

git clone https://github.com/sieteunoseis/netbox-endpoints.git
cd netbox-endpoints
pip install -e ".[dev]"

Code Style

black netbox_endpoints/
isort netbox_endpoints/
flake8 netbox_endpoints/

Changelog

See CHANGELOG.md for release history.

Support

If you find this plugin helpful, consider supporting development:

License

Apache License 2.0 - See LICENSE for details.

Author

sieteunoseis