mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
ACI ENCAP POOL RANGES: Add new module to support encap ranges (#33758)
* ACI ENCAP POOL RANGES: Add new module to support encap ranges * fix module name * remove extra format string
This commit is contained in:
Jacob McGill
Dag Wieers
parent
afa82be019
commit
3b941802ac
6 changed files with 728 additions and 0 deletions
304
lib/ansible/modules/network/aci/aci_encap_pool_range.py
Normal file
304
lib/ansible/modules/network/aci/aci_encap_pool_range.py
Normal file
|
|
@ -0,0 +1,304 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# 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: aci_encap_pool_range
|
||||
short_description: Manage encap ranges assigned to pools on Cisco ACI fabrics (fvns:EncapBlk, fvns:VsanEncapBlk)
|
||||
description:
|
||||
- Manage vlan, vxlan, and vsan ranges that are assigned to pools on Cisco ACI fabrics.
|
||||
- More information from the internal APIC class
|
||||
I(fvns:EncapBlk) and I(fvns:VsanEncapBlk) at U(https://developer.cisco.com/site/aci/docs/apis/apic-mim-ref/).
|
||||
author:
|
||||
- Jacob McGill (@jmcgill298)
|
||||
version_added: '2.5'
|
||||
requirements:
|
||||
- The C(pool) must exist in order to add or delete a range.
|
||||
options:
|
||||
allocation_mode:
|
||||
description:
|
||||
- The method used for allocating encaps to resources.
|
||||
- Only vlan and vsan support allocation modes.
|
||||
aliases: [ mode ]
|
||||
choices: [ dynamic, inherit, static]
|
||||
description:
|
||||
description:
|
||||
- Description for the pool range.
|
||||
aliases: [ descr ]
|
||||
pool:
|
||||
description:
|
||||
- The name of the pool that the range should be assigned to.
|
||||
aliases: [ pool_name ]
|
||||
pool_type:
|
||||
description:
|
||||
- The encap type of C(pool).
|
||||
required: yes
|
||||
aliases: [ type ]
|
||||
choices: [ vlan, vxlan, vsan]
|
||||
range_end:
|
||||
description:
|
||||
- The end of encap range.
|
||||
aliases: [ end ]
|
||||
range_name:
|
||||
description:
|
||||
- The name to give to the encap range.
|
||||
aliases: [ name, range ]
|
||||
range_start:
|
||||
description:
|
||||
- The start of the encap range.
|
||||
aliases: [ start ]
|
||||
state:
|
||||
description:
|
||||
- Use C(present) or C(absent) for adding or removing.
|
||||
- Use C(query) for listing an object or multiple objects.
|
||||
choices: [ absent, present, query ]
|
||||
default: present
|
||||
extends_documentation_fragment: aci
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Add a new vlan range
|
||||
aci_pool_to_range:
|
||||
hostname: apic
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
pool: production
|
||||
pool_type: vlan
|
||||
encap_start: 20
|
||||
encap_end: 50
|
||||
state: present
|
||||
|
||||
- name: Remove a vlan range
|
||||
aci_pool_to_range:
|
||||
hostname: apic
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
pool: production
|
||||
pool_type: vlan
|
||||
encap_start: 20
|
||||
encap_end: 50
|
||||
state: absent
|
||||
|
||||
- name: Query a vlan range
|
||||
aci_pool_to_range:
|
||||
hostname: apic
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
pool: production
|
||||
pool_type: vlan
|
||||
encap_start: 20
|
||||
encap_end: 50
|
||||
state: query
|
||||
|
||||
- name: Query a vlan pool for ranges
|
||||
aci_pool_to_range:
|
||||
hostname: apic
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
pool: production
|
||||
pool_type: vlan
|
||||
state: query
|
||||
|
||||
- name: Query all vlan ranges
|
||||
aci_pool_to_range:
|
||||
hostname: apic
|
||||
username: admin
|
||||
password: SomeSecretPassword
|
||||
pool_type: vlan
|
||||
state: query
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
#
|
||||
'''
|
||||
|
||||
from ansible.module_utils.network.aci.aci import ACIModule, aci_argument_spec
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
ACI_POOL_MAPPING = dict(
|
||||
vlan=dict(
|
||||
aci_class='fvnsVlanInstP',
|
||||
aci_mo='infra/vlanns-',
|
||||
),
|
||||
vxlan=dict(
|
||||
aci_class='fvnsVxlanInstP',
|
||||
aci_mo='infra/vxlanns-',
|
||||
),
|
||||
vsan=dict(
|
||||
aci_class='fvnsVsanInstP',
|
||||
aci_mo='infra/vsanns-',
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = aci_argument_spec
|
||||
argument_spec.update(
|
||||
allocation_mode=dict(type='str', aliases=['mode'], choices=['dynamic', 'inherit', 'static']),
|
||||
description=dict(type='str', aliases=['descr']),
|
||||
pool=dict(type='str', aliases=['pool_name']),
|
||||
pool_allocation_mode=dict(type='str', aliases=['pool_mode'], choices=['dynamic', 'static']),
|
||||
pool_type=dict(type='str', aliases=['type'], choices=['vlan', 'vxlan', 'vsan'], required=True),
|
||||
range_end=dict(type='int', aliases=['end']),
|
||||
range_name=dict(type='str', aliases=["name", "range"]),
|
||||
range_start=dict(type='int', aliases=["start"]),
|
||||
state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True,
|
||||
required_if=[
|
||||
['state', 'absent', ['pool', 'range_end', 'range_name', 'range_start']],
|
||||
['state', 'present', ['pool', 'range_end', 'range_name', 'range_start']],
|
||||
],
|
||||
)
|
||||
|
||||
allocation_mode = module.params['allocation_mode']
|
||||
description = module.params['description']
|
||||
pool = module.params['pool']
|
||||
pool_allocation_mode = module.params['pool_allocation_mode']
|
||||
pool_type = module.params['pool_type']
|
||||
range_end = module.params['range_end']
|
||||
range_name = module.params['range_name']
|
||||
range_start = module.params['range_start']
|
||||
state = module.params['state']
|
||||
|
||||
if range_end is not None:
|
||||
encap_end = '{0}-{1}'.format(pool_type, range_end)
|
||||
else:
|
||||
encap_end = None
|
||||
|
||||
if range_start is not None:
|
||||
encap_start = '{0}-{1}'.format(pool_type, range_start)
|
||||
else:
|
||||
encap_start = None
|
||||
|
||||
ACI_RANGE_MAPPING = dict(
|
||||
vlan=dict(
|
||||
aci_class='fvnsEncapBlk',
|
||||
aci_mo='from-[{0}]-to-[{1}]'.format(encap_start, encap_end),
|
||||
),
|
||||
vxlan=dict(
|
||||
aci_class='fvnsEncapBlk',
|
||||
aci_mo='from-[{0}]-to-[{1}]'.format(encap_start, encap_end),
|
||||
),
|
||||
vsan=dict(
|
||||
aci_class='fvnsVsanEncapBlk',
|
||||
aci_mo='vsanfrom-[{0}]-to-[{1}]'.format(encap_start, encap_end),
|
||||
),
|
||||
)
|
||||
|
||||
# Collect proper class and mo information based on pool_type
|
||||
aci_range_class = ACI_RANGE_MAPPING[pool_type]["aci_class"]
|
||||
aci_range_mo = ACI_RANGE_MAPPING[pool_type]["aci_mo"]
|
||||
aci_pool_class = ACI_POOL_MAPPING[pool_type]["aci_class"]
|
||||
aci_pool_mo = ACI_POOL_MAPPING[pool_type]["aci_mo"]
|
||||
pool_name = pool
|
||||
|
||||
# Validate range_end and range_start are valid for its respective encap type
|
||||
for encap_id in range_end, range_start:
|
||||
if encap_id is not None:
|
||||
if pool_type == 'vlan':
|
||||
if not 1 <= encap_id <= 4094:
|
||||
module.fail_json(msg='vlan pools must have "range_start" and "range_end" values between 1 and 4094')
|
||||
elif pool_type == 'vxlan':
|
||||
if not 5000 <= encap_id <= 16777215:
|
||||
module.fail_json(msg='vxlan pools must have "range_start" and "range_end" values between 5000 and 16777215')
|
||||
elif pool_type == 'vsan':
|
||||
if not 1 <= encap_id <= 4093:
|
||||
module.fail_json(msg='vsan pools must have "range_start" and "range_end" values between 1 and 4093')
|
||||
|
||||
# Build proper proper filter_target based on range_start, range_end, and range_name
|
||||
if range_end is not None and range_start is not None:
|
||||
# Validate range_start is less than range_end
|
||||
if range_start > range_end:
|
||||
module.fail_json(msg='The "range_start" must be less than or equal to the "range_end"')
|
||||
|
||||
if range_name is None:
|
||||
range_filter_target = 'and(eq({0}.from, "{1}"),eq({0}.to, "{2}"))'.format(aci_range_class, encap_start, encap_end)
|
||||
else:
|
||||
range_filter_target = 'and(eq({0}.from, "{1}"),eq({0}.to, "{2}"),eq({0}.name, "{3}"))'.format(aci_range_class, encap_start, encap_end, range_name)
|
||||
elif range_end is None and range_start is None:
|
||||
if range_name is None:
|
||||
# Reset range managed object to None for aci util to properly handle query
|
||||
aci_range_mo = None
|
||||
range_filter_target = ''
|
||||
else:
|
||||
range_filter_target = 'eq({0}.name, "{1}")'.format(aci_range_class, range_name)
|
||||
elif range_start is not None:
|
||||
if range_name is None:
|
||||
range_filter_target = 'eq({0}.from, "{1}")'.format(aci_range_class, encap_start)
|
||||
else:
|
||||
range_filter_target = 'and(eq({0}.from, "{1}"),eq({0}.name, "{2}"))'.format(aci_range_class, encap_start, range_name)
|
||||
else:
|
||||
if range_name is None:
|
||||
range_filter_target = 'eq({0}.to, "{1}")'.format(aci_range_class, encap_end)
|
||||
else:
|
||||
range_filter_target = 'and(eq({0}.to, "{1}"),eq({0}.name, "{2}"))'.format(aci_range_class, encap_end, range_name)
|
||||
|
||||
# Vxlan does not support setting the allocation mode
|
||||
if pool_type == 'vxlan' and allocation_mode is not None:
|
||||
module.fail_json(msg='vxlan pools do not support setting the "allocation_mode"; please omit this parameter for vxlan pools')
|
||||
|
||||
# ACI Pool URL requires the allocation mode for vlan and vsan pools (ex: uni/infra/vlanns-[poolname]-static)
|
||||
if pool_type != 'vxlan' and pool is not None:
|
||||
if pool_allocation_mode is not None:
|
||||
pool_name = '[{0}]-{1}'.format(pool, pool_allocation_mode)
|
||||
else:
|
||||
module.fail_json(msg='ACI requires the "pool_allocation_mode" for "pool_type" of "vlan" and "vsan" when the "pool" is provided')
|
||||
|
||||
aci = ACIModule(module)
|
||||
aci.construct_url(
|
||||
root_class=dict(
|
||||
aci_class=aci_pool_class,
|
||||
aci_rn='{0}{1}'.format(aci_pool_mo, pool_name),
|
||||
filter_target='eq({0}.name, "{1}")'.format(aci_pool_class, pool),
|
||||
module_object=pool,
|
||||
),
|
||||
subclass_1=dict(
|
||||
aci_class=aci_range_class,
|
||||
aci_rn='{0}'.format(aci_range_mo),
|
||||
filter_target=range_filter_target,
|
||||
module_object=aci_range_mo,
|
||||
),
|
||||
)
|
||||
|
||||
aci.get_existing()
|
||||
|
||||
if state == 'present':
|
||||
# Filter out module parameters with null values
|
||||
aci.payload(
|
||||
aci_class=aci_range_class,
|
||||
class_config={
|
||||
"allocMode": allocation_mode,
|
||||
"descr": description,
|
||||
"from": encap_start,
|
||||
"name": range_name,
|
||||
"to": encap_end,
|
||||
}
|
||||
)
|
||||
|
||||
# Generate config diff which will be used as POST request body
|
||||
aci.get_diff(aci_class=aci_range_class)
|
||||
|
||||
# Submit changes if module not in check_mode and the proposed is different than existing
|
||||
aci.post_config()
|
||||
|
||||
elif state == 'absent':
|
||||
aci.delete_config()
|
||||
|
||||
module.exit_json(**aci.result)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue