Documentation
  • Docs »
  • avi_gslb – Module for setup of Gslb Avi RESTful Object

avi_gslb – Module for setup of Gslb Avi RESTful Object

New in version 2.4.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • avisdk

Parameters

Parameter Choices/Defaults Comments
api_context
dictionary
added in 2.5
Avi API context that includes current session ID and CSRF Token.
This allows user to perform single login and re-use the session.
api_version
string
Default:
"16.4.4"
Avi API version of to use for Avi API and objects.
avi_api_patch_op
-
added in 2.5
    Choices:
  • add
  • replace
  • delete
Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method
-
added in 2.5
    Choices:
  • put ←
  • patch
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
avi_credentials
dictionary
added in 2.5
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
clear_on_max_retries
-
Max retries after which the remote site is treated as a fresh start.
In fresh start all the configs are downloaded.
Allowed values are 1-1024.
Default value when not specified in API or module is interpreted by Avi Controller as 20.
client_ip_addr_group
-
added in 2.4
Group to specify if the client ip addresses are public or private.
Field introduced in 17.1.2.
controller
string
Default:
""
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
description
-
User defined description for the object.
dns_configs
-
Sub domain configuration for the gslb.
Gslb service's fqdn must be a match one of these subdomains.
is_federated
boolean
added in 2.4
    Choices:
  • no
  • yes
This field indicates that this object is replicated across gslb federation.
Field introduced in 17.1.3.
Default value when not specified in API or module is interpreted by Avi Controller as True.
leader_cluster_uuid
- / required
Mark this site as leader of gslb configuration.
This site is the one among the avi sites.
maintenance_mode
boolean
added in 2.5
    Choices:
  • no
  • yes
This field disables the configuration operations on the leader for all federated objects.
Cud operations on gslb, gslbservice, gslbgeodbprofile and other federated objects will be rejected.
The rest-api disabling helps in upgrade scenarios where we don't want configuration sync operations to the gslb member when the member is being
upgraded.
This configuration programmatically blocks the leader from accepting new gslb configuration when member sites are undergoing upgrade.
Field introduced in 17.2.1.
Default value when not specified in API or module is interpreted by Avi Controller as False.
name
- / required
Name for the gslb object.
password
string
Default:
""
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
send_interval
-
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.
Units(SEC).
sites
-
Select avi site member belonging to this gslb.
state
-
    Choices:
  • absent
  • present ←
The state that should be applied on the entity.
tenant
string
Default:
"admin"
Name of tenant used for all Avi API calls and context of object.
tenant_ref
-
It is a reference to an object of type tenant.
tenant_uuid
string
Default:
""
UUID of tenant used for all Avi API calls and context of object.
third_party_sites
-
Third party site member belonging to this gslb.
Field introduced in 17.1.1.
url
-
Avi controller URL of the object.
username
string
Default:
""
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
-
Uuid of the gslb object.
view_id
-
The view-id is used in change-leader mode to differentiate partitioned groups while they have the same gslb namespace.
Each partitioned group will be able to operate independently by using the view-id.
Default value when not specified in API or module is interpreted by Avi Controller as 0.

Notes

Note

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, the following are the fields unique to this module:

Key Returned Description
obj
dictionary
success, changed
Gslb (api/gslb) object



Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.