From 099a1c5aef593d95b657440c81fa7ce50ab4ed5f Mon Sep 17 00:00:00 2001 From: Gaurav Rastogi Date: Thu, 4 May 2017 05:18:28 -0700 Subject: [PATCH] New module to set up GLSB object (#22229) * New module to set up GLSB object * Updated descriptions for Avi 17.1.1 release and Fixed metadata --- lib/ansible/modules/network/avi/avi_gslb.py | 151 ++++++++++++++++++++ 1 file changed, 151 insertions(+) create mode 100644 lib/ansible/modules/network/avi/avi_gslb.py diff --git a/lib/ansible/modules/network/avi/avi_gslb.py b/lib/ansible/modules/network/avi/avi_gslb.py new file mode 100644 index 00000000000..757e88e1cdf --- /dev/null +++ b/lib/ansible/modules/network/avi/avi_gslb.py @@ -0,0 +1,151 @@ +#!/usr/bin/python +# +# Created on Aug 25, 2016 +# @author: Gaurav Rastogi (grastogi@avinetworks.com) +# Eric Anderson (eanderson@avinetworks.com) +# module_check: supported +# Avi Version: 17.1.1 +# +# +# 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_gslb +author: Gaurav Rastogi (grastogi@avinetworks.com) + +short_description: Module for setup of Gslb Avi RESTful Object +description: + - This module is used to configure Gslb 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"] + clear_on_max_retries: + description: + - Max retries after which the remote site is treatedas a fresh start. + - In fresh start all the configsare downloaded. + - Allowed values are 1-1024. + - Default value when not specified in API or module is interpreted by Avi Controller as 20. + description: + description: + - User defined description for the object. + dns_configs: + description: + - Sub domain configuration for the gslb. + - Gslb service's fqdn must be a match one of these subdomains. + leader_cluster_uuid: + description: + - Mark this site as leader of gslb configuration. + - This site is the one among the avi sites. + name: + description: + - Name for the gslb object. + required: true + send_interval: + description: + - Frequency with which group members communicate. + - Allowed values are 1-3600. + - Default value when not specified in API or module is interpreted by Avi Controller as 15. + sites: + description: + - Select avi site member belonging to this gslb. + tenant_ref: + description: + - It is a reference to an object of type tenant. + third_party_sites: + description: + - Third party site member belonging to this gslb. + - Field introduced in 17.1.1. + url: + description: + - Avi controller URL of the object. + uuid: + description: + - Uuid of the gslb object. + view_id: + description: + - The view-id is used in maintenance mode to differentiate partitioned groups while they havethe same gslb namespace. + - Each partitioned groupwill be able to operate independently by using theview-id. + - Default value when not specified in API or module is interpreted by Avi Controller as 0. +extends_documentation_fragment: + - avi +''' + +EXAMPLES = """ +- name: Example to create Gslb object + avi_gslb: + controller: 10.10.25.42 + username: admin + password: something + state: present + name: sample_gslb +""" + +RETURN = ''' +obj: + description: Gslb (api/gslb) 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']), + clear_on_max_retries=dict(type='int',), + description=dict(type='str',), + dns_configs=dict(type='list',), + leader_cluster_uuid=dict(type='str',), + name=dict(type='str', required=True), + send_interval=dict(type='int',), + sites=dict(type='list',), + tenant_ref=dict(type='str',), + third_party_sites=dict(type='list',), + url=dict(type='str',), + uuid=dict(type='str',), + view_id=dict(type='int',), + ) + 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, 'gslb', + set([])) + +if __name__ == '__main__': + main()