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.
289 lines
8.5 KiB
Python
289 lines
8.5 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_snmp_traps
|
|
version_added: "2.2"
|
|
short_description: Manages SNMP traps.
|
|
description:
|
|
- Manages SNMP traps configurations.
|
|
author:
|
|
- Jason Edelman (@jedelman8)
|
|
notes:
|
|
- This module works at the group level for traps. If you need to only
|
|
enable/disable 1 specific trap within a group, use the M(nxos_command)
|
|
module.
|
|
- Be aware that you can set a trap only for an enabled feature.
|
|
options:
|
|
group:
|
|
description:
|
|
- Case sensitive group.
|
|
required: true
|
|
choices: ['aaa', 'bridge', 'callhome', 'cfs', 'config', 'entity',
|
|
'feature-control', 'hsrp', 'license', 'link', 'lldp', 'ospf', 'pim',
|
|
'rf', 'rmon', 'snmp', 'storm-control', 'stpx', 'sysmgr', 'system',
|
|
'upgrade', 'vtp', 'all']
|
|
state:
|
|
description:
|
|
- Manage the state of the resource.
|
|
required: false
|
|
default: enabled
|
|
choices: ['enabled','disabled']
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# ensure lldp trap configured
|
|
- nxos_snmp_traps:
|
|
group: lldp
|
|
state: enabled
|
|
host: "{{ inventory_hostname }}"
|
|
username: "{{ un }}"
|
|
password: "{{ pwd }}"
|
|
|
|
# ensure lldp trap is not configured
|
|
- nxos_snmp_traps:
|
|
group: lldp
|
|
state: disabled
|
|
host: "{{ inventory_hostname }}"
|
|
username: "{{ un }}"
|
|
password: "{{ pwd }}"
|
|
'''
|
|
|
|
RETURN = '''
|
|
proposed:
|
|
description: k/v pairs of parameters passed into module
|
|
returned: always
|
|
type: dict
|
|
sample: {"group": "lldp"}
|
|
existing:
|
|
description: k/v pairs of existing trap status
|
|
type: dict
|
|
sample: {"lldp": [{"enabled": "No",
|
|
"trap": "lldpRemTablesChange"}]}
|
|
end_state:
|
|
description: k/v pairs of trap info after module execution
|
|
returned: always
|
|
type: dict
|
|
sample: {"lldp": [{"enabled": "Yes",
|
|
"trap": "lldpRemTablesChange"}]}
|
|
updates:
|
|
description: command sent to the device
|
|
returned: always
|
|
type: list
|
|
sample: "snmp-server enable traps lldp ;"
|
|
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
|
|
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 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] = str(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_snmp_traps(group, module):
|
|
command = 'show snmp trap'
|
|
body = execute_show_command(command, module)
|
|
|
|
trap_key = {
|
|
'description': 'trap',
|
|
'isEnabled': 'enabled'
|
|
}
|
|
|
|
resource = {}
|
|
|
|
try:
|
|
resource_table = body[0]['TABLE_snmp_trap']['ROW_snmp_trap']
|
|
|
|
for each_feature in ['aaa', 'bridge', 'callhome', 'cfs', 'config',
|
|
'entity', 'feature-control', 'hsrp', 'license',
|
|
'link', 'lldp', 'ospf', 'pim', 'rf', 'rmon',
|
|
'snmp', 'storm-control', 'stpx', 'sysmgr',
|
|
'system', 'upgrade', 'vtp']:
|
|
|
|
resource[each_feature] = []
|
|
|
|
for each_resource in resource_table:
|
|
key = str(each_resource['trap_type'])
|
|
mapped_trap = apply_key_map(trap_key, each_resource)
|
|
|
|
if key != 'Generic':
|
|
resource[key].append(mapped_trap)
|
|
|
|
except (KeyError, AttributeError):
|
|
return resource
|
|
|
|
find = resource.get(group, None)
|
|
|
|
if group == 'all'.lower():
|
|
return resource
|
|
elif find:
|
|
trap_resource = {group: resource[group]}
|
|
return trap_resource
|
|
else:
|
|
# if 'find' is None, it means that 'group' is a
|
|
# currently disabled feature.
|
|
return {}
|
|
|
|
|
|
def get_trap_commands(group, state, existing, module):
|
|
commands = []
|
|
enabled = False
|
|
disabled = False
|
|
|
|
if group == 'all':
|
|
if state == 'disabled':
|
|
for feature in existing:
|
|
trap_commands = ['no snmp-server enable traps {0}'.format(feature) for
|
|
trap in existing[feature] if trap['enabled'] == 'Yes']
|
|
trap_commands = list(set(trap_commands))
|
|
commands.append(trap_commands)
|
|
|
|
elif state == 'enabled':
|
|
for feature in existing:
|
|
trap_commands = ['snmp-server enable traps {0}'.format(feature) for
|
|
trap in existing[feature] if trap['enabled'] == 'No']
|
|
trap_commands = list(set(trap_commands))
|
|
commands.append(trap_commands)
|
|
|
|
else:
|
|
if group in existing:
|
|
for each_trap in existing[group]:
|
|
check = each_trap['enabled']
|
|
if check.lower() == 'yes':
|
|
enabled = True
|
|
if check.lower() == 'no':
|
|
disabled = True
|
|
|
|
if state == 'disabled' and enabled:
|
|
commands.append(['no snmp-server enable traps {0}'.format(group)])
|
|
elif state == 'enabled' and disabled:
|
|
commands.append(['snmp-server enable traps {0}'.format(group)])
|
|
else:
|
|
module.fail_json(msg='{0} is not a currently '
|
|
'enabled feature.'.format(group))
|
|
|
|
return commands
|
|
|
|
|
|
def main():
|
|
argument_spec = dict(
|
|
state=dict(choices=['enabled', 'disabled'], default='enabled'),
|
|
group=dict(choices=['aaa', 'bridge', 'callhome', 'cfs', 'config',
|
|
'entity', 'feature-control', 'hsrp',
|
|
'license', 'link', 'lldp', 'ospf', 'pim', 'rf',
|
|
'rmon', 'snmp', 'storm-control', 'stpx',
|
|
'sysmgr', 'system', 'upgrade', 'vtp', 'all'],
|
|
required=True),
|
|
)
|
|
|
|
argument_spec.update(nxos_argument_spec)
|
|
|
|
module = AnsibleModule(argument_spec=argument_spec,
|
|
supports_check_mode=True)
|
|
|
|
warnings = list()
|
|
check_args(module, warnings)
|
|
|
|
|
|
group = module.params['group'].lower()
|
|
state = module.params['state']
|
|
|
|
existing = get_snmp_traps(group, module)
|
|
proposed = {'group': group}
|
|
|
|
changed = False
|
|
end_state = existing
|
|
commands = get_trap_commands(group, state, existing, module)
|
|
|
|
cmds = flatten_list(commands)
|
|
if cmds:
|
|
if module.check_mode:
|
|
module.exit_json(changed=True, commands=cmds)
|
|
else:
|
|
changed = True
|
|
load_config(module, cmds)
|
|
end_state = get_snmp_traps(group, module)
|
|
if 'configure' in cmds:
|
|
cmds.pop(0)
|
|
|
|
results = {}
|
|
results['proposed'] = proposed
|
|
results['existing'] = existing
|
|
results['end_state'] = end_state
|
|
results['updates'] = cmds
|
|
results['changed'] = changed
|
|
results['warnings'] = warnings
|
|
|
|
module.exit_json(**results)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|
|
|