Netbox Update Device Interfaces Task¤
task api name:
update_device_interfaces
The Netbox Update Device Interfaces Task is a feature of the NorFab Netbox Service that allows you to synchronize and update the interface data of your network devices in Netbox. This task ensures that the interface configurations in Netbox are accurate and up-to-date, reflecting the current state of your network infrastructure.
Keeping interface data accurate and up-to-date is crucial for effective network management. The Netbox Update Device Interfaces Task automates the process of updating interface information, such as interface names, statuses, mac addresses, and other relevant details.
How it works - Netbox worker on a call to update interfaces task fetches live data from network devices using nominated datasource, by default it is Nornir service parse task using NAPALM get_interfaces
getter. Once data retrieved from network, Netbox worker updates records in Netbox database for device interfaces.
-
Client submits and on-demand request to NorFab Netbox worker to update device interfaces
-
Netbox worker sends job request to nominated datasource service to fetch live data from network devices
-
Datasource service fetches data from the network
-
Datasource returns devices interfaces data back to Netbox Service worker
-
Netbox worker processes device interfaces data and updates records in Netbox for requested devices
Limitations¤
Datasource nornir
uses NAPALM get_interfaces
getter and as such only supports these device platforms:
- Arista EOS
- Cisco IOS
- Cisco IOSXR
- Cisco NXOS
- Juniper JUNOS
Update Device Interfaces Sample Usage¤
NORFAB Netbox Update Device Interfaces Command Shell Reference¤
NorFab shell supports these command options for Netbox update_device_interfaces
task:
nf# man tree netbox.update.device.interfaces
root
└── netbox: Netbox service
└── update: Update Netbox data
└── device: Update device data
└── interfaces: Update device interfaces
├── timeout: Job timeout
├── workers: Filter workers to target, default 'any'
├── instance: Netbox instance name to target
├── dry_run: Return information that would be pushed to Netbox but do not push it
├── devices: Devices to update
└── datasource: Service to use to retrieve device data, default 'nornir'
└── nornir: Use Nornir service to retrieve data from devices
├── add_details: Add task details to results, default 'False'
├── run_num_workers: RetryRunner number of threads for tasks execution
├── run_num_connectors: RetryRunner number of threads for device connections
├── run_connect_retry: RetryRunner number of connection attempts
├── run_task_retry: RetryRunner number of attempts to run task
├── run_reconnect_on_fail: RetryRunner perform reconnect to host on task failure
├── run_connect_check: RetryRunner test TCP connection before opening actual connection
├── run_connect_timeout: RetryRunner timeout in seconds to wait for test TCP connection to establish
├── run_creds_retry: RetryRunner list of connection credentials and parameters to retry
├── tf: File group name to save task results to on worker file system
├── tf_skip_failed: Save results to file for failed tasks
├── diff: File group name to run the diff for
├── diff_last: File version number to diff, default is 1 (last)
└── progress: Display progress events, default 'True'
nf#
Python API Reference¤
Update or create device interfaces in Netbox. Interface parameters updated:
- interface name
- interface description
- mtu
- mac address
- admin status
- speed
Parameters:
Name | Type | Description | Default |
---|---|---|---|
job
|
Job
|
NorFab Job object containing relevant metadata |
required |
instance
|
str
|
The instance name to use. |
None
|
dry_run
|
bool
|
If True, no changes will be made to Netbox. |
False
|
datasource
|
str
|
The data source to use. Supported datasources:
|
'nornir'
|
timeout
|
int
|
The timeout for the job. |
60
|
devices
|
list
|
List of devices to update. |
None
|
create
|
bool
|
If True, new interfaces will be created if they do not exist. |
True
|
batch_size
|
int
|
The number of devices to process in each batch. |
10
|
**kwargs
|
Additional keyword arguments to pass to the datasource job. |
{}
|
Returns:
Name | Type | Description |
---|---|---|
dict |
Result
|
A dictionary containing the results of the update operation. |
Raises:
Type | Description |
---|---|
Exception
|
If a device does not exist in Netbox. |
UnsupportedServiceError
|
If the specified datasource is not supported. |
Source code in norfab\workers\netbox_worker.py
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 |
|