Skip to main content

Netbox Sync Status

Netbox Sync Status is a NetBox plugin that adds the capability for systems to report back to netbox if a given sync went well. One usecase is when using webhooks to sync database to other systems like, backup, aaa, dns it's possible to report the status back to netbox.

It works by having the user create a number of Sync Systems and assign what object types they can be used on, each sync system can then report back a Sync Status, so that users will be able to see how it went.

If needed it's also possible to run a re-sync for an update, behind the scenes this will trigger and update event, and netbox will automatically call the needed webhooks.

API's are available to report sync status back, and other general functions that might be needed.

Compatibility

This plugin in compatible with NetBox 4.1 and later.

Installation

If Netbox was installed according to the standard installation instructions. It may be necessary to activate the virtual environment.

source /opt/netbox/venv/bin/activate

The plugin is available as a Python package in pypi and can be installed with pip

pip install netbox-sync-status

Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:

PLUGINS = ["netbox-sync-status"]

Restart NetBox and add netbox-sync-status to your local_requirements.txt

Screenshots

Contributing

Developing tools for this project based on ntc-netbox-plugin-onboarding repo.

Issues and pull requests are welcomed.

Release files for netbox-sync-status 3.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for netbox-sync-status 3.0.4
File Size Uploaded
netbox_sync_status-3.0.4.tar.gz 16.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for netbox-sync-status 3.0.4
File Interpreter ABI Platform
netbox_sync_status-3.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 39.0 kB

Release files / netbox_sync_status-3.0.4.tar.gz

Download URL netbox_sync_status-3.0.4.tar.gz
Size 16.3 kB
Tags Source
SHA-256 checksum
How to use checksums
8f542e1c920ebff060d1d973bc809565314514bef84d6669fc6970be8d2ecd19
BLAKE2b-256 checksum
How to use checksums
ce1e3442136b822b4558a39e0b6fb070f533db17592d9590af11698ebf30f063
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / netbox_sync_status-3.0.4-py3-none-any.whl

Download URL netbox_sync_status-3.0.4-py3-none-any.whl
Size 22.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d6806aecaede2c73f7a0bb2673123b11014d006fda16232b9459ed04cb3594cd
BLAKE2b-256 checksum
How to use checksums
eae30b9f73304546f85928c10fb5c9730e373c7dd211ba7e3a5dae76d99a8aaf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

3.0.4 This release

2 release files

3.0.3

2 release files

3.0.2

2 release files

3.0.0

2 release files

2.0.8

2 release files

2.0.7

2 release files

2.0.6

2 release files

2.0.5

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page