ios_l2_interface (#35054)

* Fix sending 'None' to device on ios

* Add ios_l2_interface module & tests

* Skip l2 tests on non-l2 images

* Allow test to continue on non-L2 hosts

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

@@ -0,0 +1,488 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2017, Ansible by Red Hat, inc
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'network'}
+
+DOCUMENTATION = """
+---
+module: ios_l2_interface
+extends_documentation_fragment: ios
+version_added: "2.5"
+short_description: Manage Layer-2 interface on Cisco IOS devices.
+description:
+  - This module provides declarative management of Layer-2 interface on
+    Cisco IOS devices.
+author:
+  - Nathaniel Case (@qalthos)
+options:
+  name:
+    description:
+      - Full name of the interface excluding any logical
+        unit number, i.e. GigabitEthernet0/1.
+    required: true
+    aliases: ['interface']
+  mode:
+    description:
+      - Mode in which interface needs to be configured.
+    default: access
+    choices: ['access', 'trunk']
+  access_vlan:
+    description:
+      - Configure given VLAN in access port.
+        If C(mode=access), used as the access VLAN ID.
+  trunk_vlans:
+    description:
+      - List of VLANs to be configured in trunk port.
+        If C(mode=trunk), used as the VLAN range to ADD or REMOVE
+        from the trunk.
+  native_vlan:
+    description:
+      - Native VLAN to be configured in trunk port.
+        If C(mode=trunk), used as the trunk native VLAN ID.
+  trunk_allowed_vlans:
+    description:
+      - List of allowed VLANs in a given trunk port.
+        If C(mode=trunk), these are the only VLANs that will be
+        configured on the trunk, i.e. "2-10,15".
+  aggregate:
+    description:
+      - List of Layer-2 interface definitions.
+  state:
+    description:
+      - Manage the state of the Layer-2 Interface configuration.
+    default:  present
+    choices: ['present','absent', 'unconfigured']
+"""
+
+EXAMPLES = """
+- name: Ensure GigabitEthernet0/5 is in its default l2 interface state
+  ios_l2_interface:
+    name: GigabitEthernet0/5
+    state: unconfigured
+
+- name: Ensure GigabitEthernet0/5 is configured for access vlan 20
+  ios_l2_interface:
+    name: GigabitEthernet0/5
+    mode: access
+    access_vlan: 20
+
+- name: Ensure GigabitEthernet0/5 only has vlans 5-10 as trunk vlans
+  ios_l2_interface:
+    name: GigabitEthernet0/5
+    mode: trunk
+    native_vlan: 10
+    trunk_vlans: 5-10
+
+- name: Ensure GigabitEthernet0/5 is a trunk port and ensure 2-50 are being tagged (doesn't mean others aren't also being tagged)
+  ios_l2_interface:
+    name: GigabitEthernet0/5
+    mode: trunk
+    native_vlan: 10
+    trunk_vlans: 2-50
+
+- name: Ensure these VLANs are not being tagged on the trunk
+  ios_l2_interface:
+    name: GigabitEthernet0/5
+    mode: trunk
+    trunk_vlans: 51-4094
+    state: absent
+"""
+
+RETURN = """
+commands:
+  description: The list of configuration mode commands to send to the device
+  returned: always, except for the platforms that use Netconf transport to manage the device.
+  type: list
+  sample:
+    - interface GigabitEthernet0/5
+    - switchport access vlan 20
+"""
+
+import re
+from copy import deepcopy
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.network.common.utils import remove_default_spec
+from ansible.module_utils.network.ios.ios import get_config, load_config, run_commands
+from ansible.module_utils.network.ios.ios import ios_argument_spec
+
+
+def get_interface_type(interface):
+    intf_type = 'unknown'
+    if interface.upper()[:2] in ('ET', 'GI'):
+        intf_type = 'ethernet'
+    elif interface.upper().startswith('VL'):
+        intf_type = 'svi'
+    elif interface.upper().startswith('LO'):
+        intf_type = 'loopback'
+    elif interface.upper()[:2] in ('MG', 'MA'):
+        intf_type = 'management'
+    elif interface.upper().startswith('PO'):
+        intf_type = 'portchannel'
+    elif interface.upper().startswith('NV'):
+        intf_type = 'nve'
+
+    return intf_type
+
+
+def is_switchport(name, module):
+    intf_type = get_interface_type(name)
+
+    if intf_type in ('ethernet', 'portchannel'):
+        config = run_commands(module, ['show interface {0} switchport'.format(name)])[0]
+        match = re.search(r'Switchport: Enabled', config)
+        return bool(match)
+    return False
+
+
+def interface_is_portchannel(name, module):
+    if get_interface_type(name) == 'ethernet':
+        config = get_config(module, flags=[' | section interface'])
+        if 'channel group' in config:
+            return True
+
+    return False
+
+
+def get_switchport(name, module):
+    config = run_commands(module, ['show interface {0} switchport'.format(name)])[0]
+    mode = re.search(r'Administrative Mode: (?:.* )?(\w+)$', config, re.M).group(1)
+    access = re.search(r'Access Mode VLAN: (\d+)', config).group(1)
+    native = re.search(r'Trunking Native Mode VLAN: (\d+)', config).group(1)
+    trunk = re.search(r'Trunking VLANs Enabled: (.+)$', config, re.M).group(1)
+    if trunk == 'ALL':
+        trunk = '1-4094'
+
+    switchport_config = {
+        "interface": name,
+        "mode": mode,
+        "access_vlan": access,
+        "native_vlan": native,
+        "trunk_vlans": trunk,
+    }
+
+    return switchport_config
+
+
+def remove_switchport_config_commands(name, existing, proposed, module):
+    mode = proposed.get('mode')
+    commands = []
+    command = None
+
+    if mode == 'access':
+        av_check = existing.get('access_vlan') == proposed.get('access_vlan')
+        if av_check:
+            command = 'no switchport access vlan {0}'.format(existing.get('access_vlan'))
+            commands.append(command)
+
+    elif mode == 'trunk':
+        tv_check = existing.get('trunk_vlans_list') == proposed.get('trunk_vlans_list')
+
+        if not tv_check:
+            existing_vlans = existing.get('trunk_vlans_list')
+            proposed_vlans = proposed.get('trunk_vlans_list')
+            vlans_to_remove = set(proposed_vlans).intersection(existing_vlans)
+
+            if vlans_to_remove:
+                proposed_allowed_vlans = proposed.get('trunk_allowed_vlans')
+                remove_trunk_allowed_vlans = proposed.get('trunk_vlans', proposed_allowed_vlans)
+                command = 'switchport trunk allowed vlan remove {0}'.format(remove_trunk_allowed_vlans)
+                commands.append(command)
+
+        native_check = existing.get('native_vlan') == proposed.get('native_vlan')
+        if native_check and proposed.get('native_vlan'):
+            command = 'no switchport trunk native vlan {0}'.format(existing.get('native_vlan'))
+            commands.append(command)
+
+    if commands:
+        commands.insert(0, 'interface ' + name)
+    return commands
+
+
+def get_switchport_config_commands(name, existing, proposed, module):
+    """Gets commands required to config a given switchport interface
+    """
+
+    proposed_mode = proposed.get('mode')
+    existing_mode = existing.get('mode')
+    commands = []
+    command = None
+
+    if proposed_mode != existing_mode:
+        if proposed_mode == 'trunk':
+            command = 'switchport mode trunk'
+        elif proposed_mode == 'access':
+            command = 'switchport mode access'
+
+    if command:
+        commands.append(command)
+
+    if proposed_mode == 'access':
+        av_check = str(existing.get('access_vlan')) == str(proposed.get('access_vlan'))
+        if not av_check:
+            command = 'switchport access vlan {0}'.format(proposed.get('access_vlan'))
+            commands.append(command)
+
+    elif proposed_mode == 'trunk':
+        tv_check = existing.get('trunk_vlans_list') == proposed.get('trunk_vlans_list')
+
+        if not tv_check:
+            if proposed.get('allowed'):
+                command = 'switchport trunk allowed vlan {0}'.format(proposed.get('trunk_allowed_vlans'))
+                commands.append(command)
+
+            else:
+                existing_vlans = existing.get('trunk_vlans_list')
+                proposed_vlans = proposed.get('trunk_vlans_list')
+                vlans_to_add = set(proposed_vlans).difference(existing_vlans)
+                if vlans_to_add:
+                    command = 'switchport trunk allowed vlan add {0}'.format(proposed.get('trunk_vlans'))
+                    commands.append(command)
+
+        native_check = str(existing.get('native_vlan')) == str(proposed.get('native_vlan'))
+        if not native_check and proposed.get('native_vlan'):
+            command = 'switchport trunk native vlan {0}'.format(proposed.get('native_vlan'))
+            commands.append(command)
+
+    if commands:
+        commands.insert(0, 'interface ' + name)
+    return commands
+
+
+def is_switchport_default(existing):
+    """Determines if switchport has a default config based on mode
+    Args:
+        existing (dict): existing switchport configuration from Ansible mod
+    Returns:
+        boolean: True if switchport has OOB Layer 2 config, i.e.
+           vlan 1 and trunk all and mode is access
+    """
+
+    c1 = str(existing['access_vlan']) == '1'
+    c2 = str(existing['native_vlan']) == '1'
+    c3 = existing['trunk_vlans'] == '1-4094'
+    c4 = existing['mode'] == 'access'
+
+    default = c1 and c2 and c3 and c4
+
+    return default
+
+
+def default_switchport_config(name):
+    commands = []
+    commands.append('interface ' + name)
+    commands.append('switchport mode access')
+    commands.append('switch access vlan 1')
+    commands.append('switchport trunk native vlan 1')
+    commands.append('switchport trunk allowed vlan all')
+    return commands
+
+
+def vlan_range_to_list(vlans):
+    result = []
+    if vlans:
+        for part in vlans.split(','):
+            if part == 'none':
+                break
+            if '-' in part:
+                start, stop = (int(i) for i in part.split('-'))
+                result.extend(range(start, stop + 1))
+            else:
+                result.append(int(part))
+    return sorted(result)
+
+
+def get_list_of_vlans(module):
+    config = run_commands(module, ['show vlan'])[0]
+    vlans = set()
+
+    lines = config.strip().splitlines()
+    for line in lines:
+        line_parts = line.split()
+        if line_parts:
+            try:
+                int(line_parts[0])
+            except ValueError:
+                continue
+            vlans.add(line_parts[0])
+
+    return list(vlans)
+
+
+def flatten_list(commands):
+    flat_list = []
+    for command in commands:
+        if isinstance(command, list):
+            flat_list.extend(command)
+        else:
+            flat_list.append(command)
+    return flat_list
+
+
+def map_params_to_obj(module):
+    obj = []
+
+    aggregate = module.params.get('aggregate')
+    if aggregate:
+        for item in aggregate:
+            for key in item:
+                if item.get(key) is None:
+                    item[key] = module.params[key]
+
+            obj.append(item.copy())
+    else:
+        obj.append({
+            'name': module.params['name'],
+            'mode': module.params['mode'],
+            'access_vlan': module.params['access_vlan'],
+            'native_vlan': module.params['native_vlan'],
+            'trunk_vlans': module.params['trunk_vlans'],
+            'trunk_allowed_vlans': module.params['trunk_allowed_vlans'],
+            'state': module.params['state']
+        })
+
+    return obj
+
+
+def main():
+    """ main entry point for module execution
+    """
+    element_spec = dict(
+        name=dict(type='str', aliases=['interface']),
+        mode=dict(choices=['access', 'trunk']),
+        access_vlan=dict(type='str'),
+        native_vlan=dict(type='str'),
+        trunk_vlans=dict(type='str'),
+        trunk_allowed_vlans=dict(type='str'),
+        state=dict(choices=['absent', 'present', 'unconfigured'], default='present')
+    )
+
+    aggregate_spec = deepcopy(element_spec)
+
+    # remove default in aggregate spec, to handle common arguments
+    remove_default_spec(aggregate_spec)
+
+    argument_spec = dict(
+        aggregate=dict(type='list', elements='dict', options=aggregate_spec),
+    )
+
+    argument_spec.update(element_spec)
+    argument_spec.update(ios_argument_spec)
+
+    module = AnsibleModule(argument_spec=argument_spec,
+                           mutually_exclusive=[['access_vlan', 'trunk_vlans'],
+                                               ['access_vlan', 'native_vlan'],
+                                               ['access_vlan', 'trunk_allowed_vlans']],
+                           supports_check_mode=True)
+
+    warnings = list()
+    commands = []
+    result = {'changed': False, 'warnings': warnings}
+
+    want = map_params_to_obj(module)
+    for w in want:
+        name = w['name']
+        mode = w['mode']
+        access_vlan = w['access_vlan']
+        state = w['state']
+        trunk_vlans = w['trunk_vlans']
+        native_vlan = w['native_vlan']
+        trunk_allowed_vlans = w['trunk_allowed_vlans']
+
+        args = dict(name=name, mode=mode, access_vlan=access_vlan,
+                    native_vlan=native_vlan, trunk_vlans=trunk_vlans,
+                    trunk_allowed_vlans=trunk_allowed_vlans)
+
+        proposed = dict((k, v) for k, v in args.items() if v is not None)
+
+        name = name.lower()
+
+        if mode == 'access' and state == 'present' and not access_vlan:
+            module.fail_json(msg='access_vlan param is required when mode=access && state=present')
+
+        if mode == 'trunk' and access_vlan:
+            module.fail_json(msg='access_vlan param not supported when using mode=trunk')
+
+        if not is_switchport(name, module):
+            module.fail_json(msg='Ensure interface is configured to be a L2'
+                             '\nport first before using this module. You can use'
+                             '\nthe ios_interface module for this.')
+
+        if interface_is_portchannel(name, module):
+            module.fail_json(msg='Cannot change L2 config on physical '
+                             '\nport because it is in a portchannel. '
+                             '\nYou should update the portchannel config.')
+
+        # existing will never be null for Eth intfs as there is always a default
+        existing = get_switchport(name, module)
+
+        # Safeguard check
+        # If there isn't an existing, something is wrong per previous comment
+        if not existing:
+            module.fail_json(msg='Make sure you are using the FULL interface name')
+
+        if trunk_vlans or trunk_allowed_vlans:
+            if trunk_vlans:
+                trunk_vlans_list = vlan_range_to_list(trunk_vlans)
+            elif trunk_allowed_vlans:
+                trunk_vlans_list = vlan_range_to_list(trunk_allowed_vlans)
+                proposed['allowed'] = True
+
+            existing_trunks_list = vlan_range_to_list((existing['trunk_vlans']))
+
+            existing['trunk_vlans_list'] = existing_trunks_list
+            proposed['trunk_vlans_list'] = trunk_vlans_list
+
+        current_vlans = get_list_of_vlans(module)
+
+        if state == 'present':
+            if access_vlan and access_vlan not in current_vlans:
+                module.fail_json(msg='You are trying to configure a VLAN'
+                                 ' on an interface that\ndoes not exist on the '
+                                 ' switch yet!', vlan=access_vlan)
+            elif native_vlan and native_vlan not in current_vlans:
+                module.fail_json(msg='You are trying to configure a VLAN'
+                                 ' on an interface that\ndoes not exist on the '
+                                 ' switch yet!', vlan=native_vlan)
+            else:
+                command = get_switchport_config_commands(name, existing, proposed, module)
+                commands.append(command)
+        elif state == 'unconfigured':
+            is_default = is_switchport_default(existing)
+            if not is_default:
+                command = default_switchport_config(name)
+                commands.append(command)
+        elif state == 'absent':
+            command = remove_switchport_config_commands(name, existing, proposed, module)
+            commands.append(command)
+
+        if trunk_vlans or trunk_allowed_vlans:
+            existing.pop('trunk_vlans_list')
+            proposed.pop('trunk_vlans_list')
+
+    cmds = flatten_list(commands)
+    if cmds:
+        if module.check_mode:
+            module.exit_json(changed=True, commands=cmds)
+        else:
+            result['changed'] = True
+            load_config(module, cmds)
+            if 'configure' in cmds:
+                cmds.pop(0)
+
+    result['commands'] = cmds
+
+    module.exit_json(**result)
+
+
+if __name__ == '__main__':
+    main()

lib/ansible/plugins/cliconf/ios.py

@@ -86,8 +86,7 @@ class Cliconf(CliconfBase):
                               False, newline)
 
     def get(self, command, prompt=None, answer=None, sendonly=False):
-        return self.send_command(to_bytes(command), prompt=to_bytes(prompt),
-                                 answer=to_bytes(answer), sendonly=sendonly)
+        return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
 
     def get_capabilities(self):
         result = {}

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

@@ -1,39 +1,6 @@
 ---
 - debug: msg="START ios_interface cli/basic.yaml on connection={{ ansible_connection }}"
 
-- name: Run show version
-  ios_command:
-    commands: show version
-    authorize: yes
-  register: show_version_result
-
-- block:
-    - name: Set test interface to GigabitEthernet0/1 as we are on Cisco IOS
-      set_fact: test_interface=GigabitEthernet0/1
-    - name: Set test interface 2 to GigabitEthernet0/2 as we are on Cisco IOS
-      set_fact: test_interface2=GigabitEthernet0/2
-  when: "'Cisco IOS' in show_version_result.stdout[0]"
-
-- block:
-    - name: Set test interface to GigabitEthernet2 as we are on Cisco IOS-XE
-      set_fact: test_interface=GigabitEthernet2
-    - name: Disable autonegotiation on GigabitEthernet2
-      ios_config:
-        lines:
-          - no negotiation auto
-        parents: int GigabitEthernet2
-        authorize: yes
-
-    - name: Set test interface 2 to GigabitEthernet3 as we are on Cisco IOS-XE
-      set_fact: test_interface2=GigabitEthernet3
-    - name: Disable autonegotiation on GigabitEthernet3
-      ios_config:
-        lines:
-          - no negotiation auto
-        parents: int GigabitEthernet3
-        authorize: yes
-  when: "'Cisco IOS-XE' in show_version_result.stdout[0]"
-
 - name: Configure interface (setup)
   ios_interface:
     name: "{{ test_interface }}"

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

