From 87cee15a85a969f9716159fe89283cf68a4e3af1 Mon Sep 17 00:00:00 2001 From: Peter Sprygada Date: Wed, 17 Feb 2016 16:22:44 +0000 Subject: [PATCH] initial add of ops_template module This adds a new module ops_template used for configuring OpenSwitch using local declarative config modules --- network/openswitch/__init__.py | 0 network/openswitch/ops_template.py | 293 +++++++++++++++++++++++++++++ 2 files changed, 293 insertions(+) create mode 100644 network/openswitch/__init__.py create mode 100644 network/openswitch/ops_template.py diff --git a/network/openswitch/__init__.py b/network/openswitch/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/network/openswitch/ops_template.py b/network/openswitch/ops_template.py new file mode 100644 index 00000000000..aba8fd5c113 --- /dev/null +++ b/network/openswitch/ops_template.py @@ -0,0 +1,293 @@ +#!/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: ops_config +verions_added: "2.1" +author: "Peter Sprygada (@privateip)" +short_description: Push configuration to OpenSwitch using declarative config +description: + - The OpenSwitch platform provides a library for pushing JSON structured + configuration files into the current running-config. This module + will read the current configuration from OpenSwitch and compare it + against a provided candidate configuration. If there are changes, the + candidate configuration is merged with the current configuration and + pushed into OpenSwitch +extends_documentation_fragment: openswitch +options: + src: + description: + - The path to the config source. The source can be either a + file with config or a template that will be merged during + runtime. By default the task will search for the source + file in role or playbook root folder in templates directory. + required: false + default: null + force: + description: + - The force argument instructs the module to not consider the + current devices running-config. When set to true, this will + cause the module to push the contents of I(src) into the device + without first checking if already configured. + required: false + default: false + choices: BOOLEANS + include_defaults: + description: + - The module, by default, will collect the current device + running-config to use as a base for comparision to the commands + in I(src). Setting this value to true will cause the module + to issue the command `show running-config all` to include all + device settings. + required: false + default: false + choices: BOOLEANS + backup: + description: + - When this argument is configured true, the module will backup + the running-config from the node prior to making any changes. + The backup file will be written to backup_{{ hostname }} in + the root of the playbook directory. + required: false + default: false + choices: BOOLEANS + ignore_missing: + description: + - This flag instructs the module to ignore lines that are missing + from the device configuration. In some instances, the config + command doesn't show up in the running-config because it is the + default. See examples for how this is used. + required: false + default: false + choices: BOOLEANS + replace: + description: + - This argument will cause the provided configuration to be replaced + on the destination node. The use of the replace argument will + always cause the task to set changed to true and will implies + I(force) is true. This argument is only valid with I(transport) + is eapi. + required: false + default: false + choice: BOOLEANS + config: + description: + - The module, by default, will connect to the remote device and + retrieve the current running-config to use as a base for comparing + against the contents of source. There are times when it is not + desirable to have the task get the current running-config for + every task in a playbook. The I(config) argument allows the + implementer to pass in the configuruation to use as the base + config for comparision. + required: false + default: null +""" + +EXAMPLES = """ +# Pushes the candidate configuraition to the device using a variable + +vars: + config: + System + hostname: ops01 + +tasks: + - ops_config: + src: "{{ config }}" + +# Reads the candidate configuration from a file + +tasks: + - ops_config: + src: "{{ lookup('file', 'ops_config.json') }}" +""" + +RETURN = """ +updates: + description: The list of configuration updates to be merged The format + of the return is 'key: new_value (old_value)' + retured: always + type: list + sample: ["System.hostname: ops01 (switch)"] +""" + +def compare(this, other, ignore_missing=False): + parents = [item.text for item in this.parents] + for entry in other: + if this == entry: + return None + if not ignore_missing: + return this + +def expand(obj, queue): + block = [item.raw for item in obj.parents] + block.append(obj.raw) + + current_level = queue + for b in block: + if b not in current_level: + current_level[b] = collections.OrderedDict() + current_level = current_level[b] + for c in obj.children: + if c.raw not in current_level: + current_level[c.raw] = collections.OrderedDict() + +def flatten(data, obj): + for k, v in data.items(): + obj.append(k) + flatten(v, obj) + return obj + +def get_config(module): + config = module.params['config'] or dict() + if not config and not module.params['force']: + config = module.config + return config + +def sort(val): + if isinstance(val, (list, set)): + return sorted(val) + return val + +def diff(this, other, path=None): + updates = list() + path = path or list() + for key, value in this.items(): + if key not in other: + other_value = other.get(key) + updates.append((list(path), key, value, other_value)) + else: + if isinstance(this[key], dict): + path.append(key) + updates.extend(diff(this[key], other[key], list(path))) + path.pop() + else: + other_value = other.get(key) + if sort(this[key]) != sort(other_value): + updates.append((list(path), key, value, other_value)) + return updates + +def merge(changeset, config=None): + config = config or dict() + for path, key, value, _ in changeset: + current_level = config + for part in path: + if part not in current_level: + current_level[part] = dict() + current_level = current_level[part] + current_level[key] = value + return config + +def main(): + """ main entry point for module execution + """ + + argument_spec = dict( + src=dict(), + force=dict(default=False, type='bool'), + backup=dict(default=False, type='bool'), + ignore_missing=dict(default=False, type='bool'), + config=dict(), + ) + + mutually_exclusive = [('config', 'backup'), ('config', 'force')] + + module = get_module(argument_spec=argument_spec, + mutually_exclusive=mutually_exclusive, + supports_check_mode=True) + + src = module.params['src'] + force = module.params['force'] + backup = module.params['backup'] + ignore_missing = module.params['ignore_missing'] + config = module.params['config'] + + result = dict(changed=False) + + if module.params['transport'] in ['ssh', 'rest']: + if isinstance(src, basestring): + src = module.from_json(src) + + if not force: + config = module.config + else: + config = dict() + + if backup: + result['_config'] = module.config + + changeset = diff(src, config) + candidate = merge(changeset, config) + + updates = list() + for path, key, new_value, old_value in changeset: + update = '%s.%s' % ('.'.join(path), key) + update += ': %s (%s)' % (new_value, old_value) + updates.append(update) + result['updates'] = updates + + if changeset: + if not module.check_mode: + module.configure(config) + result['changed'] = True + + else: + candidate = module.parse_config(module.params['src']) + + contents = get_config(module) + result['_config'] = module.config + + config = module.parse_config(contents) + + commands = collections.OrderedDict() + toplevel = [c.text for c in config] + + for line in candidate: + if line.text in ['!', '']: + continue + + if not line.parents: + if line.text not in toplevel: + expand(line, commands) + else: + item = compare(line, config, ignore_missing) + if item: + expand(item, commands) + + commands = flatten(commands, list()) + + if commands: + if not module.check_mode: + commands = [str(c).strip() for c in commands] + response = module.configure(commands) + result['changed'] = True + + result['commands'] = commands + + module.exit_json(**result) + +from ansible.module_utils.basic import * +from ansible.module_utils.urls import * +from ansible.module_utils.netcfg import * +from ansible.module_utils.shell import * +from ansible.module_utils.openswitch import * +if __name__ == '__main__': + main() + + +