Inventory: Add dns_name option for the Primary IP's dns_name host_var (#394)

Author: nahun

plugins/inventory/nb_inventory.py

@@ -171,6 +171,12 @@
                 - The host var values will be from the virtual chassis master.
             type: boolean
             default: False
+        dns_name:
+            description:
+                - Force IP Addresses to be fetched so that the dns_name for the primary_ip of each device or VM is set as a host_var.
+                - Setting interfaces will also fetch IP addresses and the dns_name host_var will be set.
+            type: boolean
+            default: False
         compose:
             description: List of custom ansible host vars to create from the device object fetched from NetBox
             default: {}
@@ -420,6 +426,11 @@ def group_extractors(self):
                 {"interfaces": self.extract_interfaces,}
             )
 
+        if self.interfaces or self.dns_name:
+            extractors.update(
+                {"dns_name": self.extract_dns_name,}
+            )
+
         return extractors
 
     def _pluralize_group_by(self, group_by):
@@ -638,18 +649,20 @@ def extract_interfaces(self, host):
 
             interfaces = list(interfaces_lookup[host["id"]].values())
 
-            before_netbox_v29 = bool(self.ipaddresses_lookup)
+            before_netbox_v29 = bool(self.ipaddresses_intf_lookup)
             # Attach IP Addresses to their interface
             for interface in interfaces:
                 if before_netbox_v29:
                     interface["ip_addresses"] = list(
-                        self.ipaddresses_lookup[interface["id"]].values()
+                        self.ipaddresses_intf_lookup[interface["id"]].values()
                     )
                 else:
                     interface["ip_addresses"] = list(
-                        self.vm_ipaddresses_lookup[interface["id"]].values()
+                        self.vm_ipaddresses_intf_lookup[interface["id"]].values()
                         if host["is_virtual"]
-                        else self.device_ipaddresses_lookup[interface["id"]].values()
+                        else self.device_ipaddresses_intf_lookup[
+                            interface["id"]
+                        ].values()
                     )
 
             return interfaces
@@ -707,6 +720,28 @@ def extract_cluster_type(self, host):
     def extract_is_virtual(self, host):
         return host.get("is_virtual")
 
+    def extract_dns_name(self, host):
+        # No primary IP assigned
+        if not host.get("primary_ip"):
+            return None
+
+        before_netbox_v29 = bool(self.ipaddresses_lookup)
+        if before_netbox_v29:
+            ip_address = self.ipaddresses_lookup.get(host["primary_ip"]["id"])
+        else:
+            if host["is_virtual"]:
+                ip_address = self.vm_ipaddresses_lookup.get(host["primary_ip"]["id"])
+            else:
+                ip_address = self.device_ipaddresses_lookup.get(
+                    host["primary_ip"]["id"]
+                )
+
+        # Don"t assign a host_var for empty dns_name
+        if ip_address.get("dns_name") == "":
+            return None
+
+        return ip_address.get("dns_name")
+
     def refresh_platforms_lookup(self):
         url = self.api_endpoint + "/api/dcim/platforms/?limit=0"
         platforms = self.get_resource_list(api_url=url)
@@ -953,9 +988,13 @@ def refresh_ipaddresses(self):
 
         # Construct a dictionary of lists, to allow looking up ip addresses by interface id
         # Note that interface ids share the same namespace for both devices and vms so this is a single dictionary
+        self.ipaddresses_intf_lookup = defaultdict(dict)
+        # Construct a dictionary of the IP addresses themselves
         self.ipaddresses_lookup = defaultdict(dict)
         # NetBox v2.9 and onwards
+        self.vm_ipaddresses_intf_lookup = defaultdict(dict)
         self.vm_ipaddresses_lookup = defaultdict(dict)
+        self.device_ipaddresses_intf_lookup = defaultdict(dict)
         self.device_ipaddresses_lookup = defaultdict(dict)
 
         for ipaddress in ipaddresses:
@@ -967,9 +1006,13 @@ def refresh_ipaddresses(self):
                 ipaddress_copy = ipaddress.copy()
 
                 if ipaddress["assigned_object_type"] == "virtualization.vminterface":
-                    self.vm_ipaddresses_lookup[interface_id][ip_id] = ipaddress_copy
+                    self.vm_ipaddresses_lookup[ip_id] = ipaddress_copy
+                    self.vm_ipaddresses_intf_lookup[interface_id][
+                        ip_id
+                    ] = ipaddress_copy
                 else:
