Update from upstream

.github/workflows/tests.yml

@@ -0,0 +1,58 @@
+name: Tests
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+      - name: Install build dependencies
+        run: pip install build
+      - name: Build the package
+        run: python3 -m build
+      - name: Install the built package from tar.gz
+        run: pip install "$(echo dist/*.tar.gz)"[dev]
+      - name: Run netbox_agent to check that the installed package contains the required modules
+        run: netbox_agent --help
+      - name: Run tests
+        run: ./tests.sh
+      #- name: Upload coverage to Codecov
+      #  if: matrix.python-version == '3.13.0'
+      #  uses: codecov/codecov-action@v3
+      #  continue-on-error: true
+      #  with:
+      #    files: ./coverage.xml
+      #    token: ${{ secrets.CODECOV_TOKEN }}
+      #    fail_ci_if_error: true
+  ruff_linter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Install Ruff
+        run: pip install $(grep -Po '(?<=")ruff[^"]+' pyproject.toml)
+      - name: Ruff linter
+        run: ruff check
+  ruff_formatter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Install Ruff
+        run: pip install $(grep -Po '(?<=")ruff[^"]+' pyproject.toml)
+      - name: Ruff formatter
+        run: ruff format --diff

README.md

@@ -17,13 +17,15 @@ The goal is to generate an existing infrastructure on Netbox and have the abilit
 * Automatic cabling (server's interface to switch's interface) using lldp
 * Local inventory using `Inventory Item` for CPU, GPU, RAM, RAID cards, physical disks (behind raid cards)
 * PSUs creation and power consumption reporting (based on vendor's tools)
+* Associate hypervisor devices to the virtualization cluster
+* Associate virtual machines to the hypervisor device
 
 # Requirements
 
 - Netbox >= 3.7
 - Python >= 3.8
 - [pynetbox](https://github.com/digitalocean/pynetbox/)
-- [python3-netaddr](https://github.com/drkjam/netaddr)
+- [python3-netaddr](https://github.com/netaddr/netaddr)
 - [python3-netifaces](https://github.com/al45tair/netifaces)
 - [jsonargparse](https://github.com/omni-us/jsonargparse/)
 
@@ -128,6 +130,13 @@ network:
 #   # see https://netbox.company.com/virtualization/clusters/
 #   cluster_name: my_vm_cluster
 
+## Enable hypervisor support
+# virtual:
+#   enabled: false
+#   hypervisor: true
+#   cluster_name: my_cluster
+#   list_guests_cmd: command that lists VMs names
+
 # Enable datacenter location feature in Netbox
 datacenter_location:
  driver: "cmd:cat /etc/qualification | tr [A-Z] [a-z]"
@@ -290,3 +299,9 @@ On a personal note, I use the docker image from [netbox-community/netbox-docker]
 # docker-compose pull
 # docker-compose up
 ```
+
+For the linter and code formatting, you need to run:
+```
+ruff check
+ruff format
+```

netbox_agent/cli.py

@@ -1,3 +1,4 @@
+import sys
 from packaging import version
 import netbox_agent.dmidecode as dmidecode
 from netbox_agent.config import config
@@ -29,32 +30,43 @@ def run(config):
     dmi = dmidecode.parse()
 
     if config.virtual.enabled or is_vm(dmi):
+        if config.virtual.hypervisor:
+            raise Exception("This host can't be a hypervisor because it's a VM")
         if not config.virtual.cluster_name:
-            raise Exception('virtual.cluster_name parameter is mandatory because it\'s a VM')
+            raise Exception("virtual.cluster_name parameter is mandatory because it's a VM")
         server = VirtualMachine(dmi=dmi)
     else:
-        manufacturer = dmidecode.get_by_type(dmi, 'Chassis')[0].get('Manufacturer')
-        logging.info("Found manufacturer: %s" % manufacturer)
+        if config.virtual.hypervisor and not config.virtual.cluster_name:
+            raise Exception(
+                "virtual.cluster_name parameter is mandatory because it's a hypervisor"
+            )
+        manufacturer = dmidecode.get_by_type(dmi, "Chassis")[0].get("Manufacturer")
         try:
             server = MANUFACTURERS[manufacturer](dmi=dmi)
         except KeyError:
             server = GenericHost(dmi=dmi)
 
-    if version.parse(nb.version) < version.parse('3.7'):
-        print('netbox-agent is not compatible with Netbox prior to version 3.7')
-        return False
+    if version.parse(nb.version) < version.parse("3.7"):
+        print("netbox-agent is not compatible with Netbox prior to version 3.7")
+        return 1
 
-    if config.register or config.update_all or config.update_network or \
-       config.update_location or config.update_inventory or config.update_psu:
+    if (
+        config.register
+        or config.update_all
+        or config.update_network
+        or config.update_location
+        or config.update_inventory
+        or config.update_psu
+    ):
         server.netbox_create_or_update(config)
     if config.debug:
         server.print_debug()
-    return True
+    return 0
 
 
 def main():
     return run(config)
 
 
-if __name__ == '__main__':
-    main()
+if __name__ == "__main__":
+    sys.exit(main())

netbox_agent/config.py

@@ -10,87 +10,142 @@
 def get_config():
     p = jsonargparse.ArgumentParser(
         default_config_files=[
-            '/etc/netbox_agent.yaml',
-            '~/.config/netbox_agent.yaml',
-            '~/.netbox_agent.yaml',
+            "/etc/netbox_agent.yaml",
+            "~/.config/netbox_agent.yaml",
+            "~/.netbox_agent.yaml",
         ],
-        prog='netbox_agent',
+        prog="netbox_agent",
         description="Netbox agent to run on your infrastructure's servers",
-        env_prefix='NETBOX_AGENT_',
-        default_env=True
+        env_prefix="NETBOX_AGENT_",
+        default_env=True,
     )
-    p.add_argument('-c', '--config', action=jsonargparse.ActionConfigFile)
+    p.add_argument("-c", "--config", action=jsonargparse.ActionConfigFile)
 
-    p.add_argument('-r', '--register', action='store_true', help='Register server to Netbox')
-    p.add_argument('-u', '--update-all', action='store_true', help='Update all infos in Netbox')
-    p.add_argument('-d', '--debug', action='store_true', help='Print debug infos')
-    p.add_argument('--update-network', action='store_true', help='Update network')
-    p.add_argument('--update-inventory', action='store_true', help='Update inventory')
-    p.add_argument('--update-location', action='store_true', help='Update location')
-    p.add_argument('--update-psu', action='store_true', help='Update PSU')
-    p.add_argument('--update-old-devices', action='store_true',
-                   help='Update serial number of existing (old ?) devices having same name but different serial')
-    p.add_argument('--purge-old-devices', action='store_true',
-                   help='Purge existing (old ?) devices having same name but different serial')
-    p.add_argument('--expansion-as-device', action='store_true',
-                   help='Manage blade expansions as external devices')
+    p.add_argument("-r", "--register", action="store_true", help="Register server to Netbox")
+    p.add_argument("-u", "--update-all", action="store_true", help="Update all infos in Netbox")
+    p.add_argument("-d", "--debug", action="store_true", help="Print debug infos")
+    p.add_argument("--update-network", action="store_true", help="Update network")
+    p.add_argument("--update-inventory", action="store_true", help="Update inventory")
+    p.add_argument("--update-location", action="store_true", help="Update location")
+    p.add_argument("--update-psu", action="store_true", help="Update PSU")
+    p.add_argument(
+        "--update-hypervisor",
+        action="store_true",
+        help="Update virtualization cluster and virtual machines",
+    )
+    p.add_argument(
+        "--update-old-devices",
+        action="store_true",
+        help="Update serial number of existing (old ?) devices having same name but different serial",
+    )
+    p.add_argument(
+        "--purge-old-devices",
+        action="store_true",
+        help="Purge existing (old ?) devices having same name but different serial",
+    )
+    p.add_argument(
+        "--expansion-as-device",
+        action="store_true",
+        help="Manage blade expansions as external devices",
+    )
 
-    p.add_argument('--log_level', default='debug')
-    p.add_argument('--netbox.ssl_ca_certs_file', help='SSL CA certificates file')
-    p.add_argument('--netbox.url', help='Netbox URL')
-    p.add_argument('--netbox.token', help='Netbox API Token')
-    p.add_argument('--netbox.ssl_verify', default=True, action='store_true',
-                   help='Disable SSL verification')
-    p.add_argument('--virtual.enabled', action='store_true', help='Is a virtual machine or not')
-    p.add_argument('--virtual.cluster_name', help='Cluster name of VM')
-    p.add_argument('--hostname_cmd', default=None,
-                   help="Command to output hostname, used as Device's name in netbox")
-    p.add_argument('--device.platform', default=None,
-                   help='Override device platform. Here we use OS distribution.')
-    p.add_argument('--device.tags', default=r'',
-                   help='tags to use for a host')
-    p.add_argument('--preserve-tags', action='store_true', help='Append new unique tags, preserve those already present')
-    p.add_argument('--device.custom_fields', default=r'',
-                   help='custom_fields to use for a host, eg: field1=v1,field2=v2')
-    p.add_argument('--device.blade_role', default=r'Blade',
-                   help='role to use for a blade server')
-    p.add_argument('--device.chassis_role', default=r'Server Chassis',
-                   help='role to use for a chassis')
-    p.add_argument('--device.server_role', default=r'Server',
-                   help='role to use for a server')
-    p.add_argument('--tenant.driver',
-                   help='tenant driver, ie cmd, file')
-    p.add_argument('--tenant.driver_file',
-                   help='tenant driver custom driver file path')
-    p.add_argument('--tenant.regex',
-                   help='tenant regex to extract Netbox tenant slug')
-    p.add_argument('--datacenter_location.driver',
-                   help='Datacenter location driver, ie: cmd, file')
-    p.add_argument('--datacenter_location.driver_file',
-                   help='Datacenter location custom driver file path')
-    p.add_argument('--datacenter_location.regex',
-                   help='Datacenter location regex to extract Netbox DC slug')
-    p.add_argument('--rack_location.driver', help='Rack location driver, ie: cmd, file')
-    p.add_argument('--rack_location.driver_file', help='Rack location custom driver file path')
-    p.add_argument('--rack_location.regex', help='Rack location regex to extract Rack name')
-    p.add_argument('--slot_location.driver', help='Slot location driver, ie: cmd, file')
-    p.add_argument('--slot_location.driver_file', help='Slot location custom driver file path')
-    p.add_argument('--slot_location.regex', help='Slot location regex to extract slot name')
-    p.add_argument('--network.ignore_interfaces', default=r'(dummy.*|docker.*)',
-                   help='Regex to ignore interfaces')
-    p.add_argument('--network.ignore_ips', default=r'^(127\.0\.0\..*|fe80.*|::1.*)',
-                   help='Regex to ignore IPs')
-    p.add_argument('--network.ipmi', default=True, help='Enable gathering IPMI information')
-    p.add_argument('--network.lldp', help='Enable auto-cabling feature through LLDP infos')
-    p.add_argument('--inventory', action='store_true',
-                   help='Enable HW inventory (CPU, Memory, RAID Cards, Disks) feature')
-    p.add_argument('--process-virtual-drives', action='store_true',
-                   help='Process virtual drives information from RAID '
-                        'controllers to fill disk custom_fields')
-    p.add_argument('--force-disk-refresh', action='store_true',
-                   help='Forces disks detection reprocessing')
-    p.add_argument('--dump-disks-map',
-                   help='File path to dump physical/virtual disks map')
+    p.add_argument("--log_level", default="debug")
+    p.add_argument("--netbox.ssl_ca_certs_file", help="SSL CA certificates file")
+    p.add_argument("--netbox.url", help="Netbox URL")
+    p.add_argument("--netbox.token", help="Netbox API Token")
+    p.add_argument(
+        "--netbox.ssl_verify", default=True, action="store_true", help="Disable SSL verification"
+    )
+    p.add_argument("--virtual.enabled", action="store_true", help="Is a virtual machine or not")
+    p.add_argument("--virtual.cluster_name", help="Cluster name of VM")
+    p.add_argument("--virtual.hypervisor", action="store_true", help="Is a hypervisor or not")
+    p.add_argument(
+        "--virtual.list_guests_cmd",
+        default=None,
+        help="Command to output the list of vrtualization guests in the hypervisor separated by whitespace",
+    )
+    p.add_argument(
+        "--hostname_cmd",
+        default=None,
+        help="Command to output hostname, used as Device's name in netbox",
+    )
+    p.add_argument(
+        "--device.platform",
+        default=None,
+        help="Override device platform. Here we use OS distribution.",
+    )
+    p.add_argument("--device.tags", default=r"", help="tags to use for a host")
+    p.add_argument(
+        "--preserve-tags",
+        action="store_true",
+        help="Append new unique tags, preserve those already present",
+    )
+    p.add_argument(
+        "--device.custom_fields",
+        default=r"",
+        help="custom_fields to use for a host, eg: field1=v1,field2=v2",
+    )
+    p.add_argument("--device.blade_role", default=r"Blade", help="role to use for a blade server")
+    p.add_argument(
+        "--device.chassis_role", default=r"Server Chassis", help="role to use for a chassis"
+    )
+    p.add_argument("--device.server_role", default=r"Server", help="role to use for a server")
+    p.add_argument("--tenant.driver", help="tenant driver, ie cmd, file")
+    p.add_argument("--tenant.driver_file", help="tenant driver custom driver file path")
+    p.add_argument("--tenant.regex", help="tenant regex to extract Netbox tenant slug")
+    p.add_argument(
+        "--datacenter_location.driver", help="Datacenter location driver, ie: cmd, file"
+    )
+    p.add_argument(
+        "--datacenter_location.driver_file", help="Datacenter location custom driver file path"
+    )
+    p.add_argument(
+        "--datacenter_location.regex", help="Datacenter location regex to extract Netbox DC slug"
+    )
+    p.add_argument("--rack_location.driver", help="Rack location driver, ie: cmd, file")
+    p.add_argument("--rack_location.driver_file", help="Rack location custom driver file path")
+    p.add_argument("--rack_location.regex", help="Rack location regex to extract Rack name")
+    p.add_argument("--slot_location.driver", help="Slot location driver, ie: cmd, file")
+    p.add_argument("--slot_location.driver_file", help="Slot location custom driver file path")
+    p.add_argument("--slot_location.regex", help="Slot location regex to extract slot name")
+    p.add_argument(
+        "--network.ignore_interfaces",
+        default=r"(dummy.*|docker.*)",
+        help="Regex to ignore interfaces",
+    )
+    p.add_argument(
+        "--network.ignore_ips",
+        default=r"^(127\.0\.0\..*|fe80.*|::1.*)",
+        help="Regex to ignore IPs",
+    )
+    p.add_argument("--network.ipmi", default=True, help="Enable gathering IPMI information")
+    p.add_argument("--network.lldp", help="Enable auto-cabling feature through LLDP infos")
+    p.add_argument(
+        "--network.nic_id",
+        choices=("name", "mac"),
+        default="name",
+        help="What property to use as NIC identifier",
+    )
+    p.add_argument(
+        "--network.primary_mac",
+        choices=("permanent", "temp"),
+        default="temp",
+        help="Which MAC address to use as primary. Permanent requires ethtool and fallbacks to temporary",
+    )
+    p.add_argument(
+        "--inventory",
+        action="store_true",
+        help="Enable HW inventory (CPU, Memory, RAID Cards, Disks) feature",
+    )
+    p.add_argument(
+        "--process-virtual-drives",
+        action="store_true",
+        help="Process virtual drives information from RAID controllers to fill disk custom_fields",
+    )
+    p.add_argument(
+        "--force-disk-refresh", action="store_true", help="Forces disks detection reprocessing"
+    )
+    p.add_argument("--dump-disks-map", help="File path to dump physical/virtual disks map")
 
     options = p.parse_args()
     return options
@@ -101,7 +156,7 @@ def get_config():
 
 def get_netbox_instance():
     if config.netbox.url is None or config.netbox.token is None:
-        logging.error('Netbox URL and token are mandatory')
+        logging.error("Netbox URL and token are mandatory")
         sys.exit(1)
 
     nb = pynetbox.api(