Documentation

avi_gslb - Module for setup of Gslb Avi RESTful Object

New in version 2.4.

Synopsis

Options

parameter required default choices comments
api_version
no
Avi API version of to use for Avi API and objects.
clear_on_max_retries
no
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.
controller
no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
description
no
User defined description for the object.
dns_configs
no
Sub domain configuration for the gslb.
Gslb service's fqdn must be a match one of these subdomains.
leader_cluster_uuid
no
Mark this site as leader of gslb configuration.
This site is the one among the avi sites.
name
yes
Name for the gslb object.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
send_interval
no
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
no
Select avi site member belonging to this gslb.
state
no present
  • absent
  • present
The state that should be applied on the entity.
tenant
no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
no
It is a reference to an object of type tenant.
tenant_uuid
no
UUID of tenant used for all Avi API calls and context of object.
third_party_sites
no
Third party site member belonging to this gslb.
Field introduced in 17.1.1.
url
no
Avi controller URL of the object.
username
no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
no
Uuid of the gslb object.
view_id
no
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.

Examples

- name: Example to create Gslb object
  avi_gslb:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_gslb

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj Gslb (api/gslb) object success, changed dict


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.