#1141 Added virtual_disks to nb_inventory.py (#1188)

* Added virtual_disks to nb_inventory.py

* Update nb_inventory.py

formatting

* Increase version

* added tests

* added  virtual_disks to test data

* Update test-inventory.yml

Added virtual_disks

* Update data.json

added virtual_disks

* Update test-inventory.json

Updated virtual_disks data in inventory file

* Update test-inventory.json

corrected syntax error

* Update test-inventory.json

syntax error corrected

* Update test-inventory.json

No vdisks?

* Update test-inventory.json

removed duplicate virtual disks

* Update test-inventory.json

No vm disk in test enviroment test

* Create data.json

add virtual disks to test100-vm

* Update netbox-deploy.py

added virtual disks to deploy

* Update test-inventory.json

added to inventory

* Update netbox-deploy.py

changed virtual machine to id

* #1141 2 (#2)

* Added virtual_disks to deploy

* Added virtual_disks to inventory

* Update data.json with virtual disks

* Update test_nb_inventory.py

* Update test-inventory.yml

* fix integration tests

---------

Co-authored-by: = <=>

* fix linting

* fix unit tests

* fix integration tests

* fix integration tests

* fix inventory result files

---------

Co-authored-by: Martin Adler <[email protected]>
Co-authored-by: = <=>

Author: tkn2023

plugins/inventory/nb_inventory.py

@@ -13,6 +13,7 @@
         - Nikhil Singh Baliyan (@nikkytub)
         - Sander Steffann (@steffann)
         - Douglas Heriot (@DouglasHeriot)
+        - Thore Knickrehm (@tkn2023)
     short_description: NetBox inventory source
     description:
         - Get inventory hosts from NetBox
@@ -99,6 +100,12 @@
             default: True
             type: boolean
             version_added: "0.2.1"
+        virtual_disks:
+            description:
+                - If True, it adds the virtual disks information in host vars.
+            default: False
+            type: boolean
+            version_added: "3.18.0"
         interfaces:
             description:
                 - If True, it adds the device or virtual machine interface information in host vars.
@@ -592,7 +599,12 @@ def group_extractors(self):
                     "services": self.extract_services,
                 }
             )
-
+        if self.virtual_disks:
+            extractors.update(
+                {
+                    "virtual_disks": self.extract_virtual_disks,
+                }
+            )
         if self.interfaces:
             extractors.update(
                 {
@@ -845,6 +857,15 @@ def extract_tags(self, host):
         except Exception:
             return host["tags"]
 
+    def extract_virtual_disks(self, host):
+        try:
+            virtual_disks_lookup = self.vm_virtual_disks_lookup
+            virtual_disks = deepcopy(list(virtual_disks_lookup[host["id"]].values()))
+
+            return virtual_disks
+        except Exception:
+            return
+
     def extract_interfaces(self, host):
         try:
             interfaces_lookup = (
@@ -1306,6 +1327,30 @@ def refresh_services(self):
                     service_id
                 ] = service
 
+    def refresh_virtual_disks(self):
+        url_vm_virtual_disks = (
+            self.api_endpoint + "/api/virtualization/virtual-disks/?limit=0"
+        )
+
+        vm_virtual_disks = []
+
+        if self.fetch_all:
+            vm_virtual_disks = self.get_resource_list(url_vm_virtual_disks)
+        else:
+            vm_virtual_disks = self.get_resource_list_chunked(
+                api_url=url_vm_virtual_disks,
+                query_key="virtual_machine_id",
+                query_values=self.vms_lookup.keys(),
+            )
+
+        self.vm_virtual_disks_lookup = defaultdict(dict)
+
+        for virtual_disk in vm_virtual_disks:
+            virtual_disk_id = virtual_disk["id"]
+            vm_id = virtual_disk["virtual_machine"]["id"]
+
+            self.vm_virtual_disks_lookup[vm_id][virtual_disk_id] = virtual_disk
+
     def refresh_interfaces(self):
         url_device_interfaces = self.api_endpoint + "/api/dcim/interfaces/?limit=0"
         url_vm_interfaces = (
@@ -1452,6 +1497,8 @@ def lookup_processes(self):
             self.refresh_manufacturers_lookup,
             self.refresh_clusters_lookup,
         ]
+        if self.virtual_disks:
+            lookups.append(self.refresh_virtual_disks)
 
         if self.interfaces:
             lookups.append(self.refresh_interfaces)
@@ -2055,6 +2102,7 @@ def parse(self, inventory, loader, path, cache=True):
         self.flatten_local_context_data = self.get_option("flatten_local_context_data")
         self.flatten_custom_fields = self.get_option("flatten_custom_fields")
         self.plurals = self.get_option("plurals")
+        self.virtual_disks = self.get_option("virtual_disks")
         self.interfaces = self.get_option("interfaces")
         self.services = self.get_option("services")
         self.site_data = self.get_option("site_data")

tests/integration/netbox-deploy.py

@@ -466,6 +466,15 @@ def make_netbox_calls(endpoint, payload):
 test101_vm = nb.virtualization.virtual_machines.get(name="test101-vm")
 test_spaces_vm = nb.virtualization.virtual_machines.get(name="Test VM With Spaces")
 
+# Create Virtaul Disks
+virtual_disks = [
+    {"name": "disk1", "size": 60, "virtual_machine": test100_vm.id},
+    {"name": "disk2", "size": 110, "virtual_machine": test100_vm.id},
+]
+created_virtual_disks = make_netbox_calls(
+    nb.virtualization.virtual_disks, virtual_disks
+)
+
 ## Create Virtual Machine Interfaces
 virtual_machines_intfs = [
     # Create test100-vm intfs