#!/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_igmp_interface version_added: "2.2" short_description: Manages IGMP interface configuration. description: - Manages IGMP interface configuration settings. extends_documentation_fragment: nxos author: - Jason Edelman (@jedelman8) - Gabriele Gerbino (@GGabriele) notes: - When C(state=default), supported params will be reset to a default state. These include C(version), C(startup_query_interval), C(startup_query_count), C(robustness), C(querier_timeout), C(query_mrt), C(query_interval), C(last_member_qrt), C(last_member_query_count), C(group_timeout), C(report_llg), and C(immediate_leave). - When C(state=absent), all configs for C(oif_prefix), C(oif_source), and C(oif_routemap) will be removed. - PIM must be enabled to use this module. - This module is for Layer 3 interfaces. - Route-map check not performed (same as CLI) check when configuring route-map with 'static-oif' - If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place. options: interface: description: - The full interface name for IGMP configuration. e.g. I(Ethernet1/2). required: true version: description: - IGMP version. It can be 2 or 3. required: false default: null choices: ['2', '3'] startup_query_interval: description: - Query interval used when the IGMP process starts up. The range is from 1 to 18000. The default is 31. required: false default: null startup_query_count: description: - Query count used when the IGMP process starts up. The range is from 1 to 10. The default is 2. required: false default: null robustness: description: - Sets the robustness variable. Values can range from 1 to 7. The default is 2. required: false default: null querier_timeout: description: - Sets the querier timeout that the software uses when deciding to take over as the querier. Values can range from 1 to 65535 seconds. The default is 255 seconds. required: false default: null query_mrt: description: - Sets the response time advertised in IGMP queries. Values can range from 1 to 25 seconds. The default is 10 seconds. required: false default: null query_interval: description: - Sets the frequency at which the software sends IGMP host query messages. Values can range from 1 to 18000 seconds. he default is 125 seconds. required: false default: null last_member_qrt: description: - Sets the query interval waited after sending membership reports before the software deletes the group state. Values can range from 1 to 25 seconds. The default is 1 second. required: false default: null last_member_query_count: description: - Sets the number of times that the software sends an IGMP query in response to a host leave message. Values can range from 1 to 5. The default is 2. required: false default: null group_timeout: description: - Sets the group membership timeout for IGMPv2. Values can range from 3 to 65,535 seconds. The default is 260 seconds. required: false default: null report_llg: description: - Configures report-link-local-groups. Enables sending reports for groups in 224.0.0.0/24. Reports are always sent for nonlink local groups. By default, reports are not sent for link local groups. required: false choices: ['true', 'false'] default: false immediate_leave: description: - Enables the device to remove the group entry from the multicast routing table immediately upon receiving a leave message for the group. Use this command to minimize the leave latency of IGMPv2 group memberships on a given IGMP interface because the device does not send group-specific queries. The default is disabled. required: false choices: ['true', 'false'] default: false oif_routemap: description: - Configure a routemap for static outgoing interface (OIF). required: false default: null oif_prefix: description: - Configure a prefix for static outgoing interface (OIF). required: false default: null oif_source: description: - Configure a source for static outgoing interface (OIF). required: false default: null restart: description: - Restart IGMP. required: false choices: ['true', 'false'] default: null state: description: - Manages desired state of the resource. required: false default: present choices: ['present', 'default'] ''' EXAMPLES = ''' - nxos_igmp_interface: interface: ethernet1/32 startup_query_interval: 30 state: present username: "{{ un }}" password: "{{ pwd }}" host: "{{ inventory_hostname }}" ''' RETURN = ''' proposed: description: k/v pairs of parameters passed into module returned: always type: dict sample: {"asn": "65535", "router_id": "1.1.1.1", "vrf": "test"} existing: description: k/v pairs of existing BGP configuration type: dict sample: {"asn": "65535", "bestpath_always_compare_med": false, "bestpath_aspath_multipath_relax": false, "bestpath_compare_neighborid": false, "bestpath_compare_routerid": false, "bestpath_cost_community_ignore": false, "bestpath_med_confed": false, "bestpath_med_missing_as_worst": false, "bestpath_med_non_deterministic": false, "cluster_id": "", "confederation_id": "", "confederation_peers": "", "graceful_restart": true, "graceful_restart_helper": false, "graceful_restart_timers_restart": "120", "graceful_restart_timers_stalepath_time": "300", "local_as": "", "log_neighbor_changes": false, "maxas_limit": "", "neighbor_down_fib_accelerate": false, "reconnect_interval": "60", "router_id": "11.11.11.11", "suppress_fib_pending": false, "timer_bestpath_limit": "", "timer_bgp_hold": "180", "timer_bgp_keepalive": "60", "vrf": "test"} end_state: description: k/v pairs of BGP configuration after module execution returned: always type: dict sample: {"asn": "65535", "bestpath_always_compare_med": false, "bestpath_aspath_multipath_relax": false, "bestpath_compare_neighborid": false, "bestpath_compare_routerid": false, "bestpath_cost_community_ignore": false, "bestpath_med_confed": false, "bestpath_med_missing_as_worst": false, "bestpath_med_non_deterministic": false, "cluster_id": "", "confederation_id": "", "confederation_peers": "", "graceful_restart": true, "graceful_restart_helper": false, "graceful_restart_timers_restart": "120", "graceful_restart_timers_stalepath_time": "300", "local_as": "", "log_neighbor_changes": false, "maxas_limit": "", "neighbor_down_fib_accelerate": false, "reconnect_interval": "60", "router_id": "1.1.1.1", "suppress_fib_pending": false, "timer_bestpath_limit": "", "timer_bgp_hold": "180", "timer_bgp_keepalive": "60", "vrf": "test"} 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 ''' import json import collections # 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 def get_cli_body_ssh(command, response, module): """Get response for when transport=cli. This is kind of a hack and mainly needed because these modules were originally written for NX-API. And not every command supports "| json" when using cli/ssh. As such, we assume if | json returns an XML string, it is a valid command, but that the resource doesn't exist yet. Instead, the output will be a raw string when issuing commands containing 'show run'. """ if 'xml' in response[0]: body = [] elif 'show run' in command: body = response else: try: response = response[0].replace(command + '\n\n', '').strip() body = [json.loads(response)] except ValueError: module.fail_json(msg='Command does not support JSON output', command=command) return body def execute_show(cmds, module, command_type=None): command_type_map = { 'cli_show': 'json', 'cli_show_ascii': 'text' } try: if command_type: response = module.execute(cmds, command_type=command_type) else: response = module.execute(cmds) except ShellError: clie = get_exception() module.fail_json(msg='Error sending {0}'.format(cmds), error=str(clie)) except AttributeError: try: if command_type: command_type = command_type_map.get(command_type) module.cli.add_commands(cmds, output=command_type) response = module.cli.run_commands() else: module.cli.add_commands(cmds, output=command_type) response = module.cli.run_commands() except ShellError: clie = get_exception() module.fail_json(msg='Error sending {0}'.format(cmds), error=str(clie)) return response def execute_show_command(command, module, command_type='cli_show'): if module.params['transport'] == 'cli': command += ' | json' cmds = [command] response = execute_show(cmds, module) body = get_cli_body_ssh(command, response, module) elif module.params['transport'] == 'nxapi': cmds = [command] body = execute_show(cmds, module, command_type=command_type) return body def get_interface_mode(interface, intf_type, module): command = 'show interface {0}'.format(interface) interface = {} mode = 'unknown' if intf_type in ['ethernet', 'portchannel']: body = execute_show_command(command, module)[0] interface_table = body['TABLE_interface']['ROW_interface'] mode = str(interface_table.get('eth_mode', 'layer3')) if mode == 'access' or mode == 'trunk': mode = 'layer2' elif intf_type == 'loopback' or intf_type == 'svi': mode = 'layer3' return mode def get_interface_type(interface): if interface.upper().startswith('ET'): return 'ethernet' elif interface.upper().startswith('VL'): return 'svi' elif interface.upper().startswith('LO'): return 'loopback' elif interface.upper().startswith('MG'): return 'management' elif interface.upper().startswith('MA'): return 'management' elif interface.upper().startswith('PO'): return 'portchannel' else: return 'unknown' 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 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 get_igmp_interface(module, interface): command = 'show ip igmp interface {0}'.format(interface) igmp = {} key_map = { 'IGMPVersion': 'version', 'ConfiguredStartupQueryInterval': 'startup_query_interval', 'StartupQueryCount': 'startup_query_count', 'RobustnessVariable': 'robustness', 'QuerierTimeout': 'querier_timeout', 'ConfiguredMaxResponseTime': 'query_mrt', 'ConfiguredQueryInterval': 'query_interval', 'LastMemberMTR': 'last_member_qrt', 'LastMemberQueryCount': 'last_member_query_count', 'ConfiguredGroupTimeout': 'group_timeout' } body = execute_show_command(command, module)[0] if body: resource = body['TABLE_vrf']['ROW_vrf']['TABLE_if']['ROW_if'] igmp = apply_key_map(key_map, resource) report_llg = str(resource['ReportingForLinkLocal']) if report_llg == 'true': igmp['report_llg'] = True elif report_llg == 'false': igmp['report_llg'] = False immediate_leave = str(resource['ImmediateLeave']) # returns en or dis if immediate_leave == 'en': igmp['immediate_leave'] = True elif immediate_leave == 'dis': igmp['immediate_leave'] = False # the next block of code is used to retrieve anything with: # ip igmp static-oif *** i.e.. could be route-map ROUTEMAP # or PREFIX source , etc. command = 'show run interface {0} | inc oif'.format(interface) body = execute_show_command( command, module, command_type='cli_show_ascii')[0] staticoif = [] if body: split_body = body.split('\n') route_map_regex = ('.*ip igmp static-oif route-map\s+' '(?P\S+).*') prefix_source_regex = ('.*ip igmp static-oif\s+(?P' '((\d+.){3}\d+))(\ssource\s' '(?P\S+))?.*') for line in split_body: temp = {} try: match_route_map = re.match(route_map_regex, line, re.DOTALL) route_map = match_route_map.groupdict()['route_map'] except AttributeError: route_map = '' try: match_prefix_source = re.match( prefix_source_regex, line, re.DOTALL) prefix_source_group = match_prefix_source.groupdict() prefix = prefix_source_group['prefix'] source = prefix_source_group['source'] except AttributeError: prefix = '' source = '' if route_map: temp['route_map'] = route_map if prefix: temp['prefix'] = prefix if source: temp['source'] = source if temp: staticoif.append(temp) igmp['oif_routemap'] = None igmp['oif_prefix_source'] = [] if staticoif: if len(staticoif) == 1 and staticoif[0].get('route_map'): igmp['oif_routemap'] = staticoif[0]['route_map'] else: igmp['oif_prefix_source'] = staticoif return igmp def config_igmp_interface(delta, found_both, found_prefix): CMDS = { 'version': 'ip igmp version {0}', 'startup_query_interval': 'ip igmp startup-query-interval {0}', 'startup_query_count': 'ip igmp startup-query-count {0}', 'robustness': 'ip igmp robustness-variable {0}', 'querier_timeout': 'ip igmp querier-timeout {0}', 'query_mrt': 'ip igmp query-max-response-time {0}', 'query_interval': 'ip igmp query-interval {0}', 'last_member_qrt': 'ip igmp last-member-query-response-time {0}', 'last_member_query_count': 'ip igmp last-member-query-count {0}', 'group_timeout': 'ip igmp group-timeout {0}', 'report_llg': 'ip igmp report-link-local-groups', 'immediate_leave': 'ip igmp immediate-leave', 'oif_prefix_source': 'ip igmp static-oif {0} source {1} ', 'oif_routemap': 'ip igmp static-oif route-map {0}', 'oif_prefix': 'ip igmp static-oif {0}', } commands = [] command = None for key, value in delta.iteritems(): if key == 'oif_source' or found_both or found_prefix: pass elif key == 'oif_prefix': if delta.get('oif_source'): command = CMDS.get('oif_prefix_source').format( delta.get('oif_prefix'), delta.get('oif_source')) else: command = CMDS.get('oif_prefix').format( delta.get('oif_prefix')) elif value: command = CMDS.get(key).format(value) elif not value: command = 'no {0}'.format(CMDS.get(key).format(value)) if command: if command not in commands: commands.append(command) command = None return commands def get_igmp_interface_defaults(): version = '2' startup_query_interval = '31' startup_query_count = '2' robustness = '2' querier_timeout = '255' query_mrt = '10' query_interval = '125' last_member_qrt = '1' last_member_query_count = '2' group_timeout = '260' report_llg = False immediate_leave = False args = dict(version=version, startup_query_interval=startup_query_interval, startup_query_count=startup_query_count, robustness=robustness, querier_timeout=querier_timeout, query_mrt=query_mrt, query_interval=query_interval, last_member_qrt=last_member_qrt, last_member_query_count=last_member_query_count, group_timeout=group_timeout, report_llg=report_llg, immediate_leave=immediate_leave) default = dict((param, value) for (param, value) in args.iteritems() if value is not None) return default def config_default_igmp_interface(existing, delta, found_both, found_prefix): commands = [] proposed = get_igmp_interface_defaults() delta = dict(set(proposed.iteritems()).difference(existing.iteritems())) if delta: command = config_igmp_interface(delta, found_both, found_prefix) if command: for each in command: commands.append(each) return commands def config_remove_oif(existing, existing_oif_prefix_source): commands = [] command = None if existing.get('routemap'): command = 'no ip igmp static-oif route-map {0}'.format( existing.get('routemap')) if existing_oif_prefix_source: for each in existing_oif_prefix_source: if each.get('prefix') and each.get('source'): command = 'no ip igmp static-oif {0} source {1} '.format( each.get('prefix'), each.get('source') ) elif each.get('prefix'): command = 'no ip igmp static-oif {0}'.format( each.get('prefix') ) if command: commands.append(command) command = None return commands def execute_config_command(commands, module): try: module.configure(commands) except ShellError: clie = get_exception() module.fail_json(msg='Error sending CLI commands', error=str(clie), commands=commands) def main(): argument_spec = dict( interface=dict(required=True, type='str'), version=dict(required=False, type='str'), startup_query_interval=dict(required=False, type='str'), startup_query_count=dict(required=False, type='str'), robustness=dict(required=False, type='str'), querier_timeout=dict(required=False, type='str'), query_mrt=dict(required=False, type='str'), query_interval=dict(required=False, type='str'), last_member_qrt=dict(required=False, type='str'), last_member_query_count=dict(required=False, type='str'), group_timeout=dict(required=False, type='str'), report_llg=dict(type='bool'), immediate_leave=dict(type='bool'), oif_routemap=dict(required=False, type='str'), oif_prefix=dict(required=False, type='str'), oif_source=dict(required=False, type='str'), restart=dict(type='bool', default=False), state=dict(choices=['present', 'absent', 'default'], default='present'), include_defaults=dict(default=True), config=dict(), save=dict(type='bool', default=False) ) module = get_network_module(argument_spec=argument_spec, supports_check_mode=True) state = module.params['state'] interface = module.params['interface'] oif_prefix = module.params['oif_prefix'] oif_source = module.params['oif_source'] oif_routemap = module.params['oif_routemap'] if oif_source: if not oif_prefix: module.fail_json(msg='oif_prefix required when setting oif_source') intf_type = get_interface_type(interface) if get_interface_mode(interface, intf_type, module) == 'layer2': module.fail_json(msg='this module only works on Layer 3 interfaces') if oif_prefix and oif_routemap: module.fail_json(msg='cannot use oif_prefix AND oif_routemap.' ' select one.') existing = get_igmp_interface(module, interface) existing_copy = existing.copy() end_state = existing_copy if not existing.get('version'): module.fail_json(msg='pim needs to be enabled on the interface') existing_oif_prefix_source = existing.get('oif_prefix_source') # not json serializable existing.pop('oif_prefix_source') if oif_routemap and existing_oif_prefix_source: module.fail_json(msg='Delete static-oif configurations on this ' 'interface if you want to use a routemap') if oif_prefix and existing.get('oif_routemap'): module.fail_json(msg='Delete static-oif route-map configuration ' 'on this interface if you want to config ' 'static entries') args = [ 'version', 'startup_query_interval', 'startup_query_count', 'robustness', 'querier_timeout', 'query_mrt', 'query_interval', 'last_member_qrt', 'last_member_query_count', 'group_timeout', 'report_llg', 'immediate_leave', 'oif_routemap', 'oif_prefix', 'oif_source' ] changed = False commands = [] proposed = dict((k, v) for k, v in module.params.iteritems() if v is not None and k in args) CANNOT_ABSENT = ['version', 'startup_query_interval', 'startup_query_count', 'robustness', 'querier_timeout', 'query_mrt', 'query_interval', 'last_member_qrt', 'last_member_query_count', 'group_timeout', 'report_llg', 'immediate_leave'] if state == 'absent': for each in CANNOT_ABSENT: if each in proposed.keys(): module.fail_json(msg='only params: oif_prefix, oif_source, ' 'oif_routemap can be used when ' 'state=absent') # delta check for all params except oif_prefix and oif_source delta = dict(set(proposed.iteritems()).difference(existing.iteritems())) # now check to see there is a delta for prefix and source command option found_both = False found_prefix = False if existing_oif_prefix_source: if oif_prefix and oif_source: for each in existing_oif_prefix_source: if (oif_prefix == each.get('prefix') and oif_source == each.get('source')): found_both = True if not found_both: delta['prefix'] = oif_prefix delta['source'] = oif_source elif oif_prefix: for each in existing_oif_prefix_source: if oif_prefix == each.get('prefix') and not each.get('source'): found_prefix = True if not found_prefix: delta['prefix'] = oif_prefix if state == 'present': if delta: command = config_igmp_interface(delta, found_both, found_prefix) if command: commands.append(command) elif state == 'default': command = config_default_igmp_interface(existing, delta, found_both, found_prefix) if command: commands.append(command) elif state == 'absent': command = None if existing.get('oif_routemap') or existing_oif_prefix_source: command = config_remove_oif(existing, existing_oif_prefix_source) if command: commands.append(command) command = config_default_igmp_interface(existing, delta, found_both, found_prefix) if command: commands.append(command) if module.params['restart']: commands.append('restart igmp') cmds = [] results = {} if commands: commands.insert(0, ['interface {0}'.format(interface)]) cmds = flatten_list(commands) if module.check_mode: module.exit_json(changed=True, commands=cmds) else: execute_config_command(cmds, module) changed = True end_state = get_igmp_interface(module, interface) results['proposed'] = proposed results['existing'] = existing_copy results['updates'] = cmds results['changed'] = changed results['end_state'] = end_state module.exit_json(**results) if __name__ == '__main__': main()