-                    self.device_ipaddresses_lookup[interface_id][
+                    self.device_ipaddresses_lookup[ip_id] = ipaddress_copy
+                    self.device_ipaddresses_intf_lookup[interface_id][
                         ip_id
                     ] = ipaddress_copy  # Remove "assigned_object_X" attributes, as that's redundant when ipaddress is added to an interface
 
@@ -986,7 +1029,8 @@ def refresh_ipaddresses(self):
             # We need to copy the ipaddress entry to preserve the original in case caching is used.
             ipaddress_copy = ipaddress.copy()
 
-            self.ipaddresses_lookup[interface_id][ip_id] = ipaddress_copy
+            self.ipaddresses_intf_lookup[interface_id][ip_id] = ipaddress_copy
+            self.ipaddresses_lookup[ip_id] = ipaddress_copy
             # Remove "interface" attribute, as that's redundant when ipaddress is added to an interface
             del ipaddress_copy["interface"]
 
@@ -1017,7 +1061,8 @@ def lookup_processes(self):
     def lookup_processes_secondary(self):
         lookups = []
 
-        if self.interfaces:
+        # IP addresses are needed for either interfaces or dns_name options
+        if self.interfaces or self.dns_name:
             lookups.append(self.refresh_ipaddresses)
 
         return lookups
@@ -1458,5 +1503,6 @@ def parse(self, inventory, loader, path, cache=True):
         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.dns_name = self.get_option("dns_name")
 
         self.main()

tests/integration/netbox-deploy.py

@@ -7,6 +7,7 @@
 import os
 import sys
 import pynetbox
+from packaging import version
 
 # NOTE: If anything depends on specific versions of NetBox, can check INTEGRATION_TESTS in env
 # os.environ["INTEGRATION_TESTS"]
@@ -16,7 +17,7 @@
 nb_host = os.getenv("NETBOX_HOST", "http://localhost:32768")
 nb_token = os.getenv("NETBOX_TOKEN", "0123456789abcdef0123456789abcdef01234567")
 nb = pynetbox.api(nb_host, nb_token)
-version = float(nb.version)
+nb_version = version.parse(nb.version)
 
 ERRORS = False
 
@@ -39,7 +40,7 @@ def make_netbox_calls(endpoint, payload):
 
 
 # Create tags used in future tests
-if version >= 2.9:
+if nb_version >= version.parse("2.9"):
     create_tags = nb.extras.tags.create(
         [
             {"name": "First", "slug": "first"},
@@ -187,7 +188,7 @@ def make_netbox_calls(endpoint, payload):
     },
     {"model": "1841", "slug": "1841", "manufacturer": cisco_manu.id,},
 ]
-if version > 2.8:
+if nb_version > version.parse("2.8"):
     temp_dt = []
     for dt_type in device_types:
         if dt_type.get("subdevice_role") is not None and not dt_type["subdevice_role"]:
@@ -322,10 +323,14 @@ def make_netbox_calls(endpoint, payload):
     {"address": "172.16.180.1/24", "interface": test100_gi1.id},
     {"address": "2001::1:1/64", "interface": test100_gi2.id},
     {"address": "172.16.180.11/24", "interface": created_nexus_interfaces[0].id},
-    {"address": "172.16.180.12/24", "interface": created_nexus_interfaces[1].id},
+    {
+        "address": "172.16.180.12/24",
+        "interface": created_nexus_interfaces[1].id,
+        "dns_name": "nexus.example.com",
+    },
     {"address": "172.16.180.254/24"},
 ]
-if version > 2.8:
+if nb_version > version.parse("2.8"):
     temp_ips = []
     for ip in ip_addresses:
         if ip.get("interface"):
@@ -335,6 +340,8 @@ def make_netbox_calls(endpoint, payload):
 
 created_ip_addresses = make_netbox_calls(nb.ipam.ip_addresses, ip_addresses)
 
+# Assign Primary IP
+nexus.update({"primary_ip4": 4})
 
 ## Create RIRs
 rirs = [{"name": "Example RIR", "slug": "example-rir"}]
@@ -425,6 +432,12 @@ def make_netbox_calls(endpoint, payload):
         "protocol": "tcp",
     },
 ]
+# 2.10+ requires the port attribute to be 'ports' and a list instead of an integer
+for service in services:
+    if nb_version >= version.parse("2.10"):
+        service["ports"] = [service["port"]]
+        del service["port"]
+
 created_services = make_netbox_calls(nb.ipam.services, services)
 
 

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

