mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-07-06 09:00:58 +02:00
350 lines
11 KiB
Python
350 lines
11 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 = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'network'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: nxos_aaa_server_host
|
|
extends_documentation_fragment: nxos
|
|
version_added: "2.2"
|
|
short_description: Manages AAA server host-specific configuration.
|
|
description:
|
|
- Manages AAA server host-specific configuration.
|
|
author: Jason Edelman (@jedelman8)
|
|
notes:
|
|
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
|
- Changes to the host key (shared secret) are not idempotent for type 0.
|
|
- If C(state=absent) removes the whole host configuration.
|
|
options:
|
|
server_type:
|
|
description:
|
|
- The server type is either radius or tacacs.
|
|
required: true
|
|
choices: ['radius', 'tacacs']
|
|
address:
|
|
description:
|
|
- Address or name of the radius or tacacs host.
|
|
required: true
|
|
key:
|
|
description:
|
|
- Shared secret for the specified host or keyword 'default'.
|
|
encrypt_type:
|
|
description:
|
|
- The state of encryption applied to the entered key.
|
|
O for clear text, 7 for encrypted. Type-6 encryption is
|
|
not supported.
|
|
choices: ['0', '7']
|
|
host_timeout:
|
|
description:
|
|
- Timeout period for specified host, in seconds or keyword 'default.
|
|
Range is 1-60.
|
|
auth_port:
|
|
description:
|
|
- Alternate UDP port for RADIUS authentication or keyword 'default'.
|
|
acct_port:
|
|
description:
|
|
- Alternate UDP port for RADIUS accounting or keyword 'default'.
|
|
tacacs_port:
|
|
description:
|
|
- Alternate TCP port TACACS Server or keyword 'default'.
|
|
state:
|
|
description:
|
|
- Manage the state of the resource.
|
|
default: present
|
|
choices: ['present','absent']
|
|
'''
|
|
EXAMPLES = '''
|
|
# Radius Server Host Basic settings
|
|
- name: "Radius Server Host Basic settings"
|
|
nxos_aaa_server_host:
|
|
state: present
|
|
server_type: radius
|
|
address: 1.2.3.4
|
|
acct_port: 2084
|
|
host_timeout: 10
|
|
host: "{{ inventory_hostname }}"
|
|
username: "{{ un }}"
|
|
password: "{{ pwd }}"
|
|
|
|
# Radius Server Host Key Configuration
|
|
- name: "Radius Server Host Key Configuration"
|
|
nxos_aaa_server_host:
|
|
state: present
|
|
server_type: radius
|
|
address: 1.2.3.4
|
|
key: hello
|
|
encrypt_type: 7
|
|
host: inventory_hostname }}
|
|
username: "{{ un }}"
|
|
password: "{{ pwd }}"
|
|
|
|
# TACACS Server Host Configuration
|
|
- name: "Tacacs Server Host Configuration"
|
|
nxos_aaa_server_host:
|
|
state: present
|
|
server_type: tacacs
|
|
tacacs_port: 89
|
|
host_timeout: 10
|
|
address: 5.6.7.8
|
|
host: inventory_hostname }}
|
|
username: un }}
|
|
password: pwd }}
|
|
'''
|
|
|
|
RETURN = '''
|
|
proposed:
|
|
description: k/v pairs of parameters passed into module
|
|
returned: always
|
|
type: dict
|
|
sample: {"address": "1.2.3.4", "auth_port": "2084",
|
|
"host_timeout": "10", "server_type": "radius"}
|
|
existing:
|
|
description:
|
|
- k/v pairs of existing configuration
|
|
returned: always
|
|
type: dict
|
|
sample: {}
|
|
end_state:
|
|
description: k/v pairs of configuration after module execution
|
|
returned: always
|
|
type: dict
|
|
sample: {"address": "1.2.3.4", "auth_port": "2084",
|
|
"host_timeout": "10", "server_type": "radius"}
|
|
updates:
|
|
description: command sent to the device
|
|
returned: always
|
|
type: list
|
|
sample: ["radius-server host 1.2.3.4 auth-port 2084 timeout 10"]
|
|
changed:
|
|
description: check to see if a change was made on the device
|
|
returned: always
|
|
type: boolean
|
|
sample: true
|
|
'''
|
|
import re
|
|
|
|
from ansible.module_utils.network.nxos.nxos import load_config, run_commands
|
|
from ansible.module_utils.network.nxos.nxos import get_capabilities, nxos_argument_spec
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
|
|
def execute_show_command(command, module):
|
|
device_info = get_capabilities(module)
|
|
network_api = device_info.get('network_api', 'nxapi')
|
|
|
|
if network_api == 'cliconf':
|
|
cmds = [command]
|
|
body = run_commands(module, cmds)
|
|
elif network_api == 'nxapi':
|
|
cmds = {'command': command, 'output': 'text'}
|
|
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_aaa_host_info(module, server_type, address):
|
|
aaa_host_info = {}
|
|
command = 'show run | inc {0}-server.host.{1}'.format(server_type, address)
|
|
|
|
body = execute_show_command(command, module)[0]
|
|
if body:
|
|
try:
|
|
if 'radius' in body:
|
|
pattern = (r'\S+ host \S+(?:\s+key 7\s+(\S+))?(?:\s+auth-port (\d+))?'
|
|
r'(?:\s+acct-port (\d+))?(?:\s+authentication)?'
|
|
r'(?:\s+accounting)?(?:\s+timeout (\d+))?')
|
|
match = re.search(pattern, body)
|
|
aaa_host_info['key'] = match.group(1)
|
|
if aaa_host_info['key']:
|
|
aaa_host_info['key'] = aaa_host_info['key'].replace('"', '')
|
|
aaa_host_info['encrypt_type'] = '7'
|
|
aaa_host_info['auth_port'] = match.group(2)
|
|
aaa_host_info['acct_port'] = match.group(3)
|
|
aaa_host_info['host_timeout'] = match.group(4)
|
|
elif 'tacacs' in body:
|
|
pattern = (r'\S+ host \S+(?:\s+key 7\s+(\S+))?(?:\s+port (\d+))?'
|
|
r'(?:\s+timeout (\d+))?')
|
|
match = re.search(pattern, body)
|
|
aaa_host_info['key'] = match.group(1)
|
|
if aaa_host_info['key']:
|
|
aaa_host_info['key'] = aaa_host_info['key'].replace('"', '')
|
|
aaa_host_info['encrypt_type'] = '7'
|
|
aaa_host_info['tacacs_port'] = match.group(2)
|
|
aaa_host_info['host_timeout'] = match.group(3)
|
|
|
|
aaa_host_info['server_type'] = server_type
|
|
aaa_host_info['address'] = address
|
|
except TypeError:
|
|
return {}
|
|
else:
|
|
return {}
|
|
|
|
return aaa_host_info
|
|
|
|
|
|
def config_aaa_host(server_type, address, params, existing):
|
|
cmds = []
|
|
cmd_str = '{0}-server host {1}'.format(server_type, address)
|
|
cmd_no_str = 'no ' + cmd_str
|
|
|
|
key = params.get('key')
|
|
enc_type = params.get('encrypt_type', '')
|
|
|
|
defval = False
|
|
nondef = False
|
|
|
|
if key:
|
|
if key != 'default':
|
|
cmds.append(cmd_str + ' key {0} {1}'.format(enc_type, key))
|
|
else:
|
|
cmds.append(cmd_no_str + ' key 7 {0}'.format(existing.get('key')))
|
|
|
|
locdict = {'auth_port': 'auth-port', 'acct_port': 'acct-port',
|
|
'tacacs_port': 'port', 'host_timeout': 'timeout'}
|
|
|
|
# platform CLI needs the keywords in the following order
|
|
for key in ['auth_port', 'acct_port', 'tacacs_port', 'host_timeout']:
|
|
item = params.get(key)
|
|
if item:
|
|
if item != 'default':
|
|
cmd_str += ' {0} {1}'.format(locdict.get(key), item)
|
|
nondef = True
|
|
else:
|
|
cmd_no_str += ' {0} 1'.format(locdict.get(key))
|
|
defval = True
|
|
if defval:
|
|
cmds.append(cmd_no_str)
|
|
if nondef or not existing:
|
|
cmds.append(cmd_str)
|
|
|
|
return cmds
|
|
|
|
|
|
def main():
|
|
argument_spec = dict(
|
|
server_type=dict(choices=['radius', 'tacacs'], required=True),
|
|
address=dict(type='str', required=True),
|
|
key=dict(type='str'),
|
|
encrypt_type=dict(type='str', choices=['0', '7']),
|
|
host_timeout=dict(type='str'),
|
|
auth_port=dict(type='str'),
|
|
acct_port=dict(type='str'),
|
|
tacacs_port=dict(type='str'),
|
|
state=dict(choices=['absent', 'present'], default='present'),
|
|
)
|
|
|
|
argument_spec.update(nxos_argument_spec)
|
|
|
|
module = AnsibleModule(argument_spec=argument_spec,
|
|
supports_check_mode=True)
|
|
|
|
warnings = list()
|
|
|
|
server_type = module.params['server_type']
|
|
address = module.params['address']
|
|
key = module.params['key']
|
|
encrypt_type = module.params['encrypt_type']
|
|
host_timeout = module.params['host_timeout']
|
|
auth_port = module.params['auth_port']
|
|
acct_port = module.params['acct_port']
|
|
tacacs_port = module.params['tacacs_port']
|
|
state = module.params['state']
|
|
|
|
args = dict(server_type=server_type, address=address, key=key,
|
|
encrypt_type=encrypt_type, host_timeout=host_timeout,
|
|
auth_port=auth_port, acct_port=acct_port,
|
|
tacacs_port=tacacs_port)
|
|
|
|
proposed = dict((k, v) for k, v in args.items() if v is not None)
|
|
changed = False
|
|
|
|
if encrypt_type and not key:
|
|
module.fail_json(msg='encrypt_type must be used with key')
|
|
|
|
if tacacs_port and server_type != 'tacacs':
|
|
module.fail_json(
|
|
msg='tacacs_port can only be used with server_type=tacacs')
|
|
|
|
if (auth_port or acct_port) and server_type != 'radius':
|
|
module.fail_json(msg='auth_port and acct_port can only be used'
|
|
'when server_type=radius')
|
|
|
|
existing = get_aaa_host_info(module, server_type, address)
|
|
end_state = existing
|
|
|
|
commands = []
|
|
delta = {}
|
|
if state == 'present':
|
|
if not existing:
|
|
delta = proposed
|
|
else:
|
|
for key, value in proposed.items():
|
|
if value != existing.get(key):
|
|
if value != 'default' or existing.get(key):
|
|
delta[key] = value
|
|
|
|
command = config_aaa_host(server_type, address, delta, existing)
|
|
if command:
|
|
commands.append(command)
|
|
|
|
elif state == 'absent':
|
|
intersect = dict(
|
|
set(proposed.items()).intersection(existing.items()))
|
|
if intersect.get('address') and intersect.get('server_type'):
|
|
command = 'no {0}-server host {1}'.format(
|
|
intersect.get('server_type'), intersect.get('address'))
|
|
commands.append(command)
|
|
|
|
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_aaa_host_info(module, server_type, address)
|
|
|
|
results = {}
|
|
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()
|