# Netbox Sync Status
Netbox Sync Status is a [NetBox](https://github.com/netbox-community/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.
A full log of how all sync's went is saved so you can go back in history and view errors if needed.
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](https://netbox.readthedocs.org/) 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
<p align="middle">
<img align="top" src="/screenshots/sync_status_list.png?raw=true" width="32%" />
<img align="top" src="/screenshots/sync_status_list.png?raw=true" width="32%" />
<img align="top" src="/screenshots/sync_system_view.png?raw=true" width="32%" />
</p>
## Contributing
Developing tools for this project based on [ntc-netbox-plugin-onboarding](https://github.com/networktocode/ntc-netbox-plugin-onboarding) repo.
Issues and pull requests are welcomed.
Raw data
{
"_id": null,
"home_page": "https://github.com/jysk-network/netbox-sync-status",
"name": "netbox-sync-status",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Patrick Falk Nielsen",
"author_email": "panie@jysk.com",
"download_url": "https://files.pythonhosted.org/packages/9e/4d/fb34e907fc4b94ad2dae068bfec8e1c91b2cd4317998369d3b7c5e98110a/netbox_sync_status-2.0.1.tar.gz",
"platform": null,
"description": "# Netbox Sync Status\n\nNetbox Sync Status is a [NetBox](https://github.com/netbox-community/netbox) plugin that adds the capability for systems to report back to netbox if a given sync went well.\nOne 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.\n\nIt 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. \n\nA full log of how all sync's went is saved so you can go back in history and view errors if needed.\n\nIf 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.\n\nAPI's are available to report sync status back, and other general functions that might be needed.\n\n## Compatibility\n\nThis plugin in compatible with [NetBox](https://netbox.readthedocs.org/) 4.1 and later.\n\n## Installation\n\nIf Netbox was installed according to the standard installation instructions. It may be necessary to activate the virtual environment.\n\n```\nsource /opt/netbox/venv/bin/activate\n```\n\nThe plugin is available as a Python package in pypi and can be installed with pip\n\n```\npip install netbox-sync-status\n```\nEnable the plugin in /opt/netbox/netbox/netbox/configuration.py:\n```\nPLUGINS = [\"netbox-sync-status\"]\n```\nRestart NetBox and add `netbox-sync-status` to your local_requirements.txt\n\n## Screenshots\n<p align=\"middle\">\n <img align=\"top\" src=\"/screenshots/sync_status_list.png?raw=true\" width=\"32%\" />\n <img align=\"top\" src=\"/screenshots/sync_status_list.png?raw=true\" width=\"32%\" /> \n <img align=\"top\" src=\"/screenshots/sync_system_view.png?raw=true\" width=\"32%\" />\n</p>\n\n\n## Contributing\nDeveloping tools for this project based on [ntc-netbox-plugin-onboarding](https://github.com/networktocode/ntc-netbox-plugin-onboarding) repo.\n\nIssues and pull requests are welcomed.\n",
"bugtrack_url": null,
"license": null,
"summary": "Sync Status for netbox objects",
"version": "2.0.1",
"project_urls": {
"Homepage": "https://github.com/jysk-network/netbox-sync-status"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c9966d0c529e2cf4c0a9ffe7eae3e7da660bdbaa6ec08a91621b4ca5d9b39bc",
"md5": "590d266cf8f07b5f9ffa0ff3c24ac7cc",
"sha256": "b3d60436daaf3070b5a5916f36852db981e7378f53e6ef2d360e1f3d8c312af8"
},
"downloads": -1,
"filename": "netbox_sync_status-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "590d266cf8f07b5f9ffa0ff3c24ac7cc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19298,
"upload_time": "2024-11-25T09:49:40",
"upload_time_iso_8601": "2024-11-25T09:49:40.853364Z",
"url": "https://files.pythonhosted.org/packages/6c/99/66d0c529e2cf4c0a9ffe7eae3e7da660bdbaa6ec08a91621b4ca5d9b39bc/netbox_sync_status-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9e4dfb34e907fc4b94ad2dae068bfec8e1c91b2cd4317998369d3b7c5e98110a",
"md5": "7ca1eddd8da49eed0ff73fc3bcb8c8fa",
"sha256": "307c264db9aa67d1e1549afed32dae0ba27d65f217b5e5d4576c289c749db0e8"
},
"downloads": -1,
"filename": "netbox_sync_status-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "7ca1eddd8da49eed0ff73fc3bcb8c8fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14371,
"upload_time": "2024-11-25T09:49:41",
"upload_time_iso_8601": "2024-11-25T09:49:41.681543Z",
"url": "https://files.pythonhosted.org/packages/9e/4d/fb34e907fc4b94ad2dae068bfec8e1c91b2cd4317998369d3b7c5e98110a/netbox_sync_status-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-25 09:49:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jysk-network",
"github_project": "netbox-sync-status",
"github_not_found": true,
"lcname": "netbox-sync-status"
}
JSON