@@ -1,21 +1,6 @@
 ---
 - debug: msg="START ios_interface cli/intent.yaml on connection={{ ansible_connection }}"
 
-- name: Run show version
-  ios_command:
-    commands: show version
-    authorize: yes
-  register: show_version_result
-
-- name: Set test interface to GigabitEthernet0/2 if we are on Cisco IOS
-  set_fact: test_interface=GigabitEthernet0/2
-  when: "'Cisco IOS' in show_version_result.stdout[0]"
-
-- name: Set test interface to GigabitEthernet2 if we are on Cisco IOS-XE
-  set_fact: test_interface=GigabitEthernet2
-  when: "'Cisco IOS-XE' in show_version_result.stdout[0]"
-
-
 - name: Check intent arguments
   ios_interface:
     name: "{{ test_interface }}"

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

@@ -4,39 +4,6 @@
 # Add minimal testcase to check args are passed correctly to
 # implementation module and module run is successful.
 
-- name: Run show version
-  ios_command:
-    commands: show version
-    authorize: yes
-  register: show_version_result
-
-- block:
-    - name: Set test interface to GigabitEthernet0/1 as we are on Cisco IOS
-      set_fact: test_interface=GigabitEthernet0/1
-    - name: Set test interface 2 to GigabitEthernet0/2 as we are on Cisco IOS
-      set_fact: test_interface2=GigabitEthernet0/2
-  when: "'Cisco IOS' in show_version_result.stdout[0]"
-
-- block:
-    - name: Set test interface to GigabitEthernet2 as we are on Cisco IOS-XE
-      set_fact: test_interface=GigabitEthernet2
-    - name: Disable autonegotiation on GigabitEthernet2
-      ios_config:
-        lines:
-          - no negotiation auto
-        parents: int GigabitEthernet2
-        authorize: yes
-
-    - name: Set test interface 2 to GigabitEthernet3 as we are on Cisco IOS-XE
-      set_fact: test_interface2=GigabitEthernet3
-    - name: Disable autonegotiation on GigabitEthernet3
-      ios_config:
-        lines:
-          - no negotiation auto
-        parents: int GigabitEthernet3
-        authorize: yes
-  when: "'Cisco IOS-XE' in show_version_result.stdout[0]"
-
 - name: Configure interface (setup)
   net_interface:
     name: "{{ test_interface }}"

