summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/network/aci/mso_schema_site_anp_epg.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/modules/network/aci/mso_schema_site_anp_epg.py')
-rw-r--r--lib/ansible/modules/network/aci/mso_schema_site_anp_epg.py228
1 files changed, 0 insertions, 228 deletions
diff --git a/lib/ansible/modules/network/aci/mso_schema_site_anp_epg.py b/lib/ansible/modules/network/aci/mso_schema_site_anp_epg.py
deleted file mode 100644
index 5128f833df..0000000000
--- a/lib/ansible/modules/network/aci/mso_schema_site_anp_epg.py
+++ /dev/null
@@ -1,228 +0,0 @@
-#!/usr/bin/python
-# -*- coding: utf-8 -*-
-
-# Copyright: (c) 2019, Dag Wieers (@dagwieers) <dag@wieers.com>
-# 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_anp_epg
-short_description: Manage site-local Endpoint Groups (EPGs) in schema template
-description:
-- Manage site-local EPGs 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
- anp:
- description:
- - The name of the ANP.
- type: str
- epg:
- description:
- - The name of the EPG to manage.
- type: str
- aliases: [ name ]
- 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_anp
-- module: mso_schema_site_anp_epg_subnet
-- module: mso_schema_template_anp_epg
-extends_documentation_fragment: mso
-'''
-
-EXAMPLES = r'''
-- name: Add a new site EPG
- mso_schema_site_anp_epg:
- host: mso_host
- username: admin
- password: SomeSecretPassword
- schema: Schema1
- site: Site1
- template: Template1
- anp: ANP1
- epg: EPG1
- state: present
- delegate_to: localhost
-
-- name: Remove a site EPG
- mso_schema_site_anp_epg:
- host: mso_host
- username: admin
- password: SomeSecretPassword
- schema: Schema1
- site: Site1
- template: Template1
- anp: ANP1
- epg: EPG1
- state: absent
- delegate_to: localhost
-
-- name: Query a specific site EPGs
- mso_schema_site_anp_epg:
- host: mso_host
- username: admin
- password: SomeSecretPassword
- schema: Schema1
- site: Site1
- template: Template1
- anp: ANP1
- epg: EPG1
- state: query
- delegate_to: localhost
- register: query_result
-
-- name: Query all site EPGs
- mso_schema_site_anp_epg:
- host: mso_host
- username: admin
- password: SomeSecretPassword
- schema: Schema1
- site: Site1
- template: Template1
- anp: ANP1
- 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, issubset
-
-
-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),
- anp=dict(type='str', required=True),
- epg=dict(type='str', aliases=['name']), # This parameter is not required for querying all objects
- state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
- )
-
- module = AnsibleModule(
- argument_spec=argument_spec,
- supports_check_mode=True,
- required_if=[
- ['state', 'absent', ['epg']],
- ['state', 'present', ['epg']],
- ],
- )
-
- schema = module.params.get('schema')
- site = module.params.get('site')
- template = module.params.get('template')
- anp = module.params.get('anp')
- epg = module.params.get('epg')
- state = module.params.get('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.get('id')
-
- # Get site
- site_id = mso.lookup_site(site)
- sites = [(s.get('siteId'), s.get('templateName')) for s in schema_obj.get('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 ANP
- anp_ref = mso.anp_ref(schema_id=schema_id, template=template, anp=anp)
- anps = [a.get('anpRef') for a in schema_obj.get('sites')[site_idx]['anps']]
- if anp_ref not in anps:
- mso.fail_json(msg="Provided anp '{0}' does not exist. Existing anps: {1}".format(anp, ', '.join(anps)))
- anp_idx = anps.index(anp_ref)
-
- # Get EPG
- epg_ref = mso.epg_ref(schema_id=schema_id, template=template, anp=anp, epg=epg)
- epgs = [e.get('epgRef') for e in schema_obj.get('sites')[site_idx]['anps'][anp_idx]['epgs']]
- if epg is not None and epg_ref in epgs:
- epg_idx = epgs.index(epg_ref)
- epg_path = '/sites/{0}/anps/{1}/epgs/{2}'.format(site_template, anp, epg)
- mso.existing = schema_obj.get('sites')[site_idx]['anps'][anp_idx]['epgs'][epg_idx]
-
- if state == 'query':
- if epg is None:
- mso.existing = schema_obj.get('sites')[site_idx]['anps'][anp_idx]['epgs']
- elif not mso.existing:
- mso.fail_json(msg="EPG '{epg}' not found".format(epg=epg))
- mso.exit_json()
-
- epgs_path = '/sites/{0}/anps/{1}/epgs'.format(site_template, anp)
- ops = []
-
- mso.previous = mso.existing
- if state == 'absent':
- if mso.existing:
- mso.sent = mso.existing = {}
- ops.append(dict(op='remove', path=epg_path))
-
- elif state == 'present':
-
- payload = dict(
- epgRef=dict(
- schemaId=schema_id,
- templateName=template,
- anpName=anp,
- epgName=epg,
- ),
- )
-
- mso.sanitize(payload, collate=True)
-
- if not mso.existing:
- ops.append(dict(op='add', path=epgs_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()