mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 05:10:22 -07:00
new module nxos_system (#21627)
* provides declarative config support for nxos system attributes * adds unit test cases for new module
This commit is contained in:
parent
2f10bdf0c7
commit
76c9ad9dfc
5 changed files with 611 additions and 0 deletions
359
lib/ansible/modules/network/nxos/nxos_system.py
Normal file
359
lib/ansible/modules/network/nxos/nxos_system.py
Normal file
|
@ -0,0 +1,359 @@
|
|||
#!/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': 'core',
|
||||
'version': '1.0'
|
||||
}
|
||||
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
module: nxos_system
|
||||
version_added: "2.3"
|
||||
author: "Peter Sprygada (@privateip)"
|
||||
short_description: Manage the system attributes on Cisco NXOS devices
|
||||
description:
|
||||
- This module provides declarative management of node system attributes
|
||||
on Cisco NXOS devices. It provides an option to configure host system
|
||||
parameters or remove those parameters from the device active
|
||||
configuration.
|
||||
options:
|
||||
hostname:
|
||||
description:
|
||||
- The C(hostname) argument will configure the device hostname
|
||||
parameter on Cisco NXOS devices. The C(hostname) value is an
|
||||
ASCII string value.
|
||||
required: false
|
||||
default: null
|
||||
domain_lookup:
|
||||
description:
|
||||
- The C(domain_lookup) argument enables or disables the DNS
|
||||
lookup feature in Cisco NXOS. This argument accepts boolean
|
||||
values. When enabled, the system will try to resolve hostnames
|
||||
using DNS and when disabled, hostnames will not be resolved.
|
||||
required: false
|
||||
default: null
|
||||
domain_search:
|
||||
description:
|
||||
- The C(domain_search) argument configures a list of domain
|
||||
name suffixes to search when performing DNS name resolution.
|
||||
This argument accepts either a list of domain names or
|
||||
a list of dicts that configure the domain name and VRF name. See
|
||||
examples.
|
||||
required: false
|
||||
default: null
|
||||
domain_name:
|
||||
description:
|
||||
- The C(domain_name) argument configures the default domain
|
||||
name suffix to be used when referencing this node by its
|
||||
FQDN. This argument accepts either a list of domain names or
|
||||
a list of dicts that configure the domain name and VRF name. See
|
||||
examples.
|
||||
required: false
|
||||
default: null
|
||||
name_servers:
|
||||
description:
|
||||
- The C(name_servers) argument accepts a list of DNS name servers by
|
||||
way of either FQDN or IP address to use to perform name resolution
|
||||
lookups. This argument accepts wither a list of DNS servers or
|
||||
a list of hashes that configure the name server and VRF name. See
|
||||
examples.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- The C(state) argument configures the state of the configuration
|
||||
values in the device's current active configuration. When set
|
||||
to I(present), the values should be configured in the device active
|
||||
configuration and when set to I(absent) the values should not be
|
||||
in the device active configuration
|
||||
required: false
|
||||
default: present
|
||||
choices: ['present', 'absent']
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: configure hostname and domain-name
|
||||
nxos_system:
|
||||
hostname: nxos01
|
||||
domain_name: eng.ansible.com
|
||||
|
||||
- name: remove configuration
|
||||
nxos_system:
|
||||
state: absent
|
||||
|
||||
- name: configure DNS lookup sources
|
||||
nxos_system:
|
||||
lookup_source: Management1
|
||||
|
||||
- name: configure name servers
|
||||
nxos_system:
|
||||
name_servers:
|
||||
- 8.8.8.8
|
||||
- 8.8.4.4
|
||||
|
||||
- name: configure name servers with VRF support
|
||||
nxos_system:
|
||||
name_servers:
|
||||
- { server: 8.8.8.8, vrf: mgmt }
|
||||
- { server: 8.8.4.4, vrf: mgmt }
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
commands:
|
||||
description: The list of configuration mode commands to send to the device
|
||||
returned: always
|
||||
type: list
|
||||
sample:
|
||||
- hostname nxos01
|
||||
- ip domain-name eng.ansible.com
|
||||
"""
|
||||
import re
|
||||
|
||||
from ansible.module_utils.nxos import get_config, load_config
|
||||
from ansible.module_utils.nxos import nxos_argument_spec, check_args
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.six import iteritems
|
||||
from ansible.module_utils.netcfg import NetworkConfig
|
||||
from ansible.module_utils.network_common import ComplexList
|
||||
|
||||
_CONFIGURED_VRFS = None
|
||||
|
||||
def has_vrf(module, vrf):
|
||||
global _CONFIGURED_VRFS
|
||||
if _CONFIGURED_VRFS is not None:
|
||||
return vrf in _CONFIGURED_VRFS
|
||||
config = get_config(module)
|
||||
_CONFIGURED_VRFS = re.findall('vrf context (\S+)', config)
|
||||
return vrf in _CONFIGURED_VRFS
|
||||
|
||||
def map_obj_to_commands(want, have, module):
|
||||
commands = list()
|
||||
state = module.params['state']
|
||||
|
||||
needs_update = lambda x: want.get(x) and (want.get(x) != have.get(x))
|
||||
difference = lambda x,y,z: [item for item in x[z] if item not in y[z]]
|
||||
|
||||
def remove(cmd, commands, vrf=None):
|
||||
if vrf:
|
||||
commands.append('vrf context %s' % vrf)
|
||||
commands.append(cmd)
|
||||
if vrf:
|
||||
commands.append('exit')
|
||||
|
||||
def add(cmd, commands, vrf=None):
|
||||
if vrf:
|
||||
if not has_vrf(module, vrf):
|
||||
module.fail_json(msg='invalid vrf name %s' % vrf)
|
||||
return remove(cmd, commands, vrf)
|
||||
|
||||
if state == 'absent':
|
||||
if have['hostname']:
|
||||
commands.append('no hostname')
|
||||
|
||||
for item in have['domain_name']:
|
||||
cmd = 'no ip domain-name %s' % item['name']
|
||||
remove(cmd, commands, item['vrf'])
|
||||
|
||||
for item in have['domain_search']:
|
||||
cmd = 'no ip domain-list %s' % item['name']
|
||||
remove(cmd, commands, item['vrf'])
|
||||
|
||||
for item in have['name_servers']:
|
||||
cmd = 'no ip name-server %s' % item['server']
|
||||
remove(cmd, commands, item['vrf'])
|
||||
|
||||
if state == 'present':
|
||||
if needs_update('hostname'):
|
||||
commands.append('hostname %s' % want['hostname'])
|
||||
|
||||
if needs_update('domain_lookup'):
|
||||
cmd = 'ip domain-lookup'
|
||||
if want['domain_lookup'] is False:
|
||||
cmd = 'no %s' % cmd
|
||||
commands.append(cmd)
|
||||
|
||||
if want['domain_name']:
|
||||
for item in difference(have, want, 'domain_name'):
|
||||
cmd = 'no ip domain-name %s' % item['name']
|
||||
remove(cmd, commands, item['vrf'])
|
||||
for item in difference(want, have, 'domain_name'):
|
||||
cmd = 'ip domain-name %s' % item['name']
|
||||
add(cmd, commands, item['vrf'])
|
||||
|
||||
if want['domain_search']:
|
||||
for item in difference(have, want, 'domain_search'):
|
||||
cmd = 'no ip domain-list %s' % item['name']
|
||||
remove(cmd, commands, item['vrf'])
|
||||
for item in difference(want, have, 'domain_search'):
|
||||
cmd = 'ip domain-list %s' % item['name']
|
||||
add(cmd, commands, item['vrf'])
|
||||
|
||||
if want['name_servers']:
|
||||
for item in difference(have, want, 'name_servers'):
|
||||
cmd = 'no ip name-server %s' % item['server']
|
||||
remove(cmd, commands, item['vrf'])
|
||||
for item in difference(want, have, 'name_servers'):
|
||||
cmd = 'ip name-server %s' % item['server']
|
||||
add(cmd, commands, item['vrf'])
|
||||
|
||||
return commands
|
||||
|
||||
def parse_hostname(config):
|
||||
match = re.search('^hostname (\S+)', config, re.M)
|
||||
if match:
|
||||
return match.group(1)
|
||||
|
||||
def parse_domain_name(config, vrf_config):
|
||||
objects = list()
|
||||
regex = re.compile('ip domain-name (\S+)')
|
||||
|
||||
match = regex.search(config, re.M)
|
||||
if match:
|
||||
objects.append({'name': match.group(1), 'vrf': None})
|
||||
|
||||
for vrf, cfg in iteritems(vrf_config):
|
||||
match = regex.search(cfg, re.M)
|
||||
if match:
|
||||
objects.append({'name': match.group(1), 'vrf': vrf})
|
||||
|
||||
return objects
|
||||
|
||||
def parse_domain_search(config, vrf_config):
|
||||
objects = list()
|
||||
|
||||
for item in re.findall('^ip domain-list (\S+)', config, re.M):
|
||||
objects.append({'name': item, 'vrf': None})
|
||||
|
||||
for vrf, cfg in iteritems(vrf_config):
|
||||
for item in re.findall('ip domain-list (\S+)', cfg, re.M):
|
||||
objects.append({'name': item, 'vrf': vrf})
|
||||
|
||||
return objects
|
||||
|
||||
def parse_name_servers(config, vrf_config):
|
||||
objects = list()
|
||||
|
||||
match = re.search('^ip name-server (.+)$', config, re.M)
|
||||
if match:
|
||||
for addr in match.group(1).split(' '):
|
||||
objects.append({'server': addr, 'vrf': None})
|
||||
|
||||
for vrf, cfg in iteritems(vrf_config):
|
||||
for item in re.findall('ip name-server (\S+)', cfg, re.M):
|
||||
for addr in match.group(1).split(' '):
|
||||
objects.append({'server': addr, 'vrf': vrf})
|
||||
|
||||
return objects
|
||||
|
||||
def map_config_to_obj(module):
|
||||
config = get_config(module)
|
||||
configobj = NetworkConfig(indent=2, contents=config)
|
||||
|
||||
vrf_config = {}
|
||||
|
||||
vrfs = re.findall('^vrf context (\S+)$', config, re.M)
|
||||
for vrf in vrfs:
|
||||
config_data = configobj.get_block_config(path=['vrf context %s' % vrf])
|
||||
vrf_config[vrf] = config_data
|
||||
|
||||
return {
|
||||
'hostname': parse_hostname(config),
|
||||
'domain_lookup': 'no ip domain-lookup' not in config,
|
||||
'domain_name': parse_domain_name(config, vrf_config),
|
||||
'domain_search': parse_domain_search(config, vrf_config),
|
||||
'name_servers': parse_name_servers(config, vrf_config)
|
||||
}
|
||||
|
||||
def map_params_to_obj(module):
|
||||
obj = {
|
||||
'hostname': module.params['hostname'],
|
||||
'domain_lookup': module.params['domain_lookup'],
|
||||
}
|
||||
|
||||
domain_name = ComplexList(dict(
|
||||
name=dict(key=True),
|
||||
vrf=dict()
|
||||
), module)
|
||||
|
||||
domain_search = ComplexList(dict(
|
||||
name=dict(key=True),
|
||||
vrf=dict()
|
||||
), module)
|
||||
|
||||
name_servers = ComplexList(dict(
|
||||
server=dict(key=True),
|
||||
vrf=dict()
|
||||
), module)
|
||||
|
||||
for arg, cast in [('domain_name', domain_name), ('domain_search', domain_search),
|
||||
('name_servers', name_servers)]:
|
||||
if module.params[arg] is not None:
|
||||
obj[arg] = cast(module.params[arg])
|
||||
else:
|
||||
obj[arg] = None
|
||||
|
||||
return obj
|
||||
|
||||
def main():
|
||||
""" main entry point for module execution
|
||||
"""
|
||||
argument_spec = dict(
|
||||
hostname=dict(),
|
||||
domain_lookup=dict(type='bool'),
|
||||
|
||||
# { name: <str>, vrf: <str> }
|
||||
domain_name=dict(type='list'),
|
||||
|
||||
# {name: <str>, vrf: <str> }
|
||||
domain_search=dict(type='list'),
|
||||
|
||||
# { server: <str>; vrf: <str> }
|
||||
name_servers=dict(type='list'),
|
||||
|
||||
state=dict(default='present', choices=['present', 'absent'])
|
||||
)
|
||||
|
||||
argument_spec.update(nxos_argument_spec)
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec,
|
||||
supports_check_mode=True)
|
||||
|
||||
warnings = list()
|
||||
check_args(module, warnings)
|
||||
|
||||
result = {'changed': False}
|
||||
if warnings:
|
||||
result['warnings'] = warnings
|
||||
|
||||
want = map_params_to_obj(module)
|
||||
have = map_config_to_obj(module)
|
||||
|
||||
commands = map_obj_to_commands(want, have, module)
|
||||
result['commands'] = commands
|
||||
|
||||
if commands:
|
||||
if not module.check_mode:
|
||||
load_config(module, commands)
|
||||
result['changed'] = True
|
||||
|
||||
module.exit_json(**result)
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Add table
Add a link
Reference in a new issue