test/integration/targets/ios_l2_interface/defaults/main.yaml

@@ -0,0 +1,2 @@
+---
+testcase: "*"

test/integration/targets/ios_l2_interface/meta/main.yml

@@ -0,0 +1,2 @@
+dependencies:
+  - prepare_ios_tests

test/integration/targets/ios_l2_interface/tasks/cli.yaml

@@ -0,0 +1,24 @@
+---
+- name: collect all cli test cases
+  find:
+    paths: "{{ role_path }}/tests/cli"
+    patterns: "{{ testcase }}.yaml"
+  register: test_cases
+  delegate_to: localhost
+
+- name: set test_items
+  set_fact: test_items="{{ test_cases.files | map(attribute='path') | list }}"
+
+- name: run test cases (connection=network_cli)
+  include: "{{ test_case_to_run }}"
+  with_items: "{{ test_items }}"
+  loop_control:
+    loop_var: test_case_to_run
+
+- name: run test case (connection=local)
+  include: "{{ test_case_to_run }} ansible_connection=local"
+  with_first_found:
+    - files: "{{ test_items|default([]) }}"
+      skip: true
+  loop_control:
+    loop_var: test_case_to_run

test/integration/targets/ios_l2_interface/tasks/main.yaml

@@ -0,0 +1,4 @@
+---
+- block:
+    - { include: cli.yaml, tags: ['cli'] }
+  when: 'switch_type == "L2"'