@@ -33,6 +33,7 @@
                 "tags": []
             },
             "Test Nexus One": {
+                "ansible_host": "172.16.180.12",
                 "custom_fields": {},
                 "device_roles": [
                     "core-switch"
@@ -47,6 +48,7 @@
                 "manufacturers": [
                     "cisco"
                 ],
+                "primary_ip4": "172.16.180.12",
                 "regions": [
                     "test-region",
                     "parent-region"

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

@@ -44,7 +44,9 @@
                 "tags": []
             },
             "Test Nexus One": {
+                "ansible_host": "172.16.180.12",
                 "device_type": "nexus-parent",
+                "dns_name": "nexus.example.com",
                 "interfaces": [
                     {
                         "cable": null,
@@ -117,7 +119,7 @@
                                 "address": "172.16.180.12/24",
                                 "custom_fields": {},
                                 "description": "",
-                                "dns_name": "",
+                                "dns_name": "nexus.example.com",
                                 "family": {
                                     "label": "IPv4",
                                     "value": 4
@@ -153,6 +155,7 @@
                 ],
                 "is_virtual": false,
                 "manufacturer": "cisco",
+                "primary_ip4": "172.16.180.12",
                 "regions": [
                     "test-region",
                     "parent-region"

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

@@ -81,11 +81,14 @@
                 "tags": []
             },
             "VC1": {
+                "ansible_host": "172.16.180.12",
                 "custom_fields": {},
                 "device_type": "nexus-parent",
                 "display": "Test Nexus One",
+                "dns_name": "nexus.example.com",
                 "is_virtual": false,
                 "manufacturer": "cisco",
+                "primary_ip4": "172.16.180.12",
                 "regions": [
                     "test-region",
                     "parent-region"

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

@@ -16,6 +16,7 @@ interfaces: False
 services: False
 group_names_raw: True
 virtual_chassis_name: True
+dns_name: True
 
 group_by:
   - site

tests/integration/targets/inventory-latest/files/test-inventory-plurals-flatten.json

@@ -55,6 +55,7 @@
                 "tags": []
             },
             "Test Nexus One": {
+                "ansible_host": "172.16.180.12",
                 "device_roles": [
                     "core-switch"
                 ],
@@ -68,6 +69,7 @@
                 "manufacturers": [
                     "cisco"
                 ],
+                "primary_ip4": "172.16.180.12",
                 "regions": [
                     "test-region",
                     "parent-region"

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

@@ -37,6 +37,7 @@
                 "tags": []
             },
             "Test Nexus One": {
+                "ansible_host": "172.16.180.12",
                 "config_context": [
                     {}
                 ],
@@ -47,6 +48,7 @@
                 "device_types": [
                     "nexus-parent"
                 ],
+                "dns_name": "nexus.example.com",
                 "interfaces": [
                     {
                         "cable": null,
@@ -119,7 +121,7 @@
                                 "address": "172.16.180.12/24",
                                 "custom_fields": {},
                                 "description": "",
-                                "dns_name": "",
+                                "dns_name": "nexus.example.com",
                                 "family": {
                                     "label": "IPv4",
                                     "value": 4
@@ -160,6 +162,7 @@
                 "manufacturers": [
                     "cisco"
                 ],
+                "primary_ip4": "172.16.180.12",
                 "regions": [
                     "test-region",
                     "parent-region"

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

@@ -22,9 +22,11 @@
                 "tags": []
             },
             "Test Nexus One": {
+                "ansible_host": "172.16.180.12",
                 "config_context": {},
                 "custom_fields": {},
                 "device_type": "nexus-parent",
+                "dns_name": "nexus.example.com",
                 "interfaces": [
                     {
                         "cable": null,
@@ -97,7 +99,7 @@
                                 "address": "172.16.180.12/24",
                                 "custom_fields": {},
                                 "description": "",
-                                "dns_name": "",
+                                "dns_name": "nexus.example.com",
                                 "family": {
                                     "label": "IPv4",
                                     "value": 4
@@ -133,6 +135,7 @@
                 ],
                 "is_virtual": false,
                 "manufacturer": "cisco",
+                "primary_ip4": "172.16.180.12",
                 "regions": [
                     "test-region",
                     "parent-region"
@@ -843,14 +846,14 @@
             "test100"
         ]
     },
-    "service_ssh": {
+    "service_http": {
         "hosts": [
-            "Test VM With Spaces",
             "test100"
         ]
     },
-    "service_http": {
+    "service_ssh": {
         "hosts": [
+            "Test VM With Spaces",
             "test100"
         ]
     },

tests/integration/targets/inventory-v2.8/files/test-inventory-legacy.json

@@ -34,6 +34,7 @@
                 "tags": []
             },
             "Test Nexus One": {
+                "ansible_host": "172.16.180.12",
                 "custom_fields": {},
                 "device_roles": [
                     "core-switch"
@@ -48,6 +49,7 @@
                 "manufacturers": [
                     "cisco"
                 ],
+                "primary_ip4": "172.16.180.12",
                 "regions": [
                     "test-region",
                     "parent-region"