https://github.com/drygdryg/netbox-plugin-interface-sync
NetBox Plugin to compare and synchronize interfaces between devices and device types
https://github.com/drygdryg/netbox-plugin-interface-sync
netbox netbox-plugin network-automation
Last synced: 2 months ago
JSON representation
NetBox Plugin to compare and synchronize interfaces between devices and device types
- Host: GitHub
- URL: https://github.com/drygdryg/netbox-plugin-interface-sync
- Owner: drygdryg
- Created: 2021-04-20T07:28:50.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-12T20:10:24.000Z (about 2 years ago)
- Last Synced: 2024-05-14T00:31:23.906Z (about 2 years ago)
- Topics: netbox, netbox-plugin, network-automation
- Language: Python
- Homepage:
- Size: 296 KB
- Stars: 53
- Watchers: 8
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# netbox-interface-sync
[Русская версия](./README_ru.md)
## Overview
This plugin allows you to compare and synchronize interfaces between devices and device types in NetBox. It can be useful for finding and correcting inconsistencies between interfaces.
Tested with NetBox versions 2.10, 2.11
## Installation
If your NetBox installation uses virtualenv, activate it like this:
```
source /opt/netbox/venv/bin/activate
```
Install the plugin from PyPI:
```
pip install netbox-interface-sync
```
or clone this repository, then go to the folder with it and install the plugin:
```
pip install .
```
To enable to plugin, add the plugin's name to the `PLUGINS` list in `configuration.py` (it's usually located in `/opt/netbox/netbox/netbox/`) like so:
```
PLUGINS = [
'netbox_interface_sync'
]
```
Don't forget to restart NetBox:
```
sudo systemctl restart netbox
```
## Usage
To compare the interfaces, open the page of the desired device and find the "Interface sync" button:
Mark the required actions with the checkboxes and click "Apply".
### Plugin settings
If you want to override the default values, configure the `PLUGINS_CONFIG` in your `configuration.py`:
```
PLUGINS_CONFIG = {
'netbox_interface_sync': {
'exclude_virtual_interfaces': True
}
}
```
| Setting | Default value | Description |
| --- | --- | --- |
| exclude_virtual_interfaces | `True` | Exclude virtual interfaces (VLANs, LAGs) from comparison