Inventory: Add ansible_host_dns_name option for ansible_host to use dns_name (#434)

Author: drehelis

plugins/inventory/nb_inventory.py

@@ -178,6 +178,11 @@
                 - Setting interfaces will also fetch IP addresses and the dns_name host_var will be set.
             type: boolean
             default: False
+        ansible_host_dns_name:
+            description:
+                - If True, sets DNS Name (fetched from primary_ip) to be used in ansible_host variable, instead of IP Address.
+            type: boolean
+            default: False
         compose:
             description: List of custom ansible host vars to create from the device object fetched from NetBox
             default: {}
@@ -427,7 +432,7 @@ def group_extractors(self):
                 {"interfaces": self.extract_interfaces,}
             )
 
-        if self.interfaces or self.dns_name:
+        if self.interfaces or self.dns_name or self.ansible_host_dns_name:
             extractors.update(
                 {"dns_name": self.extract_dns_name,}
             )
@@ -1063,7 +1068,7 @@ def lookup_processes_secondary(self):
         lookups = []
 
         # IP addresses are needed for either interfaces or dns_name options
-        if self.interfaces or self.dns_name:
+        if self.interfaces or self.dns_name or self.ansible_host_dns_name:
             lookups.append(self.refresh_ipaddresses)
 
         return lookups
@@ -1369,6 +1374,13 @@ def _fill_host_variables(self, host, hostname):
         if extracted_primary_ip:
             self.inventory.set_variable(hostname, "ansible_host", extracted_primary_ip)
 
+        if self.ansible_host_dns_name:
+            extracted_dns_name = self.extract_dns_name(host=host)
+            if extracted_dns_name:
+                self.inventory.set_variable(
+                    hostname, "ansible_host", extracted_dns_name
+                )
+
         extracted_primary_ip4 = self.extract_primary_ip4(host=host)
         if extracted_primary_ip4:
             self.inventory.set_variable(hostname, "primary_ip4", extracted_primary_ip4)
@@ -1508,5 +1520,6 @@ def parse(self, inventory, loader, path, cache=True):
         self.vm_query_filters = self.get_option("vm_query_filters")
         self.virtual_chassis_name = self.get_option("virtual_chassis_name")
         self.dns_name = self.get_option("dns_name")
+        self.ansible_host_dns_name = self.get_option("ansible_host_dns_name")
 
         self.main()

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

@@ -81,7 +81,7 @@
                 "tags": []
             },
             "VC1": {
-                "ansible_host": "172.16.180.12",
+                "ansible_host": "nexus.example.com",
                 "custom_fields": {},
                 "device_type": "nexus-parent",
                 "display": "Test Nexus One",

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

@@ -17,6 +17,7 @@ services: False
 group_names_raw: True
 virtual_chassis_name: True
 dns_name: True
+ansible_host_dns_name: True
 
 group_by:
   - site

tests/integration/targets/inventory-v2.9/files/test-inventory-options.json

@@ -81,7 +81,7 @@
                 "tags": []
             },
             "VC1": {
-                "ansible_host": "172.16.180.12",
+                "ansible_host": "nexus.example.com",
                 "custom_fields": {},
                 "device_type": "nexus-parent",
                 "display": "Test Nexus One",

tests/integration/targets/inventory-v2.9/files/test-inventory-options.yml

@@ -17,6 +17,7 @@ services: False
 group_names_raw: True
 virtual_chassis_name: True
 dns_name: True
+ansible_host_dns_name: True
 
 group_by:
   - site

tests/unit/inventory/test_data/group_extractors/data.json

@@ -4,6 +4,7 @@
         "interfaces": false,
         "services": false,
         "dns_name": false,
+        "ansible_host_dns_name": false,
         "expected": [
             "disk",
             "memory",
@@ -35,14 +36,56 @@
             "manufacturers",
             "services",
             "interfaces",
-            "dns_name"
+            "dns_name",
+            "ansible_host_dns_name"
         ]
     },
     {
         "plurals": true,
         "interfaces": true,
         "services": true,
         "dns_name": true,
+        "ansible_host_dns_name": true,
+        "expected": [
+            "disk",
+            "memory",
+            "vcpus",
+            "config_context",
+            "custom_fields",
+            "region",
+            "cluster",
+            "cluster_group",
+            "cluster_type",
+            "is_virtual",
+            "sites",
+            "tenants",
+            "racks",
+            "tags",
+            "device_roles",
+            "platforms",
+            "device_types",
+            "manufacturers",
+            "services",
+            "interfaces",
+            "dns_name"
+        ],
+        "not_expected": [
+            "site",
+            "tenant",
+            "rack",
+            "tag",
+            "role",
+            "platform",
+            "device_type",
+            "manufacturer"
+        ]
+    },
+    {
+        "plurals": true,
+        "interfaces": true,
+        "services": true,
+        "dns_name": false,
+        "ansible_host_dns_name": true,
         "expected": [
             "disk",
             "memory",

tests/unit/inventory/test_nb_inventory.py

@@ -142,16 +142,24 @@ def does_not_raise():
 
 
 @pytest.mark.parametrize(
-    "plurals, services, interfaces, dns_name, expected, not_expected",
+    "plurals, services, interfaces, dns_name, ansible_host_dns_name, expected, not_expected",
     load_relative_test_data("group_extractors"),
 )
 def test_group_extractors(
-    inventory_fixture, plurals, services, interfaces, dns_name, expected, not_expected
+    inventory_fixture,
+    plurals,
+    services,
+    interfaces,
+    dns_name,
+    ansible_host_dns_name,
+    expected,
+    not_expected,
 ):
     inventory_fixture.plurals = plurals
     inventory_fixture.services = services
     inventory_fixture.interfaces = interfaces
     inventory_fixture.dns_name = dns_name
+    inventory_fixture.ansible_host_dns_name = ansible_host_dns_name
     extractors = inventory_fixture.group_extractors
 
     for key in expected: