diff --git a/CHANGELOG.md b/CHANGELOG.md index 8be5474d4e..911ecf88c5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,6 +34,7 @@ Ansible Changes By Release check_invalid_arguments will be removed in Ansible-2.9. * nxos_ip_interface module is deprecated in Ansible 2.5. Use nxos_l3_interface module instead. * nxos_portchannel module is deprecated in Ansible 2.5. Use nxos_linkagg module instead. +* nxos_switchport module is deprecated in Ansible 2.5. Use nxos_l2_interface module instead. ### Minor Changes * added a few new magic vars corresponding to configuration/command line options: diff --git a/docs/docsite/rst/porting_guide_2.5.rst b/docs/docsite/rst/porting_guide_2.5.rst index 469c9cb4a2..3746c2cce0 100644 --- a/docs/docsite/rst/porting_guide_2.5.rst +++ b/docs/docsite/rst/porting_guide_2.5.rst @@ -81,6 +81,7 @@ The following modules will be removed in Ansible 2.9. Please update update your * :ref:`fixme ` * :ref:`nxos_ip_interface ` use :ref:`nxos_l3_interface ` instead. * :ref:`nxos_portchannel ` use :ref:`nxos_linkagg ` instead. +* :ref:`nxos_switchport ` use :ref:`nxos_l2_interface ` instead. Noteworthy module changes ------------------------- diff --git a/lib/ansible/modules/network/nxos/nxos_switchport.py b/lib/ansible/modules/network/nxos/_nxos_switchport.py similarity index 99% rename from lib/ansible/modules/network/nxos/nxos_switchport.py rename to lib/ansible/modules/network/nxos/_nxos_switchport.py index cc11d30476..2b045c307e 100644 --- a/lib/ansible/modules/network/nxos/nxos_switchport.py +++ b/lib/ansible/modules/network/nxos/_nxos_switchport.py @@ -17,7 +17,7 @@ # ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'network'} DOCUMENTATION = ''' @@ -25,6 +25,9 @@ DOCUMENTATION = ''' module: nxos_switchport extends_documentation_fragment: nxos version_added: "2.1" +deprecated: + version: 2.5 + alternative: Use M(nxos_l2_interface) instead. short_description: Manages Layer 2 switchport interfaces. description: - Manages Layer 2 interfaces diff --git a/lib/ansible/modules/network/nxos/nxos_l2_interface.py b/lib/ansible/modules/network/nxos/nxos_l2_interface.py new file mode 100644 index 0000000000..f8e0d85409 --- /dev/null +++ b/lib/ansible/modules/network/nxos/nxos_l2_interface.py @@ -0,0 +1,596 @@ +#!/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: nxos_l2_interface +extends_documentation_fragment: nxos +version_added: "2.5" +short_description: Manage Layer-2 interface on Cisco NXOS devices. +description: + - This module provides declarative management of Layer-2 interface on + Cisco NXOS devices. +author: + - Trishna Guha (@trishnaguha) +notes: + - Tested against NXOSv 7.0(3)I5(1). +options: + name: + description: + - Full name of the interface excluding any logical + unit number, i.e. Ethernet1/1. + required: true + aliases: interface + mode: + description: + - Mode in which interface needs to be configured. + choices: ['access','trunk'] + access_vlan: + description: + - Configure given VLAN in access port. + If C(mode=access), used as the access VLAN ID. + native_vlan: + description: + - Native VLAN to be configured in trunk port. + If C(mode=trunk), used as the trunk native 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. + aliases: trunk_add_vlans + 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 Eth1/5 is in its default l2 interface state + nxos_l2_interface: + name: Ethernet1/5 + state: unconfigured + +- name: Ensure Eth1/5 is configured for access vlan 20 + nxos_l2_interface: + name: Ethernet1/5 + mode: access + access_vlan: 20 + +- name: Ensure Eth1/5 only has vlans 5-10 as trunk vlans + nxos_l2_interface: + name: Ethernet1/5 + mode: trunk + native_vlan: 10 + trunk_vlans: 5-10 + +- name: Ensure eth1/5 is a trunk port and ensure 2-50 are being tagged (doesn't mean others aren't also being tagged) + nxos_l2_interface: + name: Ethernet1/5 + mode: trunk + native_vlan: 10 + trunk_vlans: 2-50 + +- name: Ensure these VLANs are not being tagged on the trunk + nxos_l2_interface: + name: Ethernet1/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 eth1/5 + - switchport access vlan 20 +""" + +import re +from copy import deepcopy + +from ansible.module_utils.network.nxos.nxos import get_config, load_config, run_commands +from ansible.module_utils.network.nxos.nxos import nxos_argument_spec +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.network.common.utils import remove_default_spec + + +def get_interface_type(name): + """Gets the type of interface + Args: + interface (str): full name of interface, i.e. Ethernet1/1, loopback10, + port-channel20, vlan20 + Returns: + type of interface: ethernet, svi, loopback, management, portchannel, + or unknown + """ + if name.upper().startswith('ET'): + return 'ethernet' + elif name.upper().startswith('VL'): + return 'svi' + elif name.upper().startswith('LO'): + return 'loopback' + elif name.upper().startswith('MG'): + return 'management' + elif name.upper().startswith('MA'): + return 'management' + elif name.upper().startswith('PO'): + return 'portchannel' + else: + return 'unknown' + + +def get_interface_mode(name, module): + """Gets current mode of interface: layer2 or layer3 + Args: + device (Device): This is the device object of an NX-API enabled device + using the Device class within device.py + interface (string): full name of interface, i.e. Ethernet1/1, + loopback10, port-channel20, vlan20 + Returns: + str: 'layer2' or 'layer3' + """ + command = 'show interface {0} | json'.format(name) + intf_type = get_interface_type(name) + mode = 'unknown' + interface_table = {} + + try: + body = run_commands(module, [command])[0] + interface_table = body['TABLE_interface']['ROW_interface'] + except (KeyError, AttributeError, IndexError): + return mode + + if interface_table: + # HACK FOR NOW + if intf_type in ['ethernet', 'portchannel']: + mode = str(interface_table.get('eth_mode', 'layer3')) + if mode in ['access', 'trunk']: + mode = 'layer2' + if mode == 'routed': + mode = 'layer3' + elif intf_type == 'loopback' or intf_type == 'svi': + mode = 'layer3' + return mode + + +def interface_is_portchannel(name, module): + """Checks to see if an interface is part of portchannel bundle + Args: + interface (str): full name of interface, i.e. Ethernet1/1 + Returns: + True/False based on if interface is a member of a portchannel bundle + """ + intf_type = get_interface_type(name) + + if intf_type == 'ethernet': + command = 'show interface {0} | json'.format(name) + try: + body = run_commands(module, [command])[0] + interface_table = body['TABLE_interface']['ROW_interface'] + except (KeyError, AttributeError, IndexError): + interface_table = None + + if interface_table: + state = interface_table.get('eth_bundle') + if state: + return True + else: + return False + + return False + + +def get_switchport(port, module): + """Gets current config of L2 switchport + Args: + device (Device): This is the device object of an NX-API enabled device + using the Device class within device.py + port (str): full name of interface, i.e. Ethernet1/1 + Returns: + dictionary with k/v pairs for L2 vlan config + """ + + command = 'show interface {0} switchport | json'.format(port) + + try: + body = run_commands(module, [command])[0] + sp_table = body['TABLE_interface']['ROW_interface'] + except (KeyError, AttributeError, IndexError): + sp_table = None + + if sp_table: + key_map = { + "interface": "name", + "oper_mode": "mode", + "switchport": "switchport", + "access_vlan": "access_vlan", + "access_vlan_name": "access_vlan_name", + "native_vlan": "native_vlan", + "native_vlan_name": "native_vlan_name", + "trunk_vlans": "trunk_vlans" + } + sp = apply_key_map(key_map, sp_table) + return sp + + else: + return {} + + +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: + a, b = part.split('-') + a, b = int(a), int(b) + result.extend(range(a, b + 1)) + else: + a = int(part) + result.append(a) + return numerical_sort(result) + return result + + +def get_list_of_vlans(module): + + command = 'show vlan | json' + vlan_list = [] + + try: + body = run_commands(module, [command])[0] + vlan_table = body['TABLE_vlanbrief']['ROW_vlanbrief'] + except (KeyError, AttributeError, IndexError): + return [] + + if isinstance(vlan_table, list): + for vlan in vlan_table: + vlan_list.append(str(vlan['vlanshowbr-vlanid-utf'])) + else: + vlan_list.append('1') + + return vlan_list + + +def numerical_sort(string_int_list): + """Sorts list of strings/integers that are digits in numerical order. + """ + + as_int_list = [] + as_str_list = [] + for vlan in string_int_list: + as_int_list.append(int(vlan)) + as_int_list.sort() + for vlan in as_int_list: + as_str_list.append(str(vlan)) + return as_str_list + + +def apply_key_map(key_map, table): + new_dict = {} + for key, value in table.items(): + new_key = key_map.get(key) + if new_key: + new_dict[new_key] = str(value) + return new_dict + + +def apply_value_map(value_map, resource): + for key, value in value_map.items(): + resource[key] = value[resource.get(key)] + return resource + + +def flatten_list(command_lists): + flat_command_list = [] + for command in command_lists: + if isinstance(command, list): + flat_command_list.extend(command) + else: + flat_command_list.append(command) + return flat_command_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] + + d = item.copy() + obj.append(d) + 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', aliases=['trunk_add_vlans']), + 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(nxos_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} + if warnings: + result['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') + + current_mode = get_interface_mode(name, module) + + # Current mode will return layer3, layer2, or unknown + if current_mode == 'unknown' or current_mode == 'layer3': + module.fail_json(msg='Ensure interface is configured to be a L2' + '\nport first before using this module. You can use' + '\nthe nxos_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 + result['warnings'] = warnings + + module.exit_json(**result) + + +if __name__ == '__main__': + main() diff --git a/test/integration/nxos.yaml b/test/integration/nxos.yaml index 04be74b422..2f67c59668 100644 --- a/test/integration/nxos.yaml +++ b/test/integration/nxos.yaml @@ -581,6 +581,15 @@ failed_modules: "{{ failed_modules }} + [ 'nxos_lldp' ]" test_failed: true + - block: + - include_role: + name: nxos_l2_interface + when: "limit_to in ['*', 'nxos_l2_interface']" + rescue: + - set_fact: + failed_modules: "{{ failed_modules }} + [ 'nxos_l2_interface' ]" + test_failed: true + ########### - debug: var=failed_modules when: test_failed diff --git a/test/integration/targets/nxos_l2_interface/defaults/main.yaml b/test/integration/targets/nxos_l2_interface/defaults/main.yaml new file mode 100644 index 0000000000..5f709c5aac --- /dev/null +++ b/test/integration/targets/nxos_l2_interface/defaults/main.yaml @@ -0,0 +1,2 @@ +--- +testcase: "*" diff --git a/test/integration/targets/nxos_l2_interface/meta/main.yml b/test/integration/targets/nxos_l2_interface/meta/main.yml new file mode 100644 index 0000000000..ae741cbdc7 --- /dev/null +++ b/test/integration/targets/nxos_l2_interface/meta/main.yml @@ -0,0 +1,2 @@ +dependencies: + - prepare_nxos_tests diff --git a/test/integration/targets/nxos_l2_interface/tasks/cli.yaml b/test/integration/targets/nxos_l2_interface/tasks/cli.yaml new file mode 100644 index 0000000000..0ab3f8f908 --- /dev/null +++ b/test/integration/targets/nxos_l2_interface/tasks/cli.yaml @@ -0,0 +1,25 @@ +--- +- name: collect common cli test cases + find: + paths: "{{ role_path }}/tests/common" + patterns: "{{ testcase }}.yaml" + register: test_cases + +- name: collect cli test cases + find: + paths: "{{ role_path }}/tests/cli" + patterns: "{{ testcase }}.yaml" + register: cli_cases + +- set_fact: + test_cases: + files: "{{ test_cases.files }} + {{ cli_cases.files }}" + +- name: set test_items + set_fact: test_items="{{ test_cases.files | map(attribute='path') | list }}" + +- name: run test case + include: "{{ test_case_to_run }} connection={{ cli }}" + with_items: "{{ test_items }}" + loop_control: + loop_var: test_case_to_run diff --git a/test/integration/targets/nxos_l2_interface/tasks/main.yaml b/test/integration/targets/nxos_l2_interface/tasks/main.yaml new file mode 100644 index 0000000000..4b0f8c64d9 --- /dev/null +++ b/test/integration/targets/nxos_l2_interface/tasks/main.yaml @@ -0,0 +1,3 @@ +--- +- { include: cli.yaml, tags: ['cli'] } +- { include: nxapi.yaml, tags: ['nxapi'] } diff --git a/test/integration/targets/nxos_l2_interface/tasks/nxapi.yaml b/test/integration/targets/nxos_l2_interface/tasks/nxapi.yaml new file mode 100644 index 0000000000..378db2f016 --- /dev/null +++ b/test/integration/targets/nxos_l2_interface/tasks/nxapi.yaml @@ -0,0 +1,25 @@ +--- +- name: collect common nxapi test cases + find: + paths: "{{ role_path }}/tests/common" + patterns: "{{ testcase }}.yaml" + register: test_cases + +- name: collect nxapi test cases + find: + paths: "{{ role_path }}/tests/nxapi" + patterns: "{{ testcase }}.yaml" + register: nxapi_cases + +- set_fact: + test_cases: + files: "{{ test_cases.files }} + {{ nxapi_cases.files }}" + +- name: set test_items + set_fact: test_items="{{ test_cases.files | map(attribute='path') | list }}" + +- name: run test case + include: "{{ test_case_to_run }} connection={{ nxapi }}" + with_items: "{{ test_items }}" + loop_control: + loop_var: test_case_to_run diff --git a/test/integration/targets/nxos_l2_interface/tests/common/agg.yaml b/test/integration/targets/nxos_l2_interface/tests/common/agg.yaml new file mode 100644 index 0000000000..557a03d467 --- /dev/null +++ b/test/integration/targets/nxos_l2_interface/tests/common/agg.yaml @@ -0,0 +1,71 @@ +--- +- debug: msg="START TRANSPORT:{{ connection.transport }} nxos_l2_interface aggregate test" + +# Select interface for test +- set_fact: intname1="{{ nxos_int1 }}" +- set_fact: intname2="{{ nxos_int2 }}" + +- name: "Setup vlans" + nxos_vlan: + vlan_range: "6,15" + provider: "{{ connection }}" + +- name: Setup - Remove interface aggregate before testing + nxos_l2_interface: + aggregate: + - { name: "{{ intname1 }}", mode: access, access_vlan: 6 } + - { name: "{{ intname2 }}", mode: access, access_vlan: 15 } + state: absent + provider: "{{ connection }}" + +- block: + - name: Configure interface for access_vlan aggregate + nxos_l2_interface: &conf_agg + aggregate: + - { name: "{{ intname1 }}", mode: access, access_vlan: 6 } + - { name: "{{ intname2 }}", mode: access, access_vlan: 15 } + provider: "{{ connection }}" + register: result + + - assert: + that: + - "result.changed == true" + + - name: Configure interface for access_vlan aggregate(Idempotence) + nxos_l2_interface: *conf_agg + register: result + + - assert: + that: + - "result.changed == false" + + - name: Remove interface aggregate + nxos_l2_interface: &rm_agg + aggregate: + - { name: "{{ intname1 }}", mode: access, access_vlan: 6 } + - { name: "{{ intname2 }}", mode: access, access_vlan: 15 } + provider: "{{ connection }}" + state: absent + register: result + + - assert: + that: + - "result.changed == true" + + - name: Remove interface aggregate(Idempotence) + nxos_l2_interface: *rm_agg + register: result + + - assert: + that: + - "result.changed == false" + + always: + - name: "remove vlans" + nxos_vlan: + vlan_range: "6,15" + state: absent + provider: "{{ connection }}" + ignore_errors: yes + +- debug: msg="END TRANSPORT:{{ connection.transport }} nxos_l2_interface aggregate test" diff --git a/test/integration/targets/nxos_l2_interface/tests/common/sanity.yaml b/test/integration/targets/nxos_l2_interface/tests/common/sanity.yaml new file mode 100644 index 0000000000..0a244aa478 --- /dev/null +++ b/test/integration/targets/nxos_l2_interface/tests/common/sanity.yaml @@ -0,0 +1,124 @@ +--- +- debug: msg="START TRANSPORT:{{ connection.transport }} nxos_l2_interface sanity test" + +# Select interface for test +- set_fact: intname="{{ nxos_int1 }}" + +- name: "Interface selected for this test" + debug: msg="{{ intname }}" + +- name: "Setup interface" + nxos_config: &default + lines: + - "default interface {{ intname }}" + provider: "{{ connection }}" + ignore_errors: yes + +- name: "Setup vlans" + nxos_vlan: + vlan_range: "5-10,20" + provider: "{{ connection }}" + +- block: + - name: Ensure interface is in its default switchport state + nxos_l2_interface: &def_swi + name: "{{ intname }}" + state: unconfigured + provider: "{{ connection }}" + + - name: Ensure interface is configured for access vlan 20 + nxos_l2_interface: &acc_vl + name: "{{ intname }}" + mode: access + access_vlan: 20 + provider: "{{ connection }}" + register: result + + - assert: &true + that: + - "result.changed == true" + + - name: "access vlan Idempotence" + nxos_l2_interface: *acc_vl + register: result + + - assert: &false + that: + - "result.changed == false" + + - name: Ensure interface only has vlans 5-10 as trunk vlans + nxos_l2_interface: &tr_vl + name: "{{ intname }}" + mode: trunk + native_vlan: 10 + trunk_allowed_vlans: 5-10 + provider: "{{ connection }}" + register: result + + - assert: *true + + - name: "trunk vlan Idempotence" + nxos_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) + nxos_l2_interface: &tag + name: "{{ intname }}" + mode: trunk + native_vlan: 10 + trunk_vlans: 2-50 + provider: "{{ connection }}" + register: result + + - assert: *true + + - name: "tag vlan Idempotence" + nxos_l2_interface: *tag + register: result + + - assert: *false + + - name: Ensure these VLANs are not being tagged on the trunk + nxos_l2_interface: &no_tag + name: "{{ intname }}" + mode: trunk + trunk_vlans: 30-4094 + state: absent + provider: "{{ connection }}" + register: result + + - assert: *true + + - name: "no tag vlan Idempotence" + nxos_l2_interface: *no_tag + register: result + + - assert: *false + + - name: put interface default state + nxos_l2_interface: *def_swi + register: result + + - assert: *true + + - name: "default state idempotence" + nxos_l2_interface: *def_swi + register: result + + - assert: *false + + always: + - name: "remove vlans" + nxos_vlan: + vlan_range: "5-10,20" + state: absent + provider: "{{ connection }}" + ignore_errors: yes + + - name: "default interface" + nxos_config: *default + ignore_errors: yes + +- debug: msg="END TRANSPORT:{{ connection.transport }} nxos_l2_interface sanity test" diff --git a/test/units/modules/network/nxos/fixtures/nxos_switchport/show_interface_ethernet b/test/units/modules/network/nxos/fixtures/_nxos_switchport/show_interface_ethernet similarity index 100% rename from test/units/modules/network/nxos/fixtures/nxos_switchport/show_interface_ethernet rename to test/units/modules/network/nxos/fixtures/_nxos_switchport/show_interface_ethernet diff --git a/test/units/modules/network/nxos/fixtures/nxos_switchport/show_interface_ethernet_switchport b/test/units/modules/network/nxos/fixtures/_nxos_switchport/show_interface_ethernet_switchport similarity index 100% rename from test/units/modules/network/nxos/fixtures/nxos_switchport/show_interface_ethernet_switchport rename to test/units/modules/network/nxos/fixtures/_nxos_switchport/show_interface_ethernet_switchport diff --git a/test/units/modules/network/nxos/fixtures/nxos_switchport/show_vlan b/test/units/modules/network/nxos/fixtures/_nxos_switchport/show_vlan similarity index 100% rename from test/units/modules/network/nxos/fixtures/nxos_switchport/show_vlan rename to test/units/modules/network/nxos/fixtures/_nxos_switchport/show_vlan diff --git a/test/units/modules/network/nxos/test_nxos_switchport.py b/test/units/modules/network/nxos/test_nxos_switchport.py index 424b6790f3..26dc5d990a 100644 --- a/test/units/modules/network/nxos/test_nxos_switchport.py +++ b/test/units/modules/network/nxos/test_nxos_switchport.py @@ -20,24 +20,24 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type from ansible.compat.tests.mock import patch -from ansible.modules.network.nxos import nxos_switchport +from ansible.modules.network.nxos import _nxos_switchport from .nxos_module import TestNxosModule, load_fixture, set_module_args class TestNxosSwitchportModule(TestNxosModule): - module = nxos_switchport + module = _nxos_switchport def setUp(self): super(TestNxosSwitchportModule, self).setUp() - self.mock_run_commands = patch('ansible.modules.network.nxos.nxos_switchport.run_commands') + self.mock_run_commands = patch('ansible.modules.network.nxos._nxos_switchport.run_commands') self.run_commands = self.mock_run_commands.start() - self.mock_load_config = patch('ansible.modules.network.nxos.nxos_switchport.load_config') + self.mock_load_config = patch('ansible.modules.network.nxos._nxos_switchport.load_config') self.load_config = self.mock_load_config.start() - self.mock_get_capabilities = patch('ansible.modules.network.nxos.nxos_switchport.get_capabilities') + self.mock_get_capabilities = patch('ansible.modules.network.nxos._nxos_switchport.get_capabilities') self.get_capabilities = self.mock_get_capabilities.start() self.get_capabilities.return_value = {'network_api': 'cliconf'} @@ -54,7 +54,7 @@ class TestNxosSwitchportModule(TestNxosModule): for command in commands: filename = str(command).split(' | ')[0].replace(' ', '_') filename = filename.replace('2/1', '') - output.append(load_fixture('nxos_switchport', filename)) + output.append(load_fixture('_nxos_switchport', filename)) return output self.run_commands.side_effect = load_from_file