first commit
This commit is contained in:
Vlastislav Svatek
259
docs/README.md
Normal file
259
docs/README.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# NetBox LibreNMS Plugin
|
||||
|
||||
### Intro
|
||||
|
||||
The NetBox LibreNMS Plugin enables integration between NetBox and LibreNMS, allowing you to leverage data from both systems. NetBox remains the Source of Truth (SoT) for you network, but this plugin allows you to easily onboard device objects from existing data in LibreNMS. The plugin does not automatically create objects in NetBox to ensure only verified data is used to populate NetBox.
|
||||
|
||||
## Features
|
||||
|
||||
The plugin offers the following key features:
|
||||
|
||||
### Device Import
|
||||
|
||||
Search and import devices from LibreNMS into NetBox with comprehensive validation and control:
|
||||
|
||||
* Filter devices by location, type, OS, hostname, system name, or hardware model
|
||||
* Validate import prerequisites (Site, Device Type, Device Role)
|
||||
* Smart matching for Sites, Device Types, and Platforms
|
||||
* Import as physical Devices or Virtual Machines
|
||||
* Bulk import multiple devices
|
||||
* Automatic Virtual Chassis creation for stackable switches
|
||||
* Background job processing for large device sets
|
||||
|
||||
See the [Device Import Guide](librenms_import/overview.md) for detailed usage instructions.
|
||||
|
||||
### Device Field Sync
|
||||
|
||||
Synchronize device information from LibreNMS to NetBox. The following device fields can be synchronized:
|
||||
|
||||
* Device Name (with naming preference support)
|
||||
* Serial Number (including virtual chassis members)
|
||||
* Device Type
|
||||
* Platform
|
||||
|
||||
### Interface Sync
|
||||
|
||||
Pull interface data from Devices and Virtual Machines from LibreNMS into NetBox. The following interface attributes are synchronized:
|
||||
|
||||
* Name
|
||||
* Description
|
||||
* Status (Enabled/Disabled)
|
||||
* Type (with [custom mapping support](usage_tips/interface_mappings.md))
|
||||
* Speed
|
||||
* MTU
|
||||
* MAC Address
|
||||
* VLAN (Tagged and untagged)
|
||||
|
||||
> Set custom mappings for interface types to ensure that the correct interface type is used when syncing from LibreNMS to NetBox.
|
||||
|
||||
### Cable Sync
|
||||
|
||||
Create cable connection in NetBox from LibreNMS links data.
|
||||
|
||||
### IP Address Sync
|
||||
|
||||
Create IP address in NetBox from LibreNMS device IP data.
|
||||
|
||||
### VLAN Sync
|
||||
- Create VLAN objects in NetBox from LibreNMS device VLAN data
|
||||
- Per-VLAN group assignment with scope-aware auto-selection
|
||||
|
||||
### Add device to LibreNMS from Netbox
|
||||
|
||||
* Add device to LibreNMS from Netbox device page. SNMP v2c and v3 are supported.
|
||||
|
||||
### Site & Location Sync
|
||||
|
||||
The plugin also supports synchronizing NetBox Sites with LibreNMS locations:
|
||||
|
||||
* Compare NetBox sites to LibreNMS location data
|
||||
* Create LibreNMS locations to match NetBox sites
|
||||
* Update existing LibreNMS locations latitude and longitude values based on NetBox data ⚠️ *(currently not working due to LibreNMS API issue)*
|
||||
* Sync device site to LibreNMS location
|
||||
|
||||
### Screenshots/GIFs
|
||||
|
||||
> Screenshots from older plugin version
|
||||
|
||||
#### Site & Location Sync
|
||||
|
||||
|
||||
|
||||
#### Sync devices and Interfaces
|
||||
|
||||
|
||||
|
||||
#### Virtual Chassis Member Select
|
||||
|
||||
|
||||
|
||||
#### Interface Type Mappings
|
||||
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
There's more to do! Coding is not my day job so bugs will exist and improvements will be needed. Contributions are very welcome! I've got more ideas for new features and improvements but please [contribute](contributing.md) if you can!
|
||||
|
||||
Or just share your ideas for the plugin over in [discussions](https://github.com/bonzo81/netbox-librenms-plugin/discussions).
|
||||
|
||||
## Compatibility
|
||||
|
||||
| NetBox Version | Plugin Version |
|
||||
| -------------- | -------------- |
|
||||
| 4.1 | 0.2.x - 0.3.5 |
|
||||
| 4.2 - 4.5 | 0.3.6+ |
|
||||
|
||||
|
||||
## Installing
|
||||
|
||||
### Standard Installation
|
||||
|
||||
Activate your virtual environment and install the plugin:
|
||||
|
||||
```bash
|
||||
source /opt/netbox/venv/bin/activate
|
||||
```
|
||||
|
||||
Install with pip:
|
||||
|
||||
```bash
|
||||
(venv) $ pip install netbox-librenms-plugin
|
||||
```
|
||||
|
||||
Add to your `local_requirements.txt` to ensure it is automatically reinstalled during future upgrades.
|
||||
|
||||
```bash
|
||||
echo "netbox-librenms-plugin" >> /opt/netbox/local_requirements.txt #Check your NetBox install location
|
||||
```
|
||||
|
||||
### Docker
|
||||
|
||||
For adding to a NetBox Docker setup see how to create a custom Docker image. [the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
|
||||
|
||||
Add the plugin to `plugin_requirements.txt` (netbox-docker):
|
||||
|
||||
```bash
|
||||
# plugin_requirements.txt
|
||||
netbox-librenms-plugin
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
### 1. Enable the Plugin
|
||||
|
||||
Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`, or if you use netbox-docker, your `/configuration/plugins.py` file :
|
||||
|
||||
```python
|
||||
PLUGINS = [
|
||||
'netbox_librenms_plugin'
|
||||
]
|
||||
```
|
||||
|
||||
### 2. Apply the plugin configuration
|
||||
|
||||
Multi server example:
|
||||
|
||||
```python
|
||||
PLUGINS_CONFIG = {
|
||||
'netbox_librenms_plugin': {
|
||||
'servers': {
|
||||
'production': {
|
||||
'display_name': 'Production LibreNMS',
|
||||
'librenms_url': 'https://librenms-prod.example.com',
|
||||
'api_token': 'your_production_token',
|
||||
'cache_timeout': 300,
|
||||
'verify_ssl': True,
|
||||
'interface_name_field': 'ifDescr'
|
||||
},
|
||||
'testing': {
|
||||
'display_name': 'Test LibreNMS',
|
||||
'librenms_url': 'https://librenms-test.example.com',
|
||||
'api_token': 'your_test_token',
|
||||
'cache_timeout': 300,
|
||||
'verify_ssl': False,
|
||||
'interface_name_field': 'ifName'
|
||||
},
|
||||
'development': {
|
||||
'display_name': 'Dev LibreNMS',
|
||||
'librenms_url': 'https://librenms-dev.example.com',
|
||||
'api_token': 'your_dev_token',
|
||||
'cache_timeout': 180,
|
||||
'verify_ssl': False,
|
||||
'interface_name_field': 'ifDescr'
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Or use the original single server confiig example:
|
||||
|
||||
```python
|
||||
PLUGINS_CONFIG = {
|
||||
'netbox_librenms_plugin': {
|
||||
'librenms_url': 'https://your-librenms-instance.com',
|
||||
'api_token': 'your_librenms_api_token',
|
||||
'cache_timeout': 300,
|
||||
'verify_ssl': True, # Optional: Change to False if needed,
|
||||
'interface_name_field': 'ifDescr', # Optional: LibreNMS field used for interface name. ifName used as default
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Apply Database Migrations
|
||||
|
||||
Apply database migrations with Netbox `manage.py`:
|
||||
|
||||
```
|
||||
(venv) $ python manage.py migrate
|
||||
```
|
||||
|
||||
### 4. Collect Static Files
|
||||
|
||||
The plugin includes static files that need to be collected by NetBox. Run the following command to collect static files:
|
||||
|
||||
```
|
||||
(venv) $ python manage.py collectstatic --no-input
|
||||
```
|
||||
|
||||
### 5. Restart Netbox
|
||||
|
||||
Restart the Netbox service to apply changes:
|
||||
|
||||
```
|
||||
sudo systemctl restart netbox
|
||||
```
|
||||
|
||||
### 6. Custom Field
|
||||
|
||||
As of version 0.4.4, the plugin **automatically creates** the `librenms_id` custom field (JSON type) when migrations are run. No manual setup is required.
|
||||
|
||||
The field is created for Device, Virtual Machine, Interface, and VM Interface objects and stores a per-server mapping (e.g., `{"production": 42}`).
|
||||
|
||||
For more info check out [custom field docs](usage_tips/custom_field.md)
|
||||
|
||||
## Update
|
||||
|
||||
```
|
||||
source /opt/netbox/venv/bin/activate
|
||||
pip install -U netbox-librenms-plugin
|
||||
python manage.py migrate
|
||||
python manage.py collectstatic --no-input
|
||||
systemctl restart netbox
|
||||
```
|
||||
|
||||
|
||||
## Uninstall
|
||||
|
||||
See [the instructions for uninstalling plugins](https://netboxlabs.com/docs/netbox/en/stable/plugins/removal/).
|
||||
|
||||
## Credits
|
||||
|
||||
Based on the NetBox plugin tutorial and docs:
|
||||
|
||||
* [demo repository](https://github.com/netbox-community/netbox-plugin-demo)
|
||||
* [tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)
|
||||
* [docs](https://netboxlabs.com/docs/netbox/en/stable/plugins/development/)
|
||||
|
||||
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter). Thanks to the [`netbox-community/cookiecutter-netbox-plugin`](https://github.com/netbox-community/cookiecutter-netbox-plugin) for the project template.
|
||||
Reference in New Issue
Block a user