ACI Subject Filter Binding: New Module (#28201)
* ACI Subject Filter Binding: New Module * add metadata * fix whitespace
This commit is contained in:
Jacob McGill
Dag Wieers
parent
f8d24b4111
commit
46956f0273
1 changed files with 141 additions and 0 deletions
141
lib/ansible/modules/network/aci/aci_subject_filter_binding.py
Normal file
141
lib/ansible/modules/network/aci/aci_subject_filter_binding.py
Normal file
|
|
@ -0,0 +1,141 @@
|
|||
#!/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_subject_filter_binding
|
||||
short_description: Manage filters belonging to contracts on Cisco ACI fabrics
|
||||
description:
|
||||
- Manage Contract Subject to Filter Bindings 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 C(tenant), C(contract), C(subject), and C(filter_name) must exist before using this module in your playbook.
|
||||
The M(aci_tenant), M(aci_contract), M(aci_contract_subject), and M(aci_filter) modules can be used for these.
|
||||
options:
|
||||
contract:
|
||||
description:
|
||||
- The name of the contract.
|
||||
aliases: [ contract_name ]
|
||||
filter_name:
|
||||
description:
|
||||
- The name of the Filter to bind to the Subject.
|
||||
log:
|
||||
description:
|
||||
- Determines if the binding should be set to log.
|
||||
- The APIC defaults new Subject to Filter bindings to a value of none.
|
||||
choices: [ log, none ]
|
||||
aliases: [ directive ]
|
||||
subject:
|
||||
description:
|
||||
- The name of the Contract Subject.
|
||||
aliases: [ subject_name ]
|
||||
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
|
||||
tenant:
|
||||
description:
|
||||
- The name of the tenant.
|
||||
required: yes
|
||||
aliases: [ tenant_name ]
|
||||
extends_documentation_fragment: aci
|
||||
'''
|
||||
|
||||
# FIXME: Add more, better examples
|
||||
EXAMPLES = r'''
|
||||
- aci_subject_bind_filter:
|
||||
hostname: '{{ inventory_hostname }}'
|
||||
username: '{{ username }}'
|
||||
password: '{{ password }}'
|
||||
tenant: '{{ tenant }}'
|
||||
contract: '{{ contract }}'
|
||||
subject: '{{ subject }}'
|
||||
filter_name: '{{ filter_name }}'
|
||||
log: '{{ log }}'
|
||||
'''
|
||||
|
||||
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(
|
||||
contract=dict(type='str', aliases=['contract_name']),
|
||||
filter_name=dict(type='str'),
|
||||
log=dict(tyep='str', choices=['log', 'none'], aliases=['directive']),
|
||||
subject=dict(type='str', aliases=['subject_name']),
|
||||
tenant=dict(type='str', aliases=['tenant_name']),
|
||||
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', ['contract', 'filter_name', 'subject', 'tenant']],
|
||||
['state', 'present', ['contract', 'filter_name', 'subject', 'tenant']]]
|
||||
)
|
||||
|
||||
# contract = module.params['contract']
|
||||
filter_name = module.params['filter_name']
|
||||
log = module.params['log']
|
||||
# subject = module.params['subject']
|
||||
# tenant = module.params['tenant']
|
||||
state = module.params['state']
|
||||
|
||||
# Convert log to empty string if none, as that is what API expects. An empty string is not a good option to present the user.
|
||||
if log == 'none':
|
||||
log = ''
|
||||
|
||||
# TODO: cleanup this logic and provide better filter_strings for all options
|
||||
if filter_name is not None:
|
||||
# Work with specific binding
|
||||
path = 'api/mo/uni/tn-%(tenant)s/brc-%(contract)s/subj-%(subject)s/rssubjFiltAtt-%(filter_name)s.json' % module.params
|
||||
else:
|
||||
path = 'api/class/vzRsSubjFiltAtt.json'
|
||||
|
||||
aci = ACIModule(module)
|
||||
|
||||
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='vzRsSubjFiltAtt', class_config=dict(tnVzFilterName=filter_name, directives=log))
|
||||
|
||||
# Generate config diff which will be used as POST request body
|
||||
aci.get_diff(aci_class='vzRsSubjFiltAtt')
|
||||
|
||||
# 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