Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/routetonull/nornir_ipfabric
IPFabric plugin for Nornir
https://github.com/routetonull/nornir_ipfabric
automation ipfabric nornir python
Last synced: about 2 months ago
JSON representation
IPFabric plugin for Nornir
- Host: GitHub
- URL: https://github.com/routetonull/nornir_ipfabric
- Owner: routetonull
- License: apache-2.0
- Created: 2020-11-05T16:52:07.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-07T05:33:27.000Z (about 1 year ago)
- Last Synced: 2024-07-19T06:34:19.991Z (2 months ago)
- Topics: automation, ipfabric, nornir, python
- Language: Python
- Homepage: https://pypi.org/project/nornir-ipfabric/
- Size: 16.6 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ipfabric-list - nornir-ipfabric
README
[](https://pypi.org/project/nornir-ipfabric/)
nornir_ipfabric
==============
[IPFabric](https://ipfabric.io/) Inventory plugin for [nornir](https://github.com/nornir-automation/nornir).
# Install
The recommended way to install nornir_ipfabric is via pip
```sh
pip install nornir-ipfabric
```
# Requirements
An instance of [IP Fabric](https://ipfabric.io/) is required to collect information. [Request trial license.](https://ipfabric.io/booking-trial/)
# Example usage
## Using env vars
Set environment vars to provide url and credentials to connect to the IP Fabric server
```sh
export IPF_URL=https://ipfabric.local
export IPF_USER=admin
export IPF_PASSWORD=mySecretPassword
```
If IP Fabric version 3.7 or above is in use, [token authentication](https://ipfabric.atlassian.net/wiki/spaces/ND/pages/1448575064/API+tokens) is available
```sh
export IPF_URL=https://ipfabric.local
export IPF_TOKEN=myToken
```
```python
from nornir import InitNornir
nr = InitNornir(inventory={"plugin": "IPFabricInventory"})
```
## Using the InitNornir function
Init with credentials
```python
from nornir import InitNornir
nr = InitNornir(
inventory=
{
"plugin": "IPFabricInventory",
"options": {
"ipf_url":"https://ipfabric.local",
"ipf_user":"admin",
"ipf_password":"mySecretPassword",
},
},
)
```
Init with token
```python
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
```yaml
---
inventory:
plugin: IPFInventory
options:
ipf_url: "https://ipfabric.local"
ipf_user: "admin"
ipf_password: "mySecretPassword"
```
File *config.yaml* with token
```yaml
---
inventory:
plugin: IPFInventory
options:
ipf_url: "https://ipfabric.local"
ipf_token: "myToken"
```
Usage:
```python
from nornir import InitNornir
nr = InitNornir(config_file="config.yaml",inventory={"plugin": "IPFabricInventory"})
```
# Useful Links
- [IP Fabric website](https://www.ipfabric.io)
- [IP Fabric channel on Slack ](https://networktocode.slack.com/)
- [Nornir](https://github.com/nornir-automation/nornir)
- [Nornir plugins page](https://nornir.tech/nornir/plugins/)
- [An Introduction to Nornir](https://pynet.twb-tech.com/blog/nornir/intro.html)