Inventory: Add option to use VC name instead of device name (#383)

Author: nahun

plugins/inventory/nb_inventory.py

@@ -165,6 +165,12 @@
             type: int
             default: 4000
             version_added: "0.2.1"
+        virtual_chassis_name:
+            description:
+                - When a device is part of a virtual chassis, use the virtual chassis name as the Ansible inventory hostname.
+                - The host var values will be from the virtual chassis master.
+            type: boolean
+            default: False
         compose:
             description: List of custom ansible host vars to create from the device object fetched from NetBox
             default: {}
@@ -1191,7 +1197,11 @@ def extract_name(self, host):
         # An host in an Ansible inventory requires an hostname.
         # name is an unique but not required attribute for a device in NetBox
         # We default to an UUID for hostname in case the name is not set in NetBox
-        return host["name"] or str(uuid.uuid4())
+        # Use virtual chassis name if set by the user.
+        if self.virtual_chassis_name and self._get_host_virtual_chassis_master(host):
+            return host["virtual_chassis"]["name"] or str(uuid.uuid4())
+        else:
+            return host["name"] or str(uuid.uuid4())
 
     def generate_group_name(self, grouping, group):
 
@@ -1447,5 +1457,6 @@ def parse(self, inventory, loader, path, cache=True):
         self.query_filters = self.get_option("query_filters")
         self.device_query_filters = self.get_option("device_query_filters")
         self.vm_query_filters = self.get_option("vm_query_filters")
+        self.virtual_chassis_name = self.get_option("virtual_chassis_name")
 
         self.main()

tests/integration/targets/inventory-latest/files/test-inventory-options.json

@@ -44,24 +44,6 @@
                 },
                 "tags": []
             },
-            "Test Nexus One": {
-                "custom_fields": {},
-                "device_type": "nexus-parent",
-                "display": "Test Nexus One",
-                "is_virtual": false,
-                "manufacturer": "cisco",
-                "regions": [
-                    "test-region",
-                    "parent-region"
-                ],
-                "role": "core-switch",
-                "site": "test-site",
-                "status": {
-                    "label": "Active",
-                    "value": "active"
-                },
-                "tags": []
-            },
             "Test VM With Spaces": {
                 "cluster": "Test Cluster 2",
                 "cluster_type": "test-cluster-type",
@@ -98,6 +80,24 @@
                 },
                 "tags": []
             },
+            "VC1": {
+                "custom_fields": {},
+                "device_type": "nexus-parent",
+                "display": "Test Nexus One",
+                "is_virtual": false,
+                "manufacturer": "cisco",
+                "regions": [
+                    "test-region",
+                    "parent-region"
+                ],
+                "role": "core-switch",
+                "site": "test-site",
+                "status": {
+                    "label": "Active",
+                    "value": "active"
+                },
+                "tags": []
+            },
             "test100": {
                 "custom_fields": {},
                 "device_type": "cisco-test",
@@ -229,8 +229,8 @@
     "cisco": {
         "hosts": [
             "R1-Device",
-            "Test Nexus One",
             "TestDeviceR1",
+            "VC1",
             "test100"
         ]
     },
@@ -244,8 +244,8 @@
     "core_switch": {
         "hosts": [
             "R1-Device",
-            "Test Nexus One",
             "TestDeviceR1",
+            "VC1",
             "test100"
         ]
     },
@@ -261,14 +261,13 @@
     },
     "jinja_test_group": {
         "hosts": [
-            "Test Nexus One",
             "Test VM With Spaces",
             "TestDeviceR1"
         ]
     },
     "nexus_parent": {
         "hosts": [
-            "Test Nexus One"
+            "VC1"
         ]
     },
     "parent_rack_group": {
@@ -316,8 +315,8 @@
     },
     "test_site": {
         "hosts": [
-            "Test Nexus One",
             "TestDeviceR1",
+            "VC1",
             "test100",
             "test100-vm",
             "test101-vm",

tests/integration/targets/inventory-latest/files/test-inventory-options.yml

@@ -15,6 +15,7 @@ plurals: False
 interfaces: False
 services: False
 group_names_raw: True
+virtual_chassis_name: True
 
 group_by:
   - site