mirror of https://github.com/ansible/ansible.git
added resources to associate domain to EPG (#60571)
Nirav Katarmal
5 years ago
committed by
Dag Wieers
parent
d77697e4d5
commit
dbd3ace53e
@ -0,0 +1,401 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright: (c) 2019, Nirav Katarmal (@nkatarmal-crest) <nirav.katarmal@crestdatasys.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_domain
|
||||
short_description: Manage site-local EPG domains in schema template
|
||||
description:
|
||||
- Manage site-local EPG domains in schema template on Cisco ACI Multi-Site.
|
||||
author:
|
||||
- Nirav Katarmal (@nkatarmal-crest)
|
||||
version_added: '2.9'
|
||||
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.
|
||||
type: str
|
||||
domain_association_type:
|
||||
description:
|
||||
- The type of domain to associate.
|
||||
type: str
|
||||
choices: [ vmmDomain, l3ExtDomain, l2ExtDomain, physicalDomain, fibreChannel ]
|
||||
domain_profile:
|
||||
description:
|
||||
- The domain profile name.
|
||||
type: str
|
||||
deployment_immediacy:
|
||||
description:
|
||||
- The deployment immediacy of the domain.
|
||||
- C(immediate) means B(Deploy immediate).
|
||||
- C(lazy) means B(deploy on demand).
|
||||
type: str
|
||||
choices: [ immediate, lazy ]
|
||||
resolution_immediacy:
|
||||
description:
|
||||
- Determines when the policies should be resolved and available.
|
||||
- Defaults to C(lazy) when unset during creation.
|
||||
type: str
|
||||
choices: [ immediate, lazy, pre-provision ]
|
||||
micro_seg_vlan_type:
|
||||
description:
|
||||
- Virtual LAN type for microsegmentation. This attribute can only be used with vmmDomain domain association.
|
||||
type: str
|
||||
micro_seg_vlan:
|
||||
description:
|
||||
- Virtual LAN for microsegmentation. This attribute can only be used with vmmDomain domain association.
|
||||
type: int
|
||||
port_encap_vlan_type:
|
||||
description:
|
||||
- Virtual LAN type for port encap. This attribute can only be used with vmmDomain domain association.
|
||||
type: str
|
||||
port_encap_vlan:
|
||||
description:
|
||||
- Virtual LAN type for port encap. This attribute can only be used with vmmDomain domain association.
|
||||
type: int
|
||||
vlan_encap_mode:
|
||||
description:
|
||||
- Which VLAN enacap mode to use. This attribute can only be used with vmmDomain domain association.
|
||||
type: str
|
||||
choices: [ static, dynamic ]
|
||||
allow_micro_segmentation:
|
||||
description:
|
||||
- Specifies microsegmentation is enabled or not. This attribute can only be used with vmmDomain domain association.
|
||||
type: bool
|
||||
switch_type:
|
||||
description:
|
||||
- Which switch type to use with this domain association. This attribute can only be used with vmmDomain domain association.
|
||||
type: str
|
||||
switching_mode:
|
||||
description:
|
||||
- Which switching mode to use with this domain association. This attribute can only be used with vmmDomain domain association.
|
||||
type: str
|
||||
enhanced_lagpolicy_name:
|
||||
description:
|
||||
- EPG enhanced lagpolicy name. This attribute can only be used with vmmDomain domain association.
|
||||
type: str
|
||||
enhanced_lagpolicy_dn:
|
||||
description:
|
||||
- Distingushied name of EPG lagpolicy. This attribute can only be used with vmmDomain domain association.
|
||||
type: str
|
||||
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
|
||||
notes:
|
||||
- The ACI MultiSite PATCH API has a deficiency requiring some objects to be referenced by index.
|
||||
This can cause silent corruption on concurrent access when changing/removing on object as
|
||||
the wrong object may be referenced. This module is affected by this deficiency.
|
||||
seealso:
|
||||
- module: mso_schema_site_anp_epg
|
||||
- module: mso_schema_template_anp_epg
|
||||
extends_documentation_fragment: mso
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Add a new static leaf to a site EPG
|
||||
mso_schema_template_anp_epg_domain:
|
||||
host: mso_host
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
schema: Schema1
|
||||
site: Site1
|
||||
template: Template1
|
||||
anp: ANP1
|
||||
epg: EPG1
|
||||
domain_association_type: vmmDomain
|
||||
domain_profile: 'VMware-VMM'
|
||||
deployment_immediacy: lazy
|
||||
resolution_immediacy: pre-provision
|
||||
state: present
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Remove a static leaf from a site EPG
|
||||
mso_schema_template_anp_epg_domain:
|
||||
host: mso_host
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
schema: Schema1
|
||||
site: Site1
|
||||
template: Template1
|
||||
anp: ANP1
|
||||
epg: EPG1
|
||||
domain_association_type: vmmDomain
|
||||
domain_profile: 'VMware-VMM'
|
||||
deployment_immediacy: lazy
|
||||
resolution_immediacy: pre-provision
|
||||
state: absent
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Query a specific site EPG static leaf
|
||||
mso_schema_template_anp_epg_domain:
|
||||
host: mso_host
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
schema: Schema1
|
||||
site: Site1
|
||||
template: Template1
|
||||
anp: ANP1
|
||||
epg: EPG1
|
||||
domain_association_type: vmmDomain
|
||||
domain_profile: 'VMware-VMM'
|
||||
state: query
|
||||
delegate_to: localhost
|
||||
register: query_result
|
||||
|
||||
- name: Query all site EPG static leafs
|
||||
mso_schema_template_anp_epg_domain:
|
||||
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
|
||||
'''
|
||||
|
||||
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),
|
||||
anp=dict(type='str', required=True),
|
||||
epg=dict(type='str', required=True),
|
||||
domain_association_type=dict(type='str', choices=['vmmDomain', 'l3ExtDomain', 'l2ExtDomain', 'physicalDomain', 'fibreChannel']),
|
||||
domain_profile=dict(type='str'),
|
||||
deployment_immediacy=dict(type='str', choices=['immediate', 'lazy']),
|
||||
resolution_immediacy=dict(type='str', choices=['immediate', 'lazy', 'pre-provision']),
|
||||
state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
|
||||
micro_seg_vlan_type=dict(type='str'),
|
||||
micro_seg_vlan=dict(type='int'),
|
||||
port_encap_vlan_type=dict(type='str'),
|
||||
port_encap_vlan=dict(type='int'),
|
||||
vlan_encap_mode=dict(type='str', choices=['static', 'dynamic']),
|
||||
allow_micro_segmentation=dict(type='bool'),
|
||||
switch_type=dict(type='str'),
|
||||
switching_mode=dict(type='str'),
|
||||
enhanced_lagpolicy_name=dict(type='str'),
|
||||
enhanced_lagpolicy_dn=dict(type='str'),
|
||||
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True,
|
||||
required_if=[
|
||||
['state', 'absent', ['domain_association_type', 'domain_profile', 'deployment_immediacy', 'resolution_immediacy']],
|
||||
['state', 'present', ['domain_association_type', 'domain_profile', 'deployment_immediacy', 'resolution_immediacy']],
|
||||
],
|
||||
)
|
||||
|
||||
schema = module.params['schema']
|
||||
site = module.params['site']
|
||||
template = module.params['template']
|
||||
anp = module.params['anp']
|
||||
epg = module.params['epg']
|
||||
domain_association_type = module.params['domain_association_type']
|
||||
domain_profile = module.params['domain_profile']
|
||||
deployment_immediacy = module.params['deployment_immediacy']
|
||||
resolution_immediacy = module.params['resolution_immediacy']
|
||||
state = module.params['state']
|
||||
micro_seg_vlan_type = module.params['micro_seg_vlan_type']
|
||||
micro_seg_vlan = module.params['micro_seg_vlan']
|
||||
port_encap_vlan_type = module.params['port_encap_vlan_type']
|
||||
port_encap_vlan = module.params['port_encap_vlan']
|
||||
vlan_encap_mode = module.params['vlan_encap_mode']
|
||||
allow_micro_segmentation = module.params['allow_micro_segmentation']
|
||||
switch_type = module.params['switch_type']
|
||||
switching_mode = module.params['switching_mode']
|
||||
enhanced_lagpolicy_name = module.params['enhanced_lagpolicy_name']
|
||||
enhanced_lagpolicy_dn = module.params['enhanced_lagpolicy_dn']
|
||||
|
||||
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 ANP
|
||||
anp_ref = mso.anp_ref(schema_id=schema_id, template=template, anp=anp)
|
||||
anps = [a['anpRef'] for a in schema_obj['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)
|
||||
print(epg_ref)
|
||||
epgs = [e['epgRef'] for e in schema_obj['sites'][site_idx]['anps'][anp_idx]['epgs']]
|
||||
if epg_ref not in epgs:
|
||||
mso.fail_json(msg="Provided epg '{0}' does not exist. Existing epgs: {1} epgref {2}".format(epg, str(schema_obj['sites'][site_idx]), epg_ref))
|
||||
epg_idx = epgs.index(epg_ref)
|
||||
|
||||
if domain_association_type == 'vmmDomain':
|
||||
domain_dn = 'uni/vmmp-VMware/dom-{0}'.format(domain_profile)
|
||||
elif domain_association_type == 'l3ExtDomain':
|
||||
domain_dn = 'uni/l3dom-{0}'.format(domain_profile)
|
||||
elif domain_association_type == 'l2ExtDomain':
|
||||
domain_dn = 'uni/l2dom-{0}'.format(domain_profile)
|
||||
elif domain_association_type == 'physicalDomain':
|
||||
domain_dn = 'uni/phys-{0}'.format(domain_profile)
|
||||
elif domain_association_type == 'fibreChannel':
|
||||
domain_dn = 'uni/fc-{0}'.format(domain_profile)
|
||||
else:
|
||||
domain_dn = ''
|
||||
|
||||
# Get Domains
|
||||
domains = [dom['dn'] for dom in schema_obj['sites'][site_idx]['anps'][anp_idx]['epgs'][epg_idx]['domainAssociations']]
|
||||
if domain_dn in domains:
|
||||
domain_idx = domains.index(domain_dn)
|
||||
domain_path = '/sites/{0}/anps/{1}/epgs/{2}/domainAssociations/{3}'.format(site_template, anp, epg, domain_idx)
|
||||
mso.existing = schema_obj['sites'][site_idx]['anps'][anp_idx]['epgs'][epg_idx]['domainAssociations'][domain_idx]
|
||||
|
||||
if state == 'query':
|
||||
if domain_association_type is None or domain_profile is None:
|
||||
mso.existing = schema_obj['sites'][site_idx]['anps'][anp_idx]['epgs'][epg_idx]['domainAssociations']
|
||||
elif not mso.existing:
|
||||
mso.fail_json(msg="Domain association '{domain_association_type}/{domain_profile}' not found".format(
|
||||
domain_association_type=domain_association_type,
|
||||
domain_profile=domain_profile))
|
||||
mso.exit_json()
|
||||
|
||||
domains_path = '/sites/{0}/anps/{1}/epgs/{2}/domainAssociations'.format(site_template, anp, epg)
|
||||
ops = []
|
||||
if domain_association_type == 'vmmDomain':
|
||||
vmmDomainProperties = {}
|
||||
if micro_seg_vlan_type and micro_seg_vlan:
|
||||
microSegVlan = dict(vlanType=micro_seg_vlan_type, vlan=micro_seg_vlan)
|
||||
vmmDomainProperties['microSegVlan'] = microSegVlan
|
||||
elif not micro_seg_vlan_type and micro_seg_vlan:
|
||||
mso.fail_json(msg="micro_seg_vlan_type is required when micro_seg_vlan is provied.")
|
||||
elif micro_seg_vlan_type and not micro_seg_vlan:
|
||||
mso.fail_json(msg="micro_seg_vlan is required when micro_seg_vlan_type is provided.")
|
||||
|
||||
if micro_seg_vlan_type and micro_seg_vlan:
|
||||
portEncapVlan = dict(vlanType=port_encap_vlan_type, vlan=port_encap_vlan)
|
||||
vmmDomainProperties['portEncapVlan'] = portEncapVlan
|
||||
elif not port_encap_vlan_type and port_encap_vlan:
|
||||
mso.fail_json(msg="port_encap_vlan_type is required when port_encap_vlan is provied.")
|
||||
elif port_encap_vlan_type and not port_encap_vlan:
|
||||
mso.fail_json(msg="port_encap_vlan is required when port_encap_vlan_type is provided.")
|
||||
|
||||
if vlan_encap_mode:
|
||||
vmmDomainProperties['vlanEncapMode'] = vlan_encap_mode
|
||||
|
||||
if allow_micro_segmentation:
|
||||
vmmDomainProperties['allowMicroSegmentation'] = allow_micro_segmentation
|
||||
if switch_type:
|
||||
vmmDomainProperties['switchType'] = switch_type
|
||||
if switching_mode:
|
||||
vmmDomainProperties['switchingMode'] = switching_mode
|
||||
|
||||
if enhanced_lagpolicy_name and enhanced_lagpolicy_dn:
|
||||
enhancedLagPol = dict(name=enhanced_lagpolicy_name, dn=enhanced_lagpolicy_dn)
|
||||
epgLagPol = dict(enhancedLagPol=enhancedLagPol)
|
||||
vmmDomainProperties['epgLagPol'] = epgLagPol
|
||||
elif not enhanced_lagpolicy_name and enhanced_lagpolicy_dn:
|
||||
mso.fail_json(msg="enhanced_lagpolicy_name is required when enhanced_lagpolicy_dn is provied.")
|
||||
elif enhanced_lagpolicy_name and not enhanced_lagpolicy_dn:
|
||||
mso.fail_json(msg="enhanced_lagpolicy_dn is required when enhanced_lagpolicy_name is provied.")
|
||||
|
||||
payload = dict(
|
||||
dn=domain_dn,
|
||||
domainType=domain_association_type,
|
||||
deploymentImmediacy=deployment_immediacy,
|
||||
resolutionImmediacy=resolution_immediacy,
|
||||
)
|
||||
|
||||
if vmmDomainProperties:
|
||||
payload['vmmDomainProperties'] = vmmDomainProperties
|
||||
else:
|
||||
payload = dict(
|
||||
dn=domain_dn,
|
||||
domainType=domain_association_type,
|
||||
deploymentImmediacy=deployment_immediacy,
|
||||
resolutionImmediacy=resolution_immediacy,
|
||||
)
|
||||
|
||||
mso.previous = mso.existing
|
||||
if state == 'absent':
|
||||
if mso.existing:
|
||||
mso.sent = mso.existing = {}
|
||||
ops.append(dict(op='remove', path=domains_path))
|
||||
elif state == 'present':
|
||||
mso.sanitize(payload, collate=True)
|
||||
|
||||
if mso.existing:
|
||||
ops.append(dict(op='replace', path=domain_path, value=mso.sent))
|
||||
else:
|
||||
ops.append(dict(op='add', path=domains_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()
|
||||
Loading…
Reference in New Issue