Utility to return a dictionary of napalm getters based on install napalm version.
Returns:
| Type |
Description |
Dict[str, Dict[str, bool]]
|
Keys are OS and values are a dictionary of supported napalm getters.
|
Raises:
| Type |
Description |
ImportError
|
If optional dependency Napalm is not installed.
|
Examples:
>>> from netutils.lib_helpers import get_napalm_getters
>>> napalm_getters = get_napalm_getters()
>>> napalm_getters["eos"]["get_arp_table"]
>>> True
>>> napalm_getters["eos"]["get_ipv6_neighbors_table"]
>>> False
Source code in netutils/lib_helpers.py
| def get_napalm_getters() -> t.Dict[str, t.Dict[str, bool]]:
"""Utility to return a dictionary of napalm getters based on install napalm version.
Returns:
Keys are OS and values are a dictionary of supported napalm getters.
Raises:
ImportError: If optional dependency Napalm is not installed.
Examples:
>>> from netutils.lib_helpers import get_napalm_getters
>>> napalm_getters = get_napalm_getters() # doctest: +SKIP
>>> napalm_getters["eos"]["get_arp_table"] # doctest: +SKIP
>>> True # doctest: +SKIP
>>> napalm_getters["eos"]["get_ipv6_neighbors_table"] # doctest: +SKIP
>>> False # doctest: +SKIP
"""
if not HAS_NAPALM:
raise ImportError("Napalm must be install for this function to operate.")
napalm_dict: t.Dict[str, t.Dict[str, bool]] = {}
oses = NAPALM_LIB_MAPPER.keys()
for my_os in oses:
try:
get_network_driver(my_os)
except ModuleImportError:
continue
napalm_dict[my_os] = {}
for getter in inspect.getmembers(get_network_driver(my_os), predicate=inspect.isfunction):
if getter[0].startswith("get_"):
# If the module is only in the base class it has not been implemented by the child class.
state = bool(getter[1].__module__ == "napalm.base.base")
napalm_dict[my_os][getter[0]] = state
return napalm_dict
|