diff --git a/network/nxos/nxos_pim_rp_address.py b/network/nxos/nxos_pim_rp_address.py new file mode 100644 index 00000000000..bdb3c46fdb7 --- /dev/null +++ b/network/nxos/nxos_pim_rp_address.py @@ -0,0 +1,412 @@ +#!/usr/bin/python +# +# 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 . +# + +DOCUMENTATION = ''' +--- +module: nxos_pim_rp_address +version_added: "2.2" +short_description: Manages configuration of an PIM static RP address instance. +description: + - Manages configuration of an Protocol Independent Multicast (PIM) static + rendezvous point (RP) address instance. +author: Gabriele Gerbino (@GGabriele) +extends_documentation_fragment: nxos +notes: + - C(state=absent) remove the whole rp-address configuration, if existing. +options: + rp_address: + description: + - Configures a Protocol Independent Multicast (PIM) static + rendezvous point (RP) address. Valid values are + unicast addresses. + required: true + group_list: + description: + - Group range for static RP. Valid values are multicast addresses. + required: false + default: null + prefix_list: + description: + - Prefix list policy for static RP. Valid values are prefix-list + policy names. + required: false + default: null + route_map: + description: + - Route map policy for static RP. Valid values are route-map + policy names. + required: false + default: null + bidir: + description: + - Group range is treated in PIM bidirectional mode. + required: false + choices: ['true','false'] + default: null +''' +EXAMPLES = ''' +- nxos_pim_rp_address: + rp_address: "10.1.1.20" + state: present + username: "{{ un }}" + password: "{{ pwd }}" + host: "{{ inventory_hostname }}" +''' + +RETURN = ''' +proposed: + description: k/v pairs of parameters passed into module + returned: verbose mode + type: dict + sample: {"rp_address": "10.1.1.21"} +existing: + description: list of existing pim rp-address configuration entries + returned: verbose mode + type: list + sample: [] +end_state: + description: pim rp-address configuration entries after module execution + returned: verbose mode + type: list + sample: [{"bidir": false, "group_list": "224.0.0.0/4", + "rp_address": "10.1.1.21"}] +updates: + description: commands sent to the device + returned: always + type: list + sample: ["router bgp 65535", "vrf test", "router-id 1.1.1.1"] +changed: + description: check to see if a change was made on the device + returned: always + type: boolean + sample: true +''' + + + +# COMMON CODE FOR MIGRATION +import re + +from ansible.module_utils.basic import get_exception +from ansible.module_utils.netcfg import NetworkConfig, ConfigLine +from ansible.module_utils.shell import ShellError + +try: + from ansible.module_utils.nxos import get_module +except ImportError: + from ansible.module_utils.nxos import NetworkModule + + +def to_list(val): + if isinstance(val, (list, tuple)): + return list(val) + elif val is not None: + return [val] + else: + return list() + + +class CustomNetworkConfig(NetworkConfig): + + def expand_section(self, configobj, S=None): + if S is None: + S = list() + S.append(configobj) + for child in configobj.children: + if child in S: + continue + self.expand_section(child, S) + return S + + def get_object(self, path): + for item in self.items: + if item.text == path[-1]: + parents = [p.text for p in item.parents] + if parents == path[:-1]: + return item + + def to_block(self, section): + return '\n'.join([item.raw for item in section]) + + def get_section(self, path): + try: + section = self.get_section_objects(path) + return self.to_block(section) + except ValueError: + return list() + + def get_section_objects(self, path): + if not isinstance(path, list): + path = [path] + obj = self.get_object(path) + if not obj: + raise ValueError('path does not exist in config') + return self.expand_section(obj) + + + def add(self, lines, parents=None): + """Adds one or lines of configuration + """ + + ancestors = list() + offset = 0 + obj = None + + ## global config command + if not parents: + for line in to_list(lines): + item = ConfigLine(line) + item.raw = line + if item not in self.items: + self.items.append(item) + + else: + for index, p in enumerate(parents): + try: + i = index + 1 + obj = self.get_section_objects(parents[:i])[0] + ancestors.append(obj) + + except ValueError: + # add parent to config + offset = index * self.indent + obj = ConfigLine(p) + obj.raw = p.rjust(len(p) + offset) + if ancestors: + obj.parents = list(ancestors) + ancestors[-1].children.append(obj) + self.items.append(obj) + ancestors.append(obj) + + # add child objects + for line in to_list(lines): + # check if child already exists + for child in ancestors[-1].children: + if child.text == line: + break + else: + offset = len(parents) * self.indent + item = ConfigLine(line) + item.raw = line.rjust(len(line) + offset) + item.parents = ancestors + ancestors[-1].children.append(item) + self.items.append(item) + + +def get_network_module(**kwargs): + try: + return get_module(**kwargs) + except NameError: + return NetworkModule(**kwargs) + +def get_config(module, include_defaults=False): + config = module.params['config'] + if not config: + try: + config = module.get_config() + except AttributeError: + defaults = module.params['include_defaults'] + config = module.config.get_config(include_defaults=defaults) + return CustomNetworkConfig(indent=2, contents=config) + +def load_config(module, candidate): + config = get_config(module) + + commands = candidate.difference(config) + commands = [str(c).strip() for c in commands] + + save_config = module.params['save'] + + result = dict(changed=False) + + if commands: + if not module.check_mode: + try: + module.configure(commands) + except AttributeError: + module.config(commands) + + if save_config: + try: + module.config.save_config() + except AttributeError: + module.execute(['copy running-config startup-config']) + + result['changed'] = True + result['updates'] = commands + + return result +# END OF COMMON CODE + +BOOL_PARAMS = ['bidir'] +PARAM_TO_COMMAND_KEYMAP = { + 'rp_address': 'ip pim rp-address' +} +PARAM_TO_DEFAULT_KEYMAP = {} +WARNINGS = [] + +def invoke(name, *args, **kwargs): + func = globals().get(name) + if func: + return func(*args, **kwargs) + + +def get_value(config, module): + value_list = [] + splitted_config = config.splitlines() + for line in splitted_config: + tmp = {} + if 'ip pim rp-address' in line: + splitted_line = line.split() + tmp['rp_address'] = splitted_line[3] + if len(splitted_line) > 5: + value = splitted_line[5] + if splitted_line[4] == 'route-map': + tmp['route_map'] = value + elif splitted_line[4] == 'prefix-list': + tmp['prefix_list'] = value + elif splitted_line[4] == 'group-list': + tmp['group_list'] = value + if 'bidir' in line: + tmp['bidir'] = True + else: + tmp['bidir'] = False + value_list.append(tmp) + return value_list + + +def get_existing(module, args): + existing = {} + config = str(get_config(module)) + existing = get_value(config, module) + return existing + + +def apply_key_map(key_map, table): + new_dict = {} + for key, value in table.items(): + new_key = key_map.get(key) + if new_key: + value = table.get(key) + if value: + new_dict[new_key] = value + else: + new_dict[new_key] = value + return new_dict + + +def state_present(module, existing, proposed, candidate): + command = 'ip pim rp-address {0}'.format(module.params['rp_address']) + commands = build_command(proposed, command) + if commands: + candidate.add(commands, parents=[]) + + +def build_command(param_dict, command): + for param in ['group_list', 'prefix_list', 'route_map']: + if param_dict.get(param): + command += ' {0} {1}'.format( + param.replace('_', '-'), param_dict.get(param)) + if param_dict.get('bidir'): + command += ' bidir' + return [command] + + +def state_absent(module, existing, proposed, candidate): + commands = list() + for each in existing: + if each.get('rp_address') == proposed['rp_address']: + command = 'no ip pim rp-address {0}'.format(proposed['rp_address']) + if each.get('group_list'): + commands = build_command(each, command) + else: + commands = [command] + if commands: + candidate.add(commands, parents=[]) + + +def main(): + argument_spec = dict( + rp_address=dict(required=True, type='str'), + group_list=dict(required=False, type='str'), + prefix_list=dict(required=False, type='str'), + route_map=dict(required=False, type='str'), + bidir=dict(required=False, type='bool'), + state=dict(choices=['present', 'absent'], default='present', + required=False), + include_defaults=dict(default=False), + config=dict(), + save=dict(type='bool', default=False) + ) + module = get_network_module(argument_spec=argument_spec, + mutually_exclusive=[['group_list', 'route_map'], + ['group_list', 'prefix_list'], + ['route_map', 'prefix_list']], + supports_check_mode=True) + + state = module.params['state'] + + args = [ + 'rp_address', + 'group_list', + 'prefix_list', + 'route_map', + 'bidir' + ] + + existing = invoke('get_existing', module, args) + end_state = existing + proposed_args = dict((k, v) for k, v in module.params.iteritems() + if v is not None and k in args) + + proposed = {} + for key, value in proposed_args.iteritems(): + if str(value).lower() == 'true': + value = True + elif str(value).lower() == 'false': + value = False + for each in existing: + if each.get(key) or (not each.get(key) and value): + proposed[key] = value + + result = {} + candidate = CustomNetworkConfig(indent=3) + invoke('state_%s' % state, module, existing, proposed, candidate) + + try: + response = load_config(module, candidate) + result.update(response) + except ShellError: + exc = get_exception() + module.fail_json(msg=str(exc)) + + result['connected'] = module.connected + if module._verbosity > 0: + end_state = invoke('get_existing', module, args) + result['end_state'] = end_state + result['existing'] = existing + result['proposed'] = proposed_args + + if WARNINGS: + result['warnings'] = WARNINGS + + module.exit_json(**result) + + +if __name__ == '__main__': + main()