diff --git a/lib/ansible/modules/network/netvisor/pn_vrouter_loopback_interface.py b/lib/ansible/modules/network/netvisor/pn_vrouter_loopback_interface.py new file mode 100644 index 0000000000..bd2066ef54 --- /dev/null +++ b/lib/ansible/modules/network/netvisor/pn_vrouter_loopback_interface.py @@ -0,0 +1,227 @@ +#!/usr/bin/python +# Copyright: (c) 2018, Pluribus Networks +# 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: pn_vrouter_loopback_interface +author: "Pluribus Networks (@rajaspachipulusu17)" +version_added: "2.9" +short_description: CLI command to add/remove vrouter-loopback-interface +description: + - This module can be used to add loopback interface to a vRouter or + remove loopback interface from a vRouter. +options: + pn_cliswitch: + description: + - Target switch to run the CLI on. + required: false + type: str + state: + description: + - State the action to perform. Use C(present) to add vrouter-loopback-interface + and C(absent) to remove vrouter-loopback-interface. + required: false + type: str + choices: ['present', 'absent'] + default: 'present' + pn_ip: + description: + - loopback IP address. + required: true + type: str + pn_index: + description: + - loopback index from 1 to 255. + required: false + type: str + pn_vrouter_name: + description: + - name of service config. + required: true + type: str +""" + +EXAMPLES = """ +- name: Add vrouter loopback interface + pn_vrouter_loopback_interface: + state: "present" + pn_cliswitch: "sw01" + pn_vrouter_name: "sw01-vrouter" + pn_ip: "192.168.10.1" + +- name: Remove vrouter loopback interface + pn_vrouter_loopback_interface: + state: "absent" + pn_cliswitch: "sw01" + pn_vrouter_name: "sw01-vrouter" + pn_ip: "192.168.10.1" + pn_index: "2" +""" + +RETURN = """ +command: + description: the CLI command run on the target node. + returned: always + type: str +stdout: + description: set of responses from the vrouter-loopback-interface command. + returned: always + type: list +stderr: + description: set of error response from the vrouter-loopback-interface + command. + returned: on error + type: list +changed: + description: indicates whether the CLI caused changes on the target. + returned: always + type: bool +""" + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.network.netvisor.pn_nvos import pn_cli, run_cli +from ansible.module_utils.network.netvisor.netvisor import run_commands + + +def check_cli(module, cli): + """ + This method checks if vRouter exists on the target node. + This method also checks for idempotency using the vrouter-interface-show + command. + If the given vRouter exists, return VROUTER_EXISTS as True else False. + + :param module: The Ansible module to fetch input parameters + :param cli: The CLI string + :return Booleans: VROUTER_EXISTS, INTERFACE_EXISTS + """ + vrouter_name = module.params['pn_vrouter_name'] + interface_ip = module.params['pn_ip'] + + # Check for vRouter + check_vrouter = 'vrouter-show format name no-show-headers' + out = run_commands(module, check_vrouter)[1] + if out: + out = out.split() + + VROUTER_EXISTS = True if vrouter_name in out else False + + if interface_ip: + # Check for interface and VRRP and fetch nic for VRRP + show = cli + ' vrouter-loopback-interface-show ' + show += 'vrouter-name %s ' % vrouter_name + show += 'format ip no-show-headers' + out = run_commands(module, show)[1] + + if out and interface_ip in out.split(): + INTERFACE_EXISTS = True + else: + INTERFACE_EXISTS = False + + return VROUTER_EXISTS, INTERFACE_EXISTS + + +def main(): + """ This section is for arguments parsing """ + + state_map = dict( + present='vrouter-loopback-interface-add', + absent='vrouter-loopback-interface-remove' + ) + + argument_spec = dict( + pn_cliswitch=dict(required=False, type='str'), + state=dict(required=False, type='str', + choices=state_map.keys(), default='present'), + pn_ip=dict(required=True, type='str'), + pn_index=dict(required=False, type='str'), + pn_vrouter_name=dict(required=True, type='str'), + ) + + module = AnsibleModule( + argument_spec=argument_spec, + required_if=( + ["state", "present", ["pn_vrouter_name", "pn_ip"]], + ["state", "absent", ["pn_vrouter_name", "pn_ip", "pn_index"]] + ), + ) + + # Accessing the arguments + cliswitch = module.params['pn_cliswitch'] + state = module.params['state'] + ip = module.params['pn_ip'] + index = module.params['pn_index'] + vrouter_name = module.params['pn_vrouter_name'] + + command = state_map[state] + + # Building the CLI command string + cli = pn_cli(module, cliswitch) + + VROUTER_EXISTS, INTERFACE_EXISTS = check_cli(module, cli) + cli += ' %s vrouter-name %s ' % (command, vrouter_name) + + if index and (int(index) < 1 or int(index) > 255): + module.fail_json( + failed=True, + msg='index should be in range 1 to 255' + ) + + if index and state == 'present': + show = 'vrouter-loopback-interface-show format index parsable-delim ,' + out = run_commands(module, show)[1] + if out: + out = out.split() + for res in out: + res = res.strip().split(',') + if index in res: + module.fail_json( + failed=True, + msg='index with value %s exist' % index + ) + + if command == 'vrouter-loopback-interface-add': + if VROUTER_EXISTS is False: + module.fail_json( + failed=True, + msg='vRouter %s does not exist' % vrouter_name + ) + if INTERFACE_EXISTS is True: + module.exit_json( + skipped=True, + msg='vRouter with loopback ip %s exist' % ip + ) + if ip: + cli += ' ip ' + ip + if index: + cli += ' index ' + index + + if command == 'vrouter-loopback-interface-remove': + if VROUTER_EXISTS is False: + module.fail_json( + failed=True, + msg='vRouter %s does not exist' % vrouter_name + ) + if INTERFACE_EXISTS is False: + module.exit_json( + skipped=True, + msg='vRouter with loopback ip %s doesnt exist' % ip + ) + + if index: + cli += ' index ' + index + + run_cli(module, cli, state_map) + + +if __name__ == '__main__': + main() diff --git a/test/units/modules/network/netvisor/test_pn_vrouter_loopback_interface.py b/test/units/modules/network/netvisor/test_pn_vrouter_loopback_interface.py new file mode 100644 index 0000000000..fb557ee433 --- /dev/null +++ b/test/units/modules/network/netvisor/test_pn_vrouter_loopback_interface.py @@ -0,0 +1,62 @@ +# Copyright: (c) 2018, Pluribus Networks +# 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 + +import json + +from units.compat.mock import patch +from ansible.modules.network.netvisor import pn_vrouter_loopback_interface +from units.modules.utils import set_module_args +from .nvos_module import TestNvosModule, load_fixture + + +class TestVrouterLoopbackInterfaceModule(TestNvosModule): + + module = pn_vrouter_loopback_interface + + def setUp(self): + self.mock_run_nvos_commands = patch('ansible.modules.network.netvisor.pn_vrouter_loopback_interface.run_cli') + self.run_nvos_commands = self.mock_run_nvos_commands.start() + + self.mock_run_check_cli = patch('ansible.modules.network.netvisor.pn_vrouter_loopback_interface.check_cli') + self.run_check_cli = self.mock_run_check_cli.start() + + def tearDown(self): + self.mock_run_nvos_commands.stop() + self.mock_run_check_cli.stop() + + def run_cli_patch(self, module, cli, state_map): + if state_map['present'] == 'vrouter-loopback-interface-add': + results = dict( + changed=True, + cli_cmd=cli + ) + elif state_map['absent'] == 'vrouter-loopback-remove': + results = dict( + changed=True, + cli_cmd=cli + ) + module.exit_json(**results) + + def load_fixtures(self, commands=None, state=None, transport='cli'): + self.run_nvos_commands.side_effect = self.run_cli_patch + if state == 'present': + self.run_check_cli.return_value = True, False + if state == 'absent': + self.run_check_cli.return_value = True, True + + def test_vrouter_loopback_interface_add(self): + set_module_args({'pn_cliswitch': 'sw01', 'pn_vrouter_name': 'foo-vrouter', + 'pn_ip': '192.168.10.1', 'state': 'present'}) + result = self.execute_module(changed=True, state='present') + expected_cmd = ' switch sw01 vrouter-loopback-interface-add vrouter-name foo-vrouter ip 192.168.10.1' + self.assertEqual(result['cli_cmd'], expected_cmd) + + def test_vrouter_loopback_interface_remove(self): + set_module_args({'pn_cliswitch': 'sw01', 'pn_vrouter_name': 'foo-vrouter', + 'pn_ip': '192.168.10.1', 'pn_index': '1', 'state': 'absent'}) + result = self.execute_module(changed=True, state='absent') + expected_cmd = ' switch sw01 vrouter-loopback-interface-remove vrouter-name foo-vrouter index 1' + self.assertEqual(result['cli_cmd'], expected_cmd)