Metadata-Version: 2.1
Name: netbox4_interface_sync
Version: 4.0.1
Summary: Syncing Device Interfaces with the Interfaces from Device Type for NetBox 4
Author-email: Keith Knowles <mkknowles@outlook.com>
Project-URL: Homepage, https://github.com/NetTech2001/netbox4-interface-sync
Project-URL: Issues, https://github.com/NetTech2001/netbox4-interface-sync/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE

# netbox4-interface-sync
## Overview
This plugin allows you to compare and synchronize interfaces between devices and device types in NetBox 4. It can be useful for finding and correcting inconsistencies between interfaces.
## Compatibility
Tested with NetBox versions 4.0.0, 4.0.1, 4.0.2.  This plugin is not compatible with Netbox 2 or 3
## Installation
If your NetBox 4 installation uses virtualenv, activate it like this:
```
source /opt/netbox/venv/bin/activate
```
Install the plugin from PyPI:
```
pip install netbox4-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 = [
    'netbox4_interface_sync'
]
```
Don't forget to restart NetBox:
```
sudo systemctl restart netbox
```
### Plugin Settings
If you want to override the default values, configure the `PLUGINS_CONFIG` in your `configuration.py`:
```
PLUGINS_CONFIG = {
    'netbox4_interface_sync': {
        'exclude_virtual_interfaces': True
    }
}
```
| Setting | Default value | Description |
| --- | --- | --- |
| exclude_virtual_interfaces | `True` | Exclude virtual interfaces (VLANs, LAGs) from comparison

