From 615df814f174d78de83ee7bcce1660a73b51adba Mon Sep 17 00:00:00 2001 From: Damien Date: Fri, 17 Feb 2017 17:26:21 -0800 Subject: [PATCH] New Module : aos_logical_device as part of network/aos (#21226) * Add new module aos_logical_device * Add hard stop to documentation * Removed required false from documentation * Add comment before sleep * Replace IP Pool by Logical Device in the doc --- .../modules/network/aos/aos_logical_device.py | 251 ++++++++++++++++++ 1 file changed, 251 insertions(+) create mode 100644 lib/ansible/modules/network/aos/aos_logical_device.py diff --git a/lib/ansible/modules/network/aos/aos_logical_device.py b/lib/ansible/modules/network/aos/aos_logical_device.py new file mode 100644 index 00000000000..24d6ed13580 --- /dev/null +++ b/lib/ansible/modules/network/aos/aos_logical_device.py @@ -0,0 +1,251 @@ +#!/usr/bin/python +# +# (c) 2017 Apstra Inc, +# +# This file is part of Ansible +# +# Ansible is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Ansible is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with Ansible. If not, see . +# + +ANSIBLE_METADATA = {'status': ['preview'], + 'supported_by': 'community', + 'version': '1.0'} + +DOCUMENTATION = ''' +--- +module: aos_logical_device +author: Damien Garros (@dgarros) +version_added: "2.3" +short_description: Manage AOS Logical Device +description: + - Apstra AOS Logical Device module let you manage your Logical Devices easily. + You can create create and delete Logical Device by Name, ID or by using a JSON File. + This module is idempotent and support the I(check) mode. + It's using the AOS REST API. +requirements: + - "aos-pyez >= 0.6.0" +options: + session: + description: + - An existing AOS session as obtained by aos_login module. + required: true + name: + description: + - Name of the Logical Device to manage. + Only one of I(name), I(id) or I(content) can be set. + id: + description: + - AOS Id of the Logical Device to manage (can't be used to create a new Logical Device), + Only one of I(name), I(id) or I(content) can be set. + content: + description: + - Datastructure of the Logical Device to create. The data can be in YAML / JSON or + directly a variable. It's the same datastructure that is returned + on success in I(value). + state: + description: + - Indicate what is the expected state of the Logical Device (present or not). + default: present + choices: ['present', 'absent'] +''' + +EXAMPLES = ''' + +- name: "Delete a Logical Device by name" + aos_logical_device: + session: "{{ session }}" + name: "my-logical-device" + state: absent + +- name: "Delete a Logical Device by id" + aos_logical_device: + session: "{{ session }}" + id: "45ab26fc-c2ed-4307-b330-0870488fa13e" + state: absent + +# Save a Logical Device to a file + +- name: "Access Logical Device 1/3" + aos_logical_device: + session: "{{ session_ok }}" + name: "my-logical-device" + state: present + register: logical_device +- name: "Save Logical Device into a JSON file 2/3" + copy: + content: "{{ logical_device.value | to_nice_json }}" + dest: logical_device_saved.json +- name: "Save Logical Device into a YAML file 3/3" + copy: + content: "{{ logical_device.value | to_nice_yaml }}" + dest: logical_device_saved.yaml + +- name: "Load Logical Device from a JSON file" + aos_logical_device: + session: "{{ session_ok }}" + content: "{{ lookup('file', 'resources/logical_device_saved.json') }}" + state: present + +- name: "Load Logical Device from a YAML file" + aos_logical_device: + session: "{{ session_ok }}" + content: "{{ lookup('file', 'resources/logical_device_saved.yaml') }}" + state: present +''' + +RETURNS = ''' +name: + description: Name of the Logical Device + returned: always + type: str + sample: AOS-1x25-1 + +id: + description: AOS unique ID assigned to the Logical Device + returned: always + type: str + sample: fcc4ac1c-e249-4fe7-b458-2138bfb44c06 + +value: + description: Value of the object as returned by the AOS Server + returned: always + type: dict + sample: {'...'} +''' + +import json +import time + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.aos import get_aos_session, find_collection_item, do_load_resource, check_aos_version, content_to_dict + +######################################################### +# State Processing +######################################################### +def logical_device_absent(module, aos, my_logical_dev): + + margs = module.params + + # If the module do not exist, return directly + if my_logical_dev.exists is False: + module.exit_json(changed=False, + name=margs['name'], + id=margs['id'], + value={}) + + # If not in check mode, delete Logical Device + if not module.check_mode: + try: + # Need to way 1sec before a delete to workaround a current limitation in AOS + time.sleep(1) + my_logical_dev.delete() + except: + module.fail_json(msg="An error occured, while trying to delete the Logical Device") + + module.exit_json( changed=True, + name=my_logical_dev.name, + id=my_logical_dev.id, + value={} ) + +def logical_device_present(module, aos, my_logical_dev): + + margs = module.params + + if margs['content'] is not None: + + if 'display_name' in module.params['content'].keys(): + do_load_resource(module, aos.LogicalDevices, module.params['content']['display_name']) + else: + module.fail_json(msg="Unable to find display_name in 'content', Mandatory") + + # if logical_device doesn't exist already, create a new one + if my_logical_dev.exists is False and 'content' not in margs.keys(): + module.fail_json(msg="'content' is mandatory for module that don't exist currently") + + module.exit_json( changed=False, + name=my_logical_dev.name, + id=my_logical_dev.id, + value=my_logical_dev.value ) + +######################################################### +# Main Function +######################################################### +def logical_device(module): + + margs = module.params + + try: + aos = get_aos_session(module, margs['session']) + except: + module.fail_json(msg="Unable to login to the AOS server") + + item_name = False + item_id = False + + if margs['content'] is not None: + + content = content_to_dict(module, margs['content'] ) + + if 'display_name' in content.keys(): + item_name = content['display_name'] + else: + module.fail_json(msg="Unable to extract 'display_name' from 'content'") + + elif margs['name'] is not None: + item_name = margs['name'] + + elif margs['id'] is not None: + item_id = margs['id'] + + #---------------------------------------------------- + # Find Object if available based on ID or Name + #---------------------------------------------------- + my_logical_dev = find_collection_item(aos.LogicalDevices, + item_name=item_name, + item_id=item_id) + + #---------------------------------------------------- + # Proceed based on State value + #---------------------------------------------------- + if margs['state'] == 'absent': + + logical_device_absent(module, aos, my_logical_dev) + + elif margs['state'] == 'present': + + logical_device_present(module, aos, my_logical_dev) + +def main(): + module = AnsibleModule( + argument_spec=dict( + session=dict(required=True, type="dict"), + name=dict(required=False ), + id=dict(required=False ), + content=dict(required=False, type="json"), + state=dict( required=False, + choices=['present', 'absent'], + default="present") + ), + mutually_exclusive = [('name', 'id', 'content')], + required_one_of=[('name', 'id', 'content')], + supports_check_mode=True + ) + + # Check if aos-pyez is present and match the minimum version + check_aos_version(module, '0.6.0') + + logical_device(module) + +if __name__ == "__main__": + main()