mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
mso_s_t_anp_epg: Manage EPGs in templates (#51275)
A new module to create EPGs in MSO schema templates.
This commit is contained in:
Dag Wieers
GitHub
parent
18ee119a40
commit
dfad17ad8a
1 changed files with 315 additions and 0 deletions
315
lib/ansible/modules/network/aci/mso_schema_template_anp_epg.py
Normal file
315
lib/ansible/modules/network/aci/mso_schema_template_anp_epg.py
Normal file
|
|
@ -0,0 +1,315 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright: (c) 2018, 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_template_anp_epg
|
||||
short_description: Manage Endpoint Groups (EPGs) in schema templates
|
||||
description:
|
||||
- Manage EPGs in schema templates 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
|
||||
template:
|
||||
description:
|
||||
- The name of the template to change.
|
||||
type: list
|
||||
anp:
|
||||
description:
|
||||
- The name of the ANP.
|
||||
type: str
|
||||
epg:
|
||||
description:
|
||||
- The name of the EPG to manage.
|
||||
type: str
|
||||
aliases: [ name ]
|
||||
display_name:
|
||||
description:
|
||||
- The name as displayed on the MSO web interface.
|
||||
type: str
|
||||
# contracts:
|
||||
# description:
|
||||
# - A list of contracts associated to this ANP.
|
||||
# type: list
|
||||
bd:
|
||||
description:
|
||||
- The BD associated to this ANP.
|
||||
type: dict
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- The name of the BD to associate with.
|
||||
required: true
|
||||
type: str
|
||||
schema:
|
||||
description:
|
||||
- The schema that defines the referenced BD.
|
||||
- If this parameter is unspecified, it defaults to the current schema.
|
||||
type: str
|
||||
template:
|
||||
description:
|
||||
- The template that defines the referenced BD.
|
||||
type: str
|
||||
subnets:
|
||||
description:
|
||||
- The subnets associated to this ANP.
|
||||
type: list
|
||||
suboptions:
|
||||
ip:
|
||||
description:
|
||||
- The IP range in CIDR notation.
|
||||
type: str
|
||||
required: true
|
||||
description:
|
||||
description:
|
||||
- The description of this subnet.
|
||||
type: str
|
||||
scope:
|
||||
description:
|
||||
- The scope of the subnet.
|
||||
type: str
|
||||
choices: [ private, public ]
|
||||
shared:
|
||||
description:
|
||||
- Whether this subnet is shared between VRFs.
|
||||
type: bool
|
||||
no_default_gateway:
|
||||
description:
|
||||
- Whether this subnet has a default gateway.
|
||||
type: bool
|
||||
useg_epg:
|
||||
description:
|
||||
- Whether this is a USEG EPG.
|
||||
type: bool
|
||||
# useg_epg_attributes:
|
||||
# description:
|
||||
# - A dictionary consisting of USEG attributes.
|
||||
# type: dict
|
||||
intra_epg_isolation:
|
||||
description:
|
||||
- Whether intra EPG isolation is enforced.
|
||||
- When not specified, this parameter defaults to C(unenforced).
|
||||
type: str
|
||||
choices: [ enforced, unenforced ]
|
||||
intersite_multicaste_source:
|
||||
description:
|
||||
- Whether intersite multicase source is enabled.
|
||||
- When not specified, this parameter defaults to C(no).
|
||||
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_template_anp
|
||||
- module: mso_schema_template_anp_epg_subnet
|
||||
- module: mso_schema_template_bd
|
||||
- module: mso_schema_template_contract
|
||||
extends_documentation_fragment: mso
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Add a new EPG
|
||||
mso_schema_template_anp_epg:
|
||||
host: mso_host
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
schema: Schema 1
|
||||
template: Template 1
|
||||
anp: ANP 1
|
||||
epg: EPG 1
|
||||
state: present
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Remove an EPG
|
||||
mso_schema_template_anp_epg:
|
||||
host: mso_host
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
schema: Schema 1
|
||||
template: Template 1
|
||||
anp: ANP 1
|
||||
epg: EPG 1
|
||||
state: absent
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Query a specific EPG
|
||||
mso_schema_template_anp_epg:
|
||||
host: mso_host
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
schema: Schema 1
|
||||
template: Template 1
|
||||
anp: ANP 1
|
||||
epg: EPG 1
|
||||
state: query
|
||||
delegate_to: localhost
|
||||
register: query_result
|
||||
|
||||
- name: Query all EPGs
|
||||
mso_schema_template_anp_epg:
|
||||
host: mso_host
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
schema: Schema 1
|
||||
template: Template 1
|
||||
anp: ANP 1
|
||||
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, mso_reference_spec, mso_subnet_spec, issubset
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = mso_argument_spec()
|
||||
argument_spec.update(
|
||||
schema=dict(type='str', required=True),
|
||||
template=dict(type='str', required=True),
|
||||
anp=dict(type='str', required=True),
|
||||
epg=dict(type='str', required=False, aliases=['name']), # This parameter is not required for querying all objects
|
||||
bd=dict(type='dict', options=mso_reference_spec()),
|
||||
display_name=dict(type='str'),
|
||||
useg_epg=dict(type='bool'),
|
||||
intra_epg_isolation=dict(type='str', choices=['enforced', 'unenforced']),
|
||||
intersite_multicaste_source=dict(type='bool'),
|
||||
subnets=dict(type='list', options=mso_subnet_spec()),
|
||||
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['schema']
|
||||
template = module.params['template']
|
||||
anp = module.params['anp']
|
||||
epg = module.params['epg']
|
||||
display_name = module.params['display_name']
|
||||
bd = module.params['bd']
|
||||
useg_epg = module.params['useg_epg']
|
||||
intra_epg_isolation = module.params['intra_epg_isolation']
|
||||
intersite_multicaste_source = module.params['intersite_multicaste_source']
|
||||
subnets = module.params['subnets']
|
||||
state = module.params['state']
|
||||
|
||||
mso = MSOModule(module)
|
||||
|
||||
# Get schema_id
|
||||
schema_obj = mso.get_obj('schemas', displayName=schema)
|
||||
if schema_obj:
|
||||
schema_id = schema_obj['id']
|
||||
else:
|
||||
mso.fail_json(msg="Provided schema '{0}' does not exist".format(schema))
|
||||
|
||||
path = 'schemas/{id}'.format(id=schema_id)
|
||||
|
||||
# Get template
|
||||
templates = [t['name'] for t in schema_obj['templates']]
|
||||
if template not in templates:
|
||||
mso.fail_json(msg="Provided template '{0}' does not exist. Existing templates: {1}".format(template, ', '.join(templates)))
|
||||
template_idx = templates.index(template)
|
||||
|
||||
# Get ANP
|
||||
anps = [a['name'] for a in schema_obj['templates'][template_idx]['anps']]
|
||||
if anp 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)
|
||||
|
||||
# Get EPG
|
||||
epgs = [e['name'] for e in schema_obj['templates'][template_idx]['anps'][anp_idx]['epgs']]
|
||||
if epg is not None and epg in epgs:
|
||||
epg_idx = epgs.index(epg)
|
||||
mso.existing = schema_obj['templates'][template_idx]['anps'][anp_idx]['epgs'][epg_idx]
|
||||
|
||||
if state == 'query':
|
||||
if epg is None:
|
||||
mso.existing = schema_obj['templates'][template_idx]['anps'][anp_idx]['epgs']
|
||||
elif not mso.existing:
|
||||
mso.fail_json(msg="EPG '{epg}' not found".format(epg=epg))
|
||||
mso.exit_json()
|
||||
|
||||
mso.previous = mso.existing
|
||||
if state == 'absent':
|
||||
if mso.existing:
|
||||
mso.sent = mso.existing = {}
|
||||
operation = [dict(
|
||||
op='remove',
|
||||
path='/templates/{template}/anps/{anp}/epgs/{epg}'.format(template=template, anp=anp, epg=epg),
|
||||
)]
|
||||
if not module.check_mode:
|
||||
mso.request(path, method='PATCH', data=operation)
|
||||
|
||||
elif state == 'present':
|
||||
bd_ref = mso.make_reference(bd, 'bd', schema_id, template)
|
||||
subnets = mso.make_subnets(subnets)
|
||||
|
||||
if display_name is None and not mso.existing:
|
||||
display_name = epg
|
||||
|
||||
payload = dict(
|
||||
name=epg,
|
||||
displayName=display_name,
|
||||
uSegEpg=useg_epg,
|
||||
intraEpg=intra_epg_isolation,
|
||||
proxyArp=intersite_multicaste_source,
|
||||
# FIXME: Missing functionality
|
||||
# uSegAttrs=[],
|
||||
# contractRelationships=[],
|
||||
subnets=subnets,
|
||||
bdRef=bd_ref,
|
||||
)
|
||||
|
||||
mso.sanitize(payload, collate=True)
|
||||
|
||||
if mso.existing:
|
||||
operation = [dict(
|
||||
op='replace',
|
||||
path='/templates/{template}/anps/{anp}/epgs/{epg}'.format(template=template, anp=anp, epg=epg),
|
||||
value=mso.sent,
|
||||
)]
|
||||
else:
|
||||
operation = [dict(
|
||||
op='add',
|
||||
path='/templates/{template}/anps/{anp}/epgs/-'.format(template=template, anp=anp),
|
||||
value=mso.sent,
|
||||
)]
|
||||
|
||||
mso.existing = mso.proposed
|
||||
if not module.check_mode:
|
||||
mso.request(path, method='PATCH', data=operation)
|
||||
|
||||
mso.exit_json()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Loading…
Reference in a new issue