From a289fcb8035d3e87a32c30401c94ee2e21376434 Mon Sep 17 00:00:00 2001 From: "sgerhart@gmail.com" Date: Thu, 8 Nov 2018 10:55:41 -0500 Subject: [PATCH] create aci_firmware_policy module --- .../network/aci/aci_firmware_policy.py | 245 ++++++++++++++++++ 1 file changed, 245 insertions(+) create mode 100644 lib/ansible/modules/network/aci/aci_firmware_policy.py diff --git a/lib/ansible/modules/network/aci/aci_firmware_policy.py b/lib/ansible/modules/network/aci/aci_firmware_policy.py new file mode 100644 index 0000000000..32fd724ab1 --- /dev/null +++ b/lib/ansible/modules/network/aci/aci_firmware_policy.py @@ -0,0 +1,245 @@ +#!/usr/bin/python + + +# 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 = ''' +--- +module: aci_firmware_policy + +short_description: This creates a firmware policy + +version_added: "2.8" + +description: + - This module creates a firmware policy for firmware groups. The firmware policy is create first and then + - referenced by the firmware group. You will assign the firmware and specify if you want to ignore the compatibility + - check +options: + name: + description: + - Name of the firmware policy + required: true + version: + description: + - The version of the firmware assoicated with this policy. This value is very import as well as constructing + - it correctly. The syntax for this field is n9000-xx.x. If you look at the firmware repository using the UI + - each version will have a "Full Version" column, this is the value you need to use. So, if the Full Version + - is 13.1(1i), the value for this field would be n9000-13.1(1i) + required: true + ignoreCompat: + description: + - Check if compatibility checks should be ignored + required: false + 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 + +author: + - Steven Gerhart (@sgerhart) +''' + +EXAMPLES = ''' + - name: firmware policy + aci_firmware_policy: + host: "{{ inventory_hostname }}" + username: "{{ user }}" + password: "{{ pass }}" + validate_certs: no + name: test2FrmPol + version: n9000-13.2(1m) + ignoreCompat: False + state: present + +''' + +RETURN = ''' +current: + description: The existing configuration from the APIC after the module has finished + returned: success + type: list + sample: + [ + { + "fvTenant": { + "attributes": { + "descr": "Production environment", + "dn": "uni/tn-production", + "name": "production", + "nameAlias": "", + "ownerKey": "", + "ownerTag": "" + } + } + } + ] +error: + description: The error information as returned from the APIC + returned: failure + type: dict + sample: + { + "code": "122", + "text": "unknown managed object class foo" + } +raw: + description: The raw output returned by the APIC REST API (xml or json) + returned: parse error + type: string + sample: '' +sent: + description: The actual/minimal configuration pushed to the APIC + returned: info + type: list + sample: + { + "fvTenant": { + "attributes": { + "descr": "Production environment" + } + } + } +previous: + description: The original configuration from the APIC before the module has started + returned: info + type: list + sample: + [ + { + "fvTenant": { + "attributes": { + "descr": "Production", + "dn": "uni/tn-production", + "name": "production", + "nameAlias": "", + "ownerKey": "", + "ownerTag": "" + } + } + } + ] +proposed: + description: The assembled configuration from the user-provided parameters + returned: info + type: dict + sample: + { + "fvTenant": { + "attributes": { + "descr": "Production environment", + "name": "production" + } + } + } +filter_string: + description: The filter string used for the request + returned: failure or debug + type: string + sample: ?rsp-prop-include=config-only +method: + description: The HTTP method used for the request to the APIC + returned: failure or debug + type: string + sample: POST +response: + description: The HTTP response from the APIC + returned: failure or debug + type: string + sample: OK (30 bytes) +status: + description: The HTTP status from the APIC + returned: failure or debug + type: int + sample: 200 +url: + description: The HTTP url used for the request to the APIC + returned: failure or debug + type: string + sample: https://10.11.12.13/api/mo/uni/tn-production.json +''' + + +from ansible.module_utils.network.aci.aci import ACIModule, aci_argument_spec +from ansible.module_utils.basic import AnsibleModule + + +def main(): + argument_spec = aci_argument_spec() + argument_spec.update( + name=dict(type='str', aliases=['name']), # Not required for querying all objects + version=dict(type='str', aliases=['version']), + ignoreCompat=dict(type=bool), + state=dict(type='str', default='present', choices=['absent', 'present', 'query']), + ) + + module = AnsibleModule( + argument_spec=argument_spec, + supports_check_mode=True, + required_if=[ + ['state', 'absent', ['name']], + ['state', 'present', ['name', 'version']], + ], + ) + + state = module.params['state'] + name = module.params['name'] + version = module.params['version'] + + if module.params['ignoreCompat']: + ignore = 'yes' + else: + ignore = 'no' + + aci = ACIModule(module) + aci.construct_url( + root_class=dict( + aci_class='firmwareFwP', + aci_rn='fabric/fwpol-{0}'.format(name), + target_filter={'name': name}, + module_object=name, + ), + + + ) + + aci.get_existing() + + if state == 'present': + aci.payload( + aci_class='firmwareFwP', + class_config=dict( + name=name, + version=version, + ignoreCompat=ignore, + ), + + ) + + aci.get_diff(aci_class='firmwareFwP') + + aci.post_config() + + elif state == 'absent': + aci.delete_config() + + aci.exit_json() + + +if __name__ == "__main__": + main()