From 89670133c193e85e3a6ee4f67c8f54b736cdcdfb Mon Sep 17 00:00:00 2001 From: Samer Deeb Date: Sun, 24 Dec 2017 23:51:40 -0800 Subject: [PATCH] Module mlnxos_l3_interface (#34199) * Add module mlnxos_l3_interface for configuring L3 on Mellanox switches Signed-off-by: Samer Deeb * Rename test class Signed-off-by: Samer Deeb --- .../network/mlnxos/mlnxos_l3_interface.py | 295 ++++++++++++++++++ .../fixtures/mlnxos_l3_interface_show.cfg | 89 ++++++ .../mlnxos_l3_vlan_interface_show.cfg | 18 ++ .../mlnxos/test_mlnxos_l3_interface.py | 108 +++++++ 4 files changed, 510 insertions(+) create mode 100644 lib/ansible/modules/network/mlnxos/mlnxos_l3_interface.py create mode 100644 test/units/modules/network/mlnxos/fixtures/mlnxos_l3_interface_show.cfg create mode 100644 test/units/modules/network/mlnxos/fixtures/mlnxos_l3_vlan_interface_show.cfg create mode 100644 test/units/modules/network/mlnxos/test_mlnxos_l3_interface.py diff --git a/lib/ansible/modules/network/mlnxos/mlnxos_l3_interface.py b/lib/ansible/modules/network/mlnxos/mlnxos_l3_interface.py new file mode 100644 index 0000000000..372b7caa43 --- /dev/null +++ b/lib/ansible/modules/network/mlnxos/mlnxos_l3_interface.py @@ -0,0 +1,295 @@ +#!/usr/bin/python +# +# Copyright: Ansible Project +# 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': 'community'} + +DOCUMENTATION = """ +--- +module: mlnxos_l3_interface +version_added: "2.5" +author: "Samer Deeb (@samerd)" +short_description: Manage L3 interfaces on Mellanox MLNX-OS network devices +description: + - This module provides declarative management of L3 interfaces + on Mellanox MLNX-OS network devices. +options: + name: + description: + - Name of the L3 interface. + ipv4: + description: + - IPv4 of the L3 interface. + ipv6: + description: + - IPv6 of the L3 interface (not supported for now). + aggregate: + description: List of L3 interfaces definitions + purge: + description: + - Purge L3 interfaces not defined in the I(aggregate) parameter. + default: false + type: bool + state: + description: + - State of the L3 interface configuration. + default: present + choices: ['present', 'absent'] +""" + +EXAMPLES = """ +- name: Set Eth1/1 IPv4 address + mlnxos_l3_interface: + name: Eth1/1 + ipv4: 192.168.0.1/24 + +- name: Remove Eth1/1 IPv4 address + mlnxos_l3_interface: + name: Eth1/1 + state: absent + +- name: Set IP addresses on aggregate + mlnxos_l3_interface: + aggregate: + - { name: Eth1/1, ipv4: 192.168.2.10/24 } + - { name: Eth1/2, ipv4: 192.168.3.10/24 } + +- name: Remove IP addresses on aggregate + mlnxos_l3_interface: + aggregate: + - { name: Eth1/1, ipv4: 192.168.2.10/24 } + - { name: Eth1/2, ipv4: 192.168.3.10/24 } + state: absent +""" + +RETURN = """ +commands: + description: The list of configuration mode commands to send to the device + returned: always. + type: list + sample: + - interfaces ethernet 1/1 ip address 192.168.0.1 /24 +""" +import re +from copy import deepcopy + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.six import iteritems +from ansible.module_utils.network.common.utils import remove_default_spec + +from ansible.module_utils.network.mlnxos.mlnxos import BaseMlnxosModule +from ansible.module_utils.network.mlnxos.mlnxos import get_interfaces_config + + +class MlnxosL3InterfaceModule(BaseMlnxosModule): + IF_ETH_REGEX = re.compile(r"^Eth(\d+\/\d+|Eth\d+\/\d+\d+)$") + IF_VLAN_REGEX = re.compile(r"^Vlan (\d+)$") + IF_LOOPBACK_REGEX = re.compile(r"^Loopback (\d+)$") + + IF_TYPE_ETH = "ethernet" + IF_TYPE_LOOPBACK = "loopback" + IF_TYPE_VLAN = "vlan" + + IF_TYPE_MAP = { + IF_TYPE_ETH: IF_ETH_REGEX, + IF_TYPE_VLAN: IF_VLAN_REGEX, + IF_TYPE_LOOPBACK: IF_LOOPBACK_REGEX, + } + + IP_ADDR_ATTR_MAP = { + IF_TYPE_ETH: 'IP Address', + IF_TYPE_VLAN: 'Internet Address', + IF_TYPE_LOOPBACK: 'Internet Address', + } + + _purge = False + + @classmethod + def _get_element_spec(cls): + return dict( + name=dict(type='str'), + ipv4=dict(type='str'), + ipv6=dict(type='str'), + state=dict(default='present', + choices=['present', 'absent', 'enabled', 'disabled']), + ) + + @classmethod + def _get_aggregate_spec(cls, element_spec): + aggregate_spec = deepcopy(element_spec) + aggregate_spec['name'] = dict(required=True) + + # remove default in aggregate spec, to handle common arguments + remove_default_spec(aggregate_spec) + return aggregate_spec + + def init_module(self): + """ module initialization + """ + element_spec = self._get_element_spec() + aggregate_spec = self._get_aggregate_spec(element_spec) + if aggregate_spec: + argument_spec = dict( + aggregate=dict(type='list', elements='dict', + options=aggregate_spec), + purge=dict(default=False, type='bool'), + ) + else: + argument_spec = dict() + argument_spec.update(element_spec) + required_one_of = [['name', 'aggregate']] + mutually_exclusive = [['name', 'aggregate']] + self._module = AnsibleModule( + argument_spec=argument_spec, + required_one_of=required_one_of, + mutually_exclusive=mutually_exclusive, + supports_check_mode=True) + + def _get_interface_type(self, if_name): + if_type = None + if_id = None + for interface_type, interface_regex in iteritems(self.IF_TYPE_MAP): + match = interface_regex.match(if_name) + if match: + if_type = interface_type + if_id = match.group(1) + break + return if_type, if_id + + def _set_if_type(self, params): + if_name = params['name'] + if_type, if_id = self._get_interface_type(if_name) + if not if_id: + self._module.fail_json( + msg='unsupported interface: %s' % if_name) + params['if_type'] = if_type + params['if_id'] = if_id + + def get_required_config(self): + self._required_config = list() + module_params = self._module.params + aggregate = module_params.get('aggregate') + self._purge = module_params.get('purge', False) + if aggregate: + for item in aggregate: + for key in item: + if item.get(key) is None: + item[key] = module_params[key] + self.validate_param_values(item, item) + req_item = item.copy() + self._set_if_type(req_item) + self._required_config.append(req_item) + else: + params = { + 'name': module_params['name'], + 'ipv4': module_params['ipv4'], + 'ipv6': module_params['ipv6'], + 'state': module_params['state'], + } + self.validate_param_values(params) + self._set_if_type(params) + self._required_config.append(params) + + def _get_interfaces_config(self, interface_type): + return get_interfaces_config(self._module, interface_type) + + def _parse_interfaces_config(self, if_type, if_config): + ipaddr_attr = self.IP_ADDR_ATTR_MAP[if_type] + for if_data in if_config: + if_name = self.get_config_attr(if_data, 'header') + regex = self.IF_TYPE_MAP[if_type] + match = regex.match(if_name) + if not match: + continue + ipv4 = self.get_config_attr(if_data, ipaddr_attr) + if ipv4: + ipv4 = ipv4.replace(' ', '') + ipv6 = self.get_config_attr(if_data, 'IPv6 address(es)') + if ipv6: + ipv6 = ipv6.replace('[primary]', '') + ipv6 = ipv6.strip() + if_id = match.group(1) + switchport = self.get_config_attr(if_data, 'Switchport mode') + if_obj = { + 'name': if_name, + 'if_id': if_id, + 'if_type': if_type, + 'ipv4': ipv4, + 'ipv6': ipv6, + 'switchport': switchport, + } + self._current_config[if_name] = if_obj + + def load_current_config(self): + # called in base class in run function + self._current_config = dict() + if_types = set([if_obj['if_type'] for if_obj in self._required_config]) + for if_type in if_types: + if_config = self._get_interfaces_config(if_type) + if not if_config: + continue + self._parse_interfaces_config(if_type, if_config) + + def _generate_no_ip_commands(self, req_conf, curr_conf): + curr_ip = curr_conf.get('ipv4') + if_type = req_conf['if_type'] + if_id = req_conf['if_id'] + if curr_ip: + cmd = "interface %s %s no ip address" % (if_type, if_id) + self._commands.append(cmd) + curr_ipv6 = curr_conf.get('ipv6') + if curr_ipv6: + cmd = "interface %s %s no ipv6 address %s" % ( + if_type, if_id, curr_ipv6) + self._commands.append(cmd) + + def _generate_ip_commands(self, req_conf, curr_conf): + curr_ipv4 = curr_conf.get('ipv4') + req_ipv4 = req_conf.get('ipv4') + curr_ipv6 = curr_conf.get('ipv6') + req_ipv6 = req_conf.get('ipv6') + if_type = req_conf['if_type'] + if_id = req_conf['if_id'] + switchport = curr_conf.get('switchport') + if switchport: + cmd = "interface %s %s no switchport force" % (if_type, if_id) + self._commands.append(cmd) + if curr_ipv4 != req_ipv4: + cmd = "interface %s %s ip address %s" % (if_type, if_id, req_ipv4) + self._commands.append(cmd) + if curr_ipv6 != req_ipv6: + cmd = "interface %s %s ipv6 address %s" % ( + if_type, if_id, req_ipv6) + self._commands.append(cmd) + + def generate_commands(self): + req_interfaces = set() + for req_conf in self._required_config: + state = req_conf['state'] + if_name = req_conf['name'] + curr_conf = self._current_config.get(if_name, {}) + if state == 'absent': + self._generate_no_ip_commands(req_conf, curr_conf) + else: + req_interfaces.add(if_name) + self._generate_ip_commands(req_conf, curr_conf) + if self._purge: + for if_name, curr_conf in iteritems(self._current_config): + if if_name not in req_interfaces: + self._generate_no_ip_commands(req_conf, curr_conf) + + +def main(): + """ main entry point for module execution + """ + MlnxosL3InterfaceModule.main() + + +if __name__ == '__main__': + main() diff --git a/test/units/modules/network/mlnxos/fixtures/mlnxos_l3_interface_show.cfg b/test/units/modules/network/mlnxos/fixtures/mlnxos_l3_interface_show.cfg new file mode 100644 index 0000000000..6298953bf8 --- /dev/null +++ b/test/units/modules/network/mlnxos/fixtures/mlnxos_l3_interface_show.cfg @@ -0,0 +1,89 @@ +[ + { + "Broadcast address": "172.3.1.255", + "Fec": "auto", + "Tx": { + "error packets": "0", + "packets": "0", + "bytes": "0", + "multicast packets": "0", + "unicast packets": "0", + "discard packets": "0", + "hoq discard packets": "0", + "broadcast packets": "0" + }, + "Rx": { + "error packets": "0", + "packets": "0", + "bytes": "0", + "multicast packets": "0", + "unicast packets": "0", + "discard packets": "0", + "broadcast packets": "0" + }, + "header": "Eth1/5", + "Arp timeout": "1500 seconds", + "Actual speed": "40 Gbps", + "60 seconds egress rate": "0 bits/sec, 0 bytes/sec, 0 packets/sec", + "Last change in operational status": "Never", + "Boot delay time": "0 sec", + "Description": "N\\A", + "DHCP client": "Disabled", + "VRF": "default", + "Mac address": "24:8A:07:F5:54:01", + "60 seconds ingress rate": "0 bits/sec, 0 bytes/sec, 0 packets/sec", + "Last clearing of \"show interface\" counters": "Never", + "MTU": "1500 bytes(Maximum packet size 1522 bytes)", + "Telemetry threshold": "Disabled\t TCs: N\\A", + "Telemetry threshold level": "N\\A", + "Flow-control": "receive off send off", + "Forwarding mode": "inherited cut-through", + "Admin state": "Enabled", + "Telemetry sampling": "Disabled\t TCs: N\\A", + "IP Address": "172.3.12.4 /24", + "Operational state": "Down", + "Width reduction mode": "Not supported" + }, + { + "Fec": "auto", + "Mac address": "24:8a:07:f5:54:0c", + "60 seconds ingress rate": "0 bits/sec, 0 bytes/sec, 0 packets/sec", + "Last clearing of \"show interface\" counters": "Never", + "Actual speed": "40 Gbps", + "MTU": "1500 bytes(Maximum packet size 1522 bytes)", + "header": "Eth1/6", + "Telemetry threshold": "Disabled\t TCs: N\\A", + "Telemetry threshold level": "N\\A", + "Flow-control": "receive off send off", + "Forwarding mode": "inherited cut-through", + "60 seconds egress rate": "0 bits/sec, 0 bytes/sec, 0 packets/sec", + "Last change in operational status": "Never", + "Boot delay time": "0 sec", + "Description": "N\\A", + "Admin state": "Enabled", + "Telemetry sampling": "Disabled\t TCs: N\\A", + "Operational state": "Down", + "Width reduction mode": "Not supported", + "Tx": { + "error packets": "0", + "packets": "0", + "bytes": "0", + "multicast packets": "0", + "unicast packets": "0", + "discard packets": "0", + "hoq discard packets": "0", + "broadcast packets": "0" + }, + "MAC learning mode": "Enabled", + "Switchport mode": "access", + "Rx": { + "error packets": "0", + "packets": "0", + "bytes": "0", + "multicast packets": "0", + "unicast packets": "0", + "discard packets": "0", + "broadcast packets": "0" + } + } +] diff --git a/test/units/modules/network/mlnxos/fixtures/mlnxos_l3_vlan_interface_show.cfg b/test/units/modules/network/mlnxos/fixtures/mlnxos_l3_vlan_interface_show.cfg new file mode 100644 index 0000000000..66a5509e21 --- /dev/null +++ b/test/units/modules/network/mlnxos/fixtures/mlnxos_l3_vlan_interface_show.cfg @@ -0,0 +1,18 @@ +[ + { + "Autostate": "Enabled", + "Icmp redirect": "Enabled", + "Broadcast address": "172.3.12.255", + "Description": "N/A", + "Mac Address": "7C:FE:90:E5:CA:01", + "Internet Address": "172.3.12.4/24", + "Admin state": "Enabled", + "header": "Vlan 1002", + "MTU": "1500 bytes", + "DHCP client": "Disabled", + "Operational state": "Down", + "VRF": "default", + "Arp timeout": "1500 seconds", + "Counters": "Disabled" + } +] diff --git a/test/units/modules/network/mlnxos/test_mlnxos_l3_interface.py b/test/units/modules/network/mlnxos/test_mlnxos_l3_interface.py new file mode 100644 index 0000000000..075830c4db --- /dev/null +++ b/test/units/modules/network/mlnxos/test_mlnxos_l3_interface.py @@ -0,0 +1,108 @@ +# +# Copyright: Ansible Project +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +# Make coding more python3-ish +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +from ansible.compat.tests.mock import patch +from ansible.modules.network.mlnxos import mlnxos_l3_interface +from units.modules.utils import set_module_args +from .mlnxos_module import TestMlnxosModule, load_fixture + + +class TestMlnxosL3InterfaceModule(TestMlnxosModule): + + module = mlnxos_l3_interface + + def setUp(self): + super(TestMlnxosL3InterfaceModule, self).setUp() + self.mock_get_config = patch.object( + mlnxos_l3_interface.MlnxosL3InterfaceModule, + "_get_interfaces_config") + self.get_config = self.mock_get_config.start() + + self.mock_load_config = patch( + 'ansible.module_utils.network.mlnxos.mlnxos.load_config') + self.load_config = self.mock_load_config.start() + + def tearDown(self): + super(TestMlnxosL3InterfaceModule, self).tearDown() + self.mock_get_config.stop() + self.mock_load_config.stop() + + def _execute_module(self, failed=False, changed=False, commands=None, sort=True): + if failed: + result = self.failed() + self.assertTrue(result['failed'], result) + else: + result = self.changed(changed) + self.assertEqual(result['changed'], changed, result) + + if commands is not None: + commands_res = result.get('commands') + if sort: + self.assertEqual(sorted(commands), sorted(commands_res), commands_res) + else: + self.assertEqual(commands, commands_res, commands_res) + + return result + + def load_fixture(self, config_file): + self.get_config.return_value = load_fixture(config_file) + self.load_config.return_value = None + + def load_eth_ifc_fixture(self): + config_file = 'mlnxos_l3_interface_show.cfg' + self.load_fixture(config_file) + + def load_vlan_ifc_fixture(self): + config_file = 'mlnxos_l3_vlan_interface_show.cfg' + self.load_fixture(config_file) + + def test_vlan_ifc_no_change(self): + set_module_args(dict(name='Vlan 1002', state='present', + ipv4='172.3.12.4/24')) + self.load_vlan_ifc_fixture() + self._execute_module(changed=False) + + def test_vlan_ifc_remove(self): + set_module_args(dict(name='Vlan 1002', state='absent')) + commands = ['interface vlan 1002 no ip address'] + self.load_vlan_ifc_fixture() + self._execute_module(changed=True, commands=commands) + + def test_vlan_ifc_update(self): + set_module_args(dict(name='Vlan 1002', state='present', + ipv4='172.3.13.4/24')) + commands = ['interface vlan 1002 ip address 172.3.13.4/24'] + self.load_vlan_ifc_fixture() + self._execute_module(changed=True, commands=commands) + + def test_eth_ifc_no_change(self): + set_module_args(dict(name='Eth1/5', state='present', + ipv4='172.3.12.4/24')) + self.load_eth_ifc_fixture() + self._execute_module(changed=False) + + def test_eth_ifc_remove(self): + set_module_args(dict(name='Eth1/5', state='absent')) + commands = ['interface ethernet 1/5 no ip address'] + self.load_eth_ifc_fixture() + self._execute_module(changed=True, commands=commands) + + def test_eth_ifc_update(self): + set_module_args(dict(name='Eth1/5', state='present', + ipv4='172.3.13.4/24')) + commands = ['interface ethernet 1/5 ip address 172.3.13.4/24'] + self.load_eth_ifc_fixture() + self._execute_module(changed=True, commands=commands) + + def test_eth_ifc_add_ip(self): + set_module_args(dict(name='Eth1/6', state='present', + ipv4='172.3.14.4/24')) + commands = ['interface ethernet 1/6 no switchport force', + 'interface ethernet 1/6 ip address 172.3.14.4/24'] + self.load_eth_ifc_fixture() + self._execute_module(changed=True, commands=commands)