aci_taboo_contract: Manage taboo contracts (#28144)
Manage taboo contracts on Cisco ACI fabrics. This module is idempotent, and supports check-mode and has diff-support.
This commit is contained in:
parent
42d8a9ea89
commit
9b05195a04
1 changed files with 130 additions and 0 deletions
130
lib/ansible/modules/network/aci/aci_taboo_contract.py
Normal file
130
lib/ansible/modules/network/aci/aci_taboo_contract.py
Normal file
|
@ -0,0 +1,130 @@
|
|||
#!/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_taboo_contract
|
||||
short_description: Manage taboo contracts on Cisco ACI fabrics
|
||||
description:
|
||||
- Manage taboo contracts on Cisco ACI fabrics.
|
||||
author:
|
||||
- Swetha Chunduri (@schunduri)
|
||||
- Dag Wieers (@dagwieers)
|
||||
- Jacob McGill (@jmcgill298)
|
||||
version_added: '2.4'
|
||||
requirements:
|
||||
- ACI Fabric 1.0(3f)+
|
||||
notes:
|
||||
- The tenant used must exist before using this module in your playbook. The M(aci_tenant) module can be used for this.
|
||||
options:
|
||||
taboo_contract:
|
||||
description:
|
||||
- Taboo Contract name.
|
||||
required: yes
|
||||
aliases: [ name ]
|
||||
description:
|
||||
description:
|
||||
- Description for the filter.
|
||||
aliases: [ descr ]
|
||||
tenant:
|
||||
description:
|
||||
- The name of the tenant.
|
||||
required: yes
|
||||
aliases: [ tenant_name ]
|
||||
scope:
|
||||
description:
|
||||
- The scope of a service contract.
|
||||
- The APIC defaults new Taboo Contracts to a scope of context (VRF).
|
||||
choices: [ application-profile, context, global, tenant ]
|
||||
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
|
||||
'''
|
||||
|
||||
# FIXME: Add more, better examples
|
||||
EXAMPLES = r'''
|
||||
- aci_taboo_contract:
|
||||
hostname: '{{ inventory_hostname }}'
|
||||
username: '{{ username }}'
|
||||
password: '{{ password }}'
|
||||
taboo_contract: '{{ taboo_contract }}'
|
||||
description: '{{ descr }}'
|
||||
tenant: '{{ tenant }}'
|
||||
'''
|
||||
|
||||
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(
|
||||
taboo_contract=dict(type='str', required=False, aliases=['name']), # Not required for querying all contracts
|
||||
tenant=dict(type='str', required=False, aliases=['tenant_name']), # Not required for querying all contracts
|
||||
scope=dict(type='str', choices=['application-profile', 'context', 'global', 'tenant']),
|
||||
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,
|
||||
)
|
||||
|
||||
taboo_contract = module.params['taboo_contract']
|
||||
# tenant = module.params['tenant']
|
||||
description = module.params['description']
|
||||
scope = module.params['scope']
|
||||
state = module.params['state']
|
||||
|
||||
aci = ACIModule(module)
|
||||
|
||||
# TODO: This logic could be cleaner.
|
||||
if taboo_contract is not None:
|
||||
path = 'api/mo/uni/tn-%(tenant)s/taboo-%(taboo_contract)s.json' % module.params
|
||||
elif state == 'query':
|
||||
# Query all objects
|
||||
path = 'api/node/class/vzTaboo.json'
|
||||
else:
|
||||
module.fail_json(msg="Parameter 'taboo_contract' 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='vzBrCP', class_config=dict(name=taboo_contract, descr=description, scope=scope))
|
||||
|
||||
# Generate config diff which will be used as POST request body
|
||||
aci.get_diff(aci_class='vzBrCP')
|
||||
|
||||
# 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…
Reference in a new issue