Clusters without sites or scopes support

README.md

@@ -1,6 +1,9 @@
 
 # NetBox-Sync
 
+> [!CAUTION]
+> **Maintainer wanted - sunsetting this repository by 31.10.2025 [#474](https://github.com/bb-Ricardo/netbox-sync/issues/474)**
+
 This is a tool to sync data from different sources to a NetBox instance.
 
 Available source types:

module/netbox/__init__.py

@@ -17,6 +17,8 @@
     NBTenant,
     NBSite,
     NBSiteGroup,
+    NBRegion,
+    NBLocation,
     NBVRF,
     NBVLAN,
     NBVLANList,

module/netbox/connection.py

@@ -196,15 +196,29 @@ def get_api_version(self):
         str: NetBox API version
         """
         response = None
+        result = None
+
         try:
             response = self.session.get(
-                self.url,
+                f"{self.url}/status",
                 timeout=self.settings.timeout,
                 verify=self.settings.validate_tls_certs)
         except Exception as e:
             do_error_exit(f"NetBox connection: {e}")
 
-        result = str(response.headers.get("API-Version"))
+        # noinspection PyBroadException
+        try:
+            result = grab(response.json(), "netbox-version").split("-")[0]
+        except Exception:
+            pass
+
+        if not isinstance(result, str):
+            result = str(response.headers.get("API-Version"))
+
+        try:
+            version.parse(result)
+        except Exception as e:
+            do_error_exit(f"Unable to parse NetBox version '{result}': {e}")
 
         log.info(f"Successfully connected to NetBox '{self.settings.host_fqdn}'")
         log.debug(f"Detected NetBox API version: {result}")

module/netbox/object_classes.py

@@ -552,7 +552,6 @@ def update(self, data=None, read_from_netbox=False, source=None):
 
         parsed_data = dict()
         for key, value in data.items():
-
             if key not in self.data_model.keys():
                 log.error(f"Found undefined data model key '{key}' for object '{self.__class__.__name__}'")
                 continue
@@ -683,6 +682,29 @@ def update(self, data=None, read_from_netbox=False, source=None):
             if self.data_model.get(key) == NBCustomField:
                 if current_value is None:
                     current_value = dict()
+
+                # Fix for object/multi-object custom fields
+                # When patching, we only need the IDs, not the full object representation
+                new_value_copy = new_value.copy()
+                for field_name, field_value in new_value_copy.items():
+                    # Check for custom field type
+                    custom_field = self.inventory.get_by_data(NBCustomField, data={"name": field_name})
+                    if custom_field is not None:
+                        field_type = grab(custom_field, "data.type")
+
+                        # Handle object type custom fields - need only ID
+                        if field_type == "object" and isinstance(field_value, dict) and field_value.get('id') is not None:
+                            new_value[field_name] = field_value.get('id')
+
+                        # Handle multi-object type custom fields - need list of IDs
+                        elif field_type == "multi-object" and isinstance(field_value, list):
+                            ids = []
+                            for item in field_value:
+                                if isinstance(item, dict) and item.get('id') is not None:
+                                    ids.append(item.get('id'))
+                            if ids:
+                                new_value[field_name] = ids
+
                 new_value = {**current_value, **new_value}
                 new_value_str = str(new_value)
             elif isinstance(new_value, (NetBoxObject, NBObjectList)):
@@ -728,7 +750,7 @@ def update(self, data=None, read_from_netbox=False, source=None):
                 new_value_str = new_value_str.replace("\n", " ")
                 log.info(f"{self.name.capitalize()} '{display_name}' attribute '{key}' changed from "
                          f"'{current_value_str}' to '{new_value_str}'")
-
+            
             self.data[key] = new_value
             self.updated_items.append(key)
             data_updated = True
@@ -1250,7 +1272,6 @@ def get_site_name(self, data=None):
             if isinstance(this_site, dict):
                 return this_site.get("name")
 
-
 class NBObjectList(list):
     """
     Base class of listed NetBox objects. Extends list(). Currently used for tags and untagged VLANs
@@ -1288,7 +1309,7 @@ def __init__(self, *args, **kwargs):
             "object_types": list,
             # field name (object_types) for NetBox < 4.0.0
             "content_types": list,
-            "type": ["text", "longtext", "integer", "boolean", "date", "url", "json", "select", "multiselect"],
+            "type": ["text", "longtext", "integer", "boolean", "date", "url", "json", "select", "multiselect", "object", "multi-object"],
             "name": 50,
             "label": 50,
             "description": 200,
@@ -1401,39 +1422,39 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
 
-# class NBLocation(NetBoxObject):
-#     name = "location"
-#     api_path = "dcim/locations"
-#     object_type = "dcim.location"
-#     primary_key = "name"
-#     prune = False
-#     read_only = True
-#
-#     def __init__(self, *args, **kwargs):
-#         self.data_model = {
-#             "name": 100,
-#             "slug": 100,
-#             "site": NBSite,
-#             "tags": NBTagList
-#         }
-#         super().__init__(*args, **kwargs)
-#
-#
-# class NBRegion(NetBoxObject):
-#     name = "region"
-#     api_path = "dcim/regions"
-#     object_type = "dcim.region"
-#     primary_key = "name"
-#     prune = False
-#     read_only = True
-#
-#     def __init__(self, *args, **kwargs):
-#         self.data_model = {
-#             "name": 100,
-#             "slug": 100,
-#             "tags": NBTagList
-#         }
-#         super().__init__(*args, **kwargs)
+class NBLocation(NetBoxObject):
+    name = "location"
+    api_path = "dcim/locations"
+    object_type = "dcim.location"
+    primary_key = "name"
+    prune = False
+    read_only = True
+
+    def __init__(self, *args, **kwargs):
+        self.data_model = {
+            "name": 100,
+            "slug": 100,
+            "site": NBSite,
+            "tags": NBTagList
+        }
+        super().__init__(*args, **kwargs)
+
+
+class NBRegion(NetBoxObject):
+    name = "region"
+    api_path = "dcim/regions"
+    object_type = "dcim.region"
+    primary_key = "name"
+    prune = False
+    read_only = True
+
+    def __init__(self, *args, **kwargs):
+        self.data_model = {
+            "name": 100,
+            "slug": 100,
+            "tags": NBTagList
+        }
+        super().__init__(*args, **kwargs)
 
 
 class NBSite(NetBoxObject):
@@ -1845,14 +1866,14 @@ class NBCluster(NetBoxObject):
     api_path = "virtualization/clusters"
     object_type = "virtualization.cluster"
     primary_key = "name"
-    secondary_key = "site"
+    secondary_key = "scope_id"
     prune = False
-    # include_secondary_key_if_present = True
 
     def __init__(self, *args, **kwargs):
         self.mapping = NetBoxMappings()
+        # scope types allowed for clusters
         self.scopes = [
-            NBSite, NBSiteGroup
+            NBSite, NBSiteGroup, NBLocation, NBRegion
         ]
         self.data_model = {
             "name": 100,
@@ -1861,29 +1882,20 @@ def __init__(self, *args, **kwargs):
             "tenant": NBTenant,
             "group": NBClusterGroup,
             "scope_type": self.mapping.scopes_object_types(self.scopes),
-            # currently only site is supported as a scope
-            "scope_id": NBSite,
+            # supports scoped clusters
+            "scope_id": NetBoxObject,
+            # supports pre4.2.0 clusters with site
+            "site": NBSite,
             "tags": NBTagList
         }
         super().__init__(*args, **kwargs)
 
     def update(self, data=None, read_from_netbox=False, source=None):
 
-        # Add adaption for change in NetBox 4.2.0 Device model
-        if version.parse(self.inventory.netbox_api_version) >= version.parse("4.2.0"):
-            if data.get("site") is not None:
-                data["scope_id"] = data.get("site")
-                data["scope_type"] = "dcim.site"
-                del data["site"]
-
-            if data.get("scope_id") is not None:
-                data["scope_type"] = "dcim.site"
-
         super().update(data=data, read_from_netbox=read_from_netbox, source=source)
 
     def resolve_relations(self):
-
-        self.resolve_scoped_relations("scope_id", "scope_type")
+        log.debug2(f"Resolving relations for {self.name} '{self.get_display_name()}'")
         super().resolve_relations()
 
 

module/sources/common/source_base.py

@@ -8,6 +8,7 @@
 #  repository or visit: <https://opensource.org/licenses/MIT>.
 
 import re
+from typing import Union,Optional
 
 from ipaddress import ip_interface, ip_address, IPv6Address, IPv4Address, IPv6Network, IPv4Network
 from packaging import version
@@ -179,7 +180,7 @@ def map_object_interfaces_to_current_interfaces(self, device_vm_object, interfac
 
         return return_data
 
-    def return_longest_matching_prefix_for_ip(self, ip_to_match=None, site_name=None) -> NBPrefix|None:
+    def return_longest_matching_prefix_for_ip(self, ip_to_match=None, site_name=None) -> Optional[NBPrefix]:
         """
         This is a lazy approach to find the longest matching prefix to an IP address.
         If site_name is set only IP prefixes from that site are matched.
@@ -716,7 +717,7 @@ def patch_data(object_to_patch, data, overwrite=False):
 
         return data_to_update
 
-    def add_vlan_group(self, vlan_data, vlan_site, vlan_cluster) -> NBVLAN | dict:
+    def add_vlan_group(self, vlan_data, vlan_site, vlan_cluster) -> Union[NBVLAN ,dict]:
         """
         This function will try to find a matching VLAN group according to the settings.
         Name matching will take precedence over ID matching. First match wins.

module/sources/vmware/config.py

@@ -143,6 +143,27 @@ def __init__(self):
                                              description="""Same as cluster site but on host level.
                                              If unset it will fall back to cluster_site_relation""",
                                              config_example="nyc02.* = New York, ffm01.* = Frankfurt"),
+                                ConfigOption("cluster_scope_type_relation", 
+                                             str,
+                                             description="""This option defines the scope type for a cluster.
+                                             The scope type can be 'dcim.site', 'dcim.sitegroup', 'dcim.location' or 'dcim.region'.
+                                             This is done with a comma separated key = value list.
+                                             Can be set to "<NONE>" to not assign a scope type.
+                                             Note: this does not remove scope types from existing clusters in NetBox.
+                                               key: defines a cluster name as regex
+                                               value: defines the NetBox scope type name (use quotes if name contains commas)
+                                             """,
+                                             config_example="Cluster_NYC = dcim.site, Cluster_FFM = dcim.sitegroup, Cluster_BER = dcim.location"),
+                                ConfigOption("cluster_scope_id_relation",
+                                             str,
+                                             description="""This option defines the scope id for a cluster.
+                                             The scope id is the NetBox ID of the scope type.
+                                             This is done with a comma separated key = value list.
+                                             To be used in combination with the 'cluster_scope_type_relation'.
+                                               key: defines a cluster name as regex
+                                               value: defines the NetBox scope id (use quotes if name contains commas)
+                                             """,
+                                             config_example="Cluster_NYC = 1, Cluster_FFM.* = 2, Cluster_BER = 7"),
                                 ConfigOption("cluster_tenant_relation",
                                              str,
                                              description="""\