Development

Dockerfile

@@ -2,18 +2,23 @@ FROM python:3.11-slim-bookworm AS builder
 
 COPY requirements.txt .
 
+ARG VENV=/opt/netbox-sync/venv
+
 # Install dependencies
 RUN apt-get update && apt-get install -y --no-install-recommends git && \
     rm -rf /var/lib/apt/lists/* && \
-    python3 -m venv /opt/netbox-sync/venv && \
-    /opt/netbox-sync/venv/bin/python3 -m pip install --upgrade pip && \
-    /opt/netbox-sync/venv/bin/pip install -r requirements.txt && \
-    /opt/netbox-sync/venv/bin/pip install --upgrade git+https://github.com/vmware/vsphere-automation-sdk-python.git
+    python3 -m venv $VENV && \
+    $VENV/bin/python3 -m pip install --upgrade pip && \
+    $VENV/bin/pip install -r requirements.txt && \
+    $VENV/bin/pip install --upgrade git+https://github.com/vmware/vsphere-automation-sdk-python.git && \
+    find $VENV -type d -name "__pycache__" -print0 | xargs -0 -n1 rm -rf
 
 FROM python:3.11-slim-bookworm AS netbox-sync
 
+ARG VENV=/opt/netbox-sync/venv
+
 # Copy installed packages
-COPY --from=builder /opt/netbox-sync/venv /opt/netbox-sync/venv
+COPY --from=builder $VENV $VENV
 
 # Add netbox-sync user
 RUN groupadd --gid 1000 netbox-sync && \
@@ -27,7 +32,7 @@ WORKDIR /app
 COPY --chown=netbox-sync:netbox-sync . .
 
 # Use virtual env packages and allow timezone setup
-ENV PATH=/opt/netbox-sync/venv/bin:$PATH
+ENV PATH=$VENV/bin:$PATH
 ENV TZ=Europe/Berlin
 
 ENTRYPOINT ["python3", "netbox-sync.py"]

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 - 2021 Ricardo Bartels
+Copyright (c) 2020 - 2025 Ricardo Bartels
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -99,7 +99,7 @@ usage: netbox-sync.py [-h] [-c settings.ini [settings.ini ...]] [-g]
 
 Sync objects from various sources to NetBox
 
-Version: 1.7.0 (2024-10-21)
+Version: 1.8.0 (2025-03-07)
 Project URL: https://github.com/bb-ricardo/netbox-sync
 
 options:

docs/source_vmware.md

@@ -28,7 +28,7 @@ IP addresses and interfaces will be added to NetBox.
 Try to find object first based on the object data, interface MAC addresses and primary IPs.
 1. try to find by name and cluster/site
 2. try to find by mac addresses interfaces
-3. try to find by serial number (1st) or asset tag (2nd) (ESXi host)
+3. try to find by serial number (1st) or asset tag (2nd)
 4. try to find by primary IP
 
 ### Finding hosts and VMs from discovered data
@@ -49,7 +49,7 @@ If two or more NetBox object (device, vm) with matching MACs were found, compare
 NetBox object (device, vm) with the highest amount of matching interfaces. If the ratio of matching interface
 MAC addresses exceeds 2.0 then the top matching NetBox object (device, vm) is chosen as desired object.
 
-If the ratio is below 2.0 then None will be chosen. The probability is to low that
+If the ratio is below 2.0 then None will be chosen. The probability is too low that
 this one is the correct one.
 
 #### 3. Try to find a NetBox object based on the primary IP (v4 or v6) address

module/__init__.py

@@ -1,14 +1,14 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #
 #  This work is licensed under the terms of the MIT license.
 #  For a copy, see file LICENSE.txt included in this
 #  repository or visit: <https://opensource.org/licenses/MIT>.
 
-__version__ = "1.7.0"
-__version_date__ = "2024-10-21"
+__version__ = "1.8.0"
+__version_date__ = "2025-03-07"
 __author__ = "Ricardo Bartels <ricardo.bartels@telekom.de>"
 __description__ = "NetBox Sync"
 __license__ = "MIT"

module/common/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #

module/common/cli_parser.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #
@@ -23,7 +23,7 @@ def parse_command_line(self_description=None):
     Parameters
     ----------
     self_description: str
-        short self description of this program
+        short self-description of this program
 
     Returns
     -------

module/common/config.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #

module/common/logging.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #

module/common/misc.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #
@@ -15,7 +15,7 @@ def grab(structure=None, path=None, separator=".", fallback=None):
     """
         get data from a complex object/json structure with a
         "." separated path information. If a part of a path
-        is not not present then this function returns the
+        is not present then this function returns the
         value of fallback (default: "None").
 
         example structure:
@@ -38,7 +38,7 @@ def grab(structure=None, path=None, separator=".", fallback=None):
         Parameters
         ----------
         structure: dict, list, object
-            object structure to extract data from
+            an object structure to extract data from
         path: str
             nested path to extract
         separator: str

module/common/support.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #
@@ -51,9 +51,9 @@ def perform_ptr_lookups(ips, dns_servers=None):
     Parameters
     ----------
     ips: list
-        list of IP addresses to look up
+        a list of IP addresses to look up
     dns_servers: list
-        list of DNS servers to use to look up list of IP addresses
+        a list of DNS servers to use to look up list of IP addresses
 
     Returns
     -------

module/config/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #

module/config/base.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #
@@ -30,6 +30,10 @@ def __eq__(self, other):
     def __contains__(self, key):
         return key in self.__dict__
 
+    def __getattr__(self, item):
+        if item in self:
+            return getattr(self, item)
+        return None
 
 class ConfigBase:
     """

module/config/file_output.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #

module/config/files.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #

module/config/formatter.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #

module/config/group.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #

module/config/option.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #

module/config/parser.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #

module/netbox/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #
@@ -16,9 +16,11 @@
     NBTagList,
     NBTenant,
     NBSite,
+    NBSiteGroup,
     NBVRF,
     NBVLAN,
     NBVLANList,
+    NBVLANGroup,
     NBPrefix,
     NBManufacturer,
     NBDeviceType,
@@ -33,6 +35,7 @@
     NBVirtualDisk,
     NBInterface,
     NBIPAddress,
+    NBMACAddress,
     NBFHRPGroupItem,
     NBInventoryItem,
     NBPowerPort

module/netbox/config.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #

module/netbox/connection.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2023 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2025 Ricardo Bartels. All rights reserved.
 #
 #  netbox-sync.py
 #
@@ -217,20 +217,20 @@ def request(self, object_class, req_type="GET", data=None, params=None, nb_id=No
 
         Parameters
         ----------
-        object_class: NetBoxObject sub class
+        object_class: NetBoxObject subclass
             class definition of the desired NetBox object
         req_type: str
             GET, PATCH, PUT, DELETE
         data: dict
-            data which shall be send to NetBox
+            data which shall be sent to NetBox
         params: dict
-            dict of URL params which should be passed to NetBox
+            dictionary of URL params which should be passed to NetBox
         nb_id: int
             ID of the NetBox object which will be appended to the requested NetBox URL
 
         Returns
         -------
-        (dict, bool, None): of returned NetBox data. If object was requested to be deleted and it was
+        dict, bool, None: of returned NetBox data. If object was requested to be deleted, and it was
                             successful then True will be returned. None if request failed or was empty
         """
 
@@ -373,12 +373,12 @@ def query_current_data(self, netbox_objects_to_query=None):
         """
         Request all current NetBox objects. Use caching whenever possible.
         Objects must provide "last_updated" attribute to support caching for this object type.
-        Otherwise it's not possible to query only changed objects since last run. If attribute is
+        Otherwise, it's not possible to query only changed objects since last run. If attribute is
         not present all objects will be requested (looking at you *Interfaces)
 
         Parameters
         ----------
-        netbox_objects_to_query: list of NetBoxObject sub classes
+        netbox_objects_to_query: list of NetBoxObject subclasses
             NetBox items to query
 
         """
@@ -585,14 +585,14 @@ def initialize_basic_data(self):
 
     def update_object(self, nb_object_sub_class, unset=False, last_run=False):
         """
-        Iterate over all objects of a certain NetBoxObject sub class and add/update them.
+        Iterate over all objects of a certain NetBoxObject subclass and add/update them.
         But first update objects which this object class depends on.
         If some dependencies are unresolvable then these will be removed from the request
         and re added later to the object to try update object in a third run.
 
         Parameters
         ----------
-        nb_object_sub_class: NetBoxObject sub class
+        nb_object_sub_class: NetBoxObject subclass
             NetBox objects to update
         unset: bool
             True if only unset items should be deleted
@@ -650,17 +650,18 @@ def update_object(self, nb_object_sub_class, unset=False, last_run=False):
                         # resolve dependency issues in last run
                         # primary IP always set in last run
                         if value.get_nb_reference() is None or \
-                                (key.startswith("primary_ip") and last_run is False):
+                                (key.startswith("primary_ip") and last_run is False) or \
+                                (key.startswith("primary_mac_address") and last_run is False):
                             unresolved_dependency_data[key] = value
                         else:
                             data_to_patch[key] = value.get_nb_reference()
 
                     else:
                         data_to_patch[key] = value
 
-            # special case for IP address
-            if isinstance(this_object, NBIPAddress):
-                # if object is new and and has no id, then we need to remove assigned_object_type from data_to_patch
+            # special case for IP and MAC addresses
+            if isinstance(this_object, (NBIPAddress, NBMACAddress)):
+                # if object is new and has no id, then we need to remove assigned_object_type from data_to_patch
                 if "assigned_object_id" in unresolved_dependency_data.keys() and \
                         "assigned_object_type" in data_to_patch.keys():
                     del data_to_patch["assigned_object_type"]
@@ -674,7 +675,7 @@ def update_object(self, nb_object_sub_class, unset=False, last_run=False):
                 req_type = "POST"
                 action = "Creating new"
 
-                # if its not a new object then update it
+                # if it's not a new object then update it
                 if this_object.is_new is False:
                     nb_id = this_object.nb_id
                     req_type = "PATCH"
@@ -928,7 +929,7 @@ def delete_unused_tags(self):
             if tag_description is None or not tag_description.startswith(self.primary_tag):
                 continue
 
-            if tag_tagged_items is None or tag_tagged_items != 0:
+            if tag_tagged_items is None or tag_tagged_items != 0 or this_tag.used is True:
                 continue
 
             log.info(f"Deleting unused tag '{this_tag.get_display_name()}'")