new module: manage attachable entity profiles [network/aci/aci_aep] (#27987)

* New Cisco ACI Attachable Entity Profile Module

* PEP8 Verified

* Various Fixes

* Refactored: aci_aep

* Updated to the latest changes from aci-ansible

* And a small cosmetic change
pull/28255/head
schunduri 7 years ago committed by Dag Wieers
parent da3f8df20d
commit 83d9f2d9ed

@ -0,0 +1,132 @@
#!/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.0',
'status': ['preview'],
'supported_by': 'community'}
DOCUMENTATION = r'''
---
module: aci_aep
short_description: Manage Attachable Access Entity Profile on Cisco ACI fabrics
description:
- Connect to external virtual and physical domains by using Attachable Access Entity Profiles on Cisco ACI fabrics.
author:
- Swetha Chunduri (@schunduri)
- Dag Wieers (@dagwieers)
- Jacob McGill (@jmcgill298)
version_added: '2.4'
requirements:
- ACI Fabric 1.0(3f)+
options:
aep:
description:
- The name of the Attachable Access Entity Profile.
required: yes
aliases: [ aep_name, name ]
description:
description:
- Description for the AEP.
state:
description:
- Use C(present) or C(absent) for adding or removing.
- Use C(query) for listing an object or multiple objects.
default: present
choices: [ absent, present, query ]
extends_documentation_fragment: aci
'''
EXAMPLES = r'''
- name: Add a new AEP
aci_aep:
hostname: apic
username: admin
password: SomeSecretPassword
aep: ACI-AEP
description: default
state: present
- name: Remove an existing AEP
aci_aep:
hostname: apic
username: admin
password: SomeSecretPassword
aep: ACI-AEP
state: absent
- name: Query an AEP
aci_aep:
hostname: apic
username: admin
password: SomeSecretPassword
aep: ACI-AEP
state: query
- name: Query all AEPs
aci_aep:
hostname: apic
username: admin
password: SomeSecretPassword
state: query
'''
RETURN = r'''
#
'''
from ansible.module_utils.aci import ACIModule, aci_argument_spec
from ansible.module_utils.basic import AnsibleModule
def main():
argument_spec = aci_argument_spec
argument_spec.update(
aep=dict(type='str', aliases=['name', 'aep_name']), # not required for querying all AEPs
description=dict(type='str', aliases=['descr']),
state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
)
module = AnsibleModule(
argument_spec=argument_spec,
supports_check_mode=True,
)
aep = module.params['aep']
description = module.params['description']
state = module.params['state']
aci = ACIModule(module)
if aep is not None:
path = 'api/mo/uni/infra/attentp-%(aep)s.json' % module.params
elif state == 'query':
path = 'api/class/infraAttEntityP.json'
else:
module.fail_json(msg="Parameter 'aep' is required for state 'absent' or 'present'")
aci.result['url'] = '%(protocol)s://%(hostname)s/' % aci.params + path
aci.get_existing()
if state == 'present':
# Filter out module parameters with null values
aci.payload(aci_class='infraAttEntityP', class_config=dict(name=aep, descr=description))
# Generate config diff which will be used as POST request body
aci.get_diff(aci_class='infraAttEntityP')
# 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…
Cancel
Save