mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-07-06 09:00:58 +02:00
345 lines
9.9 KiB
Python
345 lines
9.9 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2017, Jacob McGill (jmcgill298)
|
|
# 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': 'certified'}
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: aci_vlan_pool_encap_block
|
|
short_description: Manage encap blocks assigned to VLAN pools (fvns:EncapBlk)
|
|
description:
|
|
- Manage VLAN encap blocks that are assigned to VLAN pools on Cisco ACI fabrics.
|
|
notes:
|
|
- The C(pool) must exist in order to add or delete a encap block.
|
|
- More information about the internal APIC class B(fvns:EncapBlk) from
|
|
L(the APIC Management Information Model reference,https://developer.cisco.com/docs/apic-mim-ref/).
|
|
author:
|
|
- Jacob McGill (@jmcgill298)
|
|
- Dag Wieers (@dagwieers)
|
|
version_added: '2.5'
|
|
options:
|
|
allocation_mode:
|
|
description:
|
|
- The method used for allocating encaps to resources.
|
|
aliases: [ mode ]
|
|
choices: [ dynamic, inherit, static]
|
|
description:
|
|
description:
|
|
- Description for the pool encap block.
|
|
aliases: [ descr ]
|
|
pool:
|
|
description:
|
|
- The name of the pool that the encap block should be assigned to.
|
|
aliases: [ pool_name ]
|
|
pool_allocation_mode:
|
|
description:
|
|
- The method used for allocating encaps to resources.
|
|
choices: [ dynamic, static]
|
|
aliases: [ pool_mode ]
|
|
block_end:
|
|
description:
|
|
- The end of encap block.
|
|
type: int
|
|
aliases: [ end ]
|
|
block_name:
|
|
description:
|
|
- The name to give to the encap block.
|
|
aliases: [ name ]
|
|
block_start:
|
|
description:
|
|
- The start of the encap block.
|
|
type: int
|
|
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 encap block
|
|
aci_vlan_pool_encap_block:
|
|
host: apic
|
|
username: admin
|
|
password: SomeSecretPassword
|
|
pool: production
|
|
block_start: 20
|
|
block_end: 50
|
|
state: present
|
|
delegate_to: localhost
|
|
|
|
- name: Remove a VLAN encap block
|
|
aci_vlan_pool_encap_block:
|
|
host: apic
|
|
username: admin
|
|
password: SomeSecretPassword
|
|
pool: production
|
|
block_start: 20
|
|
block_end: 50
|
|
state: absent
|
|
delegate_to: localhost
|
|
|
|
- name: Query a VLAN encap block
|
|
aci_vlan_pool_encap_block:
|
|
host: apic
|
|
username: admin
|
|
password: SomeSecretPassword
|
|
pool: production
|
|
block_start: 20
|
|
block_end: 50
|
|
state: query
|
|
delegate_to: localhost
|
|
register: query_result
|
|
|
|
- name: Query a VLAN pool for encap blocks
|
|
aci_vlan_pool_encap_block:
|
|
host: apic
|
|
username: admin
|
|
password: SomeSecretPassword
|
|
pool: production
|
|
state: query
|
|
delegate_to: localhost
|
|
register: query_result
|
|
|
|
- name: Query all VLAN encap blocks
|
|
aci_vlan_pool_encap_block:
|
|
host: apic
|
|
username: admin
|
|
password: SomeSecretPassword
|
|
state: query
|
|
delegate_to: localhost
|
|
register: query_result
|
|
'''
|
|
|
|
RETURN = r'''
|
|
current:
|
|
description: The existing configuration from the APIC after the module has finished
|
|
returned: success
|
|
type: list
|
|
sample:
|
|
[
|
|
{
|
|
"fvTenant": {
|
|
"attributes": {
|
|
"descr": "Production environment",
|
|
"dn": "uni/tn-production",
|
|
"name": "production",
|
|
"nameAlias": "",
|
|
"ownerKey": "",
|
|
"ownerTag": ""
|
|
}
|
|
}
|
|
}
|
|
]
|
|
error:
|
|
description: The error information as returned from the APIC
|
|
returned: failure
|
|
type: dict
|
|
sample:
|
|
{
|
|
"code": "122",
|
|
"text": "unknown managed object class foo"
|
|
}
|
|
raw:
|
|
description: The raw output returned by the APIC REST API (xml or json)
|
|
returned: parse error
|
|
type: string
|
|
sample: '<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>'
|
|
sent:
|
|
description: The actual/minimal configuration pushed to the APIC
|
|
returned: info
|
|
type: list
|
|
sample:
|
|
{
|
|
"fvTenant": {
|
|
"attributes": {
|
|
"descr": "Production environment"
|
|
}
|
|
}
|
|
}
|
|
previous:
|
|
description: The original configuration from the APIC before the module has started
|
|
returned: info
|
|
type: list
|
|
sample:
|
|
[
|
|
{
|
|
"fvTenant": {
|
|
"attributes": {
|
|
"descr": "Production",
|
|
"dn": "uni/tn-production",
|
|
"name": "production",
|
|
"nameAlias": "",
|
|
"ownerKey": "",
|
|
"ownerTag": ""
|
|
}
|
|
}
|
|
}
|
|
]
|
|
proposed:
|
|
description: The assembled configuration from the user-provided parameters
|
|
returned: info
|
|
type: dict
|
|
sample:
|
|
{
|
|
"fvTenant": {
|
|
"attributes": {
|
|
"descr": "Production environment",
|
|
"name": "production"
|
|
}
|
|
}
|
|
}
|
|
filter_string:
|
|
description: The filter string used for the request
|
|
returned: failure or debug
|
|
type: string
|
|
sample: ?rsp-prop-include=config-only
|
|
method:
|
|
description: The HTTP method used for the request to the APIC
|
|
returned: failure or debug
|
|
type: string
|
|
sample: POST
|
|
response:
|
|
description: The HTTP response from the APIC
|
|
returned: failure or debug
|
|
type: string
|
|
sample: OK (30 bytes)
|
|
status:
|
|
description: The HTTP status from the APIC
|
|
returned: failure or debug
|
|
type: int
|
|
sample: 200
|
|
url:
|
|
description: The HTTP url used for the request to the APIC
|
|
returned: failure or debug
|
|
type: string
|
|
sample: https://10.11.12.13/api/mo/uni/tn-production.json
|
|
'''
|
|
|
|
from ansible.module_utils.network.aci.aci import ACIModule, aci_argument_spec
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
|
|
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']), # Not required for querying all objects
|
|
pool_allocation_mode=dict(type='str', aliases=['pool_mode'], choices=['dynamic', 'static']),
|
|
block_name=dict(type='str', aliases=['name']), # Not required for querying all objects
|
|
block_end=dict(type='int', aliases=['end']), # Not required for querying all objects
|
|
block_start=dict(type='int', aliases=["start"]), # 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', ['pool', 'block_end', 'block_name', 'block_start']],
|
|
['state', 'present', ['pool', 'block_end', 'block_name', 'block_start']],
|
|
],
|
|
)
|
|
|
|
allocation_mode = module.params['allocation_mode']
|
|
description = module.params['description']
|
|
pool = module.params['pool']
|
|
pool_allocation_mode = module.params['pool_allocation_mode']
|
|
block_end = module.params['block_end']
|
|
block_name = module.params['block_name']
|
|
block_start = module.params['block_start']
|
|
state = module.params['state']
|
|
|
|
if block_end is not None:
|
|
encap_end = 'vlan-{0}'.format(block_end)
|
|
else:
|
|
encap_end = None
|
|
|
|
if block_start is not None:
|
|
encap_start = 'vlan-{0}'.format(block_start)
|
|
else:
|
|
encap_start = None
|
|
|
|
# Collect proper mo information
|
|
aci_block_mo = 'from-[{0}]-to-[{1}]'.format(encap_start, encap_end)
|
|
pool_name = pool
|
|
|
|
# Validate block_end and block_start are valid for its respective encap type
|
|
for encap_id in block_end, block_start:
|
|
if encap_id is not None:
|
|
if not 1 <= encap_id <= 4094:
|
|
module.fail_json(msg="vlan pools must have 'block_start' and 'block_end' values between 1 and 4094")
|
|
|
|
if block_end is not None and block_start is not None:
|
|
# Validate block_start is less than block_end
|
|
if block_start > block_end:
|
|
module.fail_json(msg="The 'block_start' must be less than or equal to the 'block_end'")
|
|
|
|
elif block_end is None and block_start is None:
|
|
if block_name is None:
|
|
# Reset range managed object to None for aci util to properly handle query
|
|
aci_block_mo = None
|
|
|
|
# ACI Pool URL requires the allocation mode (ex: uni/infra/vlanns-[poolname]-static)
|
|
if 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' when 'pool' is provided")
|
|
|
|
aci = ACIModule(module)
|
|
aci.construct_url(
|
|
root_class=dict(
|
|
aci_class='fvnsVlanInstP',
|
|
aci_rn='infra/vlanns-{0}'.format(pool_name),
|
|
module_object=pool,
|
|
target_filter={'name': pool},
|
|
),
|
|
subclass_1=dict(
|
|
aci_class='fvnsEncapBlk',
|
|
aci_rn=aci_block_mo,
|
|
module_object=aci_block_mo,
|
|
target_filter={'from': encap_start, 'to': encap_end, 'name': block_name},
|
|
),
|
|
)
|
|
|
|
aci.get_existing()
|
|
|
|
if state == 'present':
|
|
aci.payload(
|
|
aci_class='fvnsEncapBlk',
|
|
class_config={
|
|
"allocMode": allocation_mode,
|
|
"descr": description,
|
|
"from": encap_start,
|
|
"name": block_name,
|
|
"to": encap_end,
|
|
},
|
|
)
|
|
|
|
aci.get_diff(aci_class='fvnsEncapBlk')
|
|
|
|
aci.post_config()
|
|
|
|
elif state == 'absent':
|
|
aci.delete_config()
|
|
|
|
aci.exit_json()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|