mirror of
https://github.com/TheNetworkGuy/netbox-zabbix-sync.git
synced 2025-07-14 01:41:25 -06:00
Cleaning up code
This commit is contained in:
Raymond Kuiper
parent
173fdbf19f
commit
de8143e89f
25
.github/actions/quality.yml
vendored
Normal file
25
.github/actions/quality.yml
vendored
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
name: Pylint
|
||||
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
python-version: ["3.8", "3.9", "3.10"]
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v3
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install pylint
|
||||
pip install -r requirements.txt
|
||||
- name: Analysing the code with pylint
|
||||
run: |
|
||||
pylint $(git ls-files '*.py')
|
||||
@ -1,10 +1,10 @@
|
||||
#!/usr/bin/python3
|
||||
#!/usr/bin/env python3
|
||||
"""Netbox to Zabbix sync script."""
|
||||
|
||||
from os import environ, path, sys
|
||||
from packaging import version
|
||||
import logging
|
||||
import argparse
|
||||
from os import environ, path, sys
|
||||
from packaging import version
|
||||
from pynetbox import api
|
||||
from pyzabbix import ZabbixAPI, ZabbixAPIException
|
||||
try:
|
||||
@ -19,9 +19,8 @@ try:
|
||||
hostgroup_format,
|
||||
nb_device_filter
|
||||
)
|
||||
|
||||
except ModuleNotFoundError:
|
||||
print(f"Configuration file config.py not found in main directory."
|
||||
print("Configuration file config.py not found in main directory."
|
||||
"Please create the file or rename the config.py.example file to config.py.")
|
||||
sys.exit(0)
|
||||
|
||||
@ -46,7 +45,7 @@ logger.setLevel(logging.WARNING)
|
||||
def main(arguments):
|
||||
"""Run the sync process."""
|
||||
# set environment variables
|
||||
if(arguments.verbose):
|
||||
if arguments.verbose:
|
||||
logger.setLevel(logging.DEBUG)
|
||||
env_vars = ["ZABBIX_HOST", "NETBOX_HOST", "NETBOX_TOKEN"]
|
||||
if "ZABBIX_TOKEN" in environ:
|
||||
@ -61,10 +60,13 @@ def main(arguments):
|
||||
raise EnvironmentVarError(e)
|
||||
# Get all virtual environment variables
|
||||
if "ZABBIX_TOKEN" in env_vars:
|
||||
zabbix_user = None
|
||||
zabbix_pass = None
|
||||
zabbix_token = environ.get("ZABBIX_TOKEN")
|
||||
else:
|
||||
zabbix_user = environ.get("ZABBIX_USER")
|
||||
zabbix_pass = environ.get("ZABBIX_PASS")
|
||||
zabbix_token = None
|
||||
zabbix_host = environ.get("ZABBIX_HOST")
|
||||
netbox_host = environ.get("NETBOX_HOST")
|
||||
netbox_token = environ.get("NETBOX_TOKEN")
|
||||
@ -78,9 +80,9 @@ def main(arguments):
|
||||
device_cfs = netbox.extras.custom_fields.filter(type="text", content_type_id=23)
|
||||
for cf in device_cfs:
|
||||
allowed_objects.append(cf.name)
|
||||
for object in hg_objects:
|
||||
if(object not in allowed_objects):
|
||||
e = (f"Hostgroup item {object} is not valid. Make sure you"
|
||||
for hg_object in hg_objects:
|
||||
if hg_object not in allowed_objects:
|
||||
e = (f"Hostgroup item {hg_object} is not valid. Make sure you"
|
||||
" use valid items and seperate them with '/'.")
|
||||
logger.error(e)
|
||||
raise HostgroupError(e)
|
||||
@ -90,7 +92,7 @@ def main(arguments):
|
||||
if "ZABBIX_TOKEN" in env_vars:
|
||||
zabbix.login(api_token=zabbix_token)
|
||||
else:
|
||||
m=(f"Logging in with Zabbix user and password,"
|
||||
m=("Logging in with Zabbix user and password,"
|
||||
" consider using an API token instead.")
|
||||
logger.warning(m)
|
||||
zabbix.login(zabbix_user, zabbix_pass)
|
||||
@ -123,9 +125,9 @@ def main(arguments):
|
||||
device.set_template(templates_config_context, templates_config_context_overrule)
|
||||
# Checks if device is part of cluster.
|
||||
# Requires clustering variable
|
||||
if(device.isCluster() and clustering):
|
||||
if device.isCluster() and clustering:
|
||||
# Check if device is master or slave
|
||||
if(device.promoteMasterDevice()):
|
||||
if device.promoteMasterDevice():
|
||||
e = (f"Device {device.name} is "
|
||||
f"part of cluster and primary.")
|
||||
logger.info(e)
|
||||
@ -137,8 +139,8 @@ def main(arguments):
|
||||
logger.info(e)
|
||||
continue
|
||||
# Checks if device is in cleanup state
|
||||
if(device.status in zabbix_device_removal):
|
||||
if(device.zabbix_id):
|
||||
if device.status in zabbix_device_removal:
|
||||
if device.zabbix_id:
|
||||
# Delete device from Zabbix
|
||||
# and remove hostID from Netbox.
|
||||
device.cleanup()
|
||||
@ -149,22 +151,23 @@ def main(arguments):
|
||||
# but is not in Activate state
|
||||
logger.info(f"Skipping host {device.name} since its "
|
||||
f"not in the active state.")
|
||||
continue
|
||||
elif(device.status in zabbix_device_disable):
|
||||
elif device.status in zabbix_device_disable:
|
||||
device.zabbix_state = 1
|
||||
else:
|
||||
device.zabbix_state = 0
|
||||
# Add hostgroup is variable is True
|
||||
# and Hostgroup is not present in Zabbix
|
||||
if(create_hostgroups):
|
||||
if create_hostgroups:
|
||||
for group in zabbix_groups:
|
||||
# If hostgroup is already present in Zabbix
|
||||
if(group["name"] == device.hostgroup):
|
||||
if group["name"] == device.hostgroup:
|
||||
break
|
||||
else:
|
||||
# Create new hostgroup
|
||||
hostgroup = device.createZabbixHostgroup()
|
||||
zabbix_groups.append(hostgroup)
|
||||
# Device is already present in Zabbix
|
||||
if(device.zabbix_id):
|
||||
if device.zabbix_id:
|
||||
device.ConsistencyCheck(zabbix_groups, zabbix_templates,
|
||||
zabbix_proxies, full_proxy_sync)
|
||||
# Add device to Zabbix
|
||||
@ -176,41 +179,33 @@ def main(arguments):
|
||||
|
||||
|
||||
class SyncError(Exception):
|
||||
pass
|
||||
|
||||
""" Class SyncError """
|
||||
|
||||
class SyncExternalError(SyncError):
|
||||
pass
|
||||
|
||||
""" Class SyncExternalError """
|
||||
|
||||
class SyncInventoryError(SyncError):
|
||||
pass
|
||||
|
||||
""" Class SyncInventoryError """
|
||||
|
||||
class SyncDuplicateError(SyncError):
|
||||
pass
|
||||
|
||||
""" Class SyncDuplicateError """
|
||||
|
||||
class EnvironmentVarError(SyncError):
|
||||
pass
|
||||
|
||||
""" Class EnvironmentVarError """
|
||||
|
||||
class InterfaceConfigError(SyncError):
|
||||
pass
|
||||
|
||||
""" Class InterfaceConfigError """
|
||||
|
||||
class ProxyConfigError(SyncError):
|
||||
pass
|
||||
|
||||
""" Class ProxyConfigError """
|
||||
|
||||
class HostgroupError(SyncError):
|
||||
pass
|
||||
""" Class HostgroupError """
|
||||
|
||||
class TemplateError(SyncError):
|
||||
pass
|
||||
""" Class TemplateError """
|
||||
|
||||
class NetworkDevice():
|
||||
|
||||
"""
|
||||
Represents Network device.
|
||||
INPUT: (Netbox device class, ZabbixAPI class, journal flag, NB journal class)
|
||||
@ -222,6 +217,11 @@ class NetworkDevice():
|
||||
self.name = nb.name
|
||||
self.status = nb.status.label
|
||||
self.zabbix = zabbix
|
||||
self.zabbix_id = None
|
||||
self.group_id = None
|
||||
self.zbx_template_names = []
|
||||
self.zbx_templates = []
|
||||
self.hostgroup = None
|
||||
self.tenant = nb.tenant
|
||||
self.config_context = nb.config_context
|
||||
self.zbxproxy = "0"
|
||||
@ -235,7 +235,7 @@ class NetworkDevice():
|
||||
Sets basic information like IP address.
|
||||
"""
|
||||
# Return error if device does not have primary IP.
|
||||
if(self.nb.primary_ip):
|
||||
if self.nb.primary_ip:
|
||||
self.cidr = self.nb.primary_ip.address
|
||||
self.ip = self.cidr.split("/")[0]
|
||||
else:
|
||||
@ -244,14 +244,14 @@ class NetworkDevice():
|
||||
raise SyncInventoryError(e)
|
||||
|
||||
# Check if device has custom field for ZBX ID
|
||||
if(device_cf in self.nb.custom_fields):
|
||||
if device_cf in self.nb.custom_fields:
|
||||
self.zabbix_id = self.nb.custom_fields[device_cf]
|
||||
else:
|
||||
e = f"Custom field {device_cf} not found for {self.name}."
|
||||
logger.warning(e)
|
||||
raise SyncInventoryError(e)
|
||||
|
||||
def set_hostgroup(self, format):
|
||||
def set_hostgroup(self, hg_format):
|
||||
"""Set the hostgroup for this device"""
|
||||
# Get all variables from the NB data
|
||||
dev_location = str(self.nb.location) if self.nb.location else None
|
||||
@ -268,17 +268,17 @@ class NetworkDevice():
|
||||
"site": site, "site_group": site_group,
|
||||
"tenant": tenant, "tenant_group": tenant_group}
|
||||
# Generate list based off string input format
|
||||
hg_items = format.split("/")
|
||||
hg_items = hg_format.split("/")
|
||||
hostgroup = ""
|
||||
# Go through all hostgroup items
|
||||
for item in hg_items:
|
||||
# Check if the variable (such as Tenant) is empty.
|
||||
if(not hostgroup_vars[item]):
|
||||
if not hostgroup_vars[item]:
|
||||
continue
|
||||
# Check if the item is a custom field name
|
||||
if(item not in hostgroup_vars):
|
||||
if item not in hostgroup_vars:
|
||||
cf_value = self.nb.custom_fields[item] if item in self.nb.custom_fields else None
|
||||
if(cf_value):
|
||||
if cf_value:
|
||||
# If there is a cf match, add the value of this cf to the hostgroup
|
||||
hostgroup += cf_value + "/"
|
||||
# Should there not be a match, this means that
|
||||
@ -287,7 +287,7 @@ class NetworkDevice():
|
||||
# Add value of predefined variable to hostgroup format
|
||||
hostgroup += hostgroup_vars[item] + "/"
|
||||
# If the final hostgroup variable is empty
|
||||
if(not hostgroup):
|
||||
if not hostgroup:
|
||||
e = (f"{self.name} has no reliable hostgroup. This is"
|
||||
"most likely due to the use of custom fields that are empty.")
|
||||
logger.error(e)
|
||||
@ -296,6 +296,7 @@ class NetworkDevice():
|
||||
self.hostgroup = hostgroup.rstrip("/")
|
||||
|
||||
def set_template(self, prefer_config_context, overrule_custom):
|
||||
""" Set Template """
|
||||
self.zbx_template_names = None
|
||||
# Gather templates ONLY from the device specific context
|
||||
if prefer_config_context:
|
||||
@ -319,27 +320,26 @@ class NetworkDevice():
|
||||
return True
|
||||
|
||||
def get_templates_cf(self):
|
||||
""" Get template from custom field """
|
||||
# Get Zabbix templates from the device type
|
||||
device_type_cfs = self.nb.device_type.custom_fields
|
||||
# Check if the ZBX Template CF is present
|
||||
if(template_cf in device_type_cfs):
|
||||
if template_cf in device_type_cfs:
|
||||
# Set value to template
|
||||
return [device_type_cfs[template_cf]]
|
||||
else:
|
||||
# Custom field not found, return error
|
||||
e = (f"Custom field {template_cf} not "
|
||||
f"found for {self.nb.device_type.manufacturer.name}"
|
||||
f" - {self.nb.device_type.display}.")
|
||||
|
||||
raise TemplateError(e)
|
||||
|
||||
def get_templates_context(self):
|
||||
# Get Zabbix templates from the device context
|
||||
if("zabbix" not in self.config_context):
|
||||
""" Get Zabbix templates from the device context """
|
||||
if "zabbix" not in self.config_context:
|
||||
e = ("Key 'zabbix' not found in config "
|
||||
f"context for template host {self.name}")
|
||||
raise TemplateError(e)
|
||||
if("templates" not in self.config_context["zabbix"]):
|
||||
if "templates" not in self.config_context["zabbix"]:
|
||||
e = ("Key 'zabbix' not found in config "
|
||||
f"context for template host {self.name}")
|
||||
raise TemplateError(e)
|
||||
@ -349,21 +349,18 @@ class NetworkDevice():
|
||||
"""
|
||||
Checks if device is part of cluster.
|
||||
"""
|
||||
if(self.nb.virtual_chassis):
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
return bool(self.nb.virtual_chassis)
|
||||
|
||||
def getClusterMaster(self):
|
||||
"""
|
||||
Returns chassis master ID.
|
||||
"""
|
||||
if(not self.isCluster()):
|
||||
if not self.isCluster():
|
||||
e = (f"Unable to proces {self.name} for cluster calculation: "
|
||||
f"not part of a cluster.")
|
||||
logger.warning(e)
|
||||
raise SyncInventoryError(e)
|
||||
elif(not self.nb.virtual_chassis.master):
|
||||
elif not self.nb.virtual_chassis.master:
|
||||
e = (f"{self.name} is part of a Netbox virtual chassis which does "
|
||||
"not have a master configured. Skipping for this reason.")
|
||||
logger.error(e)
|
||||
@ -378,14 +375,12 @@ class NetworkDevice():
|
||||
Returns True if succesfull, returns False if device is secondary.
|
||||
"""
|
||||
masterid = self.getClusterMaster()
|
||||
if(masterid == self.id):
|
||||
if masterid == self.id:
|
||||
logger.debug(f"Device {self.name} is primary cluster member. "
|
||||
f"Modifying hostname from {self.name} to " +
|
||||
f"{self.nb.virtual_chassis.name}.")
|
||||
self.name = self.nb.virtual_chassis.name
|
||||
|
||||
return True
|
||||
else:
|
||||
logger.debug(f"Device {self.name} is non-primary cluster member.")
|
||||
return False
|
||||
|
||||
@ -396,8 +391,8 @@ class NetworkDevice():
|
||||
OUTPUT: True
|
||||
"""
|
||||
# Check if there are templates defined
|
||||
if(not self.zbx_template_names):
|
||||
e = (f"No templates found for device {self.name}")
|
||||
if not self.zbx_template_names:
|
||||
e = f"No templates found for device {self.name}"
|
||||
logger.info(e)
|
||||
raise SyncInventoryError()
|
||||
# Set variable to empty list
|
||||
@ -408,7 +403,7 @@ class NetworkDevice():
|
||||
# Go through all templates found in Zabbix
|
||||
for zbx_template in templates:
|
||||
# If the template names match
|
||||
if(zbx_template['name'] == nb_template):
|
||||
if zbx_template['name'] == nb_template:
|
||||
# Set match variable to true, add template details
|
||||
# to class variable and return debug log
|
||||
template_match = True
|
||||
@ -418,7 +413,7 @@ class NetworkDevice():
|
||||
f" for host {self.name}.")
|
||||
logger.debug(e)
|
||||
# Return error should the template not be found in Zabbix
|
||||
if(not template_match):
|
||||
if not template_match:
|
||||
e = (f"Unable to find template {nb_template} "
|
||||
f"for host {self.name} in Zabbix. Skipping host...")
|
||||
logger.warning(e)
|
||||
@ -432,9 +427,9 @@ class NetworkDevice():
|
||||
"""
|
||||
# Go through all groups
|
||||
for group in groups:
|
||||
if(group['name'] == self.hostgroup):
|
||||
if group['name'] == self.hostgroup:
|
||||
self.group_id = group['groupid']
|
||||
e = (f"Found group {group['name']} for host {self.name}.")
|
||||
e = f"Found group {group['name']} for host {self.name}."
|
||||
logger.debug(e)
|
||||
return True
|
||||
else:
|
||||
@ -448,7 +443,7 @@ class NetworkDevice():
|
||||
Removes device from external resources.
|
||||
Resets custom fields in Netbox.
|
||||
"""
|
||||
if(self.zabbix_id):
|
||||
if self.zabbix_id:
|
||||
try:
|
||||
self.zabbix.host.delete(self.zabbix_id)
|
||||
self.nb.custom_fields[device_cf] = None
|
||||
@ -466,10 +461,7 @@ class NetworkDevice():
|
||||
Checks if hostname exists in Zabbix.
|
||||
"""
|
||||
host = self.zabbix.host.get(filter={'name': self.name}, output=[])
|
||||
if(host):
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
return bool(host)
|
||||
|
||||
def setInterfaceDetails(self):
|
||||
"""
|
||||
@ -481,9 +473,9 @@ class NetworkDevice():
|
||||
interface = ZabbixInterface(self.nb.config_context, self.ip)
|
||||
# Check if Netbox has device context.
|
||||
# If not fall back to old config.
|
||||
if(interface.get_context()):
|
||||
if interface.get_context():
|
||||
# If device is SNMP type, add aditional information.
|
||||
if(interface.interface["type"] == 2):
|
||||
if interface.interface["type"] == 2:
|
||||
interface.set_snmp()
|
||||
else:
|
||||
interface.set_default()
|
||||
@ -494,21 +486,22 @@ class NetworkDevice():
|
||||
raise SyncInventoryError(e)
|
||||
|
||||
def setProxy(self, proxy_list):
|
||||
# check if Zabbix Proxy has been defined in config context
|
||||
if("zabbix" in self.nb.config_context):
|
||||
if("proxy" in self.nb.config_context["zabbix"]):
|
||||
""" check if Zabbix Proxy has been defined in config context """
|
||||
if "zabbix" in self.nb.config_context:
|
||||
if "proxy" in self.nb.config_context["zabbix"]:
|
||||
proxy = self.nb.config_context["zabbix"]["proxy"]
|
||||
# Try matching proxy
|
||||
for px in proxy_list:
|
||||
if(px["name"] == proxy):
|
||||
if px["name"] == proxy:
|
||||
self.zbxproxy = px["proxyid"]
|
||||
logger.debug(f"Found proxy {proxy}"
|
||||
f" for {self.name}.")
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
e = f"{self.name}: Defined proxy {proxy} not found."
|
||||
logger.warning(e)
|
||||
return False
|
||||
return False
|
||||
|
||||
def createInZabbix(self, groups, templates, proxies,
|
||||
description="Host added by Netbox sync script."):
|
||||
@ -516,9 +509,9 @@ class NetworkDevice():
|
||||
Creates Zabbix host object with parameters from Netbox object.
|
||||
"""
|
||||
# Check if hostname is already present in Zabbix
|
||||
if(not self._zabbixHostnameExists()):
|
||||
if not self._zabbixHostnameExists():
|
||||
# Get group and template ID's for host
|
||||
if(not self.getZabbixGroup(groups)):
|
||||
if not self.getZabbixGroup(groups):
|
||||
raise SyncInventoryError()
|
||||
self.zbxTemplatePrepper(templates)
|
||||
templateids = []
|
||||
@ -575,7 +568,7 @@ class NetworkDevice():
|
||||
except ZabbixAPIException as e:
|
||||
e = f"Couldn't add hostgroup, Zabbix returned {str(e)}."
|
||||
logger.error(e)
|
||||
raise SyncExternalError(e)
|
||||
raise SyncExternalError(e) from e
|
||||
|
||||
def updateZabbixHost(self, **kwargs):
|
||||
"""
|
||||
@ -604,21 +597,20 @@ class NetworkDevice():
|
||||
'interfaceid'],
|
||||
selectGroups=["groupid"],
|
||||
selectParentTemplates=["templateid"])
|
||||
if(len(host) > 1):
|
||||
if len(host) > 1:
|
||||
e = (f"Got {len(host)} results for Zabbix hosts "
|
||||
f"with ID {self.zabbix_id} - hostname {self.name}.")
|
||||
logger.error(e)
|
||||
raise SyncInventoryError(e)
|
||||
elif(len(host) == 0):
|
||||
if len(host) == 0:
|
||||
e = (f"No Zabbix host found for {self.name}. "
|
||||
f"This is likely the result of a deleted Zabbix host "
|
||||
f"without zeroing the ID field in Netbox.")
|
||||
logger.error(e)
|
||||
raise SyncInventoryError(e)
|
||||
else:
|
||||
host = host[0]
|
||||
|
||||
if(host["host"] == self.name):
|
||||
if host["host"] == self.name:
|
||||
logger.debug(f"Device {self.name}: hostname in-sync.")
|
||||
else:
|
||||
logger.warning(f"Device {self.name}: hostname OUT of sync. "
|
||||
@ -626,32 +618,33 @@ class NetworkDevice():
|
||||
self.updateZabbixHost(host=self.name)
|
||||
|
||||
# Check if the templates are in-sync
|
||||
if(not self.zbx_template_comparer(host["parentTemplates"])):
|
||||
if not self.zbx_template_comparer(host["parentTemplates"]):
|
||||
logger.warning(f"Device {self.name}: template(s) OUT of sync.")
|
||||
# Update Zabbix with NB templates and clear any old / lost templates
|
||||
self.updateZabbixHost(templates_clear=host["parentTemplates"], templates=self.zbx_templates)
|
||||
self.updateZabbixHost(templates_clear=host["parentTemplates"],
|
||||
templates=self.zbx_templates)
|
||||
else:
|
||||
logger.debug(f"Device {self.name}: template(s) in-sync.")
|
||||
|
||||
for group in host["groups"]:
|
||||
if(group["groupid"] == self.group_id):
|
||||
if group["groupid"] == self.group_id:
|
||||
logger.debug(f"Device {self.name}: hostgroup in-sync.")
|
||||
break
|
||||
else:
|
||||
logger.warning(f"Device {self.name}: hostgroup OUT of sync.")
|
||||
self.updateZabbixHost(groups={'groupid': self.group_id})
|
||||
|
||||
if(int(host["status"]) == self.zabbix_state):
|
||||
if int(host["status"]) == self.zabbix_state:
|
||||
logger.debug(f"Device {self.name}: status in-sync.")
|
||||
else:
|
||||
logger.warning(f"Device {self.name}: status OUT of sync.")
|
||||
self.updateZabbixHost(status=str(self.zabbix_state))
|
||||
|
||||
# Check if a proxy has been defined
|
||||
if(self.zbxproxy != "0"):
|
||||
if self.zbxproxy != "0":
|
||||
# Check if expected proxyID matches with configured proxy
|
||||
if(("proxy_hostid" in host and host["proxy_hostid"] == self.zbxproxy)
|
||||
or ("proxyid" in host and host["proxyid"] == self.zbxproxy)):
|
||||
if (("proxy_hostid" in host and host["proxy_hostid"] == self.zbxproxy) or
|
||||
("proxyid" in host and host["proxyid"] == self.zbxproxy)):
|
||||
logger.debug(f"Device {self.name}: proxy in-sync.")
|
||||
else:
|
||||
# Proxy diff, update value
|
||||
@ -663,7 +656,7 @@ class NetworkDevice():
|
||||
else:
|
||||
if (("proxy_hostid" in host and not host["proxy_hostid"] == "0")
|
||||
or ("proxyid" in host and not host["proxyid"] == "0")):
|
||||
if(proxy_power):
|
||||
if proxy_power:
|
||||
# Variable full_proxy_sync has been enabled
|
||||
# delete the proxy link in Zabbix
|
||||
if version.parse(self.zabbix.api_version()) < version.parse("7.0.0"):
|
||||
@ -679,41 +672,41 @@ class NetworkDevice():
|
||||
" -p flag was ommited: no "
|
||||
"changes have been made.")
|
||||
# If only 1 interface has been found
|
||||
if(len(host['interfaces']) == 1):
|
||||
if len(host['interfaces']) == 1:
|
||||
updates = {}
|
||||
# Go through each key / item and check if it matches Zabbix
|
||||
for key, item in self.setInterfaceDetails()[0].items():
|
||||
# Check if Netbox value is found in Zabbix
|
||||
if(key in host["interfaces"][0]):
|
||||
if key in host["interfaces"][0]:
|
||||
# If SNMP is used, go through nested dict
|
||||
# to compare SNMP parameters
|
||||
if(type(item) == dict and key == "details"):
|
||||
if isinstance(item,dict) and key == "details":
|
||||
for k, i in item.items():
|
||||
if(k in host["interfaces"][0][key]):
|
||||
if k in host["interfaces"][0][key]:
|
||||
# Set update if values don't match
|
||||
if(host["interfaces"][0][key][k] != str(i)):
|
||||
if host["interfaces"][0][key][k] != str(i):
|
||||
# If dict has not been created, add it
|
||||
if(key not in updates):
|
||||
if key not in updates:
|
||||
updates[key] = {}
|
||||
updates[key][k] = str(i)
|
||||
# If SNMP version has been changed
|
||||
# break loop and force full SNMP update
|
||||
if(k == "version"):
|
||||
if k == "version":
|
||||
break
|
||||
# Force full SNMP config update
|
||||
# when version has changed.
|
||||
if(key in updates):
|
||||
if("version" in updates[key]):
|
||||
if key in updates:
|
||||
if "version" in updates[key]:
|
||||
for k, i in item.items():
|
||||
updates[key][k] = str(i)
|
||||
continue
|
||||
# Set update if values don't match
|
||||
if(host["interfaces"][0][key] != str(item)):
|
||||
if host["interfaces"][0][key] != str(item):
|
||||
updates[key] = item
|
||||
if(updates):
|
||||
if updates:
|
||||
# If interface updates have been found: push to Zabbix
|
||||
logger.warning(f"Device {self.name}: Interface OUT of sync.")
|
||||
if("type" in updates):
|
||||
if "type" in updates:
|
||||
# Changing interface type not supported. Raise exception.
|
||||
e = (f"Device {self.name}: changing interface type to "
|
||||
f"{str(updates['type'])} is not supported.")
|
||||
@ -730,7 +723,7 @@ class NetworkDevice():
|
||||
except ZabbixAPIException as e:
|
||||
e = f"Zabbix returned the following error: {str(e)}."
|
||||
logger.error(e)
|
||||
raise SyncExternalError(e)
|
||||
raise SyncExternalError(e) from e
|
||||
else:
|
||||
# If no updates are found, Zabbix interface is in-sync
|
||||
e = f"Device {self.name}: interface in-sync."
|
||||
@ -740,12 +733,14 @@ class NetworkDevice():
|
||||
f" Host has total of {len(host['interfaces'])} interfaces. "
|
||||
"Manual interfention required.")
|
||||
logger.error(e)
|
||||
SyncInventoryError(e)
|
||||
raise SyncInventoryError(e)
|
||||
|
||||
def create_journal_entry(self, severity, message):
|
||||
# Send a new Journal entry to Netbox. Usefull for viewing actions
|
||||
# in Netbox without having to look in Zabbix or the script log output
|
||||
if(self.journal):
|
||||
"""
|
||||
Send a new Journal entry to Netbox. Usefull for viewing actions
|
||||
in Netbox without having to look in Zabbix or the script log output
|
||||
"""
|
||||
if self.journal:
|
||||
# Check if the severity is valid
|
||||
if severity not in ["info", "success", "warning", "danger"]:
|
||||
logger.warning(f"Value {severity} not valid for NB journal entries.")
|
||||
@ -757,11 +752,13 @@ class NetworkDevice():
|
||||
}
|
||||
try:
|
||||
self.nb_journals.create(journal)
|
||||
logger.debug(f"Created journal entry in NB for host {self.name}")
|
||||
return True
|
||||
logger.debug(f"Crated journal entry in NB for host {self.name}")
|
||||
except pynetbox.RequestError as e:
|
||||
logger.warning("Unable to create journal entry for "
|
||||
f"{self.name}: NB returned {e}")
|
||||
return False
|
||||
return False
|
||||
|
||||
def zbx_template_comparer(self, tmpls_from_zabbix):
|
||||
"""
|
||||
@ -777,15 +774,15 @@ class NetworkDevice():
|
||||
# Go through each Zabbix template
|
||||
for pos, zbx_tmpl in enumerate(tmpls_from_zabbix):
|
||||
# Check if template IDs match
|
||||
if(nb_tmpl["templateid"] == zbx_tmpl["templateid"]):
|
||||
if nb_tmpl["templateid"] == zbx_tmpl["templateid"]:
|
||||
# Templates match. Remove this template from the Zabbix templates
|
||||
# and add this NB template to the list of successfull templates
|
||||
tmpls_from_zabbix.pop(pos)
|
||||
succesfull_templates.append(nb_tmpl)
|
||||
logger.debug(f"Device {self.name}: template {nb_tmpl['name']} is present in Zabbix.")
|
||||
logger.debug(f"Device {self.name}: template "
|
||||
f"{nb_tmpl['name']} is present in Zabbix.")
|
||||
break
|
||||
if(len(succesfull_templates) == len(self.zbx_templates) and
|
||||
len(tmpls_from_zabbix) == 0):
|
||||
if len(succesfull_templates) == len(self.zbx_templates) and len(tmpls_from_zabbix) == 0:
|
||||
# All of the Netbox templates have been confirmed as successfull
|
||||
# and the ZBX template list is empty. This means that
|
||||
# all of the templates match.
|
||||
@ -793,8 +790,6 @@ class NetworkDevice():
|
||||
return False
|
||||
|
||||
|
||||
|
||||
|
||||
class ZabbixInterface():
|
||||
"""Class that represents a Zabbix interface."""
|
||||
|
||||
@ -805,40 +800,38 @@ class ZabbixInterface():
|
||||
self.interface = self.skelet
|
||||
|
||||
def get_context(self):
|
||||
# check if Netbox custom context has been defined.
|
||||
if("zabbix" in self.context):
|
||||
""" check if Netbox custom context has been defined. """
|
||||
if "zabbix" in self.context:
|
||||
zabbix = self.context["zabbix"]
|
||||
if("interface_type" in zabbix and "interface_port" in zabbix):
|
||||
self.interface["type"] = zabbix["interface_type"]
|
||||
self.interface["port"] = zabbix["interface_port"]
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
else:
|
||||
return False
|
||||
|
||||
def set_snmp(self):
|
||||
# Check if interface is type SNMP
|
||||
if(self.interface["type"] == 2):
|
||||
""" Check if interface is type SNMP """
|
||||
if self.interface["type"] == 2:
|
||||
# Checks if SNMP settings are defined in Netbox
|
||||
if("snmp" in self.context["zabbix"]):
|
||||
if "snmp" in self.context["zabbix"]:
|
||||
snmp = self.context["zabbix"]["snmp"]
|
||||
self.interface["details"] = {}
|
||||
# Checks if bulk config has been defined
|
||||
if("bulk" in snmp):
|
||||
if "bulk" in snmp:
|
||||
self.interface["details"]["bulk"] = str(snmp.pop("bulk"))
|
||||
else:
|
||||
# Fallback to bulk enabled if not specified
|
||||
self.interface["details"]["bulk"] = "1"
|
||||
# SNMP Version config is required in Netbox config context
|
||||
if(snmp.get("version")):
|
||||
if snmp.get("version"):
|
||||
self.interface["details"]["version"] = str(snmp.pop("version"))
|
||||
else:
|
||||
e = "SNMP version option is not defined."
|
||||
raise InterfaceConfigError(e)
|
||||
# If version 1 or 2 is used, get community string
|
||||
if(self.interface["details"]["version"] in ['1','2']):
|
||||
if("community" in snmp):
|
||||
if self.interface["details"]["version"] in ['1','2']:
|
||||
if "community" in snmp:
|
||||
# Set SNMP community to confix context value
|
||||
community = snmp["community"]
|
||||
else:
|
||||
@ -847,12 +840,12 @@ class ZabbixInterface():
|
||||
self.interface["details"]["community"] = str(community)
|
||||
# If version 3 has been used, get all
|
||||
# SNMPv3 Netbox related configs
|
||||
elif(self.interface["details"]["version"] == '3'):
|
||||
elif self.interface["details"]["version"] == '3':
|
||||
items = ["securityname", "securitylevel", "authpassphrase",
|
||||
"privpassphrase", "authprotocol", "privprotocol",
|
||||
"contextname"]
|
||||
for key, item in snmp.items():
|
||||
if(key in items):
|
||||
if key in items:
|
||||
self.interface["details"][key] = str(item)
|
||||
else:
|
||||
e = "Unsupported SNMP version."
|
||||
@ -865,7 +858,7 @@ class ZabbixInterface():
|
||||
raise InterfaceConfigError(e)
|
||||
|
||||
def set_default(self):
|
||||
# Set default config to SNMPv2,port 161 and community macro.
|
||||
""" Set default config to SNMPv2, port 161 and community macro. """
|
||||
self.interface = self.skelet
|
||||
self.interface["type"] = "2"
|
||||
self.interface["port"] = "161"
|
||||
@ -874,7 +867,7 @@ class ZabbixInterface():
|
||||
"bulk": "1"}
|
||||
|
||||
|
||||
if(__name__ == "__main__"):
|
||||
if __name__ == "__main__":
|
||||
parser = argparse.ArgumentParser(
|
||||
description='A script to sync Zabbix with Netbox device data.'
|
||||
)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user