mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-05 00:31:37 -07:00
21d993a4b8
This completes the refactor of the nxos modules to use the persistent connection. It also updates all of the nxos modules to use the new connection module and preserves use of nxapi as well.
340 lines
10 KiB
Python
340 lines
10 KiB
Python
#!/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 <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
ANSIBLE_METADATA = {'status': ['preview'],
|
|
'supported_by': 'community',
|
|
'version': '1.0'}
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: nxos_igmp_snooping
|
|
version_added: "2.2"
|
|
short_description: Manages IGMP snooping global configuration.
|
|
description:
|
|
- Manages IGMP snooping global configuration.
|
|
author:
|
|
- Jason Edelman (@jedelman8)
|
|
- Gabriele Gerbino (@GGabriele)
|
|
notes:
|
|
- When C(state=default), params will be reset to a default state.
|
|
- C(group_timeout) also accepts I(never) as an input.
|
|
options:
|
|
snooping:
|
|
description:
|
|
- Enables/disables IGMP snooping on the switch.
|
|
required: false
|
|
default: null
|
|
choices: ['true', 'false']
|
|
group_timeout:
|
|
description:
|
|
- Group membership timeout value for all VLANs on the device.
|
|
Accepted values are integer in range 1-10080, I(never) and
|
|
I(default).
|
|
required: false
|
|
default: null
|
|
link_local_grp_supp:
|
|
description:
|
|
- Global link-local groups suppression.
|
|
required: false
|
|
default: null
|
|
choices: ['true', 'false']
|
|
report_supp:
|
|
description:
|
|
- Global IGMPv1/IGMPv2 Report Suppression.
|
|
required: false
|
|
default: null
|
|
v3_report_supp:
|
|
description:
|
|
- Global IGMPv3 Report Suppression and Proxy Reporting.
|
|
required: false
|
|
default: null
|
|
choices: ['true', 'false']
|
|
state:
|
|
description:
|
|
- Manage the state of the resource.
|
|
required: false
|
|
default: present
|
|
choices: ['present','default']
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# ensure igmp snooping params supported in this module are in there default state
|
|
- nxos_igmp_snooping:
|
|
state: default
|
|
host: inventory_hostname }}
|
|
username: un }}
|
|
password: pwd }}
|
|
|
|
# ensure following igmp snooping params are in the desired state
|
|
- nxos_igmp_snooping:
|
|
group_timeout: never
|
|
snooping: true
|
|
link_local_grp_supp: false
|
|
optimize_mcast_flood: false
|
|
report_supp: true
|
|
v3_report_supp: true
|
|
host: "{{ inventory_hostname }}"
|
|
username: "{{ un }}"
|
|
password: "{{ pwd }}"
|
|
'''
|
|
|
|
RETURN = '''
|
|
proposed:
|
|
description: k/v pairs of parameters passed into module
|
|
returned: always
|
|
type: dict
|
|
sample: {"group_timeout": "50", "link_local_grp_supp": true,
|
|
"report_supp": false, "snooping": false, "v3_report_supp": false}
|
|
existing:
|
|
description:
|
|
- k/v pairs of existing configuration
|
|
type: dict
|
|
sample: {"group_timeout": "never", "link_local_grp_supp": false,
|
|
"report_supp": true, "snooping": true, "v3_report_supp": true}
|
|
end_state:
|
|
description: k/v pairs of configuration after module execution
|
|
returned: always
|
|
type: dict
|
|
sample: {"group_timeout": "50", "link_local_grp_supp": true,
|
|
"report_supp": false, "snooping": false, "v3_report_supp": false}
|
|
updates:
|
|
description: command sent to the device
|
|
returned: always
|
|
type: list
|
|
sample: ["ip igmp snooping link-local-groups-suppression",
|
|
"ip igmp snooping group-timeout 50",
|
|
"no ip igmp snooping report-suppression",
|
|
"no ip igmp snooping v3-report-suppression",
|
|
"no ip igmp snooping"]
|
|
changed:
|
|
description: check to see if a change was made on the device
|
|
returned: always
|
|
type: boolean
|
|
sample: true
|
|
'''
|
|
|
|
from ansible.module_utils.nxos import get_config, load_config, run_commands
|
|
from ansible.module_utils.nxos import nxos_argument_spec, check_args
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.netcfg import CustomNetworkConfig
|
|
|
|
import re
|
|
|
|
|
|
def execute_show_command(command, module, command_type='cli_show'):
|
|
if module.params['transport'] == 'cli':
|
|
if 'show run' not in command:
|
|
command += ' | json'
|
|
cmds = [command]
|
|
body = run_commands(module, cmds)
|
|
elif module.params['transport'] == 'nxapi':
|
|
cmds = [command]
|
|
body = run_commands(module, cmds)
|
|
|
|
return body
|
|
|
|
|
|
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_group_timeout(config):
|
|
command = 'ip igmp snooping group-timeout'
|
|
REGEX = re.compile(r'(?:{0}\s)(?P<value>.*)$'.format(command), re.M)
|
|
value = ''
|
|
if command in config:
|
|
value = REGEX.search(config).group('value')
|
|
return value
|
|
|
|
|
|
def get_snooping(config):
|
|
REGEX = re.compile(r'{0}$'.format('no ip igmp snooping'), re.M)
|
|
value = False
|
|
try:
|
|
if REGEX.search(config):
|
|
value = False
|
|
except TypeError:
|
|
value = True
|
|
return value
|
|
|
|
|
|
def get_igmp_snooping(module):
|
|
command = 'show run all | include igmp.snooping'
|
|
existing = {}
|
|
body = execute_show_command(
|
|
command, module, command_type='cli_show_ascii')[0]
|
|
|
|
if body:
|
|
split_body = body.splitlines()
|
|
|
|
if 'no ip igmp snooping' in split_body:
|
|
existing['snooping'] = False
|
|
else:
|
|
existing['snooping'] = True
|
|
|
|
if 'no ip igmp snooping report-suppression' in split_body:
|
|
existing['report_supp'] = False
|
|
elif 'ip igmp snooping report-suppression' in split_body:
|
|
existing['report_supp'] = True
|
|
|
|
if 'no ip igmp snooping link-local-groups-suppression' in split_body:
|
|
existing['link_local_grp_supp'] = False
|
|
elif 'ip igmp snooping link-local-groups-suppression' in split_body:
|
|
existing['link_local_grp_supp'] = True
|
|
|
|
if 'ip igmp snooping v3-report-suppression' in split_body:
|
|
existing['v3_report_supp'] = True
|
|
else:
|
|
existing['v3_report_supp'] = False
|
|
|
|
existing['group_timeout'] = get_group_timeout(body)
|
|
|
|
return existing
|
|
|
|
|
|
def config_igmp_snooping(delta, existing, default=False):
|
|
CMDS = {
|
|
'snooping': 'ip igmp snooping',
|
|
'group_timeout': 'ip igmp snooping group-timeout {}',
|
|
'link_local_grp_supp': 'ip igmp snooping link-local-groups-suppression',
|
|
'v3_report_supp': 'ip igmp snooping v3-report-suppression',
|
|
'report_supp': 'ip igmp snooping report-suppression'
|
|
}
|
|
|
|
commands = []
|
|
command = None
|
|
for key, value in delta.items():
|
|
if value:
|
|
if default and key == 'group_timeout':
|
|
if existing.get(key):
|
|
command = 'no ' + CMDS.get(key).format(existing.get(key))
|
|
else:
|
|
command = CMDS.get(key).format(value)
|
|
else:
|
|
command = 'no ' + CMDS.get(key).format(value)
|
|
|
|
if command:
|
|
commands.append(command)
|
|
command = None
|
|
|
|
return commands
|
|
|
|
|
|
def get_igmp_snooping_defaults():
|
|
group_timeout = 'dummy'
|
|
report_supp = True
|
|
link_local_grp_supp = True
|
|
v3_report_supp = False
|
|
snooping = True
|
|
|
|
args = dict(snooping=snooping, link_local_grp_supp=link_local_grp_supp,
|
|
report_supp=report_supp, v3_report_supp=v3_report_supp,
|
|
group_timeout=group_timeout)
|
|
|
|
default = dict((param, value) for (param, value) in args.items()
|
|
if value is not None)
|
|
|
|
return default
|
|
|
|
|
|
def main():
|
|
argument_spec = dict(
|
|
snooping=dict(required=False, type='bool'),
|
|
group_timeout=dict(required=False, type='str'),
|
|
link_local_grp_supp=dict(required=False, type='bool'),
|
|
report_supp=dict(required=False, type='bool'),
|
|
v3_report_supp=dict(required=False, type='bool'),
|
|
state=dict(choices=['present', 'default'], default='present'),
|
|
)
|
|
|
|
argument_spec.update(nxos_argument_spec)
|
|
|
|
module = AnsibleModule(argument_spec=argument_spec,
|
|
supports_check_mode=True)
|
|
|
|
warnings = list()
|
|
check_args(module, warnings)
|
|
|
|
|
|
snooping = module.params['snooping']
|
|
link_local_grp_supp = module.params['link_local_grp_supp']
|
|
report_supp = module.params['report_supp']
|
|
v3_report_supp = module.params['v3_report_supp']
|
|
group_timeout = module.params['group_timeout']
|
|
state = module.params['state']
|
|
|
|
args = dict(snooping=snooping, link_local_grp_supp=link_local_grp_supp,
|
|
report_supp=report_supp, v3_report_supp=v3_report_supp,
|
|
group_timeout=group_timeout)
|
|
|
|
proposed = dict((param, value) for (param, value) in args.items()
|
|
if value is not None)
|
|
|
|
existing = get_igmp_snooping(module)
|
|
end_state = existing
|
|
changed = False
|
|
|
|
commands = []
|
|
if state == 'present':
|
|
delta = dict(
|
|
set(proposed.items()).difference(existing.items())
|
|
)
|
|
if delta:
|
|
command = config_igmp_snooping(delta, existing)
|
|
if command:
|
|
commands.append(command)
|
|
elif state == 'default':
|
|
proposed = get_igmp_snooping_defaults()
|
|
delta = dict(
|
|
set(proposed.items()).difference(existing.items())
|
|
)
|
|
if delta:
|
|
command = config_igmp_snooping(delta, existing, default=True)
|
|
if command:
|
|
commands.append(command)
|
|
|
|
cmds = flatten_list(commands)
|
|
results = {}
|
|
if cmds:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True, commands=cmds)
|
|
else:
|
|
changed = True
|
|
load_config(module, cmds)
|
|
end_state = get_igmp_snooping(module)
|
|
if 'configure' in cmds:
|
|
cmds.pop(0)
|
|
|
|
results['proposed'] = proposed
|
|
results['existing'] = existing
|
|
results['updates'] = cmds
|
|
results['changed'] = changed
|
|
results['warnings'] = warnings
|
|
results['end_state'] = end_state
|
|
|
|
module.exit_json(**results)
|
|
|
|
if __name__ == '__main__':
|
|
main()
|
|
|