Add cdp neighbors to ansible_net_neighbors facts

changelogs/fragments/fix_add_cdp_neighbors.yaml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - iosxr_facts - Add cdp neighbors in ansible_net_neighbors dictionary (https://github.com/ansible-collections/cisco.iosxr/pull/457).

docs/cisco.iosxr.iosxr_facts_module.rst

@@ -381,7 +381,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>when interfaces is configured</td>
                 <td>
-                            <div>The list of LLDP neighbors from the remote device</div>
+                            <div>The list of LLDP and CDP neighbors from the remote device. If both, CDP and LLDP neighbor data is present on one port, CDP is preferred.</div>
                     <br/>
                 </td>
             </tr>

plugins/module_utils/network/iosxr/facts/legacy/base.py

@@ -123,6 +123,8 @@ class Interfaces(FactsBase):
         "show ipv6 interface",
         "show lldp",
         "show lldp neighbors detail",
+        "show cdp",
+        "show cdp neighbors detail",
     ]
 
     def populate(self):
@@ -142,6 +144,10 @@ def populate(self):
             neighbors = self.responses[3]
             self.facts["neighbors"] = self.parse_neighbors(neighbors)
 
+        if "CDP is not enabled" not in self.responses[4]:
+            neighbors = self.responses[5]
+            self.facts["neighbors"] = self.parse_cdp_neighbors(neighbors)
+
     def populate_interfaces(self, interfaces):
         facts = dict()
         for key, value in iteritems(interfaces):
@@ -200,6 +206,25 @@ def parse_neighbors(self, neighbors):
             facts[intf].append(fact)
         return facts
 
+    def parse_cdp_neighbors(self, neighbors):
+        facts = dict()
+        for entry in neighbors.split("-------------------------"):
+            if entry == "":
+                continue
+            intf_port = self.parse_cdp_intf_port(entry)
+            if intf_port is None:
+                return facts
+            intf, port = intf_port
+            if intf not in facts:
+                facts[intf] = list()
+            fact = dict()
+            fact["host"] = self.parse_cdp_host(entry)
+            fact["platform"] = self.parse_cdp_platform(entry)
+            fact["port"] = port
+            fact["ip"] = self.parse_cdp_ip(entry)
+            facts[intf].append(fact)
+        return facts
+
     def parse_interfaces(self, data):
         parsed = dict()
         key = ""
@@ -281,3 +306,23 @@ def parse_lldp_port(self, data):
         match = re.search(r"Port id: (.+)$", data, re.M)
         if match:
             return match.group(1)
+
+    def parse_cdp_intf_port(self, data):
+        match = re.search(r"^Interface: (.+),  Port ID \(outgoing port\): (.+)$", data, re.M)
+        if match:
+            return match.group(1), match.group(2)
+
+    def parse_cdp_host(self, data):
+        match = re.search(r"^Device ID: (.+)$", data, re.M)
+        if match:
+            return match.group(1)
+
+    def parse_cdp_platform(self, data):
+        match = re.search(r"^Platform: (.+),", data, re.M)
+        if match:
+            return match.group(1)
+
+    def parse_cdp_ip(self, data):
+        match = re.search(r"^  IP address: (.+)$", data, re.M)
+        if match:
+            return match.group(1)

plugins/modules/iosxr_facts.py

@@ -172,7 +172,8 @@
   returned: when interfaces is configured
   type: dict
 ansible_net_neighbors:
-  description: The list of LLDP neighbors from the remote device
+  description: The list of LLDP and CDP neighbors from the remote device. If both,
+      CDP and LLDP neighbor data is present on one port, CDP is preferred.
   returned: when interfaces is configured
   type: dict
 

tests/unit/modules/network/iosxr/fixtures/show_cdp

@@ -0,0 +1,4 @@
+Global CDP information:
+    Sending CDP packets every 60 seconds
+    Sending a holdtime value of 30 seconds
+    Sending CDPv2 advertisements is not enabled

tests/unit/modules/network/iosxr/fixtures/show_cdp_neighbors_detail

@@ -0,0 +1,16 @@
+-------------------------
+Device ID: device2.cisco.com
+Entry address(es):
+  IP address: 171.68.162.134
+Platform: cisco 4500,  Capabilities: Router
+Interface: Ethernet0/1,  Port ID (outgoing port): Ethernet0
+Holdtime : 156 sec
+
+Version :
+Cisco Internetwork Operating System Software
+IOS (tm) 4500 Software (C4500-J-M), Version 11.1(10.4), MAINTENANCE INTERIM SOFTWARE
+Copyright (c) 1986-1997 by Cisco Systems, Inc.
+Compiled Mon 07-Apr-97 19:51 by dschwart
+
+
+Total cdp entries displayed : 1

tests/unit/modules/network/iosxr/test_iosxr_facts.py

@@ -131,3 +131,19 @@ def test_iosxr_facts_cpu_utilization(self):
             ansible_facts["ansible_net_cpu_utilization"],
             cpu_utilization_data,
         )
+
+    def test_iosxr_facts_neighbors(self):
+        set_module_args(dict(gather_subset="interfaces"))
+        result = self.execute_module()
+        ansible_facts = result["ansible_facts"]["ansible_net_neighbors"]
+        expected_neighbors = {
+            "Ethernet0/1": [
+                {
+                    "host": "device2.cisco.com",
+                    "platform": "cisco 4500",
+                    "port": "Ethernet0",
+                    "ip": "171.68.162.134",
+                },
+            ],
+        }
+        self.assertCountEqual(ansible_facts.keys(), expected_neighbors.keys())