diff --git a/network/dnos6/dnos6_config.py b/network/dnos6/dnos6_config.py new file mode 100644 index 00000000000..2293a2deb31 --- /dev/null +++ b/network/dnos6/dnos6_config.py @@ -0,0 +1,290 @@ +#!/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: dnos6_config +version_added: "2.2" +author: "Abirami N(@abirami-n)" +short_description: Manage Dell OS6 configuration sections +description: + - Dell OS6 configurations use a simple block indent file syntax + for segmenting configuration into sections. This module provides + an implementation for working with Dell OS6 configuration sections in + a deterministic way. +extends_documentation_fragment: dnos6 +options: + lines: + description: + - The ordered set of commands that should be configured in the + section. The commands must be the exact same commands as found + in the device running-config. Be sure to note the configuration + command syntax as some commands are automatically modified by the + device config parser. This argument is mutually exclusive with I(src). + required: false + default: null + aliases: ['commands'] + parents: + description: + - The ordered set of parents that uniquely identify the section + the commands should be checked against. If the parents argument + is omitted, the commands are checked against the set of top + level or global commands. + required: false + default: null + src: + description: + - Specifies the source path to the file that contains the configuration + or configuration template to load. The path to the source file can + either be the full path on the Ansible control host or a relative + path from the playbook or role root dir. This argument is mutually + exclusive with I(lines). + required: false + default: null + before: + description: + - The ordered set of commands to push on to the command stack if + a change needs to be made. This allows the playbook designer + the opportunity to perform configuration commands prior to pushing + any changes without affecting how the set of commands are matched + against the system. + required: false + default: null + after: + description: + - The ordered set of commands to append to the end of the command + stack if a change needs to be made. Just like with I(before) this + allows the playbook designer to append a set of commands to be + executed after the command set. + required: false + default: null + match: + description: + - Instructs the module on the way to perform the matching of + the set of commands against the current device config. If + match is set to I(line), commands are matched line by line. If + match is set to I(strict), command lines are matched with respect + to position. If match is set to I(exact), command lines + must be an equal match. Finally, if match is set to I(none), the + module will not attempt to compare the source configuration with + the running configuration on the remote device. + required: false + default: line + choices: ['line', 'strict', 'exact', 'none'] + replace: + description: + - Instructs the module on the way to perform the configuration + on the device. If the replace argument is set to I(line) then + the modified lines are pushed to the device in configuration + mode. If the replace argument is set to I(block) then the entire + command block is pushed to the device in configuration mode if any + line is not correct. + required: false + default: line + choices: ['line', 'block'] + update: + description: + - The I(update) argument controls how the configuration statements + are processed on the remote device. Valid choices for the I(update) + argument are I(merge) and I(check). When the argument is set to + I(merge), the configuration changes are merged with the current + device running configuration. When the argument is set to I(check) + the configuration updates are determined but not actually configured + on the remote device. + required: false + default: merge + choices: ['merge', 'check'] + save: + description: + - The C(save) argument instructs the module to save the running- + config to the startup-config at the conclusion of the module + running. If check mode is specified, this argument is ignored. + required: false + default: no + choices: ['yes', 'no'] + config: + description: + - The C(config) argument allows the playbook designer to supply + the base configuration to be used to validate configuration + changes necessary. If this argument is provided, the module + will not download the running-config from the remote node. + required: false + default: null + backup: + description: + - This argument will cause the module to create a full backup of + the current C(running-config) from the remote device before any + changes are made. The backup file is written to the C(backup) + folder in the playbook root directory. If the directory does not + exist, it is created. + required: false + default: no + choices: ['yes', 'no'] +""" + +EXAMPLES = """ +- dnos6_config: + lines: ['hostname {{ inventory_hostname }}'] + provider: "{{ cli }}" + +- dnos6_config: + lines: + - 10 permit ip 1.1.1.1 any log + - 20 permit ip 2.2.2.2 any log + - 30 permit ip 3.3.3.3 any log + - 40 permit ip 4.4.4.4 any log + - 50 permit ip 5.5.5.5 any log + parents: ['ip access-list test'] + before: ['no ip access-list test'] + match: exact + provider: "{{ cli }}" + +- dnos6_config: + lines: + - 10 permit ip 1.1.1.1 any log + - 20 permit ip 2.2.2.2 any log + - 30 permit ip 3.3.3.3 any log + - 40 permit ip 4.4.4.4 any log + parents: ['ip access-list test'] + before: ['no ip access-list test'] + replace: block + provider: "{{ cli }}" + +""" + +RETURN = """ +updates: + description: The set of commands that will be pushed to the remote device + returned: always + type: list + sample: ['...', '...'] + +responses: + description: The set of responses from issuing the commands on the device + returned: when not check_mode + type: list + sample: ['...', '...'] + +saved: + description: Returns whether the configuration is saved to the startup + configuration or not. + returned: when not check_mode + type: bool + sample: True + +""" +from ansible.module_utils.netcfg import NetworkConfig, dumps, ConfigLine +from ansible.module_utils.network import NetworkModule +from ansible.module_utils.dnos6 import get_config + +def get_candidate(module): + candidate = NetworkConfig(indent=1) + if module.params['src']: + candidate.load(module.params['src']) + elif module.params['lines']: + parents = module.params['parents'] or list() + candidate.add(module.params['lines'], parents=parents) + return candidate + +def get_contents(other,module): + contents =list() + + parent = ''.join(module.params['parents']) + start = False + for item in other.items: + if item.text == parent: + start = True + elif item.text != 'exit' and start: + contents.append(item.text) + elif item.text == 'exit' and start: + start = False + break + return contents + +def main(): + argument_spec = dict( + lines=dict(aliases=['commands'], type='list'), + parents=dict(type='list'), + + src=dict(type='path'), + + before=dict(type='list'), + after=dict(type='list'), + + match=dict(default='line', + choices=['line', 'strict', 'exact', 'none']), + replace=dict(default='line', choices=['line', 'block']), + update=dict(choices=['merge', 'check'], default='merge'), + save=dict(type='bool', default=False), + config=dict(), + backup=dict(type='bool', default=False) + ) + + mutually_exclusive = [('lines', 'src')] + + module = NetworkModule(argument_spec=argument_spec, + connect_on_load=False, + mutually_exclusive=mutually_exclusive, + supports_check_mode=True) + + parents = module.params['parents'] or list() + + match = module.params['match'] + replace = module.params['replace'] + before = module.params['before'] + result = dict(changed=False, saved=False) + candidate = get_candidate(module) + + if module.params['match'] != 'none': + config = get_config(module) + if parents: + con = get_contents(config,module) + config = NetworkConfig(indent=1) + config.add(con,parents=module.params['parents']) + configobjs = candidate.difference(config, match=match, replace=replace) + else: + configobjs = candidate.items + + if module.params['backup']: + result['__backup__'] = module.cli('show running-config')[0] + commands = list() + if configobjs: + commands = dumps(configobjs, 'commands') + commands = commands.split('\n') + if module.params['before']: + commands[:0] = before + if module.params['after']: + commands.extend(module.params['after']) + if not module.check_mode and module.params['update'] == 'merge': + response = module.config.load_config(commands) + result['responses'] = response + + if module.params['save']: + module.config.save_config() + result['saved'] = True + + + result['changed'] = True + + result['updates'] = commands + + module.exit_json(**result) + + +if __name__ == '__main__': + main()