From fdfb4f736d6157c46e20f569f626738a31b1bb05 Mon Sep 17 00:00:00 2001 From: Dag Wieers Date: Tue, 15 Aug 2017 03:12:20 +0200 Subject: [PATCH] new module: manage LLDP interface policies [network/aci/aci_lldp_policy] (#28099) * aci_lldp_interface_policy: Manage LLDP interface policies Module to manage LLDP interface policies on Cisco ACI fabrics. This module is idempotent, and supports check-mode and has diff-support. * Rename aci_lldp_interface_policy to aci_lldp_policy --- .../modules/network/aci/aci_lldp_policy.py | 130 ++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100644 lib/ansible/modules/network/aci/aci_lldp_policy.py diff --git a/lib/ansible/modules/network/aci/aci_lldp_policy.py b/lib/ansible/modules/network/aci/aci_lldp_policy.py new file mode 100644 index 0000000000..76e7df1d9f --- /dev/null +++ b/lib/ansible/modules/network/aci/aci_lldp_policy.py @@ -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_lldp_policy +short_description: Manage LLDP interface policies on Cisco ACI fabrics +description: +- Manage LLDP interface policies 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: + lldp_policy: + description: + - The LLDP interface policy name. + required: yes + aliases: [ name ] + description: + description: + - Description for the filter. + aliases: [ descr ] + receive_state: + description: + - Enable or disable Receive state (FIXME!) + required: yes + choices: [ disabled, enabled ] + default: enabled + transmit_state: + description: + - Enable or Disable Transmit state (FIXME!) + required: false + choices: [ disabled, enabled ] + default: enabled + 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 +''' + +# FIXME: Add more, better examples +EXAMPLES = r''' +- aci_lldp_policy: + hostname: '{{ hostname }}' + username: '{{ username }}' + password: '{{ password }}' + lldp_policy: '{{ lldp_policy }}' + description: '{{ description }}' + receive_state: '{{ receive_state }}' + transmit_state: '{{ transmit_state }}' +''' + +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( + lldp_policy=dict(type='str', require=False, aliases=['name']), + description=dict(type='str', aliases=['descr']), + receive_state=dict(type='str', choices=['disabled', 'enabled']), + transmit_state=dict(type='str', choices=['disabled', 'enabled']), + 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, + ) + + lldp_policy = module.params['lldp_policy'] + description = module.params['description'] + receive_state = module.params['receive_state'] + transmit_state = module.params['transmit_state'] + state = module.params['state'] + + aci = ACIModule(module) + + if lldp_policy is not None: + # Work with a specific object + path = 'api/mo/uni/infra/lldpIfP-%(lldp_policy)s.json' % module.params + elif state == 'query': + # Query all objects + path = 'api/node/class/lldpIfPol.json' + else: + module.fail_json(msg="Parameter 'lldp_policy' 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='lldpIfPol', class_config=dict(name=lldp_policy, descr=description, adminRxSt=receive_state, adminTxSt=transmit_state)) + + # Generate config diff which will be used as POST request body + aci.get_diff(aci_class='lldpIfPol') + + # 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()