From b5e1f1bf18617a0c3db4760962e63f5a04b682f2 Mon Sep 17 00:00:00 2001 From: Dag Wieers Date: Mon, 4 Mar 2019 01:54:25 +0100 Subject: [PATCH] MSO: New module to manage local site BDs (#53248) This adds a new module to manage local site BDs on ACI MultiSite schema templates. --- .../modules/network/aci/mso_schema_site_bd.py | 225 ++++++++++++++++++ 1 file changed, 225 insertions(+) create mode 100644 lib/ansible/modules/network/aci/mso_schema_site_bd.py diff --git a/lib/ansible/modules/network/aci/mso_schema_site_bd.py b/lib/ansible/modules/network/aci/mso_schema_site_bd.py new file mode 100644 index 0000000000..f3df8b6b83 --- /dev/null +++ b/lib/ansible/modules/network/aci/mso_schema_site_bd.py @@ -0,0 +1,225 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# Copyright: (c) 2019, Dag Wieers (@dagwieers) +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +from __future__ import absolute_import, division, print_function +__metaclass__ = type + +ANSIBLE_METADATA = {'metadata_version': '1.1', + 'status': ['preview'], + 'supported_by': 'community'} + +DOCUMENTATION = r''' +--- +module: mso_schema_site_bd +short_description: Manage site Bridge Domains (BDs) in schema template +description: +- Manage site BDs in schema template on Cisco ACI Multi-Site. +author: +- Dag Wieers (@dagwieers) +version_added: '2.8' +options: + schema: + description: + - The name of the schema. + type: str + required: yes + site: + description: + - The name of the site. + type: str + required: yes + template: + description: + - The name of the template. + type: str + required: yes + bd: + description: + - The name of the BD to manage. + type: str + aliases: [ name ] + host_route: + description: + - Whether host-based routing is enabled. + type: bool + state: + description: + - Use C(present) or C(absent) for adding or removing. + - Use C(query) for listing an object or multiple objects. + type: str + choices: [ absent, present, query ] + default: present +seealso: +- module: mso_schema_site +- module: mso_schema_site_bd_l3out +- module: mso_schema_site_bd_subnet +- module: mso_schema_template_bd +extends_documentation_fragment: mso +''' + +EXAMPLES = r''' +- name: Add a new site BD + mso_schema_site_bd: + host: mso_host + username: admin + password: SomeSecretPassword + schema: Schema1 + site: Site1 + template: Template1 + bd: BD1 + state: present + delegate_to: localhost + +- name: Remove a site VRF + mso_schema_site_vrf: + host: mso_host + username: admin + password: SomeSecretPassword + schema: Schema1 + site: Site1 + template: Template1 + bd: BD1 + state: absent + delegate_to: localhost + +- name: Query a specific site VRF + mso_schema_site_vrf: + host: mso_host + username: admin + password: SomeSecretPassword + schema: Schema1 + site: Site1 + template: Template1 + bd: BD1 + state: query + delegate_to: localhost + register: query_result + +- name: Query all site VRFs + mso_schema_site_vrf: + host: mso_host + username: admin + password: SomeSecretPassword + schema: Schema1 + site: Site1 + template: Template1 + state: query + delegate_to: localhost + register: query_result +''' + +RETURN = r''' +''' + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.network.aci.mso import MSOModule, mso_argument_spec + + +def main(): + argument_spec = mso_argument_spec() + argument_spec.update( + schema=dict(type='str', required=True), + site=dict(type='str', required=True), + template=dict(type='str', required=True), + bd=dict(type='str', aliases=['name']), # This parameter is not required for querying all objects + host_route=dict(type='bool'), + state=dict(type='str', default='present', choices=['absent', 'present', 'query']), + ) + + module = AnsibleModule( + argument_spec=argument_spec, + supports_check_mode=True, + required_if=[ + ['state', 'absent', ['bd']], + ['state', 'present', ['bd']], + ], + ) + + schema = module.params['schema'] + site = module.params['site'] + template = module.params['template'] + bd = module.params['bd'] + host_route = module.params['host_route'] + state = module.params['state'] + + mso = MSOModule(module) + + # Get schema_id + schema_obj = mso.get_obj('schemas', displayName=schema) + if not schema_obj: + mso.fail_json(msg="Provided schema '{0}' does not exist".format(schema)) + + schema_path = 'schemas/{id}'.format(**schema_obj) + schema_id = schema_obj['id'] + + # Get site + site_id = mso.lookup_site(site) + + # Get site_idx + sites = [(s['siteId'], s['templateName']) for s in schema_obj['sites']] + if (site_id, template) not in sites: + mso.fail_json(msg="Provided site/template '{0}-{1}' does not exist. Existing sites/templates: {2}".format(site, template, ', '.join(sites))) + + # Schema-access uses indexes + site_idx = sites.index((site_id, template)) + # Path-based access uses site_id-template + site_template = '{0}-{1}'.format(site_id, template) + + # Get BD + bd_ref = mso.bd_ref(schema_id=schema_id, template=template, bd=bd) + bds = [v['bdRef'] for v in schema_obj['sites'][site_idx]['bds']] + if bd is not None and bd_ref in bds: + bd_idx = bds.index(bd_ref) + bd_path = '/sites/{0}/bds/{1}'.format(site_template, bd) + mso.existing = schema_obj['sites'][site_idx]['bds'][bd_idx] + + if state == 'query': + if bd is None: + mso.existing = schema_obj['sites'][site_idx]['bds'] + elif not mso.existing: + mso.fail_json(msg="BD '{bd}' not found".format(bd=bd)) + mso.exit_json() + + bds_path = '/sites/{0}/bds'.format(site_template) + ops = [] + + mso.previous = mso.existing + if state == 'absent': + if mso.existing: + mso.sent = mso.existing = {} + ops.append(dict(op='remove', path=bd_path)) + + elif state == 'present': + if not mso.existing: + if host_route is None: + host_route = False + + payload = dict( + bdRef=dict( + schemaId=schema_id, + templateName=template, + bdName=bd, + ), + hostBasedRouting=host_route, + ) + + mso.sanitize(payload, collate=True) + + if mso.existing: + ops.append(dict(op='replace', path=bd_path, value=mso.sent)) + else: + ops.append(dict(op='add', path=bds_path + '/-', value=mso.sent)) + + mso.existing = mso.proposed + + if not module.check_mode: + mso.request(schema_path, method='PATCH', data=ops) + + mso.exit_json() + + +if __name__ == "__main__": + main()