From 4d1bd424f42baaded1a6c15795429fb09a50489c Mon Sep 17 00:00:00 2001 From: Gaurav Rastogi Date: Tue, 1 Aug 2017 09:41:25 -0700 Subject: [PATCH] New Module: Manage Avi Networks Backupconfiguration (network/avi/avi_backupconfiguration) (#27580) --- .../network/avi/avi_backupconfiguration.py | 144 ++++++++++++++++++ 1 file changed, 144 insertions(+) create mode 100644 lib/ansible/modules/network/avi/avi_backupconfiguration.py diff --git a/lib/ansible/modules/network/avi/avi_backupconfiguration.py b/lib/ansible/modules/network/avi/avi_backupconfiguration.py new file mode 100644 index 00000000000..196aab7d48d --- /dev/null +++ b/lib/ansible/modules/network/avi/avi_backupconfiguration.py @@ -0,0 +1,144 @@ +#!/usr/bin/python +# +# Created on Aug 25, 2016 +# @author: Gaurav Rastogi (grastogi@avinetworks.com) +# Eric Anderson (eanderson@avinetworks.com) +# module_check: supported +# +# +# 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 = {'metadata_version': '1.0', + 'status': ['preview'], + 'supported_by': 'community'} + +DOCUMENTATION = ''' +--- +module: avi_backupconfiguration +author: Gaurav Rastogi (grastogi@avinetworks.com) + +short_description: Module for setup of BackupConfiguration Avi RESTful Object +description: + - This module is used to configure BackupConfiguration object + - more examples at U(https://github.com/avinetworks/devops) +requirements: [ avisdk ] +version_added: "2.4" +options: + state: + description: + - The state that should be applied on the entity. + default: present + choices: ["absent","present"] + backup_file_prefix: + description: + - Prefix of the exported configuration file. + - Field introduced in 17.1.1. + backup_passphrase: + description: + - Passphrase of backup configuration. + maximum_backups_stored: + description: + - Rotate the backup files based on this count. + - Allowed values are 1-20. + - Default value when not specified in API or module is interpreted by Avi Controller as 4. + name: + description: + - Name of backup configuration. + required: true + remote_directory: + description: + - Directory at remote destination with write permission for ssh user. + remote_hostname: + description: + - Remote destination. + save_local: + description: + - Local backup. + ssh_user_ref: + description: + - Access credentials for remote destination. + - It is a reference to an object of type cloudconnectoruser. + tenant_ref: + description: + - It is a reference to an object of type tenant. + upload_to_remote_host: + description: + - Remote backup. + url: + description: + - Avi controller URL of the object. + uuid: + description: + - Unique object identifier of the object. +extends_documentation_fragment: + - avi +''' + +EXAMPLES = """ +- name: Example to create BackupConfiguration object + avi_backupconfiguration: + controller: 10.10.25.42 + username: admin + password: something + state: present + name: sample_backupconfiguration +""" + +RETURN = ''' +obj: + description: BackupConfiguration (api/backupconfiguration) object + returned: success, changed + type: dict +''' + +from ansible.module_utils.basic import AnsibleModule +try: + from ansible.module_utils.avi import ( + avi_common_argument_spec, HAS_AVI, avi_ansible_api) +except ImportError: + HAS_AVI = False + + +def main(): + argument_specs = dict( + state=dict(default='present', + choices=['absent', 'present']), + backup_file_prefix=dict(type='str',), + backup_passphrase=dict(type='str', no_log=True,), + maximum_backups_stored=dict(type='int',), + name=dict(type='str', required=True), + remote_directory=dict(type='str',), + remote_hostname=dict(type='str',), + save_local=dict(type='bool',), + ssh_user_ref=dict(type='str',), + tenant_ref=dict(type='str',), + upload_to_remote_host=dict(type='bool',), + url=dict(type='str',), + uuid=dict(type='str',), + ) + argument_specs.update(avi_common_argument_spec()) + module = AnsibleModule( + argument_spec=argument_specs, supports_check_mode=True) + if not HAS_AVI: + return module.fail_json(msg=( + 'Avi python API SDK (avisdk>=17.1) is not installed. ' + 'For more details visit https://github.com/avinetworks/sdk.')) + return avi_ansible_api(module, 'backupconfiguration', + set(['backup_passphrase'])) + +if __name__ == '__main__': + main()