Documentation

avi_gslbservice - Module for setup of GslbService 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.
controller
no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
controller_health_status_enabled
no
Gs member's overall health status is derived based on a combination of controller and datapath health-status inputs.
Note that the datapath status is determined by the association of health monitor profiles.
Only the controller provided status is determined through this configuration.
Default value when not specified in API or module is interpreted by Avi Controller as True.
description
no
User defined description for the object.
domain_names
no
Fully qualified domain name of the gslb service.
down_response
no
Response to the client query when the gslb service is down.
enabled
no
Enable or disable the gslb service.
If the gslb service is enabled, then the vips are sent in the dns responses based on reachability and configured algorithm.
If the gslb service is disabled, then the vips are no longer available in the dns response.
Default value when not specified in API or module is interpreted by Avi Controller as True.
groups
no
Select list of pools belonging to this gslb service.
health_monitor_refs
no
Verify vs health by applying one or more health monitors.
Active monitors generate synthetic traffic from dns service engine and to mark a vs up or down based on the response.
It is a reference to an object of type gslbhealthmonitor.
health_monitor_scope
no
Health monitor probe can be executed for all the members or it can be executed only for third-party members.
This operational mode is useful to reduce the number of health monitor probes in case of a hybrid scenario.
In such a case, avi members can have controller derived status while non-avi members can be probed by via health monitor probes in dataplane.
Enum options - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS, GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS.
Default value when not specified in API or module is interpreted by Avi Controller as GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS.
name
yes
Name for the gslb service.
num_dns_ip
no
Number of ip addresses of this gslb service to be returned by the dns service.
Enter 0 to return all ip addresses.
Allowed values are 1-20.
Special values are 0- 'return all ip addresses'.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
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.
ttl
no
Ttl value (in seconds) for records served for this gslb service by the dns service.
Allowed values are 1-86400.
url
no
Avi controller URL of the object.
use_edns_client_subnet
no
Use the client ip subnet from the edns option as source ipaddress for client geo-location and consistent hash algorithm.
Default is true.
Field introduced in 17.1.1.
Default value when not specified in API or module is interpreted by Avi Controller as True.
username
no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
no
Uuid of the gslb service.
wildcard_match
no
Enable wild-card match of fqdn if an exact match is not found in the dns table, the longest match is chosen by wild-carding the fqdn in the dns
request.
Default is false.
Field introduced in 17.1.1.
Default value when not specified in API or module is interpreted by Avi Controller as False.

Examples

- name: Example to create GslbService object
  avi_gslbservice:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_gslbservice

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 GslbService (api/gslbservice) 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.