bb-Ricardo · bb-Ricardo · Feb 26, 2025 · Mar 20, 2025 · Mar 21, 2025 · Mar 21, 2025
diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml
@@ -26,14 +26,14 @@ jobs:
         uses: actions/checkout@v6
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
+        uses: docker/setup-qemu-action@v4
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
+        uses: docker/setup-buildx-action@v4
 
       - name: Lower case docker image name
         id: docker_image
-        uses: ASzc/change-string-case-action@v6
+        uses: ASzc/change-string-case-action@v8
         with:
           string: ${{ github.repository }}
 
@@ -46,7 +46,7 @@ jobs:
           replace: ${{ vars.DOCKER_HUB_USERNAME }}
 
       - name: Log in to GitHub Container Registry
-        uses: docker/login-action@v3
+        uses: docker/login-action@v4
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
@@ -71,7 +71,7 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
 
       - name: Log in to Docker Hub
-        uses: docker/login-action@v3
+        uses: docker/login-action@v4
         with:
           username: ${{ vars.DOCKER_HUB_USERNAME }}
           password: ${{ secrets.DOCKER_HUB_PASSWORD }}

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,46 @@
+name: Test
+
+on:
+  push:
+    branches: [ "main", "development" ]
+  pull_request:
+    branches: [ "main", "development" ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+
+    env:
+      # vcsim serves the captured vCenter inventories in tests/fixtures/vcsim
+      GOVMOMI_VERSION: v0.56.0
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+          cache: pip
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install pytest
+
+      - name: Install vcsim
+        run: |
+          curl -fsSL -o vcsim.tar.gz \
+            "https://github.com/vmware/govmomi/releases/download/${GOVMOMI_VERSION}/vcsim_Linux_x86_64.tar.gz"
+          tar -xzf vcsim.tar.gz vcsim
+          sudo install -m 0755 vcsim /usr/local/bin/vcsim
+          vcsim -h 2>&1 | head -1 || true
+
+      - name: Run tests
+        run: pytest -v
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -0,0 +1,6 @@
+
+* @bb-ricardo
+
+
+/sources/hetzner/ @SerhiiZahuba
+docs/source_hetzner.md @SerhiiZahuba
diff --git a/Dockerfile b/Dockerfile
@@ -1,19 +1,19 @@
-FROM python:3.13-slim AS builder
+FROM python:3.14-slim 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 gcc libc-dev && \
+RUN apt-get update && \
     rm -rf /var/lib/apt/lists/* && \
     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 && \
+    $VENV/bin/pip install --upgrade vcf-sdk && \
     find $VENV -type d -name "__pycache__" -print0 | xargs -0 -n1 rm -rf
 
-FROM python:3.13-slim AS netbox-sync
+FROM python:3.14-slim AS netbox-sync
 
 ARG VENV=/opt/netbox-sync/venv
 

diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 - 2025 Ricardo Bartels
+Copyright (c) 2020 - 2026 netbox-sync team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,4 +1,3 @@
-
 # NetBox-Sync
 
 This is a tool to sync data from different sources to a NetBox instance.
@@ -30,14 +29,8 @@ This ensures stale objects are removed from NetBox keeping an accurate current s
 
 ## Requirements
 ### Software
-* python >= 3.6
-* packaging
-* urllib3==2.2.1
-* wheel
-* requests==2.31.0
-* pyvmomi==8.0.2.0.1
-* aiodns==3.0.0
-* pyyaml==6.0.1
+* python >= 3.12
+* see [requirements.txt](requirements.txt)
 
 ### Environment
 * NetBox >= 2.9
@@ -49,20 +42,17 @@ This ensures stale objects are removed from NetBox keeping an accurate current s
 # Installing
 * here we assume we install in ```/opt```
 
-## RedHat based OS
-* on RedHat/CentOS 7 you need to install python3.6 and pip from EPEL first
-* on RedHat/CentOS 8 systems the package name changed to `python3-pip`
+## RedHat based distributions
 ```shell
-yum install python36-pip
+yum install python3-pip
 ```
 
-## Ubuntu 18.04 & 20.04 && 22.04
+## Debian (Ubuntu) based distributions
 ```shell
 apt-get update && apt-get install python3-venv
 ```
 
 ## Clone repo and install dependencies
-* If you need to use python 3.6 then you would need `requirements_3.6.txt` to install requirements
 * download and setup of virtual environment
 ```shell
 cd /opt
@@ -76,10 +66,10 @@ pip3 install -r requirements.txt || pip install -r requirements.txt
 ```
 
 ### VMware tag sync (if necessary)
-The `vsphere-automation-sdk` must be installed if tags should be synced from vCenter to NetBox
+The `vcf-sdk` must be installed if tags should be synced from vCenter to NetBox
 * assuming we are still in an activated virtual env
 ```shell
-pip install --upgrade git+https://github.com/vmware/vsphere-automation-sdk-python.git
+pip install --upgrade vcf-sdk
 ```
 
 ## NetBox API token
@@ -88,6 +78,8 @@ In order to updated data in NetBox you need a NetBox API token.
   * auth
   * secrets
   * users
+* Both v1 (legacy) and v2 tokens (NetBox 4.5+, `nbt_` prefix) are supported.
+  The correct authorization header (`Token` or `Bearer`) is detected automatically.
 
 A short description can be found [here](https://docs.netbox.dev/en/stable/integrations/rest-api/#authentication)
 
@@ -99,7 +91,7 @@ usage: netbox-sync.py [-h] [-c settings.ini [settings.ini ...]] [-g]
 
 Sync objects from various sources to NetBox
 
-Version: 1.8.1 (2026-03-18)
+Version: 1.9.0 (2026-09-30)
 Project URL: https://github.com/bb-ricardo/netbox-sync
 
 options:
@@ -215,21 +207,25 @@ In Order to sync all items regularly you can add a cron job like this one
 
 ## Docker
 
-Run the application in a docker container. You can build it yourself or use the ones from docker hub.
+Run the application in a docker container. You can build it yourself or use the published images.
+
+Available here: [ghcr.io/bb-ricardo/netbox-sync](https://github.com/bb-Ricardo/netbox-sync/pkgs/container/netbox-sync)
 
-Available here: [bbricardo/netbox-sync](https://hub.docker.com/r/bbricardo/netbox-sync)
+Images used to be published on Docker Hub as [bbricardo/netbox-sync](https://hub.docker.com/r/bbricardo/netbox-sync).
+v1.9.0 is the last release pushed there; later releases are only published on the GitHub Container Registry,
+so switch the pull address to `ghcr.io/bb-ricardo/netbox-sync`.
 
 * The application working directory is ```/app```
 * Required to mount your ```settings.ini```
 
 To build it by yourself just run:
 ```shell
-docker build -t bbricardo/netbox-sync:latest .
+docker build -t ghcr.io/bb-ricardo/netbox-sync:latest .
 ```
 
 To start the container just use:
 ```shell
-docker run --rm -it -v $(pwd)/settings.ini:/app/settings.ini bbricardo/netbox-sync:latest
+docker run --rm -it -v $(pwd)/settings.ini:/app/settings.ini ghcr.io/bb-ricardo/netbox-sync:latest
 ```
 
 ## Kubernetes
@@ -295,6 +291,17 @@ Check out the documentations for the different sources
 * [vmware](https://github.com/bb-Ricardo/netbox-sync/blob/main/docs/source_vmware.md)
 * [check_redfish](https://github.com/bb-Ricardo/netbox-sync/blob/main/docs/source_check_redfish.md)
 
+### Filtering
+netbox-sync provides various filtering capabilities to control what objects are synced from sources to NetBox:
+
+1. **General VM filtering**: Use `vm_include_filter` and `vm_exclude_filter` to include or exclude VMs by name.
+2. **Tag-based VM filtering**: Use `vm_exclude_by_tag_filter` to exclude VMs with specific vCenter tags.
+3. **Partial information filtering**:
+   - Use `vm_exclude_disk_sync` to exclude disk synchronization for VMs matching specific name patterns.
+   - Use `vm_exclude_disk_sync_by_tag` to exclude disk synchronization for VMs with specific vCenter tags.
+
+These filters allow for fine-grained control over what information is synchronized, helping to avoid clutter in the change log from temporary or backup-related disk changes.
+
 If you have multiple vCenter instances or check_redfish folders just add another source with the same type
 in the **same** file.
 

diff --git a/docs/source_hetzner.md b/docs/source_hetzner.md
@@ -0,0 +1,12 @@
+# Source: hetzner
+
+## Setup
+You need to have a source section in your `settings.ini` file with following type:
+```ini
+type = hetzner
+```
+
+
+### Hetzner api
+You need to create a "Read-only" api_token
+https://docs.hetzner.com/cloud/api/getting-started/generating-api-token/
diff --git a/docs/source_vmware.md b/docs/source_vmware.md
@@ -107,3 +107,99 @@ Primary IPv4/6 will be determined by interface that provides the default route f
 
 **Note:**<br>
 IP address information can only be extracted if guest tools are installed and running.
+
+#### 6. Sync VMware Tools guest hostname to a custom field
+
+The vCenter VM name (used as the NetBox VM `name`) and the hostname reported from inside the
+guest OS by VMware Tools are not always identical. This can happen if:
+* a VM was renamed in vCenter but the OS hostname was not changed (or vice versa)
+* an OS administrator changed the hostname without informing the virtualization team
+* a VM was cloned and the guest hostname was not adjusted afterwards
+
+To make this drift visible in NetBox, the option `vm_guest_hostname_custom_field` can be set to
+the name of a NetBox custom field. If set, the guest hostname reported by VMware Tools (vCenter
+property `guest.hostName`) is synced into that custom field on every synced VM, while the NetBox
+VM `name` keeps reflecting the vCenter inventory name unchanged. This allows administrators to
+compare the NetBox VM name against the custom field value on the same VM record to spot naming
+drift.
+
+```ini
+vm_guest_hostname_custom_field = vmware_guest_hostname
+```
+
+If the custom field does not exist in NetBox yet it will be created automatically (type `Text`,
+assigned to the `Virtual Machine` object type), the same way other custom fields managed by
+netbox-sync (e.g. `vcsa_*` custom attributes) are created. An administrator can also pre-create
+the field beforehand; netbox-sync will then just use the existing field.
+
+This option is unset by default, so the feature is disabled and no additional custom field is
+created unless explicitly configured.
+
+VMware Tools may not always report a hostname, for example if Tools are not installed, not
+running, outdated, or simply have not reported guest information yet. In that case
+netbox-sync leaves the custom field untouched and keeps the last known value, instead of
+clearing it. A message is logged at debug level (`-l DEBUG2`) whenever this happens.
+
+Example result in NetBox for a VM named `APPPRD01` in vCenter whose guest OS reports
+`appprd01.corp.example.com` as its hostname:
+
+```text
+Virtual Machine Name:        APPPRD01
+Custom Fields:
+  VMware Guest Hostname:     appprd01.corp.example.com
+```
+
+### Cables to CDP/LLDP neighbors
+
+An ESXi host reports the switch and the switch port each of its physical interfaces (pNICs) is
+connected to, if CDP or LLDP is enabled on the switch. With the option `sync_host_cables` enabled
+netbox-sync uses this information to create cables in NetBox between the host interface and the
+switch port.
+
+```ini
+sync_host_cables = True
+```
+
+Cables are objects which are usually maintained by hand, that's why this option is disabled by
+default. With the option disabled no cable is read from or written to NetBox at all. NetBox 3.3 or
+newer is needed, on older versions the option is ignored.
+
+netbox-sync only connects things it can find, it never creates the other end of a cable:
+
+* the device the neighbor reports as its system name must already exist in NetBox. The name is
+  matched exactly first, a short name is only matched against a FQDN if that match is unambiguous
+* the port the neighbor reports must already exist as an interface of that device. Long and short
+  interface names are matched against each other, so a reported `FastEthernet0/16` also matches an
+  interface named `Fa0/16` in NetBox. CDP reports the port ID, LLDP additionally reports a port
+  description and both are tried
+* both interfaces must already exist in NetBox. An interface which was just discovered gets its
+  cable during the next run
+* neither of the two interfaces may be connected already. A cable which was created by hand or which
+  connects to a different port is never changed or deleted, it is reported at log level `DEBUG`
+  instead
+
+Cables created by this source are tagged like every other object and are marked as orphaned and
+pruned once the host stops reporting that neighbor (see `prune_enabled`). Disabling the option again
+leaves all previously created cables untouched in NetBox.
+
+### Filtering VM Disk Information
+VM disks are synchronized between vCenter and NetBox. Since NetBox 3.7.0, virtual disks are tracked as separate objects 
+linked to VMs. In some scenarios, such as when temporary disks are attached to VMs during backup operations 
+(e.g., "Independent-nonpersistent" disks from Veeam), you might want to exclude these changes from synchronization 
+to avoid cluttering your NetBox change log.
+
+You can use the following filter options to exclude disk synchronization for specific VMs:
+
+1. **`vm_exclude_disk_sync`**: A regex pattern matching VM names where disk synchronization should be excluded.
+   ```ini
+   vm_exclude_disk_sync = backup-.*, veeam-.*
+   ```
+
+2. **`vm_exclude_disk_sync_by_tag`**: A comma-separated list of vCenter tags. VMs with any of these tags will have 
+   their disk information excluded from synchronization.
+   ```ini
+   vm_exclude_disk_sync_by_tag = backup-vm, veeam-job
+   ```
+
+When a VM matches these filters, it will still be synchronized to NetBox with all its other information 
+(CPU, memory, interfaces, IP addresses, etc.), but changes to disk information will be ignored.
diff --git a/k8s-netbox-sync-cronjob.yaml b/k8s-netbox-sync-cronjob.yaml
@@ -13,7 +13,7 @@ spec:
         spec:
           containers:
           - name: netbox-sync
-            image: bbricardo/netbox-sync:latest
+            image: ghcr.io/bb-ricardo/netbox-sync:latest
             imagePullPolicy: IfNotPresent
             args:
               - -c

diff --git a/module/__init__.py b/module/__init__.py
@@ -1,14 +1,14 @@
 # -*- coding: utf-8 -*-
-#  Copyright (c) 2020 - 2026 Ricardo Bartels. All rights reserved.
+#  Copyright (c) 2020 - 2026 netbox-sync team. 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.8.1"
-__version_date__ = "2026-03-18"
+__version__ = "1.9.0"
+__version_date__ = "2026-09-30"
 __author__ = "Ricardo Bartels <ricardo.bartels@telekom.de>"
 __description__ = "NetBox Sync"
 __license__ = "MIT"