Skip to main content

A NetBox plugin for pinging and discovering IPs

Project description

NetBox Ping

Python NetBox License PyPI

A NetBox plugin for pinging, discovering, and monitoring IP addresses directly from your NetBox instance.

Check my other Plugin: NetBox Map | Website

Features

  • Ping individual IPs — one-click ping from any IP address detail page
  • Scan prefixes — ping all existing IPs in a prefix at once
  • Discover new hosts — scan entire subnets to find and add active IPs not yet in NetBox
  • Bulk operations — select multiple prefixes from the list view and scan/discover in bulk
  • Auto-scan scheduling — configure recurring scans and discovery globally or per-prefix
  • Per-prefix schedule overrides — three modes: Follow Global, Custom On, or Custom Off
  • DNS resolution — automatic reverse DNS lookups with configurable DNS servers
  • Ping Status columns — sortable status columns injected into the core IP Address and Prefix tables
  • Status panels — ping results shown on IP Address and Prefix detail pages
  • Background jobs — all scan/discover operations run as NetBox background jobs
  • Dark mode compatible

Requirements

  • NetBox 4.5.0 or later
  • Python 3.12 or later
  • ping command available on the NetBox server
  • NetBox background worker running (netbox-rq)

Installation

From PyPI

source /opt/netbox/venv/bin/activate
pip install netbox-ping

From source

source /opt/netbox/venv/bin/activate
pip install git+https://github.com/DenDanskeMine/netbox-ping.git

Enable the plugin

Add netbox_ping to your NetBox configuration.py:

PLUGINS = [
    'netbox_ping',
]

Apply migrations

cd /opt/netbox/netbox
python3 manage.py migrate

Restart services

sudo systemctl restart netbox netbox-rq

Usage

New settings Page

image

Ping a single IP

Navigate to any IP address in NetBox. Click the Ping Now button to ping it immediately. Results appear in the side panel showing reachability, response time, DNS name, and last seen time.

image

Scan a prefix

Navigate to a prefix and click the Ping Subnet button to ping all existing IPs in that prefix. Or click Discover IPs to scan the entire subnet range and automatically create new IP addresses for any responding hosts.

image

Bulk operations

From the prefix list view, select one or more prefixes using the checkboxes, then click Ping Selected or Discover Selected to scan them all.

image

Custom Status badge

image image

View results

  • Plugins > Ping > Ping Results — table of all individual IP ping results
  • Plugins > Ping > Scan Results — table of all prefix scan summaries
  • Ping Status column — enable the "Ping Status" column in the IP Address or Prefix table column configuration

Auto-scan scheduling

  1. Go to Plugins > Ping > Settings
  2. Enable Auto-Scan and/or Auto-Discover and choose an interval
  3. Set the Minimum Prefix Length to control which prefixes are scanned (default: /24)
  4. The system job runs every minute and dispatches scans for prefixes that are due

Per-prefix schedule overrides

From a prefix's Ping Status tab, you can override the global schedule:

Mode Behavior
Follow Global Uses whatever the global setting is (default)
Custom On Always scans at a custom interval, regardless of global setting
Custom Off Never auto-scans, even if global is enabled

Configuration

DNS settings

Configure up to three DNS servers for reverse lookups in Plugins > Ping > Settings. DNS lookups are performed on reachable IPs to resolve their hostname.

Auto-scan intervals

Available intervals: 5 minutes, 15 minutes, 30 minutes, hourly, every 6 hours, every 12 hours, daily, weekly.

Development

git clone https://github.com/DenDanskeMine/netbox-ping.git
cd netbox-ping
pip install -e .

License

This project is licensed under the Apache License 2.0 — see the LICENSE file for details.

Support

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_ping-2.0.3.tar.gz (26.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_ping-2.0.3-py3-none-any.whl (35.8 kB view details)

Uploaded Python 3

File details

Details for the file netbox_ping-2.0.3.tar.gz.

File metadata

  • Download URL: netbox_ping-2.0.3.tar.gz
  • Upload date:
  • Size: 26.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for netbox_ping-2.0.3.tar.gz
Algorithm Hash digest
SHA256 c0983e48cee3d589dd225e1b2d6d724096edb24f4e319567bcc52ffc12748e83
MD5 498d31ff27d50f2338417b648d9452ea
BLAKE2b-256 a5e330499f5ee60c6171a4852844e758687a1fc52e63a131898be84c550525f7

See more details on using hashes here.

File details

Details for the file netbox_ping-2.0.3-py3-none-any.whl.

File metadata

  • Download URL: netbox_ping-2.0.3-py3-none-any.whl
  • Upload date:
  • Size: 35.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for netbox_ping-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 712741c8dbfe6af8fc22107c224f8f58c57f736525cf50df626d65ff1a5d0ac1
MD5 ee7ce874e30e170163c7c19effbc893f
BLAKE2b-256 fc05bf9f43f5d63bede2c4a47b2a63df98f707b3b25a409d4957f1e4656ab8f0

See more details on using hashes here.

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