Skip to main content

A configurable pie/doughnut chart dashboard widget for NetBox

Project description

netbox-widget-chart

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).

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.2.0.tar.gz (8.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.2.0-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netbox_widget_chart-0.2.0.tar.gz
  • Upload date:
  • Size: 8.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.2.0.tar.gz
Algorithm Hash digest
SHA256 25234a91854d03afe59eada06a62428cef77c4670909bc341fc628be4c19f0f9
MD5 826de9c771b73088575b1c66674b01b8
BLAKE2b-256 e8f88399aff9846752904db4db6d62f664a8803c21371c40ad02d510e4631dc3

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_widget_chart-0.2.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.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_widget_chart-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 427d789c84212252e537badc94a348c40bc7a92fa9caf345fecd3e852e648e7d
MD5 931819067913c216efcaf561cb3ed4e0
BLAKE2b-256 02e610d1a2060275377636351b4fa5e966b23e23b4fe5a91b142152ac2324683

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_widget_chart-0.2.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