Add support for neighbor argument in ios_interface (#29035)

Add missing support for lldp neighbor argument in ios_interface

lib/ansible/modules/network/ios/ios_interface.py

@@ -52,6 +52,17 @@ options:
   rx_rate:
     description:
       - Receiver rate in bits per second (bps).
+  neighbors:
+    description:
+      - Check the operational state of given interface C(name) for LLDP neighbor.
+      - The following suboptions are available.
+    suboptions:
+        host:
+          description:
+            - "LLDP neighbor host for given interface C(name)."
+        port:
+          description:
+            - "LLDP neighbor port to which given interface C(name) is connected."
   aggregate:
     description: List of Interfaces definitions.
   delay:
@@ -98,6 +109,13 @@ EXAMPLES = """
     tx_rate: ge(0)
     rx_rate: le(0)
 
+- name: Check neighbors intent arguments
+  ios_interface:
+    name: Gi0/0
+    neighbors:
+    - port: eth0
+      host: netdev
+
 - name: Config + intent
   ios_interface:
     name: GigabitEthernet0/2
@@ -246,7 +264,8 @@ def map_params_to_obj(module):
             'state': module.params['state'],
             'delay': module.params['delay'],
             'tx_rate': module.params['tx_rate'],
-            'rx_rate': module.params['rx_rate']
+            'rx_rate': module.params['rx_rate'],
+            'neighbors': module.params['neighbors']
         }
 
         validate_param_values(module, params)
@@ -303,12 +322,14 @@ def map_obj_to_commands(updates):
 
 def check_declarative_intent_params(module, want, result):
     failed_conditions = []
-
+    have_neighbors = None
     for w in want:
         want_state = w.get('state')
         want_tx_rate = w.get('tx_rate')
         want_rx_rate = w.get('rx_rate')
-        if want_state not in ('up', 'down') and not want_tx_rate and not want_rx_rate:
+        want_neighbors = w.get('neighbors')
+
+        if want_state not in ('up', 'down') and not want_tx_rate and not want_rx_rate and not want_neighbors:
             continue
 
         if result['changed']:
@@ -345,12 +366,40 @@ def check_declarative_intent_params(module, want, result):
             if have_rx_rate is None or not conditional(want_rx_rate, have_rx_rate.strip(), cast=int):
                 failed_conditions.append('rx_rate ' + want_rx_rate)
 
+        if want_neighbors:
+            have_host = []
+            have_port = []
+            if have_neighbors is None:
+                rc, have_neighbors, err = exec_command(module, 'show lldp neighbors detail')
+                if rc != 0:
+                    module.fail_json(msg=to_text(err, errors='surrogate_then_replace'), command=command, rc=rc)
+
+            if have_neighbors:
+                lines = have_neighbors.strip().split('Local Intf: ')
+                for line in lines:
+                    field = line.split('\n')
+                    if field[0].strip() == w['name']:
+                        for item in field:
+                            if item.startswith('System Name:'):
+                                have_host.append(item.split(':')[1].strip())
+                            if item.startswith('Port Description:'):
+                                have_port.append(item.split(':')[1].strip())
+            for item in want_neighbors:
+                if item['host'] not in have_host:
+                    failed_conditions.append('host ' + item['host'])
+                if item['port'] not in have_port:
+                    failed_conditions.append('port ' + item['port'])
     return failed_conditions
 
 
 def main():
     """ main entry point for module execution
     """
+    neighbors_spec = dict(
+        host=dict(),
+        port=dict()
+    )
+
     element_spec = dict(
         name=dict(),
         description=dict(),
@@ -360,6 +409,7 @@ def main():
         enabled=dict(default=True, type='bool'),
         tx_rate=dict(),
         rx_rate=dict(),
+        neighbors=dict(type='list', elements='dict', options=neighbors_spec),
         delay=dict(default=10, type='int'),
         state=dict(default='present',
                    choices=['present', 'absent', 'up', 'down'])

test/integration/targets/ios_interface/tests/cli/intent.yaml

@@ -61,6 +61,37 @@
       - "result.failed == true"
       - "'state eq(up)' in result.failed_conditions"
 
+- name: Check neighbors intent arguments
+  ios_interface:
+    name: Gi0/0
+    neighbors:
+    - port: eth0
+      host: netdev
+    authorize: yes
+    provider: "{{ cli }}"
+  register: result
+
+- assert:
+    that:
+      - "result.failed == false"
+
+- name: Check neighbors intent arguments (failed condition)
+  ios_interface:
+    name: Gi0/0
+    neighbors:
+    - port: dummy_port
+      host: dummy_host
+    authorize: yes
+    provider: "{{ cli }}"
+  ignore_errors: yes
+  register: result
+
+- assert:
+    that:
+      - "result.failed == true"
+      - "'host dummy_host' in result.failed_conditions"
+      - "'port dummy_port' in result.failed_conditions"
+
 - name: Aggregate config + intent (pass)
   ios_interface:
     aggregate:
@@ -75,3 +106,39 @@
 - assert:
     that:
       - "result.failed == false"
+
+- name: Aggregate neighbors intent (pass)
+  ios_interface:
+    aggregate:
+    - name: Gi0/0
+      neighbors:
+      - port: eth0
+        host: netdev
+    authorize: yes
+    provider: "{{ cli }}"
+  ignore_errors: yes
+  register: result
+
+- assert:
+    that:
+      - "result.failed == false"
+
+- name: Aggregate neighbors intent (fail)
+  ios_interface:
+    aggregate:
+    - name: Gi0/0
+      neighbors:
+      - port: eth0
+        host: netdev
+      - port: dummy_port
+        host: dummy_host
+    authorize: yes
+    provider: "{{ cli }}"
+  ignore_errors: yes
+  register: result
+
+- assert:
+    that:
+      - "result.failed == true"
+      - "'host dummy_host' in result.failed_conditions"
+      - "'port dummy_port' in result.failed_conditions"