test/integration/targets/ios_l2_interface/tests/cli/agg.yaml

@@ -0,0 +1,81 @@
+---
+- debug: msg="START connection={{ ansible_connection }} ios_l2_interface aggregate test"
+
+- name: Setup - Ensure interfaces are switchport
+  ios_config:
+    lines:
+      - switchport
+    parents:
+      - "interface {{ item }}"
+  loop:
+    - "{{ test_interface }}"
+    - "{{ test_interface2 }}"
+
+- name: "Setup vlans"
+  ios_vlan:
+    aggregate:
+      - vlan_id: 6
+      - vlan_id: 15
+    provider: "{{ cli }}"
+
+- name: Setup - Remove interface aggregate before testing
+  ios_l2_interface:
+    aggregate:
+      - { name: "{{ test_interface }}", mode: access, access_vlan: 6 }
+      - { name: "{{ test_interface2 }}", mode: access, access_vlan: 15 }
+    state: absent
+    provider: "{{ cli }}"
+
+- block:
+  - name: Configure interface for access_vlan aggregate
+    ios_l2_interface: &conf_agg
+      aggregate:
+        - { name: "{{ test_interface }}", mode: access, access_vlan: 6 }
+        - { name: "{{ test_interface2 }}", mode: access, access_vlan: 15 }
+      provider: "{{ cli }}"
+    register: result
+
+  - assert:
+      that:
+        - "result.changed == true"
+
+  - name: Configure interface for access_vlan aggregate(Idempotence)
+    ios_l2_interface: *conf_agg
+    register: result
+
+  - assert:
+      that:
+        - "result.changed == false"
+
+  - name: Remove interface aggregate
+    ios_l2_interface: &rm_agg
+      aggregate:
+        - { name: "{{ test_interface }}", mode: access, access_vlan: 6 }
+        - { name: "{{ test_interface2 }}", mode: access, access_vlan: 15 }
+      provider: "{{ cli }}"
+      state: absent
+    register: result
+
+  - assert:
+      that:
+        - "result.changed == true"
+
+  - name: Remove interface aggregate(Idempotence)
+    ios_l2_interface: *rm_agg
+    register: result
+
+  - assert:
+      that:
+        - "result.changed == false"
+
+  always:
+  - name: "remove vlans"
+    ios_vlan:
+      aggregate:
+        - vlan_id: 6
+        - vlan_id: 15
+      state: absent
+      provider: "{{ cli }}"
+    ignore_errors: yes
+
+- debug: msg="END connection={{ ansible_connection }} ios_l2_interface aggregate test"

