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 2017-12-13 18:35:50 -05:00 committed by Dag Wieers
parent afa82be019
commit 3b941802ac
6 changed files with 728 additions and 0 deletions

View 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()

View file

@ -0,0 +1 @@
# No AcI Simulator yet, so not enabled

View file

@ -0,0 +1,18 @@
# Test code for the ACI modules
# Copyright 2017, Jacob McGill <jmcgill298
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
- name: test that we have an aci apic host, aci username and aci password
fail:
msg: 'Please define the following variables: aci_hostname, aci_username and aci_password.'
when: aci_hostname is not defined or aci_username is not defined or aci_password is not defined
- include_tasks: vlan.yml
when: "vlan is not defined or (vlan is defined and vlan == 'True')"
- include_tasks: vxlan.yml
when: "vxlan is not defined or (vxlan is defined and vxlan == 'True')"
- include_tasks: vsan.yml
when: "vsan is not defined or (vsan is defined and vsan == 'True')"

View file

@ -0,0 +1,372 @@
- name: ensure vlan pool exists for tests to kick off
aci_encap_pool:
host: "{{ aci_hostname }}"
username: "{{ aci_username }}"
password: "{{ aci_password }}"
validate_certs: no
state: absent
pool: anstest
pool_type: vlan
allocation_mode: static
description: Ansible Test
- name: ensure vlan pool exists for tests to kick off
aci_encap_pool: &aci_pool_present
host: "{{ aci_hostname }}"
username: "{{ aci_username }}"
password: "{{ aci_password }}"
validate_certs: no
state: present
pool: anstest
pool_type: vlan
allocation_mode: static
description: Ansible Test
register: pool_present
- name: create vlan pool range - check mode works
aci_encap_pool_range: &aci_range_present
<<: *aci_pool_present
range_name: anstest
range_start: 20
range_end: 40
pool: anstest
pool_allocation_mode: static
allocation_mode: inherit
description: Ansible Test
check_mode: yes
register: range_present_check_mode
- name: present assertions
assert:
that:
- range_present_check_mode.changed == true
- 'range_present_check_mode.config == {"fvnsEncapBlk": {"attributes": {"allocMode": "inherit", "descr": "Ansible Test", "from": "vlan-20", "name": "anstest", "to": "vlan-40"}}}'
- name: create vlan pool range - creation works
aci_encap_pool_range:
<<: *aci_range_present
register: range_present
- name: present assertions
assert:
that:
- range_present.changed == true
- range_present.existing == []
- range_present.config == range_present_check_mode.config
- range_present.config == range_present.proposed
- name: create vlan pool range - idempotency works
aci_encap_pool_range:
<<: *aci_range_present
register: range_present_idempotent
- name: present assertions
assert:
that:
- range_present_idempotent.changed == false
- 'range_present_idempotent.existing.0.fvnsEncapBlk.attributes.name == "anstest"'
- name: update vlan pool range - update works
aci_encap_pool_range:
<<: *aci_range_present
description: Ansible Test Update
allocation_mode: inherit
register: range_present_update
- name: present assertions
assert:
that:
- range_present_update.changed == true
- range_present_update.existing != []
- range_present_update.config != range_present.config
- name: create vlan pool range - used for query
aci_encap_pool_range: &aci_range_present_2
<<: *aci_range_present
range_name: anstest_2
range_start: 50
range_end: 55
register: range_present_2
- name: present assertions
assert:
that:
- range_present_2.changed == true
- range_present_2.existing == []
- name: invalid range_start - error message works
aci_encap_pool_range:
<<: *aci_range_present
range_start: 0
ignore_errors: yes
register: range_start_low
- name: present assertions
assert:
that:
- range_start_low.failed == true
- 'range_start_low.msg == "vlan pools must have \"range_start\" and \"range_end\" values between 1 and 4094"'
- name: invalid range_start - error message works
aci_encap_pool_range:
<<: *aci_range_present
range_start: 4096
ignore_errors: yes
register: range_start_high
- name: present assertions
assert:
that:
- range_start_high.failed == true
- 'range_start_high.msg == "vlan pools must have \"range_start\" and \"range_end\" values between 1 and 4094"'
- name: invalid range_end - error message works
aci_encap_pool_range:
<<: *aci_range_present
range_end: 0
ignore_errors: yes
register: range_end_low
- name: present assertions
assert:
that:
- range_end_low.failed == true
- 'range_end_low.msg == "vlan pools must have \"range_start\" and \"range_end\" values between 1 and 4094"'
- name: invalid range_end - error message works
aci_encap_pool_range:
<<: *aci_range_present
range_end: 4096
ignore_errors: yes
register: range_end_high
- name: present assertions
assert:
that:
- range_end_high.failed == true
- 'range_end_high.msg == "vlan pools must have \"range_start\" and \"range_end\" values between 1 and 4094"'
- name: range start higher than range end - error message works
aci_encap_pool_range:
<<: *aci_range_present
range_start: 1000
ignore_errors: yes
register: range_start_end
- name: present assertions
assert:
that:
- range_start_end.failed == true
- 'range_start_end.msg == "The \"range_start\" must be less than or equal to the \"range_end\""'
- name: missing required param - error message works
aci_encap_pool_range:
<<: *aci_range_present
pool_type: "{{ fake_var | default(omit) }}"
ignore_errors: yes
register: range_present_pool_type
- name: present assertions
assert:
that:
- range_present_pool_type.failed == true
- 'range_present_pool_type.msg == "missing required arguments: pool_type"'
- name: missing required param - error message works
aci_encap_pool_range:
<<: *aci_pool_present
ignore_errors: yes
register: range_present_missing_param
- name: present assertions
assert:
that:
- range_present_missing_param.failed == true
- 'range_present_missing_param.msg == "state is present but the following are missing: range_end,range_name,range_start"'
- name: missing required param - error message works
aci_encap_pool_range:
<<: *aci_range_present
pool_allocation_mode: "{{ fake_var | default(omit) }}"
ignore_errors: yes
register: range_present_allocation
- name: present assertions
assert:
that:
- range_present_allocation.failed == true
- 'range_present_allocation.msg == "ACI requires the \"pool_allocation_mode\" for \"pool_type\" of \"vlan\" and \"vsan\" when the \"pool\" is provided"'
- name: query specific vlan pool range
aci_encap_pool_range: &aci_range_query
<<: *aci_range_present
state: query
register: range_query
- name: query assertions
assert:
that:
- range_query.changed == false
- range_query.url.endswith("infra/vlanns-[anstest]-static/from-[vlan-20]-to-[vlan-40].json")
- range_query.existing | length == 1
- 'range_query.existing.0.fvnsEncapBlk.attributes.name == "anstest"'
- name: query vlan pool range - from, to, and name are filtered
aci_encap_pool_range: &aci_range_query_filter
<<: *aci_range_query
pool: "{{ fake_var | default(omit) }}"
register: range_query_from_to_name
- name: query assertions
assert:
that:
- range_query_from_to_name.changed == false
- 'range_query_from_to_name.url.endswith("class/fvnsEncapBlk.json")'
- '"query-target-filter=and(eq(fvnsEncapBlk.from, \"vlan-20\"),eq(fvnsEncapBlk.to, \"vlan-40\"),eq(fvnsEncapBlk.name, \"anstest\"))" in range_query_from_to_name.filter_string'
- 'range_query_from_to_name.existing.0.fvnsEncapBlk.attributes.name == "anstest"'
- 'range_query_from_to_name.existing.0.fvnsEncapBlk.attributes.from == "vlan-20"'
- 'range_query_from_to_name.existing.0.fvnsEncapBlk.attributes.to == "vlan-40"'
- name: query vlan pool range - from and name are filtered
aci_encap_pool_range:
<<: *aci_range_query_filter
range_end: "{{ fake_var | default(omit) }}"
register: range_query_from_name
- name: query assertions
assert:
that:
- range_query_from_name.changed == false
- 'range_query_from_name.url.endswith("class/fvnsEncapBlk.json")'
- '"query-target-filter=and(eq(fvnsEncapBlk.from, \"vlan-20\"),eq(fvnsEncapBlk.name, \"anstest\"))" in range_query_from_name.filter_string'
- 'range_query_from_name.existing.0.fvnsEncapBlk.attributes.name == "anstest"'
- 'range_query_from_name.existing.0.fvnsEncapBlk.attributes.from == "vlan-20"'
- name: query vlan pool range - to and name are filtered
aci_encap_pool_range:
<<: *aci_range_query_filter
range_start: "{{ fake_var | default(omit) }}"
register: range_query_to_name
- name: query assertions
assert:
that:
- range_query_to_name.changed == false
- 'range_query_to_name.url.endswith("class/fvnsEncapBlk.json")'
- '"query-target-filter=and(eq(fvnsEncapBlk.to, \"vlan-40\"),eq(fvnsEncapBlk.name, \"anstest\"))" in range_query_to_name.filter_string'
- 'range_query_to_name.existing.0.fvnsEncapBlk.attributes.name == "anstest"'
- 'range_query_to_name.existing.0.fvnsEncapBlk.attributes.to == "vlan-40"'
- name: query vlan pool range - name is filtered
aci_encap_pool_range:
<<: *aci_range_query_filter
range_start: "{{ fake_var | default(omit) }}"
range_end: "{{ fake_var | default(omit) }}"
register: range_query_name
- name: query assertions
assert:
that:
- range_query_name.changed == false
- 'range_query_name.url.endswith("class/fvnsEncapBlk.json")'
- '"query-target-filter=eq(fvnsEncapBlk.name, \"anstest\")" in range_query_name.filter_string'
- 'range_query_name.existing.0.fvnsEncapBlk.attributes.name == "anstest"'
- name: query vlan pool range - from and to are filtered
aci_encap_pool_range:
<<: *aci_range_query_filter
range_name: "{{ fake_var | default(omit) }}"
register: range_query_from_to
- name: query assertions
assert:
that:
- range_query_from_to.changed == false
- 'range_query_from_to.url.endswith("class/fvnsEncapBlk.json")'
- '"query-target-filter=and(eq(fvnsEncapBlk.from, \"vlan-20\"),eq(fvnsEncapBlk.to, \"vlan-40\"))" in range_query_from_to.filter_string'
- 'range_query_from_to.existing.0.fvnsEncapBlk.attributes.from == "vlan-20"'
- 'range_query_from_to.existing.0.fvnsEncapBlk.attributes.to == "vlan-40"'
- name: query all ranges in a vlan pool
aci_encap_pool_range:
<<: *aci_pool_present
state: query
pool_allocation_mode: static
register: range_query_pool
- name: query assertions
assert:
that:
- range_query_pool.existing | length == 1
- 'range_query_pool.existing.0.fvnsVlanInstP.attributes.name == "anstest"'
- range_query_pool.existing.0.fvnsVlanInstP.children | length > 1
- 'range_query_pool.url.endswith("infra/vlanns-[anstest]-static.json")'
- name: query all ranges
aci_encap_pool_range:
<<: *aci_pool_present
state: query
pool: "{{ fake_var | default(omit) }}"
register: range_query_all
- name: query assertions
assert:
that:
- range_query_all.changed == false
- range_query_all.existing | length > 1
- range_query_all.existing.0.fvnsEncapBlk is defined
- 'range_query_all.url.endswith("class/fvnsEncapBlk.json")'
- name: delete vlan pool range - deletion works
aci_encap_pool_range:
<<: *aci_range_present
state: absent
register: delete_range
- name: absent assertions
assert:
that:
- delete_range.changed == true
- delete_range.proposed == {}
- 'delete_range.existing.0.fvnsEncapBlk.attributes.name == "anstest"'
- name: delete vlan pool range - check mode works
aci_encap_pool_range: &aci_range_absent
<<: *aci_range_present_2
state: absent
check_mode: yes
register: delete_check_mode
- name: absent assertions
assert:
that:
- delete_check_mode.changed == true
- delete_check_mode.existing != []
- name: delete vlan pool range - deletion works
aci_encap_pool_range:
<<: *aci_range_absent
register: delete_range_2
- name: absent assertions
assert:
that:
- delete_range_2.changed == true
- delete_range_2.existing == delete_check_mode.existing
- name: delete vlan pool range again - idempotency works
aci_encap_pool_range:
<<: *aci_range_absent
register: delete_idempotent
- name: absent assertions
assert:
that:
- delete_idempotent.changed == false
- delete_idempotent.existing == []
- name: cleanup vlan pool
aci_encap_pool:
<<: *aci_pool_present
state: absent
when: pool_present.changed == true

View file

@ -0,0 +1,17 @@
- name: ensure vsan pool exists for tests to kick off
aci_encap_pool: &aci_pool_present
host: "{{ aci_hostname }}"
username: "{{ aci_username }}"
password: "{{ aci_password }}"
validate_certs: no
state: present
pool: anstest
pool_type: vsan
allocation_mode: static
description: Ansible Test
- name: cleanup vsan pool
aci_encap_pool:
<<: *aci_pool_present
state: absent
when: pool_present.changed == true

View file

@ -0,0 +1,16 @@
- name: ensure vxlan pool exists for tests to kick off
aci_encap_pool: &aci_pool_present
host: "{{ aci_hostname }}"
username: "{{ aci_username }}"
password: "{{ aci_password }}"
validate_certs: no
state: present
pool: anstest
pool_type: vxlan
description: Ansible Test
- name: cleanup vxlan pool
aci_encap_pool:
<<: *aci_pool_present
state: absent
when: pool_present.changed == true