139 lines
3.5 KiB
Python
139 lines
3.5 KiB
Python
#!/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_tenant
|
|
short_description: Manage tenants on Cisco ACI fabrics (fv:Tenant)
|
|
description:
|
|
- Manage tenants on Cisco ACI fabrics.
|
|
- More information from the internal APIC class
|
|
I(fv:Tenant) at U(https://developer.cisco.com/media/mim-ref/MO-fvTenant.html).
|
|
author:
|
|
- Swetha Chunduri (@schunduri)
|
|
- Dag Wieers (@dagwieers)
|
|
- Jacob McGill (@jmcgill298)
|
|
version_added: '2.4'
|
|
requirements:
|
|
- ACI Fabric 1.0(3f)+
|
|
options:
|
|
tenant:
|
|
description:
|
|
- The name of the tenant.
|
|
required: yes
|
|
aliases: [ name, tenant_name ]
|
|
description:
|
|
description:
|
|
- Description for the tenant.
|
|
aliases: [ descr ]
|
|
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 tenant
|
|
aci_tenant:
|
|
hostname: apic
|
|
username: admin
|
|
password: SomeSecretPassword
|
|
tenant: production
|
|
description: Production tenant
|
|
state: present
|
|
|
|
- name: Remove a tenant
|
|
aci_tenant:
|
|
hostname: apic
|
|
username: admin
|
|
password: SomeSecretPassword
|
|
tenant: production
|
|
state: absent
|
|
|
|
- name: Query a tenant
|
|
aci_tenant:
|
|
hostname: apic
|
|
username: admin
|
|
password: SomeSecretPassword
|
|
tenant: production
|
|
state: query
|
|
|
|
- name: Query all tenants
|
|
aci_tenant:
|
|
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(
|
|
tenant=dict(type='str', required=False, aliases=['name', 'tenant_name']), # Not required for querying all objects
|
|
description=dict(type='str', aliases=['descr']),
|
|
state=dict(type='str', default='present', choices=['absent', 'present', 'query']),
|
|
method=dict(type='str', choices=['delete', 'get', 'post'], aliases=['action'], removed_in_version='2.6'), # Deprecated starting from v2.6
|
|
)
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=argument_spec,
|
|
supports_check_mode=True,
|
|
required_if=[
|
|
['state', 'absent', ['tenant']],
|
|
['state', 'present', ['tenant']],
|
|
],
|
|
)
|
|
|
|
tenant = module.params['tenant']
|
|
description = module.params['description']
|
|
state = module.params['state']
|
|
|
|
aci = ACIModule(module)
|
|
aci.construct_url(root_class="tenant")
|
|
aci.get_existing()
|
|
|
|
if state == 'present':
|
|
# Filter out module parameters with null values
|
|
aci.payload(
|
|
aci_class='fvTenant',
|
|
class_config=dict(
|
|
name=tenant,
|
|
descr=description,
|
|
),
|
|
)
|
|
|
|
# Generate config diff which will be used as POST request body
|
|
aci.get_diff(aci_class='fvTenant')
|
|
|
|
# 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()
|