Merge pull request #80 from TheNetworkGuy/virtual_machines

Virtual machines

.gitignore

@@ -1,4 +1,5 @@
 *.log
+.venv
 config.py
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -19,7 +19,7 @@ docker run -d -t -i -e ZABBIX_HOST='https://zabbix.local' \
 -e ZABBIX_TOKEN='othersecrettoken' \
 -e NETBOX_HOST='https://netbox.local' \
 -e NETBOX_TOKEN='secrettoken' \
---name netbox-zabbix-sync ghcr.io/TheNetworkGuy/netbox-zabbix-sync:latest
+--name netbox-zabbix-sync ghcr.io/thenetworkguy/netbox-zabbix-sync:main
 ```
 
 This should run a one-time sync, you can check the sync with `docker logs netbox-zabbix-sync`.
@@ -87,37 +87,59 @@ You can make the `zabbix_hostid` field hidden or read-only to prevent human inte
 
 This is optional and there is a use case for leaving it read-write in the UI to manually change the ID. For example to re-run a sync.
 
+## Virtual Machine (VM) Syncing
+In order to use VM syncing, make sure that the `zabbix_id` custom field is also present on Virtual machine objects in Netbox.
+
+Use the `config.py` file and set the `sync_vms` variable to `True`.
+
+You can set the `vm_hostgroup_format` variable to a customizable value for VM hostgroups. The default is `cluster_type/cluster/role`.
+
+To enable filtering for VM's, check the `nb_vm_filter` variable out. It works the same as with the device filter (see documentation under "Hostgroup layout"). Note that not all filtering capabilities and properties of devices are applicable to VM's and vice-versa. Check the Netbox API documentation to see which filtering options are available for each object type.
+
 ## Config file
 
 ### Hostgroup
-Setting the `create_hostgroups` variable to `False` requires manual hostgroup creation for devices in a new category.
+Setting the `create_hostgroups` variable to `False` requires manual hostgroup creation for devices in a new category. I would recommend setting this variable to `True` since leaving it on `False` results in a lot of manual work.
 
-The format can be set with the `hostgroup_format` variable.
+The format can be set with the `hostgroup_format` variable for devices and `vm_hostgroup_format` for devices.
+
+Any nested parent hostgroups will also be created automatically. For instance the region `Berlin` with parent region `Germany` will create the hostgroup `Germany/Berlin`.
 
 Make sure that the Zabbix user has proper permissions to create hosts.
 The hostgroups are in a nested format. This means that proper permissions only need to be applied to the site name hostgroup and cascaded to any child hostgroups.
 
 #### Layout
 The default hostgroup layout is "site/manufacturer/device_role".
-
-**Variables**
-
 You can change this behaviour with the hostgroup_format variable. The following values can be used:
+
+**Both devices and virtual machines**
 |  name | description  |
 | ------------ | ------------ |
-|dev_location|The device location name|
-|dev_role|The device role name|
-|manufacturer|Manufacturer name|
-|region|The region name of the device|
+|role|Role name of a device or VM|
+|region|The region name|
 |site|Site name|
 |site_group|Site group name|
 |tenant|Tenant name|
 |tenant_group|Tenant group name|
+|platform|Software platform of a device or VM|
+|custom fields|See the section "Layout -> Custom Fields" to use custom fields as hostgroup variable|
+
+**Only for devices**
+|  name | description  |
+| ------------ | ------------ |
+|location|The device location name|
+|manufacturer|Device manufacturer name|
+
+**Only for VMs**
+|  name | description  |
+| ------------ | ------------ |
+|cluster|VM cluster name|
+|cluster_type|VM cluster type|
 
 
-You can specify the value like so, sperated by a "/":
+You can specify the value sperated by a "/" like so:
 ```
-hostgroup_format = "tenant/site/dev_location/dev_role"
+hostgroup_format = "tenant/site/dev_location/role"
 ```
 **Group traversal**
 
@@ -127,11 +149,18 @@ However, by setting `traverse_region` to `True` in `config.py` the script will r
 
 **Custom fields**
 
-You can also use the value of custom fields under the device object.
+You can use the value of custom fields for hostgroup generation. This allows more freedom and even allows a full static mapping instead of a dynamic rendered hostgroup name.
 
-This allows more freedom and even allows a full static mapping instead of a dynamic rendered hostgroup name.
+For instance a custom field with the name `mycustomfieldname` and type string has the following values for 2 devices:
 ```
-hostgroup_format = "site/mycustomfieldname"
+Device A has the value Train for custom field mycustomfieldname.
+Device B has the value Bus for custom field mycustomfieldname.
+Both devices are located in the site Paris.
+```
+With the hostgroup format `site/mycustomfieldname` the following hostgroups will be generated:
+```
+Device A: Paris/Train
+Device B: Paris/Bus
 ```
 **Empty variables or hostgroups**
 
@@ -172,16 +201,17 @@ You can modify this behaviour by changing the following list variables in the sc
 
 ### Zabbix Inventory
 This script allows you to enable the inventory on managed Zabbix hosts and sync NetBox device properties to the specified inventory fields.
-To enable, set `inventory_sync` to `True`.
-Set `inventory_automatic` to `False` to use manual inventory, or `True` for automatic.
-See [Zabix Manual](https://www.zabbix.com/documentation/current/en/manual/config/hosts/inventory#building-inventory) for more information about the modes.
+To map Netbox information to Netbox inventory fields, set `inventory_sync` to `True`.
+
+You can set the inventory mode to "disabled", "manual" or "automatic" with the `inventory_mode` variable.
+See [Zabbix Manual](https://www.zabbix.com/documentation/current/en/manual/config/hosts/inventory#building-inventory) for more information about the modes.
 
 Use the `inventory_map` variable to map which NetBox properties are used in which Zabbix Inventory fields.
 For nested properties, you can use the '/' seperator.
 For example, the following map will assign the custom field 'mycustomfield' to the 'alias' Zabbix inventory field:
 ```
 inventory_sync = True
-inventory_automatic = True
+inventory_mode = "manual"
 inventory_map = { "custom_fields/mycustomfield/name": "alias"}
 ```
 See `config.py.example` for an extensive example map.
@@ -232,8 +262,8 @@ If you want to automatically create hostgroups then the create permission on hos
 To make the user experience easier you could add a custom link that redirects users to the Zabbix latest data.
 ```
 * Name: zabbix_latestData
-* Text: {% if obj.cf["zabbix_hostid"] %}Show host in Zabbix{% endif %}
-* URL: http://myzabbixserver.local/zabbix.php?action=latest.view&hostids[]={{ obj.cf["zabbix_hostid"] }}
+* Text: {% if object.cf["zabbix_hostid"] %}Show host in Zabbix{% endif %}
+* URL: http://myzabbixserver.local/zabbix.php?action=latest.view&hostids[]={{ object.cf["zabbix_hostid"] }}
 ```
 ## Running the script
 ```
@@ -255,6 +285,28 @@ You can set the proxy for a device using the 'proxy' key in config context.
     }
 }
 ```
+It is now posible to specify proxy groups with the introduction of Proxy groups in Zabbix 7. Specifying a group in the config context on older Zabbix releases will have no impact and the script will ignore the statement.
+
+```json
+{
+    "zabbix": {
+        "proxy_group": "yourawesomeproxygroup.local"
+    }
+}
+```
+
+The script will prefer groups when specifying both a proxy and group. This is done with the assumption that groups are more resiliant and HA ready, making it a more logical choice to use for proxy linkage. This also makes migrating from a proxy to proxy group easier since the group take priority over the invidivual proxy.
+
+```json
+{
+    "zabbix": {
+        "proxy": "yourawesomeproxy.local",
+        "proxy_group": "yourawesomeproxygroup.local"
+    }
+}
+```
+In the example above the host will use the group on Zabbix 7. On Zabbix 6 and below the host will use the proxy. Zabbix 7 will use the proxy value when ommiting the proxy_group value.
+
 Because of the possible amount of destruction when setting up Netbox but forgetting the proxy command, the sync works a bit different. By default everything is synced except in a situation where the Zabbix host has a proxy configured but nothing is configured in Netbox. To force deletion and a full sync, set the `full_proxy_sync` variable in the config file.
 
 ### Set interface parameters within Netbox

config.py.example

@@ -3,7 +3,7 @@
 # coming from config context instead of a custom field.
 templates_config_context = False
 
-# Set to true to give config context templates a 
+# Set to true to give config context templates a
 # higher priority then custom field templates
 templates_config_context_overrule = False
 
@@ -21,6 +21,14 @@ create_hostgroups = True
 ## Create journal entries
 create_journal = False
 
+## Virtual machine sync
+# Set sync_vms to True in order to use this new feature
+# Use the hostgroup vm_hostgroup_format mapper for specific
+# hostgroup atributes of VM's such as cluster_type and cluster
+sync_vms = False
+# Check the README documentation for values to use in the VM hostgroup format.
+vm_hostgroup_format = "cluster_type/cluster/role"
+
 ## Proxy Sync
 # Set to true to enable removal of proxy's under hosts. Use with caution and make sure that you specified
 # all the required proxy's in the device config context before enabeling this option.
@@ -32,7 +40,7 @@ zabbix_device_removal = ["Decommissioning", "Inventory"]
 zabbix_device_disable = ["Offline", "Planned", "Staged", "Failed"]
 
 ## Hostgroup mapping
-# Available choices: dev_location, dev_role, manufacturer, region, site, site_group, tenant, tenant_group
+# See the README documentation for available options
 # You can also use CF (custom field) names under the device. The CF content will be used for the hostgroup generation.
 #
 # When using region in the group name, the default behaviour is to use name of the directly assigned region.
@@ -40,8 +48,8 @@ zabbix_device_disable = ["Offline", "Planned", "Staged", "Failed"]
 #
 # 'Global/Europe/Netherlands/Amsterdam' instead of just 'Amsterdam'.
 #
-# traverse_site_groups controls the same behaviour for any assigned site_groups.   
-hostgroup_format = "site/manufacturer/dev_role"
+# traverse_site_groups controls the same behaviour for any assigned site_groups.
+hostgroup_format = "site/manufacturer/role"
 traverse_regions = False
 traverse_site_groups = False
 
@@ -56,15 +64,18 @@ traverse_site_groups = False
 
 # Default device filter, only get devices which have a name in Netbox:
 nb_device_filter = {"name__n": "null"}
+# Default filter for VMs
+nb_vm_filter = {"name__n": "null"}
 
 ## Inventory
+# See https://www.zabbix.com/documentation/current/en/manual/config/hosts/inventory#building-inventory
+# Choice between disabled, manual or automatic.
+# Make sure to select at least manual or automatic in use with the inventory_sync function.
+inventory_mode = "disabled"
+
 # To allow syncing of NetBox device properties, set inventory_sync to True
 inventory_sync = False
 
-# Set inventory_automatic to False to use manual inventory, True for automatic
-# See https://www.zabbix.com/documentation/current/en/manual/config/hosts/inventory#building-inventory 
-inventory_automatic = True
-
 # inventory_map is used to map NetBox properties to Zabbix Inventory fields.
 # For nested properties, you can use the '/' seperator.
 # For example, the following map will assign the custom field 'mycustomfield' to the 'alias' Zabbix inventory field:

modules/device.py

@@ -0,0 +1,774 @@
+#!/usr/bin/env python3
+# pylint: disable=invalid-name, logging-not-lazy, too-many-locals, logging-fstring-interpolation, too-many-lines
+"""
+Device specific handeling for Netbox to Zabbix
+"""
+from os import sys
+from re import search
+from logging import getLogger
+from zabbix_utils import APIRequestError
+from modules.exceptions import (SyncInventoryError, TemplateError, SyncExternalError,
+                                InterfaceConfigError, JournalError)
+from modules.interface import ZabbixInterface
+from modules.hostgroups import Hostgroup
+try:
+    from config import (
+        template_cf, device_cf,
+        traverse_site_groups,
+        traverse_regions,
+        inventory_sync,
+        inventory_mode,
+        inventory_map
+    )
+except ModuleNotFoundError:
+    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)
+
+class PhysicalDevice():
+    # pylint: disable=too-many-instance-attributes, too-many-arguments, too-many-positional-arguments
+    """
+    Represents Network device.
+    INPUT: (Netbox device class, ZabbixAPI class, journal flag, NB journal class)
+    """
+
+    def __init__(self, nb, zabbix, nb_journal_class, nb_version, journal=None, logger=None):
+        self.nb = nb
+        self.id = nb.id
+        self.name = nb.name
+        self.visible_name = None
+        self.status = nb.status.label
+        self.zabbix = zabbix
+        self.zabbix_id = None
+        self.group_id = None
+        self.nb_api_version = nb_version
+        self.zbx_template_names = []
+        self.zbx_templates = []
+        self.hostgroup = None
+        self.tenant = nb.tenant
+        self.config_context = nb.config_context
+        self.zbxproxy = None
+        self.zabbix_state = 0
+        self.journal = journal
+        self.nb_journals = nb_journal_class
+        self.inventory_mode = -1
+        self.inventory = {}
+        self.logger = logger if logger else getLogger(__name__)
+        self._setBasics()
+
+    def __repr__(self):
+        return self.name
+
+    def __str__(self):
+        return self.__repr__()
+
+    def _setBasics(self):
+        """
+        Sets basic information like IP address.
+        """
+        # Return error if device does not have primary IP.
+        if self.nb.primary_ip:
+            self.cidr = self.nb.primary_ip.address
+            self.ip = self.cidr.split("/")[0]
+        else:
+            e = f"Host {self.name}: no primary IP."
+            self.logger.info(e)
+            raise SyncInventoryError(e)
+
+        # Check if device has custom field for ZBX ID
+        if device_cf in self.nb.custom_fields:
+            self.zabbix_id = self.nb.custom_fields[device_cf]
+        else:
+            e = f"Host {self.name}: Custom field {device_cf} not present"
+            self.logger.warning(e)
+            raise SyncInventoryError(e)
+
+        # Validate hostname format.
+        odd_character_list = ["ä", "ö", "ü", "Ä", "Ö", "Ü", "ß"]
+        self.use_visible_name = False
+        if (any(letter in self.name for letter in odd_character_list) or
+            bool(search('[\u0400-\u04FF]', self.name))):
+            self.name = f"NETBOX_ID{self.id}"
+            self.visible_name = self.nb.name
+            self.use_visible_name = True
+            self.logger.info(f"Host {self.visible_name} contains special characters. "
+                             f"Using {self.name} as name for the Netbox object "
+                             f"and using {self.visible_name} as visible name in Zabbix.")
+        else:
+            pass
+
+    def set_hostgroup(self, hg_format, nb_site_groups, nb_regions):
+        """Set the hostgroup for this device"""
+        # Create new Hostgroup instance
+        hg = Hostgroup("dev", self.nb, self.nb_api_version)
+        # Set Hostgroup nesting options
+        hg.set_nesting(traverse_site_groups, traverse_regions, nb_site_groups, nb_regions)
+        # Generate hostgroup based on hostgroup format
+        self.hostgroup = hg.generate(hg_format)
+
+    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:
+            try:
+                self.zbx_template_names = self.get_templates_context()
+            except TemplateError as e:
+                self.logger.warning(e)
+            return True
+        # Gather templates from the custom field but overrule
+        # them should there be any device specific templates
+        if overrule_custom:
+            try:
+                self.zbx_template_names = self.get_templates_context()
+            except TemplateError:
+                pass
+            if not self.zbx_template_names:
+                self.zbx_template_names = self.get_templates_cf()
+            return True
+        # Gather templates ONLY from the custom field
+        self.zbx_template_names = self.get_templates_cf()
+        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:
+            # Set value to template
+            return [device_type_cfs[template_cf]]
+        # 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:
+            e = (f"Host {self.name}: Key 'zabbix' not found in config "
+                 "context for template lookup")
+            raise TemplateError(e)
+        if "templates" not in self.config_context["zabbix"]:
+            e = (f"Host {self.name}: Key 'templates' not found in config "
+                 "context 'zabbix' for template lookup")
+            raise TemplateError(e)
+        return self.config_context["zabbix"]["templates"]
+
+    def set_inventory(self, nbdevice):
+        """ Set host inventory """
+        # Set inventory mode. Default is disabled (see class init function).
+        if inventory_mode == "disabled":
+            if inventory_sync:
+                self.logger.error(f"Host {self.name}: Unable to map Netbox inventory to Zabbix. "
+                              "Inventory sync is enabled in config but inventory mode is disabled.")
+            return True
+        if inventory_mode == "manual":
+            self.inventory_mode = 0
+        elif inventory_mode == "automatic":
+            self.inventory_mode = 1
+        else:
+            self.logger.error(f"Host {self.name}: Specified value for inventory mode in"
+                              f" config is not valid. Got value {inventory_mode}")
+            return False
+        self.inventory = {}
+        if inventory_sync and self.inventory_mode in [0,1]:
+            self.logger.debug(f"Host {self.name}: Starting inventory mapper")
+            # Let's build an inventory dict for each property in the inventory_map
+            for nb_inv_field, zbx_inv_field in inventory_map.items():
+                field_list = nb_inv_field.split("/") # convert str to list based on delimiter
+                # start at the base of the dict...
+                value = nbdevice
+                # ... and step through the dict till we find the needed value
+                for item in field_list:
+                    value = value[item] if value else None
+                # Check if the result is usable and expected
+                # We want to apply any int or float 0 values,
+                # even if python thinks those are empty.
+                if ((value and isinstance(value, int | float | str )) or
+                     (isinstance(value, int | float) and int(value) ==0)):
+                    self.inventory[zbx_inv_field] = str(value)
+                elif not value:
+                    # empty value should just be an empty string for API compatibility
+                    self.logger.debug(f"Host {self.name}: Netbox inventory lookup for "
+                                      f"'{nb_inv_field}' returned an empty value")
+                    self.inventory[zbx_inv_field] = ""
+                else:
+                    # Value is not a string or numeral, probably not what the user expected.
+                    self.logger.error(f"Host {self.name}: Inventory lookup for '{nb_inv_field}'"
+                                      " returned an unexpected type: it will be skipped.")
+            self.logger.debug(f"Host {self.name}: Inventory mapping complete. "
+                            f"Mapped {len(list(filter(None, self.inventory.values())))} field(s)")
+        return True
+
+    def isCluster(self):
+        """
+        Checks if device is part of cluster.
+        """
+        return bool(self.nb.virtual_chassis)
+
+    def getClusterMaster(self):
+        """
+        Returns chassis master ID.
+        """
+        if not self.isCluster():
+            e = (f"Unable to proces {self.name} for cluster calculation: "
+                 f"not part of a cluster.")
+            self.logger.warning(e)
+            raise SyncInventoryError(e)
+        if 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.")
+            self.logger.error(e)
+            raise SyncInventoryError(e)
+        return self.nb.virtual_chassis.master.id
+
+    def promoteMasterDevice(self):
+        """
+        If device is Primary in cluster,
+        promote device name to the cluster name.
+        Returns True if succesfull, returns False if device is secondary.
+        """
+        masterid = self.getClusterMaster()
+        if masterid == self.id:
+            self.logger.debug(f"Host {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
+        self.logger.debug(f"Host {self.name} is non-primary cluster member.")
+        return False
+
+    def zbxTemplatePrepper(self, templates):
+        """
+        Returns Zabbix template IDs
+        INPUT: list of templates from Zabbix
+        OUTPUT: True
+        """
+        # Check if there are templates defined
+        if not self.zbx_template_names:
+            e = f"Host {self.name}: No templates found"
+            self.logger.info(e)
+            raise SyncInventoryError()
+        # Set variable to empty list
+        self.zbx_templates = []
+        # Go through all templates definded in Netbox
+        for nb_template in self.zbx_template_names:
+            template_match = False
+            # Go through all templates found in Zabbix
+            for zbx_template in templates:
+                # If the template names match
+                if zbx_template['name'] == nb_template:
+                    # Set match variable to true, add template details
+                    # to class variable and return debug log
+                    template_match = True
+                    self.zbx_templates.append({"templateid": zbx_template['templateid'],
+                                               "name": zbx_template['name']})
+                    e = f"Host {self.name}: found template {zbx_template['name']}"
+                    self.logger.debug(e)
+            # Return error should the template not be found in Zabbix
+            if not template_match:
+                e = (f"Unable to find template {nb_template} "
+                    f"for host {self.name} in Zabbix. Skipping host...")
+                self.logger.warning(e)
+                raise SyncInventoryError(e)
+
+    def setZabbixGroupID(self, groups):
+        """
+        Sets Zabbix group ID as instance variable
+        INPUT: list of hostgroups
+        OUTPUT: True / False
+        """
+        # Go through all groups
+        for group in groups:
+            if group['name'] == self.hostgroup:
+                self.group_id = group['groupid']
+                e = f"Host {self.name}: matched group {group['name']}"
+                self.logger.debug(e)
+                return True
+        return False
+
+    def cleanup(self):
+        """
+        Removes device from external resources.
+        Resets custom fields in Netbox.
+        """
+        if self.zabbix_id:
+            try:
+                # Check if the Zabbix host exists in Zabbix
+                zbx_host = bool(self.zabbix.host.get(filter={'hostid': self.zabbix_id},
+                                                     output=[]))
+                e = (f"Host {self.name}: was already deleted from Zabbix."
+                        " Removed link in Netbox.")
+                if zbx_host:
+                    # Delete host should it exists
+                    self.zabbix.host.delete(self.zabbix_id)
+                    e = f"Host {self.name}: Deleted host from Zabbix."
+                self._zeroize_cf()
+                self.logger.info(e)
+                self.create_journal_entry("warning", "Deleted host from Zabbix")
+            except APIRequestError as e:
+                message = f"Zabbix returned the following error: {str(e)}."
+                self.logger.error(message)
+                raise SyncExternalError(message) from e
+
+    def _zeroize_cf(self):
+        """Sets the hostID custom field in Netbox to zero,
+        effectively destroying the link"""
+        self.nb.custom_fields[device_cf] = None
+        self.nb.save()
+
+    def _zabbixHostnameExists(self):
+        """
+        Checks if hostname exists in Zabbix.
+        """
+        # Validate the hostname or visible name field
+        if not self.use_visible_name:
+            zbx_filter = {'host': self.name}
+        else:
+            zbx_filter = {'name': self.visible_name}
+        host = self.zabbix.host.get(filter=zbx_filter, output=[])
+        return bool(host)
+
+    def setInterfaceDetails(self):
+        """
+        Checks interface parameters from Netbox and
+        creates a model for the interface to be used in Zabbix.
+        """
+        try:
+            # Initiate interface class
+            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 device is SNMP type, add aditional information.
+                if interface.interface["type"] == 2:
+                    interface.set_snmp()
+            else:
+                interface.set_default_snmp()
+            return [interface.interface]
+        except InterfaceConfigError as e:
+            message = f"{self.name}: {e}"
+            self.logger.warning(message)
+            raise SyncInventoryError(message) from e
+
+    def setProxy(self, proxy_list):
+        """
+        Sets proxy or proxy group if this
+        value has been defined in config context
+
+        input: List of all proxies and proxy groups in standardized format
+        """
+        # check if the key Zabbix is defined in the config context
+        if not "zabbix" in self.nb.config_context:
+            return False
+        if ("proxy" in self.nb.config_context["zabbix"] and
+               not self.nb.config_context["zabbix"]["proxy"]):
+            return False
+        # Proxy group takes priority over a proxy due
+        # to it being HA and therefore being more reliable
+        # Includes proxy group fix since Zabbix <= 6 should ignore this
+        proxy_types = ["proxy"]
+        if str(self.zabbix.version).startswith('7'):
+            # Only insert groups in front of list for Zabbix7
+            proxy_types.insert(0, "proxy_group")
+        for proxy_type in proxy_types:
+            # Check if the key exists in Netbox CC
+            if proxy_type in self.nb.config_context["zabbix"]:
+                proxy_name = self.nb.config_context["zabbix"][proxy_type]
+                # go through all proxies
+                for proxy in proxy_list:
+                    # If the proxy does not match the type, ignore and continue
+                    if not proxy["type"] == proxy_type:
+                        continue
+                    # If the proxy name matches
+                    if proxy["name"] == proxy_name:
+                        self.logger.debug(f"Host {self.name}: using {proxy['type']}"
+                                          f" {proxy_name}")
+                        self.zbxproxy = proxy
+                        return True
+                self.logger.warning(f"Host {self.name}: unable to find proxy {proxy_name}")
+        return False
+
+    def createInZabbix(self, groups, templates, proxies,
+                       description="Host added by Netbox sync script."):
+        """
+        Creates Zabbix host object with parameters from Netbox object.
+        """
+        # Check if hostname is already present in Zabbix
+        if not self._zabbixHostnameExists():
+            # Set group and template ID's for host
+            if not self.setZabbixGroupID(groups):
+                e = (f"Unable to find group '{self.hostgroup}' "
+                     f"for host {self.name} in Zabbix.")
+                self.logger.warning(e)
+                raise SyncInventoryError(e)
+            self.zbxTemplatePrepper(templates)
+            templateids = []
+            for template in self.zbx_templates:
+                templateids.append({'templateid': template['templateid']})
+            # Set interface, group and template configuration
+            interfaces = self.setInterfaceDetails()
+            groups = [{"groupid": self.group_id}]
+            # Set Zabbix proxy if defined
+            self.setProxy(proxies)
+            # Set basic data for host creation
+            create_data = {"host": self.name,
+                            "name": self.visible_name,
+                            "status": self.zabbix_state,
+                            "interfaces": interfaces,
+                            "groups": groups,
+                            "templates": templateids,
+                            "description": description,
+                            "inventory_mode": self.inventory_mode,
+                            "inventory": self.inventory
+                            }
+            # If a Zabbix proxy or Zabbix Proxy group has been defined
+            if self.zbxproxy:
+                # If a lower version than 7 is used, we can assume that
+                # the proxy is a normal proxy and not a proxy group
+                if not str(self.zabbix.version).startswith('7'):
+                    create_data["proxy_hostid"] = self.zbxproxy["id"]
+                else:
+                    # Configure either a proxy or proxy group
+                    create_data[self.zbxproxy["idtype"]] = self.zbxproxy["id"]
+                    create_data["monitored_by"] = self.zbxproxy["monitored_by"]
+            # Add host to Zabbix
+            try:
+                host = self.zabbix.host.create(**create_data)
+                self.zabbix_id = host["hostids"][0]
+            except APIRequestError as e:
+                e = f"Host {self.name}: Couldn't create. Zabbix returned {str(e)}."
+                self.logger.error(e)
+                raise SyncExternalError(e) from None
+            # Set Netbox custom field to hostID value.
+            self.nb.custom_fields[device_cf] = int(self.zabbix_id)
+            self.nb.save()
+            msg = f"Host {self.name}: Created host in Zabbix."
+            self.logger.info(msg)
+            self.create_journal_entry("success", msg)
+        else:
+            e = f"Host {self.name}: Unable to add to Zabbix. Host already present."
+            self.logger.warning(e)
+
+    def createZabbixHostgroup(self, hostgroups):
+        """
+        Creates Zabbix host group based on hostgroup format.
+        Creates multiple when using a nested format.
+        """
+        final_data = []
+        # Check if the hostgroup is in a nested format and check each parent
+        for pos in range(len(self.hostgroup.split('/'))):
+            zabbix_hg = self.hostgroup.rsplit('/', pos)[0]
+            if self.lookupZabbixHostgroup(hostgroups, zabbix_hg):
+                # Hostgroup already exists
+                continue
+            # Create new group
+            try:
+                # API call to Zabbix
+                groupid = self.zabbix.hostgroup.create(name=zabbix_hg)
+                e = f"Hostgroup '{zabbix_hg}': created in Zabbix."
+                self.logger.info(e)
+                # Add group to final data
+                final_data.append({'groupid': groupid["groupids"][0], 'name': zabbix_hg})
+            except APIRequestError as e:
+                msg = f"Hostgroup '{zabbix_hg}': unable to create. Zabbix returned {str(e)}."
+                self.logger.error(msg)
+                raise SyncExternalError(msg) from e
+        return final_data
+
+    def lookupZabbixHostgroup(self, group_list, lookup_group):
+        """
+        Function to check if a hostgroup
+        exists in a list of Zabbix hostgroups
+        INPUT: Group list and group lookup
+        OUTPUT: Boolean
+        """
+        for group in group_list:
+            if group["name"] == lookup_group:
+                return True
+        return False
+
+    def updateZabbixHost(self, **kwargs):
+        """
+        Updates Zabbix host with given parameters.
+        INPUT: Key word arguments for Zabbix host object.
+        """
+        try:
+            self.zabbix.host.update(hostid=self.zabbix_id, **kwargs)
+        except APIRequestError as e:
+            e = (f"Host {self.name}: Unable to update. "
+                 f"Zabbix returned the following error: {str(e)}.")
+            self.logger.error(e)
+            raise SyncExternalError(e) from None
+        self.logger.info(f"Updated host {self.name} with data {kwargs}.")
+        self.create_journal_entry("info", "Updated host in Zabbix with latest NB data.")
+
+    def ConsistencyCheck(self, groups, templates, proxies, proxy_power, create_hostgroups):
+        # pylint: disable=too-many-branches, too-many-statements
+        """
+        Checks if Zabbix object is still valid with Netbox parameters.
+        """
+        # If group is found or if the hostgroup is nested
+        if not self.setZabbixGroupID(groups) or len(self.hostgroup.split('/')) > 1:
+            if create_hostgroups:
+                # Script is allowed to create a new hostgroup
+                new_groups = self.createZabbixHostgroup(groups)
+                for group in new_groups:
+                    # Add all new groups to the list of groups
+                    groups.append(group)
+            # check if the initial group was not already found (and this is a nested folder check)
+            if not self.group_id:
+                # Function returns true / false but also sets GroupID
+                if not self.setZabbixGroupID(groups) and not create_hostgroups:
+                    e = (f"Host {self.name}: different hostgroup is required but "
+                        "unable to create hostgroup without generation permission.")
+                    self.logger.warning(e)
+                    raise SyncInventoryError(e)
+        # Prepare templates and proxy config
+        self.zbxTemplatePrepper(templates)
+        self.setProxy(proxies)
+        # Get host object from Zabbix
+        host = self.zabbix.host.get(filter={'hostid': self.zabbix_id},
+                                    selectInterfaces=['type', 'ip',
+                                                      'port', 'details',
+                                                      'interfaceid'],
+                                    selectGroups=["groupid"],
+                                    selectParentTemplates=["templateid"],
+                                    selectInventory=list(inventory_map.values()))
+        if len(host) > 1:
+            e = (f"Got {len(host)} results for Zabbix hosts "
+                 f"with ID {self.zabbix_id} - hostname {self.name}.")
+            self.logger.error(e)
+            raise SyncInventoryError(e)
+        if len(host) == 0:
+            e = (f"Host {self.name}: No Zabbix host found. "
+                 f"This is likely the result of a deleted Zabbix host "
+                 f"without zeroing the ID field in Netbox.")
+            self.logger.error(e)
+            raise SyncInventoryError(e)
+        host = host[0]
+        if host["host"] == self.name:
+            self.logger.debug(f"Host {self.name}: hostname in-sync.")
+        else:
+            self.logger.warning(f"Host {self.name}: hostname OUT of sync. "
+                                f"Received value: {host['host']}")
+            self.updateZabbixHost(host=self.name)
+        # Execute check depending on wether the name is special or not
+        if self.use_visible_name:
+            if host["name"] == self.visible_name:
+                self.logger.debug(f"Host {self.name}: visible name in-sync.")
+            else:
+                self.logger.warning(f"Host {self.name}: visible name OUT of sync."
+                                    f" Received value: {host['name']}")
+                self.updateZabbixHost(name=self.visible_name)
+
+        # Check if the templates are in-sync
+        if not self.zbx_template_comparer(host["parentTemplates"]):
+            self.logger.warning(f"Host {self.name}: template(s) OUT of sync.")
+            # Prepare Templates for API parsing
+            templateids = []
+            for template in self.zbx_templates:
+                templateids.append({'templateid': template['templateid']})
+            # Update Zabbix with NB templates and clear any old / lost templates
+            self.updateZabbixHost(templates_clear=host["parentTemplates"],
+                                      templates=templateids)
+        else:
+            self.logger.debug(f"Host {self.name}: template(s) in-sync.")
+
+        for group in host["groups"]:
+            if group["groupid"] == self.group_id:
+                self.logger.debug(f"Host {self.name}: hostgroup in-sync.")
+                break
+        else:
+            self.logger.warning(f"Host {self.name}: hostgroup OUT of sync.")
+            self.updateZabbixHost(groups={'groupid': self.group_id})
+
+        if int(host["status"]) == self.zabbix_state:
+            self.logger.debug(f"Host {self.name}: status in-sync.")
+        else:
+            self.logger.warning(f"Host {self.name}: status OUT of sync.")
+            self.updateZabbixHost(status=str(self.zabbix_state))
+        # Check if a proxy has been defined
+        if self.zbxproxy:
+            # Check if proxy or proxy group is defined
+            if (self.zbxproxy["idtype"] in host and
+                host[self.zbxproxy["idtype"]] == self.zbxproxy["id"]):
+                self.logger.debug(f"Host {self.name}: proxy in-sync.")
+            # Backwards compatibility for Zabbix <= 6
+            elif "proxy_hostid" in host and host["proxy_hostid"] == self.zbxproxy["id"]:
+                self.logger.debug(f"Host {self.name}: proxy in-sync.")
+            # Proxy does not match, update Zabbix
+            else:
+                self.logger.warning(f"Host {self.name}: proxy OUT of sync.")
+                # Zabbix <= 6 patch
+                if not str(self.zabbix.version).startswith('7'):
+                    self.updateZabbixHost(proxy_hostid=self.zbxproxy['id'])
+                # Zabbix 7+
+                else:
+                    # Prepare data structure for updating either proxy or group
+                    update_data = {self.zbxproxy["idtype"]: self.zbxproxy["id"],
+                                   "monitored_by": self.zbxproxy['monitored_by']}
+                    self.updateZabbixHost(**update_data)
+        else:
+            # No proxy is defined in Netbox
+            proxy_set = False
+            # Check if a proxy is defined. Uses the proxy_hostid key for backwards compatibility
+            for key in ("proxy_hostid", "proxyid", "proxy_groupid"):
+                if key in host:
+                    if bool(int(host[key])):
+                        proxy_set = True
+            if proxy_power and proxy_set:
+                # Zabbix <= 6 fix
+                self.logger.warning(f"Host {self.name}: no proxy is configured in Netbox "
+                                    "but is configured in Zabbix. Removing proxy config in Zabbix")
+                if "proxy_hostid" in host and bool(host["proxy_hostid"]):
+                    self.updateZabbixHost(proxy_hostid=0)
+                # Zabbix 7 proxy
+                elif "proxyid" in host and bool(host["proxyid"]):
+                    self.updateZabbixHost(proxyid=0, monitored_by=0)
+                # Zabbix 7 proxy group
+                elif "proxy_groupid" in host and bool(host["proxy_groupid"]):
+                    self.updateZabbixHost(proxy_groupid=0, monitored_by=0)
+            # Checks if a proxy has been defined in Zabbix and if proxy_power config has been set
+            if proxy_set and not proxy_power:
+                # Display error message
+                self.logger.error(f"Host {self.name} is configured "
+                                    f"with proxy in Zabbix but not in Netbox. The"
+                                    " -p flag was ommited: no "
+                                    "changes have been made.")
+            if not proxy_set:
+                self.logger.debug(f"Host {self.name}: proxy in-sync.")
+        # Check host inventory mode
+        if str(host['inventory_mode']) == str(self.inventory_mode):
+            self.logger.debug(f"Host {self.name}: inventory_mode in-sync.")
+        else:
+            self.logger.warning(f"Host {self.name}: inventory_mode OUT of sync.")
+            self.updateZabbixHost(inventory_mode=str(self.inventory_mode))
+        if inventory_sync and self.inventory_mode in [0,1]:
+            # Check host inventory mapping
+            if host['inventory'] == self.inventory:
+                self.logger.debug(f"Host {self.name}: inventory in-sync.")
+            else:
+                self.logger.warning(f"Host {self.name}: inventory OUT of sync.")
+                self.updateZabbixHost(inventory=self.inventory)
+
+        # If only 1 interface has been found
+        # pylint: disable=too-many-nested-blocks
+        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 SNMP is used, go through nested dict
+                    # to compare SNMP parameters
+                    if isinstance(item,dict) and key == "details":
+                        for k, i in item.items():
+                            if k in host["interfaces"][0][key]:
+                                # Set update if values don't match
+                                if host["interfaces"][0][key][k] != str(i):
+                                    # If dict has not been created, add it
+                                    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":
+                                        break
+                        # Force full SNMP config update
+                        # when version has changed.
+                        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):
+                        updates[key] = item
+            if updates:
+                # If interface updates have been found: push to Zabbix
+                self.logger.warning(f"Host {self.name}: Interface OUT of sync.")
+                if "type" in updates:
+                    # Changing interface type not supported. Raise exception.
+                    e = (f"Host {self.name}: changing interface type to "
+                         f"{str(updates['type'])} is not supported.")
+                    self.logger.error(e)
+                    raise InterfaceConfigError(e)
+                # Set interfaceID for Zabbix config
+                updates["interfaceid"] = host["interfaces"][0]['interfaceid']
+                try:
+                    # API call to Zabbix
+                    self.zabbix.hostinterface.update(updates)
+                    e = f"Host {self.name}: solved interface conflict."
+                    self.logger.info(e)
+                    self.create_journal_entry("info", e)
+                except APIRequestError as e:
+                    msg = f"Zabbix returned the following error: {str(e)}."
+                    self.logger.error(msg)
+                    raise SyncExternalError(msg) from e
+            else:
+                # If no updates are found, Zabbix interface is in-sync
+                e = f"Host {self.name}: interface in-sync."
+                self.logger.debug(e)
+        else:
+            e = (f"Host {self.name} has unsupported interface configuration."
+                 f" Host has total of {len(host['interfaces'])} interfaces. "
+                 "Manual interfention required.")
+            self.logger.error(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:
+            # Check if the severity is valid
+            if severity not in ["info", "success", "warning", "danger"]:
+                self.logger.warning(f"Value {severity} not valid for NB journal entries.")
+                return False
+            journal = {"assigned_object_type": "dcim.device",
+                       "assigned_object_id": self.id,
+                       "kind": severity,
+                       "comments": message
+                       }
+            try:
+                self.nb_journals.create(journal)
+                self.logger.debug(f"Host {self.name}: Created journal entry in Netbox")
+                return True
+            except JournalError(e) as e:
+                self.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):
+        """
+        Compares the Netbox and Zabbix templates with each other.
+        Should there be a mismatch then the function will return false
+
+        INPUT: list of NB and ZBX templates
+        OUTPUT: Boolean True/False
+        """
+        succesfull_templates = []
+        # Go through each Netbox template
+        for nb_tmpl in self.zbx_templates:
+            # 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"]:
+                    # 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)
+                    self.logger.debug(f"Host {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:
+            # 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.
+            return True
+        return False

modules/exceptions.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+"""
+All custom exceptions used for Exception generation
+"""
+class SyncError(Exception):
+    """ Class SyncError """
+
+class JournalError(Exception):
+    """ Class SyncError """
+
+class SyncExternalError(SyncError):
+    """ Class SyncExternalError """
+
+class SyncInventoryError(SyncError):
+    """ Class SyncInventoryError """
+
+class SyncDuplicateError(SyncError):
+    """ Class SyncDuplicateError """
+
+class EnvironmentVarError(SyncError):
+    """ Class EnvironmentVarError """
+
+class InterfaceConfigError(SyncError):
+    """ Class InterfaceConfigError """
+
+class ProxyConfigError(SyncError):
+    """ Class ProxyConfigError """
+
+class HostgroupError(SyncError):
+    """ Class HostgroupError """
+
+class TemplateError(SyncError):
+    """ Class TemplateError """

modules/hostgroups.py

@@ -0,0 +1,160 @@
+"""Module for all hostgroup related code"""
+from logging import getLogger
+from modules.exceptions import HostgroupError
+from modules.tools import build_path
+
+class Hostgroup():
+    """Hostgroup class for devices and VM's
+    Takes type (vm or dev) and NB object"""
+    def __init__(self, obj_type, nb_obj, version, logger=None):
+        self.logger = logger if logger else getLogger(__name__)
+        if obj_type not in ("vm", "dev"):
+            msg = f"Unable to create hostgroup with type {type}"
+            self.logger.error()
+            raise HostgroupError(msg)
+        self.type = str(obj_type)
+        self.nb = nb_obj
+        self.name = self.nb.name
+        self.nb_version = version
+        # Used for nested data objects
+        self.nested_objects = {}
+        self._set_format_options()
+
+    def __str__(self):
+        return f"Hostgroup for {self.type} {self.name}"
+
+    def __repr__(self):
+        return self.__str__()
+
+    def _set_format_options(self):
+        """
+        Set all available variables
+        for hostgroup generation
+        """
+        format_options = {}
+        # Set variables for both type of devices
+        if self.type in ("vm", "dev"):
+            # Role fix for Netbox <=3
+            role = None
+            if self.nb_version.startswith(("2", "3")) and self.type == "dev":
+                role = self.nb.device_role.name if self.nb.device_role else None
+            else:
+                role = self.nb.role.name if self.nb.role else None
+            # Add default formatting options
+            # Check if a site is configured. A site is optional for VMs
+            format_options["region"] = None
+            format_options["site_group"] = None
+            if self.nb.site:
+                if self.nb.site.region:
+                    format_options["region"] = self.generate_parents("region",
+                                                                     str(self.nb.site.region))
+                if self.nb.site.group:
+                    format_options["site_group"] = self.generate_parents("site_group",
+                                                                         str(self.nb.site.group))
+            format_options["role"] = role
+            format_options["site"] = self.nb.site.name if self.nb.site else None
+            format_options["tenant"] = str(self.nb.tenant) if self.nb.tenant else None
+            format_options["tenant_group"] = str(self.nb.tenant.group) if self.nb.tenant else None
+            format_options["platform"] = self.nb.platform.name if self.nb.platform else None
+        # Variables only applicable for devices
+        if self.type == "dev":
+            format_options["manufacturer"] = self.nb.device_type.manufacturer.name
+            format_options["location"] = str(self.nb.location) if self.nb.location else None
+        # Variables only applicable for VM's
+        if self.type == "vm":
+            # Check if a cluster is configured. Could also be configured in a site.
+            if self.nb.cluster:
+                format_options["cluster"] = self.nb.cluster.name
+                format_options["cluster_type"] = self.nb.cluster.type.name
+
+        self.format_options = format_options
+
+    def set_nesting(self, nested_sitegroup_flag, nested_region_flag,
+                    nb_groups, nb_regions):
+        """Set nesting options for this Hostgroup"""
+        self.nested_objects = {"site_group": {"flag": nested_sitegroup_flag, "data": nb_groups},
+                               "region": {"flag": nested_region_flag, "data": nb_regions}}
+
+    def generate(self, hg_format=None):
+        """Generate hostgroup based on a provided format"""
+        # Set format to default in case its not specified
+        if not hg_format:
+            hg_format = "site/manufacturer/role" if self.type == "dev" else "cluster/role"
+        # Split all given names
+        hg_output = []
+        hg_items = hg_format.split("/")
+        for hg_item in hg_items:
+            # Check if requested data is available as option for this host
+            if hg_item not in self.format_options:
+                # Check if a custom field exists with this name
+                cf_data = self.custom_field_lookup(hg_item)
+                # CF does not exist
+                if not cf_data["result"]:
+                    msg = (f"Unable to generate hostgroup for host {self.name}. "
+                           f"Item type {hg_item} not supported.")
+                    self.logger.error(msg)
+                    raise HostgroupError(msg)
+                # CF data is populated
+                if cf_data["cf"]:
+                    hg_output.append(cf_data["cf"])
+                continue
+            # Check if there is a value associated to the variable.
+            # For instance, if a device has no location, do not use it with hostgroup calculation
+            hostgroup_value = self.format_options[hg_item]
+            if hostgroup_value:
+                hg_output.append(hostgroup_value)
+        # Check if the hostgroup is populated with at least one item.
+        if bool(hg_output):
+            return "/".join(hg_output)
+        msg = (f"Unable to generate hostgroup for host {self.name}."
+               " Not enough valid items. This is most likely"
+               " due to the use of custom fields that are empty"
+               " or an invalid hostgroup format.")
+        self.logger.error(msg)
+        raise HostgroupError(msg)
+
+    def list_formatoptions(self):
+        """
+        Function to easily troubleshoot which values
+        are generated for a specific device or VM.
+        """
+        print(f"The following options are available for host {self.name}")
+        for option_type, value in self.format_options.items():
+            if value is not None:
+                print(f"{option_type} - {value}")
+        print("The following options are not available")
+        for option_type, value in self.format_options.items():
+            if value is None:
+                print(f"{option_type}")
+
+    def custom_field_lookup(self, hg_category):
+        """
+        Checks if a valid custom field is present in Netbox.
+        INPUT: Custom field name
+        OUTPUT: dictionary with 'result' and 'cf' keys.
+        """
+        # Check if the custom field exists
+        if hg_category not in self.nb.custom_fields:
+            return {"result": False, "cf": None}
+        # Checks if the custom field has been populated
+        if not bool(self.nb.custom_fields[hg_category]):
+            return {"result": True, "cf": None}
+        # Custom field exists and is populated
+        return {"result": True, "cf": self.nb.custom_fields[hg_category]}
+
+    def generate_parents(self, nest_type, child_object):
+        """
+        Generates parent objects to implement nested regions / nested site groups
+        INPUT: nest_type to set which type of nesting is going to be processed
+        child_object: the name of the child object (for instance the last NB region)
+        OUTPUT: STRING - Either the single child name or child and parents.
+        """
+        # Check if this type of nesting is supported.
+        if not nest_type in self.nested_objects:
+            return child_object
+        # If the nested flag is True, perform parent calculation
+        if self.nested_objects[nest_type]["flag"]:
+            final_nested_object = build_path(child_object, self.nested_objects[nest_type]["data"])
+            return "/".join(final_nested_object)
+        # Nesting is not allowed for this object. Return child_object
+        return child_object

modules/interface.py

@@ -0,0 +1,105 @@
+#!/usr/bin/env python3
+"""
+All of the Zabbix interface related configuration
+"""
+from modules.exceptions import InterfaceConfigError
+
+class ZabbixInterface():
+    """Class that represents a Zabbix interface."""
+
+    def __init__(self, context, ip):
+        self.context = context
+        self.ip = ip
+        self.skelet = {"main": "1", "useip": "1", "dns": "", "ip": self.ip}
+        self.interface = self.skelet
+
+    def _set_default_port(self):
+        """Sets default TCP / UDP port for different interface types"""
+        interface_mapping = {
+            1: 10050,
+            2: 161,
+            3: 623,
+            4: 12345
+        }
+        # Check if interface type is listed in mapper.
+        if self.interface['type'] not in interface_mapping:
+            return False
+        # Set default port to interface
+        self.interface["port"] = str(interface_mapping[self.interface['type']])
+        return True
+
+    def get_context(self):
+        """ check if Netbox custom context has been defined. """
+        if "zabbix" in self.context:
+            zabbix = self.context["zabbix"]
+            if "interface_type" in zabbix:
+                self.interface["type"] = zabbix["interface_type"]
+                if not "interface_port" in zabbix:
+                    self._set_default_port()
+                    return True
+                self.interface["port"] = zabbix["interface_port"]
+                return True
+            return False
+        return False
+
+    def set_snmp(self):
+        """ Check if interface is type SNMP """
+        # pylint: disable=too-many-branches
+        if self.interface["type"] == 2:
+            # Checks if SNMP settings are defined in Netbox
+            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:
+                    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"):
+                    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:
+                        # Set SNMP community to confix context value
+                        community = snmp["community"]
+                    else:
+                        # Set SNMP community to default
+                        community = "{$SNMP_COMMUNITY}"
+                    self.interface["details"]["community"] = str(community)
+                # If version 3 has been used, get all
+                # SNMPv3 Netbox related configs
+                elif self.interface["details"]["version"] == '3':
+                    items = ["securityname", "securitylevel", "authpassphrase",
+                             "privpassphrase", "authprotocol", "privprotocol",
+                             "contextname"]
+                    for key, item in snmp.items():
+                        if key in items:
+                            self.interface["details"][key] = str(item)
+                else:
+                    e = "Unsupported SNMP version."
+                    raise InterfaceConfigError(e)
+            else:
+                e = "Interface type SNMP but no parameters provided."
+                raise InterfaceConfigError(e)
+        else:
+            e = "Interface type is not SNMP, unable to set SNMP details"
+            raise InterfaceConfigError(e)
+
+    def set_default_snmp(self):
+        """ Set default config to SNMPv2, port 161 and community macro. """
+        self.interface = self.skelet
+        self.interface["type"] = "2"
+        self.interface["port"] = "161"
+        self.interface["details"] = {"version": "2",
+                                     "community": "{$SNMP_COMMUNITY}",
+                                     "bulk": "1"}
+
+    def set_default_agent(self):
+        """Sets interface to Zabbix agent defaults"""
+        self.interface["type"] = "1"
+        self.interface["port"] = "10050"

modules/tools.py

@@ -0,0 +1,44 @@
+"""A collection of tools used by several classes"""
+def convert_recordset(recordset):
+    """ Converts netbox RedcordSet to list of dicts. """
+    recordlist = []
+    for record in recordset:
+        recordlist.append(record.__dict__)
+    return recordlist
+
+def build_path(endpoint, list_of_dicts):
+    """
+    Builds a path list of related parent/child items.
+    This can be used to generate a joinable list to
+    be used in hostgroups.
+    """
+    item_path = []
+    itemlist = [i for i in list_of_dicts if i['name'] == endpoint]
+    item = itemlist[0] if len(itemlist) == 1 else None
+    item_path.append(item['name'])
+    while item['_depth'] > 0:
+        itemlist = [i for i in list_of_dicts if i['name'] == str(item['parent'])]
+        item = itemlist[0] if len(itemlist) == 1 else None
+        item_path.append(item['name'])
+    item_path.reverse()
+    return item_path
+
+def proxy_prepper(proxy_list, proxy_group_list):
+    """
+    Function that takes 2 lists and converts them using a
+    standardized format for further processing.
+    """
+    output = []
+    for proxy in proxy_list:
+        proxy["type"] = "proxy"
+        proxy["id"] = proxy["proxyid"]
+        proxy["idtype"] = "proxyid"
+        proxy["monitored_by"] = 1
+        output.append(proxy)
+    for group in proxy_group_list:
+        group["type"] = "proxy_group"
+        group["id"] = group["proxy_groupid"]
+        group["idtype"] = "proxy_groupid"
+        group["monitored_by"] = 2
+        output.append(group)
+    return output

modules/virtual_machine.py

@@ -0,0 +1,65 @@
+#!/usr/bin/env python3
+# pylint: disable=duplicate-code
+"""Module that hosts all functions for virtual machine processing"""
+
+from os import sys
+from modules.device import PhysicalDevice
+from modules.hostgroups import Hostgroup
+from modules.interface import ZabbixInterface
+from modules.exceptions import TemplateError, InterfaceConfigError, SyncInventoryError
+try:
+    from config import (
+        traverse_site_groups,
+        traverse_regions
+    )
+except ModuleNotFoundError:
+    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)
+
+class VirtualMachine(PhysicalDevice):
+    """Model for virtual machines"""
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.hostgroup = None
+        self.zbx_template_names = None
+
+    def set_hostgroup(self, hg_format, nb_site_groups, nb_regions):
+        """Set the hostgroup for this device"""
+        # Create new Hostgroup instance
+        hg = Hostgroup("vm", self.nb, self.nb_api_version, logger=self.logger)
+        hg.set_nesting(traverse_site_groups, traverse_regions, nb_site_groups, nb_regions)
+        # Generate hostgroup based on hostgroup format
+        self.hostgroup = hg.generate(hg_format)
+
+    def set_vm_template(self):
+        """ Set Template for VMs. Overwrites default class
+        to skip a lookup of custom fields."""
+        # Gather templates ONLY from the device specific context
+        try:
+            self.zbx_template_names = self.get_templates_context()
+        except TemplateError as e:
+            self.logger.warning(e)
+        return True
+
+    def setInterfaceDetails(self): # pylint: disable=invalid-name
+        """
+        Overwrites device function to select an agent interface type by default
+        Agent type interfaces are more likely to be used with VMs then SNMP
+        """
+        try:
+            # Initiate interface class
+            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 device is SNMP type, add aditional information.
+                if interface.interface["type"] == 2:
+                    interface.set_snmp()
+            else:
+                interface.set_default_agent()
+            return [interface.interface]
+        except InterfaceConfigError as e:
+            message = f"{self.name}: {e}"
+            self.logger.warning(message)
+            raise SyncInventoryError(message) from e

requirements.txt

@@ -1,2 +1,2 @@
 pynetbox
-pyzabbix
+zabbix_utils