test/integration/targets/ios_l2_interface/tests/cli/sanity.yaml

@@ -0,0 +1,139 @@
+---
+- debug: msg="START connection={{ ansible_connection }} ios_l2_interface sanity test"
+
+- name: "Setup interface"
+  ios_config: &default
+    lines:
+      - "default interface {{ test_interface }}"
+    provider: "{{ cli }}"
+
+- name: set trunk encapsulation type
+  ios_config:
+    lines:
+      - switchport trunk encapsulation dot1q
+    parents:
+      - "interface {{ test_interface }}"
+    provider: "{{ cli }}"
+
+- name: "Setup vlans"
+  ios_vlan:
+    aggregate:
+      - vlan_id: 5
+      - vlan_id: 6
+      - vlan_id: 7
+      - vlan_id: 8
+      - vlan_id: 9
+      - vlan_id: 10
+      - vlan_id: 20
+    provider: "{{ cli }}"
+
+- block:
+  - name: Ensure interface is in its default switchport state
+    ios_l2_interface: &def_swi
+      name: "{{ test_interface }}"
+      state: unconfigured
+      provider: "{{ cli }}"
+
+  - name: Ensure interface is configured for access vlan 20
+    ios_l2_interface: &acc_vl
+      name: "{{ test_interface }}"
+      mode: access
+      access_vlan: 20
+      provider: "{{ cli }}"
+    register: result
+
+  - assert: &true
+      that:
+        - "result.changed == true"
+
+  - name: "access vlan Idempotence"
+    ios_l2_interface: *acc_vl
+    register: result
+
+  - assert: &false
+      that:
+        - "result.changed == false"
+
+  - name: Ensure interface only has vlans 5-10 as trunk vlans
+    ios_l2_interface: &tr_vl
+      name: "{{ test_interface }}"
+      mode: trunk
+      native_vlan: 10
+      trunk_allowed_vlans: 5-10
+      provider: "{{ cli }}"
+    register: result
+
+  - assert: *true
+
+  - name: "trunk vlan Idempotence"
+    ios_l2_interface: *tr_vl
+    register: result
+
+  - assert: *false
+
+  - name: Ensure interface is a trunk port and ensure 2-50 are being tagged (doesn't mean others aren't also being tagged)
+    ios_l2_interface: &tag
+      name: "{{ test_interface }}"
+      mode: trunk
+      native_vlan: 10
+      trunk_vlans: 2-50
+      provider: "{{ cli }}"
+    register: result
+
+  - assert: *true
+
+  - name: "tag vlan Idempotence"
+    ios_l2_interface: *tag
+    register: result
+
+  - assert: *false
+
+  - name: Ensure these VLANs are not being tagged on the trunk
+    ios_l2_interface: &no_tag
+      name: "{{ test_interface }}"
+      mode: trunk
+      trunk_vlans: 30-4094
+      state: absent
+      provider: "{{ cli }}"
+    register: result
+
+  - assert: *true
+
+  - name: "no tag vlan Idempotence"
+    ios_l2_interface: *no_tag
+    register: result
+
+  - assert: *false
+
+  - name: put interface default state
+    ios_l2_interface: *def_swi
+    register: result
+
+  - assert: *true
+
+  - name: "default state idempotence"
+    ios_l2_interface: *def_swi
+    register: result
+
+  - assert: *false
+
+  always:
+    - name: "remove vlans"
+      ios_vlan:
+        aggregate:
+          - vlan_id: 5
+          - vlan_id: 6
+          - vlan_id: 7
+          - vlan_id: 8
+          - vlan_id: 9
+          - vlan_id: 10
+          - vlan_id: 20
+        state: absent
+        provider: "{{ cli }}"
+      ignore_errors: yes
+
+    - name: "default interface"
+      ios_config: *default
+      ignore_errors: yes
+
+- debug: msg="END connection={{ ansible_connection }} ios_l2_interface sanity test"

