Skip to content

Repository files navigation

netbox-widget-chart

PyPI Version PyPI Downloads CI

A configurable chart dashboard widget for NetBox.

Features

  • Pie, doughnut, bar, and polar area chart types
  • 34 built-in data sources across DCIM, virtualization, IPAM, circuits, and tenancy
  • Configurable maximum number of slices (excess grouped as "Other")
  • Powered by Chart.js (loaded lazily from CDN)

Compatibility

See COMPATIBILITY.md.

Installation

pip install netbox-widget-chart

Add the plugin to PLUGINS in your NetBox configuration.py:

PLUGINS = [
    'netbox_widget_chart',
]

Restart NetBox after installing.

Configuration

Optional settings in configuration.py:

PLUGINS_CONFIG = {
    "netbox_widget_chart": {
        # Chart.js source URL. Options:
        # - CDN URL (default)
        # - Local static path e.g. "/static/netbox_widget_chart/chart.js"
        # - None to skip loading (if Chart.js is already provided globally)
        "CHARTJS_URL": "https://cdn.jsdelivr.net/npm/chart.js@4.4.0/dist/chart.umd.min.js",
    }
}

Usage

  1. Navigate to the NetBox dashboard
  2. Click Add Widget
  3. Select Chart
  4. Configure the data source, chart type, and max slices

Available Data Sources

Key Description
device_status Devices by Status
device_role Devices by Role
device_site Devices by Site
device_platform Devices by Platform
device_type Devices by Type
vm_status VMs by Status
vm_cluster VMs by Cluster
prefix_status Prefixes by Status
ipaddress_status IP Addresses by Status
circuit_status Circuits by Status
circuit_type Circuits by Type
cable_type Cables by Type
cable_color Cables by Color
cable_status Cables by Status
cable_tenant Cables by Tenant
rack_site Racks by Site
rack_status Racks by Status
rack_role Racks by Role
prefix_vrf Prefixes by VRF
prefix_role Prefixes by Role
ipaddress_role IP Addresses by Role
ipaddress_dns IP Addresses by DNS Name
vlan_status VLANs by Status
vlan_role VLANs by Role
vm_platform VMs by Platform
vm_site VMs by Site
tenant_group Tenants by Group
contact_role Contacts by Role
powerfeed_status Power Feeds by Status
powerfeed_type Power Feeds by Type

License

Apache 2.0

Development

This plugin was coded entirely with Claude (Anthropic).

About

Configurable chart dashboard widget for NetBox

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages