enable settings ip_tenant_inheritance_order with import_inventory

Author: zvfvrv

module/sources/check_redfish/config.py

@@ -14,6 +14,7 @@
 from module.config.option import ConfigOption
 from module.sources.common.conifg import *
 from module.common.logging import get_logger
+from module.common.misc import quoted_split
 from module.sources.common.permitted_subnets import PermittedSubnets
 
 log = get_logger()
@@ -71,7 +72,21 @@ def __init__(self):
                          bool,
                          description="""define if existing interface attributes are overwritten with data discovered
                          via check_redfish if False only data which is not preset in NetBox will be added""",
-                         default_value=True)
+                         default_value=True),
+
+            ConfigOption("ip_tenant_inheritance_order",
+                         str,
+                         description="""\
+                         define in which order the IP address tenant will be assigned if tenant is undefined.
+                         possible values:
+                           * device : host or VM tenant will be assigned to the IP address
+                           * prefix : if the IP address belongs to an existing prefix and this prefix has a tenant assigned, then this one is used
+                           * disabled : no tenant assignment to the IP address will be performed
+                         the order of the definition is important, the default is "device, prefix" which means:
+                         If the device has a tenant then this one will be used. If not, the prefix tenant will be used if defined
+                         """,
+                         default_value="device, prefix"
+                         ),
         ]
 
         super().__init__()
@@ -93,6 +108,18 @@ def validate_options(self):
                     log.error(f"Inventory file path '{option.value}' not readable.")
                     self.set_validation_failed()
 
+            if option.key == "ip_tenant_inheritance_order":
+                option.set_value(quoted_split(option.value))
+                for ip_tenant_inheritance in option.value:
+                    if ip_tenant_inheritance not in ["device", "prefix", "disabled"]:
+                        log.error(f"Config value '{ip_tenant_inheritance}' invalid for "
+                                  f"config option 'ip_tenant_inheritance_order'!")
+                        self.set_validation_failed()
+
+                if len(option.value) > 2:
+                    log.error("Config option 'ip_tenant_inheritance_order' can contain only 2 items max")
+                    self.set_validation_failed()
+
         permitted_subnets_option = self.get_option_by_name("permitted_subnets")
 
         if permitted_subnets_option is not None:

module/sources/common/source_base.py

@@ -271,8 +271,8 @@ def add_update_interface(self, interface_object, device_object, interface_data,
             disable_vlan_sync = self.disable_vlan_sync
 
         ip_tenant_inheritance_order = None
-        if hasattr(self, "ip_tenant_inheritance_order"):
-            ip_tenant_inheritance_order = self.ip_tenant_inheritance_order
+        if hasattr(self.settings, "ip_tenant_inheritance_order"):
+            ip_tenant_inheritance_order = self.settings.ip_tenant_inheritance_order
 
         if not isinstance(interface_data, dict):
             log.error(f"Attribute 'interface_data' must be a dict() got {type(interface_data)}.")

settings-example.ini

@@ -376,4 +376,13 @@ inventory_file_path = /full/path/to/inventory/files
 ; check_redfish if False only data which is not preset in NetBox will be added
 ;overwrite_interface_attributes = True
 
+; define in which order the IP address tenant will be assigned if tenant is undefined.
+; possible values:
+;   * device : host or VM tenant will be assigned to the IP address
+;   * prefix : if the IP address belongs to an existing prefix and this prefix has a tenant assigned, then this one is used
+;   * disabled : no tenant assignment to the IP address will be performed
+; the order of the definition is important, the default is "device, prefix" which means:
+; If the device has a tenant then this one will be used. If not, the prefix tenant will be used if defined
+;ip_tenant_inheritance_order = device, prefix
+
 ;EOF