Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wvandeun/nornir_netbox
NetBox plugin for Nornir
https://github.com/wvandeun/nornir_netbox
netbox network-automation nornir
Last synced: 3 months ago
JSON representation
NetBox plugin for Nornir
- Host: GitHub
- URL: https://github.com/wvandeun/nornir_netbox
- Owner: wvandeun
- License: apache-2.0
- Created: 2020-04-11T09:17:29.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-07T07:25:07.000Z (6 months ago)
- Last Synced: 2024-05-07T08:33:07.157Z (6 months ago)
- Topics: netbox, network-automation, nornir
- Language: Python
- Homepage:
- Size: 345 KB
- Stars: 64
- Watchers: 6
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-netbox - wvandeun/nornir_netbox - NetBox plugin for Nornir (Integrations)
README
[](https://nornir-netbox.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/psf/black)
# nornir_netbox
[NetBox](https://github.com/netbox-community/netbox) plugin for [Nornir](https://github.com/nornir-automation/nornir)
The NetBox plugin exposes 2 inventory classes for usage.
- `NBInventory` is deprecated and should not be used anymore, it is still available for backwards compatibility only
- `NetBoxInventory2` is the recommended NetBox inventory plugin. It provides some extra functionality such as exposing all NetBox device attributes to the Nonir Host through the data attribute. It is the recommended plugin to use. All feature development will only take place on this plugin.
## Install
The recommended way to install nornir_netbox is via pip or poetry.
```bash
pip install nornir-netbox
```
```bash
poetry add nornir-netbox
```
## Example usage
### Using the Nornir configuration file
```yaml
---
inventory:
plugin: NBInventory
options:
nb_url: "https://netbox.local"
nb_token: "123_NETBOX_API_TOKEN_456"
```
```yaml
---
inventory:
plugin: NetBoxInventory2
options:
nb_url: "https://netbox.local"
nb_token: "123_NETBOX_API_TOKEN_456"
```
### Using the InitNornir function
```python
from nornir import InitNornir
nr = InitNornir(
inventory={
"plugin":"NBInventory",
"options": {
"nb_url": "https://netbox.local",
"nb_token": "123_NETBOX_API_TOKEN_456"
}
}
)
```
```python
from nornir import InitNornir
nr = InitNornir(
inventory={
"plugin":"NetBoxInventory2",
"options": {
"nb_url": "https://netbox.local",
"nb_token": "123_NETBOX_API_TOKEN_456"
}
}
)
```
### NBInventory arguments
```
Arguments:
nb_url: NetBox url, defaults to http://localhost:8080.
You can also use env variable NB_URL
nb_token: NetBox token. You can also use env variable NB_TOKEN
use_slugs: Whether to use slugs or not
ssl_verify: Enable/disable certificate validation or provide path to CA bundle file
flatten_custom_fields: Whether to assign custom fields directly to the host or not
filter_parameters: Key-value pairs to filter down hosts
```
### NetBoxInventory2 arguments
```
Environment Variables:
* ``NB_URL``: Corresponds to nb_url argument
* ``NB_TOKEN``: Corresponds to nb_token argument
Arguments:
nb_url: NetBox url (defaults to ``http://localhost:8080``)
nb_token: NetBox API token
ssl_verify: Enable/disable certificate validation or provide path to CA bundle file
(defaults to True)
flatten_custom_fields: Assign custom fields directly to the host's data attribute
(defaults to False)
filter_parameters: Key-value pairs that allow you to filter the NetBox inventory.
include_vms: Get virtual machines from NetBox as well as devices.
(defaults to False)
use_platform_slug: Use the NetBox platform slug for the platform attribute of a Host
(defaults to False)
use_platform_napalm_driver: Use the Netbox platform napalm driver setting for the platform attribute of a Host
(defaults to False)
group_file: path to file with groups definition. If it doesn't exist it will be skipped
defaults_file: path to file with defaults definition. If it doesn't exist it will be skipped
```
Only one of use_platform_slug and use_platform_napalm_driver can be set to true.
### Using SimpleInventory groups and defaults file
This feature allows you to use SimpleInventory groups and defaults file with NetBoxInventory2.
NetBoxInventory2 will automatically create groups for specific attributes of NetBox devices or virtual-machines.
The following attributes will be used to create groups:
- site
- platform
- device_role
- device_type
- manufacturer (extracted from device_type)
From these attributes we will use the slug property to create the group. Groups will be created using the following format `attribute__slug`.
For example, assume a device that is part of a site `Site 1` for which the slug is `site-1`. NetBoxInventory2 will create a group with the name `site__site-1` and add the device to the group.
These groups can then be used in a groups file and you can add data to them, similar to how the SimpleInventory plugin works.
More information on on the defaults and groups file can be found in [Nornir's documentation](https://nornir.readthedocs.io/en/latest/tutorial/inventory.html).
```python
from nornir import InitNornir
nr = InitNornir(
inventory={
"plugin":"NBInventory",
"options": {
"nb_url": "https://netbox.local",
"nb_token": "123_NETBOX_API_TOKEN_456",
"group_file": "inventory/groups.yml",
"defaults_file": "inventory/defaults.yml"
}
}
)
```
# Useful Links
- [nornir_netbox documentation](https://nornir-netbox.readthedocs.io)
- [Nornir](https://github.com/nornir-automation/nornir)
- [Nornir Discourse Group](https://nornir.discourse.group)
- [An Introduction to Nornir Blog](https://pynet.twb-tech.com/blog/nornir/intro.html)
- [NetBox](https://github.com/netbox-community/netbox.git)
- [NetBox documentation](https://netbox.readthedocs.io/)