test/integration/targets/ios_l3_interface/tests/cli/basic.yaml

@@ -1,39 +1,6 @@
 ---
 - debug: msg="START ios_l3_interface cli/basic.yaml on connection={{ ansible_connection }}"
 
-- name: Run show version
-  ios_command:
-    commands: show version
-    authorize: yes
-  register: show_version_result
-
-- block:
-    - name: Set test interface to GigabitEthernet0/1 as we are on Cisco IOS
-      set_fact: test_interface=GigabitEthernet0/1
-    - name: Set test interface 2 to GigabitEthernet0/2 as we are on Cisco IOS
-      set_fact: test_interface2=GigabitEthernet0/2
-  when: "'Cisco IOS' in show_version_result.stdout[0]"
-
-- block:
-    - name: Set test interface to GigabitEthernet2 as we are on Cisco IOS-XE
-      set_fact: test_interface=GigabitEthernet2
-    - name: Disable autonegotiation on GigabitEthernet2
-      ios_config:
-        lines:
-          - no negotiation auto
-        parents: int GigabitEthernet2
-        authorize: yes
-
-    - name: Set test interface 2 to GigabitEthernet3 as we are on Cisco IOS-XE
-      set_fact: test_interface2=GigabitEthernet3
-    - name: Disable autonegotiation on GigabitEthernet3
-      ios_config:
-        lines:
-          - no negotiation auto
-        parents: int GigabitEthernet3
-        authorize: yes
-  when: "'Cisco IOS-XE' in show_version_result.stdout[0]"
-
 - name: Delete interface ipv4 and ipv6 address(setup)
   ios_l3_interface:
     name: "{{ test_interface }}"

