Netbox Get Nornir Inventory Task¤
task api name:
get_nornir_inventory
This task designed to provide Nornir workers with inventory data sourced from Netbox.
How it works
Netbox NorFab workers able to talk with Netbox GraphQL and REST API. Nornir workers can be configured to request Nornir inventory from Netbox workers on startup. Netbox workers in response to such a request will be fetching devices data from Netbox and constructing Nornir inventory returning it to Nornir worker.
-
On startup Nornir worker sends
get_nornir_inventory
request to Netbox NorFab Workers -
Netbox worker fetches devices data from netbox - hostnames, interfaces, ip addresses, circuits, connections, configuration contexts etc.
-
Netbox worker constructs Nornir inventory and sends it back to Nornir worker
Get Nornir Inventory Sample Usage¤
NORFAB Netbox Get Nornir Inventory Command Shell Reference¤
NorFab shell supports these command options for Netbox get_nornir_inventory
task:
Python API Reference¤
Retrieve and construct Nornir inventory from NetBox data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
job
|
Job
|
NorFab Job object containing relevant metadata |
required |
filters
|
list
|
List of filters to apply when retrieving devices from NetBox. |
None
|
devices
|
list
|
List of specific devices to retrieve from NetBox. |
None
|
instance
|
str
|
NetBox instance to use. |
None
|
interfaces
|
Union[dict, bool]
|
If True, include interfaces data in the inventory. If a dict, use it as arguments for the get_interfaces method. |
False
|
connections
|
Union[dict, bool]
|
If True, include connections data in the inventory. If a dict, use it as arguments for the get_connections method. |
False
|
circuits
|
Union[dict, bool]
|
If True, include circuits data in the inventory. If a dict, use it as arguments for the get_circuits method. |
False
|
nbdata
|
bool
|
If True, include a copy of NetBox device's data in the host's data. |
True
|
primary_ip
|
str
|
Specify whether to use 'ip4' or 'ip6' for the primary IP address. Defaults to 'ip4'. |
'ip4'
|
Returns:
Name | Type | Description |
---|---|---|
dict |
Result
|
Nornir inventory dictionary containing hosts and their respective data. |
Source code in norfab\workers\netbox_worker.py
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 |
|