nornir_ipfabric
IPFabric Inventory plugin for nornir.
Install
The recommended way to install nornir_ipfabric is via pip
pip install nornir-ipfabricRequirements
An instance of IP Fabric is required to collect information. Request trial license.
Example usage
Using env vars
Set environment vars to provide url and credentials to connect to the IP Fabric server
export IPF_URL=https://ipfabric.local
export IPF_USER=admin
export IPF_PASSWORD=mySecretPasswordIf IP Fabric version 3.7 or above is in use, token authentication is available
export IPF_URL=https://ipfabric.local
export IPF_TOKEN=myTokenfrom nornir import InitNornir
nr = InitNornir(inventory={"plugin": "IPFabricInventory"})Using the InitNornir function
Init with credentials
from nornir import InitNornir
nr = InitNornir(
inventory=
{
"plugin": "IPFabricInventory",
"options": {
"ipf_url":"https://ipfabric.local",
"ipf_user":"admin",
"ipf_password":"mySecretPassword",
},
},
)Init with token
from nornir import InitNornir
nr = InitNornir(
inventory=
{
"plugin": "IPFabricInventory",
"options": {
"ipf_url":"https://ipfabric.local",
"ipf_token":"myToken",
},
},
)Using the Nornir configuration file
File config.yaml with credendials
---
inventory:
plugin: IPFInventory
options:
ipf_url: "https://ipfabric.local"
ipf_user: "admin"
ipf_password: "mySecretPassword"File config.yaml with token
---
inventory:
plugin: IPFInventory
options:
ipf_url: "https://ipfabric.local"
ipf_token: "myToken"Usage:
from nornir import InitNornir
nr = InitNornir(config_file="config.yaml",inventory={"plugin": "IPFabricInventory"})