test/integration/targets/prepare_ios_tests/tasks/main.yml

@@ -23,3 +23,30 @@
 
 - set_fact: switch_type="L2"
   when: '"l2" in result.stdout[0]'
+
+- block:
+    - name: Set test interface to GigabitEthernet0/1 as we are on Cisco IOS
+      set_fact: test_interface=GigabitEthernet0/1
+    - name: Set test interface 2 to GigabitEthernet0/2 as we are on Cisco IOS
+      set_fact: test_interface2=GigabitEthernet0/2
+  when: "'Cisco IOS' in result.stdout[0]"
+
+- block:
+    - name: Set test interface to GigabitEthernet2 as we are on Cisco IOS-XE
+      set_fact: test_interface=GigabitEthernet2
+    - name: Disable autonegotiation on GigabitEthernet2
+      ios_config:
+        lines:
+          - no negotiation auto
+        parents: int GigabitEthernet2
+        authorize: yes
+
+    - name: Set test interface 2 to GigabitEthernet3 as we are on Cisco IOS-XE
+      set_fact: test_interface2=GigabitEthernet3
+    - name: Disable autonegotiation on GigabitEthernet3
+      ios_config:
+        lines:
+          - no negotiation auto
+        parents: int GigabitEthernet3
+        authorize: yes
+  when: "'Cisco IOS-XE' in result.stdout[0]"