# NetBox Napalm Plugin
NetBox plugin for SWUpdate.
* Free software: Apache-2.0
* Documentation: https://netbox-community.github.io/netbox-swupdate/???.
## Features
The features the plugin provides should be listed here.
## Compatibility
> :warning: **NetBox 4.0.7**: This plugin is for NetBox 4.0.7
| NetBox Version | Plugin Version |
|----------------|----------------|
| 4.0.7 | 0.0.1.103 |
## Installation
For adding to a NetBox Docker setup see
[the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
```no-highlight
$ source /opt/netbox/venv/bin/activate
(venv) pip install netbox-swupdate
```
or by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):
```no-highlight
(venv) netbox-swupdate
```
### Enable the Plugin
Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
or if you use netbox-docker, your `/configuration/plugins.py` file :
```no-highlight
PLUGINS = [
'netbox_swupdate'
]
```
### Configure Plugin
Configure the plugin in `configuration.py` under the `PLUGINS_CONFIG` parameter.
```no-highlight
PLUGINS_CONFIG = {
'netbox_swupdate': {
'SWUPDATE_USERNAME': 'xxx',
'SWUPDATE_PASSWORD': 'yyy',
},
}
```
### Run Database Migrations
Run the provided schema migrations:
```no-highlight
(venv) $ cd /opt/netbox/netbox/
(venv) $ python3 manage.py migrate
```
### Collect Static Files
Ensure the static files are copied to the static root directory with the `collectstatic` management command:
```no-highlight
(venv) $ cd /opt/netbox/netbox/
(venv) $ python3 manage.py collectstatic
```
### Restart WSGI Service
Restart the WSGI service to load the new plugin:
```no-highlight
# sudo systemctl restart netbox
```
## Credits
Based on the NetBox plugin tutorial:
- [demo repository](https://github.com/netbox-community/netbox-plugin-demo)
- [tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [`netbox-community/cookiecutter-netbox-plugin`](https://github.com/netbox-community/cookiecutter-netbox-plugin) project template.
Raw data
{
"_id": null,
"home_page": "https://github.com/netbox-community/netbox-swupdate",
"name": "netbox-swupdate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "netbox, netbox-plugin, plugin",
"author": "\u00d3scar Hurtado",
"author_email": "ohurtadp@sens.solutions",
"download_url": "https://files.pythonhosted.org/packages/52/e2/fdef12b9dd4f9df7b8f5c29759100a60931854066168f5798c8cdd498716/netbox_swupdate-0.0.1.103.tar.gz",
"platform": null,
"description": "# NetBox Napalm Plugin\n\nNetBox plugin for SWUpdate.\n\n\n* Free software: Apache-2.0\n* Documentation: https://netbox-community.github.io/netbox-swupdate/???.\n\n\n## Features\n\nThe features the plugin provides should be listed here.\n\n## Compatibility\n\n> :warning: **NetBox 4.0.7**: This plugin is for NetBox 4.0.7\n\n| NetBox Version | Plugin Version |\n|----------------|----------------|\n| 4.0.7 | 0.0.1.103 |\n\n## Installation\n\nFor adding to a NetBox Docker setup see\n[the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).\n\n```no-highlight\n$ source /opt/netbox/venv/bin/activate\n(venv) pip install netbox-swupdate\n```\n\nor by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):\n\n```no-highlight\n(venv) netbox-swupdate\n```\n\n### Enable the Plugin\n\nEnable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,\n or if you use netbox-docker, your `/configuration/plugins.py` file :\n\n```no-highlight\nPLUGINS = [\n 'netbox_swupdate'\n]\n```\n\n### Configure Plugin\n\nConfigure the plugin in `configuration.py` under the `PLUGINS_CONFIG` parameter.\n\n```no-highlight\nPLUGINS_CONFIG = {\n 'netbox_swupdate': {\n 'SWUPDATE_USERNAME': 'xxx',\n 'SWUPDATE_PASSWORD': 'yyy',\n },\n}\n```\n\n### Run Database Migrations\n\nRun the provided schema migrations:\n\n```no-highlight\n(venv) $ cd /opt/netbox/netbox/\n(venv) $ python3 manage.py migrate\n```\n\n### Collect Static Files\n\nEnsure the static files are copied to the static root directory with the `collectstatic` management command:\n\n```no-highlight\n(venv) $ cd /opt/netbox/netbox/\n(venv) $ python3 manage.py collectstatic\n```\n\n### Restart WSGI Service\n\nRestart the WSGI service to load the new plugin:\n\n```no-highlight\n# sudo systemctl restart netbox\n```\n\n## Credits\n\nBased on the NetBox plugin tutorial:\n\n- [demo repository](https://github.com/netbox-community/netbox-plugin-demo)\n- [tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)\n\nThis package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [`netbox-community/cookiecutter-netbox-plugin`](https://github.com/netbox-community/cookiecutter-netbox-plugin) project template.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "NetBox plugin for SWUpdate.",
"version": "0.0.1.103",
"project_urls": {
"Homepage": "https://github.com/netbox-community/netbox-swupdate"
},
"split_keywords": [
"netbox",
" netbox-plugin",
" plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef22c0ab46f654cc615fad3c6a14b23b46de44e0816949888f6ff71b216e8331",
"md5": "4fefdf461f9822f2b1e4e2ece725edf6",
"sha256": "d76f9ec8bf2dbca8e2cb9c980f26265efc961336e64faadaf147f7157eaed091"
},
"downloads": -1,
"filename": "netbox_swupdate-0.0.1.103-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "4fefdf461f9822f2b1e4e2ece725edf6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 38619,
"upload_time": "2024-07-19T12:57:38",
"upload_time_iso_8601": "2024-07-19T12:57:38.414049Z",
"url": "https://files.pythonhosted.org/packages/ef/22/c0ab46f654cc615fad3c6a14b23b46de44e0816949888f6ff71b216e8331/netbox_swupdate-0.0.1.103-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "52e2fdef12b9dd4f9df7b8f5c29759100a60931854066168f5798c8cdd498716",
"md5": "04d8a6f5f27b3f630da71ff85e104f71",
"sha256": "6257d2b42032f4300aaebd26f5e11e2dd78cffb8331fedbaecaecc3a312c199f"
},
"downloads": -1,
"filename": "netbox_swupdate-0.0.1.103.tar.gz",
"has_sig": false,
"md5_digest": "04d8a6f5f27b3f630da71ff85e104f71",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 18975,
"upload_time": "2024-07-19T12:57:40",
"upload_time_iso_8601": "2024-07-19T12:57:40.246372Z",
"url": "https://files.pythonhosted.org/packages/52/e2/fdef12b9dd4f9df7b8f5c29759100a60931854066168f5798c8cdd498716/netbox_swupdate-0.0.1.103.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-19 12:57:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "netbox-community",
"github_project": "netbox-swupdate",
"github_not_found": true,
"lcname": "netbox-swupdate"
}
JSON
