diff --git a/lib/ansible/modules/network/slxos/slxos_l3_interface.py b/lib/ansible/modules/network/slxos/slxos_l3_interface.py new file mode 100644 index 00000000000..c787c5c34bf --- /dev/null +++ b/lib/ansible/modules/network/slxos/slxos_l3_interface.py @@ -0,0 +1,313 @@ +#!/usr/bin/python +# +# (c) 2018 Extreme Networks Inc. +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . +# +from __future__ import absolute_import, division, print_function +__metaclass__ = type + + +ANSIBLE_METADATA = {'metadata_version': '1.1', + 'status': ['preview'], + 'supported_by': 'network'} + +DOCUMENTATION = """ +--- +module: slxos_l3_interface +version_added: "2.6" +author: "Matthew Stone (@bigmstone)" +short_description: Manage L3 interfaces on Extreme Networks SLXOS network devices. +description: + - This module provides declarative management of L3 interfaces + on slxos network devices. +notes: + - Tested against slxos 15.2 +options: + name: + description: + - Name of the L3 interface to be configured eg. Ethernet 0/2 + ipv4: + description: + - IPv4 address to be set for the L3 interface mentioned in I(name) option. + The address format is /, the mask is number + in range 0-32 eg. 192.168.0.1/24 + ipv6: + description: + - IPv6 address to be set for the L3 interface mentioned in I(name) option. + The address format is /, the mask is number + in range 0-128 eg. fd5d:12c9:2201:1::1/64 + aggregate: + description: + - List of L3 interfaces definitions. Each of the entry in aggregate list should + define name of interface C(name) and a optional C(ipv4) or C(ipv6) address. + state: + description: + - State of the L3 interface configuration. It indicates if the configuration should + be present or absent on remote device. + default: present + choices: ['present', 'absent'] +""" + +EXAMPLES = """ +- name: Remove Ethernet 0/3 IPv4 and IPv6 address + slxos_l3_interface: + name: Ethernet 0/3 + state: absent + +- name: Set Ethernet 0/3 IPv4 address + slxos_l3_interface: + name: Ethernet 0/3 + ipv4: 192.168.0.1/24 + +- name: Set Ethernet 0/3 IPv6 address + slxos_l3_interface: + name: Ethernet 0/3 + ipv6: "fd5d:12c9:2201:1::1/64" + +- name: Set IP addresses on aggregate + slxos_l3_interface: + aggregate: + - { name: Ethernet 0/3, ipv4: 192.168.2.10/24 } + - { name: Ethernet 0/3, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" } + +- name: Remove IP addresses on aggregate + slxos_l3_interface: + aggregate: + - { name: Ethernet 0/3, ipv4: 192.168.2.10/24 } + - { name: Ethernet 0/3, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" } + 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 Ethernet 0/2 + - ip address 192.168.0.1/24 + - ipv6 address fd5d:12c9:2201:1::1/64 +""" +import re + +from copy import deepcopy + +from ansible.module_utils._text import to_text +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.six import iteritems +from ansible.module_utils.network.slxos.slxos import get_config, load_config +from ansible.module_utils.network.common.config import NetworkConfig +from ansible.module_utils.network.common.utils import conditional, remove_default_spec +from ansible.module_utils.network.common.utils import is_netmask, is_masklen, to_netmask, to_masklen + + +def validate_ipv4(value, module): + if value: + address = value.split('/') + if len(address) != 2: + module.fail_json(msg='address format is /, got invalid format %s' % value) + + if not is_masklen(address[1]): + module.fail_json(msg='invalid value for mask: %s, mask should be in range 0-32' % address[1]) + + +def validate_ipv6(value, module): + if value: + address = value.split('/') + if len(address) != 2: + module.fail_json(msg='address format is /, got invalid format %s' % value) + else: + if not 0 <= int(address[1]) <= 128: + module.fail_json(msg='invalid value for mask: %s, mask should be in range 0-128' % address[1]) + + +def validate_param_values(module, obj, param=None): + if param is None: + param = module.params + for key in obj: + # validate the param value (if validator func exists) + validator = globals().get('validate_%s' % key) + if callable(validator): + validator(param.get(key), module) + + +def parse_config_argument(configobj, name, arg=None): + cfg = configobj['interface %s' % name] + cfg = '\n'.join(cfg.children) + match = re.search(r'%s (.+)$' % arg, cfg, re.M) + if match: + return match.group(1).strip() + + return None + + +def search_obj_in_list(name, lst): + for o in lst: + if o['name'] == name: + return o + + return None + + +def map_obj_to_commands(updates, module): + commands = list() + want, have = updates + for w in want: + name = w['name'] + ipv4 = w['ipv4'] + ipv6 = w['ipv6'] + state = w['state'] + + interface = 'interface ' + name + commands.append(interface) + + obj_in_have = search_obj_in_list(name, have) + if state == 'absent' and obj_in_have: + if obj_in_have['ipv4']: + if ipv4: + commands.append('no ip address %s' % ipv4) + else: + commands.append('no ip address') + if obj_in_have['ipv6']: + if ipv6: + commands.append('no ipv6 address %s' % ipv6) + else: + commands.append('no ipv6 address') + + elif state == 'present': + if ipv4: + if obj_in_have is None or obj_in_have.get('ipv4') is None or ipv4 != obj_in_have['ipv4']: + commands.append('ip address %s' % ipv4) + + if ipv6: + if obj_in_have is None or obj_in_have.get('ipv6') is None or ipv6.lower() != obj_in_have['ipv6'].lower(): + commands.append('ipv6 address %s' % ipv6) + + if commands[-1] == interface: + commands.pop(-1) + + return commands + + +def map_config_to_obj(module): + config = get_config(module) + configobj = NetworkConfig(indent=1, contents=config) + + match = re.findall(r'^interface (\S+\s[0-9]+/[0-9]+)', config, re.M) + if not match: + return list() + + instances = list() + + for item in set(match): + ipv4 = parse_config_argument(configobj, item, 'ip address') + if ipv4: + # eg. 192.168.2.10 255.255.255.0 -> 192.168.2.10/24 + address = ipv4.strip().split(' ') + if len(address) == 2 and is_netmask(address[1]): + ipv4 = '%s/%s' % (address[0], to_text(to_masklen(address[1]))) + + obj = { + 'name': item, + 'ipv4': ipv4, + 'ipv6': parse_config_argument(configobj, item, 'ipv6 address'), + 'state': 'present' + } + instances.append(obj) + + return instances + + +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] + + validate_param_values(module, item, item) + obj.append(item.copy()) + else: + obj.append({ + 'name': module.params['name'], + 'ipv4': module.params['ipv4'], + 'ipv6': module.params['ipv6'], + 'state': module.params['state'] + }) + + validate_param_values(module, obj) + + return obj + + +def main(): + """ main entry point for module execution + """ + element_spec = dict( + name=dict(), + ipv4=dict(), + ipv6=dict(), + state=dict(default='present', + choices=['present', 'absent']) + ) + + 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) + + argument_spec = dict( + aggregate=dict(type='list', elements='dict', options=aggregate_spec), + ) + + argument_spec.update(element_spec) + + required_one_of = [['name', 'aggregate']] + mutually_exclusive = [['name', 'aggregate']] + module = AnsibleModule(argument_spec=argument_spec, + required_one_of=required_one_of, + mutually_exclusive=mutually_exclusive, + supports_check_mode=True) + + warnings = list() + + result = {'changed': False} + + if warnings: + result['warnings'] = warnings + + want = map_params_to_obj(module) + have = map_config_to_obj(module) + + commands = map_obj_to_commands((want, have), module) + result['commands'] = commands + + if commands: + if not module.check_mode: + load_config(module, commands) + + result['changed'] = True + + module.exit_json(**result) + + +if __name__ == '__main__': + main() diff --git a/test/units/modules/network/slxos/fixtures/slxos_config_config.cfg b/test/units/modules/network/slxos/fixtures/slxos_config_config.cfg index 824235d3dad..8d2e3637c02 100644 --- a/test/units/modules/network/slxos/fixtures/slxos_config_config.cfg +++ b/test/units/modules/network/slxos/fixtures/slxos_config_config.cfg @@ -20,3 +20,8 @@ interface Ethernet 0/11 ! interface Port-channel 20 ! +interface Ethernet 0/9 + ip address 172.16.128.99 255.255.255.0 + ipv6 address dead::beaf/64 + description Bleh +! diff --git a/test/units/modules/network/slxos/test_slxos_l3_interface.py b/test/units/modules/network/slxos/test_slxos_l3_interface.py new file mode 100644 index 00000000000..a219dbebc13 --- /dev/null +++ b/test/units/modules/network/slxos/test_slxos_l3_interface.py @@ -0,0 +1,103 @@ +# +# (c) 2018 Extreme Networks Inc. +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . +# +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import re +import json + +from ansible.compat.tests.mock import patch +from ansible.modules.network.slxos import slxos_l3_interface +from units.modules.utils import set_module_args +from .slxos_module import TestSlxosModule, load_fixture + + +class TestSlxosL3InterfaceModule(TestSlxosModule): + module = slxos_l3_interface + + def setUp(self): + super(TestSlxosL3InterfaceModule, self).setUp() + self._patch_get_config = patch( + 'ansible.modules.network.slxos.slxos_l3_interface.get_config' + ) + self._patch_load_config = patch( + 'ansible.modules.network.slxos.slxos_l3_interface.load_config' + ) + + self._get_config = self._patch_get_config.start() + self._load_config = self._patch_load_config.start() + + def tearDown(self): + super(TestSlxosL3InterfaceModule, self).tearDown() + self._patch_get_config.stop() + self._patch_load_config.stop() + + def load_fixtures(self, commands=None): + config_file = 'slxos_config_config.cfg' + self._get_config.return_value = load_fixture(config_file) + self._load_config.return_value = None + + def test_slxos_l3_interface_ipv4_address(self, *args, **kwargs): + set_module_args(dict( + name='Ethernet 0/2', + ipv4='192.168.4.1/24' + )) + result = self.execute_module(changed=True) + self.assertEqual( + result, + { + 'commands': [ + 'interface Ethernet 0/2', + 'ip address 192.168.4.1/24' + ], + 'changed': True + } + ) + + def test_slxos_l3_interface_absent(self, *args, **kwargs): + set_module_args(dict( + name='Ethernet 0/9', + state='absent' + )) + result = self.execute_module(changed=True) + self.assertEqual( + result, + { + 'commands': [ + 'interface Ethernet 0/9', + 'no ip address', + 'no ipv6 address' + ], + 'changed': True + } + ) + + def test_slxos_l3_interface_invalid_argument(self, *args, **kwargs): + set_module_args(dict( + name='Ethernet 0/1', + shawshank='Redemption' + )) + result = self.execute_module(failed=True) + self.assertEqual(result['failed'], True) + self.assertTrue(re.match( + r'Unsupported parameters for \((basic.py|basic.pyc)\) module: ' + 'shawshank Supported parameters include: aggregate, ipv4, ipv6, ' + 'name, state', + result['msg'] + ))