Skip to main content

A configurable pie/doughnut chart dashboard widget for NetBox

Project description

netbox-widget-chart

A configurable pie/doughnut chart dashboard widget for NetBox.

Features

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

Compatibility

Plugin Version NetBox Version
0.1.0 4.5

Installation

pip install netbox-widget-chart

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

PLUGINS = [
    'netbox_chart_widget',
]

Restart NetBox after installing.

Configuration

Optional settings in configuration.py:

PLUGINS_CONFIG = {
    "netbox_chart_widget": {
        # Chart.js source URL. Options:
        # - CDN URL (default)
        # - Local static path e.g. "/static/netbox_chart_widget/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

License

Apache 2.0

Development

This plugin was coded entirely with Claude (Anthropic).

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_widget_chart-0.1.0.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

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

netbox_widget_chart-0.1.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file netbox_widget_chart-0.1.0.tar.gz.

File metadata

  • Download URL: netbox_widget_chart-0.1.0.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for netbox_widget_chart-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3d87e26692e0afecc9e3950a979e04abb9ceea20d19456d2b9731efbca1c2192
MD5 f39774c44b324435a8bd749c66fb4f32
BLAKE2b-256 8fc2539410ba6e30e26ca728a4cb042879c48b74a00dfb01e06a84a95ad498e5

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_widget_chart-0.1.0.tar.gz:

Publisher: release.yml on peterbaumert/netbox-widget-chart

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_widget_chart-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_widget_chart-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e32170d878cc8b3a8d1e9bc081f323e2e2f5d01a859fa2fb872f1f095a0592f
MD5 7a81f5b0280e83cbc953e1785e1a7fab
BLAKE2b-256 3c76320c658112f50b7176ee122f0486819c035c90b500b2c93dae707b15c519

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_widget_chart-0.1.0-py3-none-any.whl:

Publisher: release.yml on peterbaumert/netbox-widget-chart

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