Try SpotterModule for setup of GslbService Avi RESTful Object
Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
preview | supported by community
Install with ansible-galaxy collection install community.general:==0.1.1
collections:
- name: community.general
version: 0.1.1This module is used to configure GslbService object
more examples at U(https://github.com/avinetworks/devops)
- name: Example to create GslbService object
avi_gslbservice:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_gslbservice
ttl:
description:
- Ttl value (in seconds) for records served for this gslb service by the dns service.
- Allowed values are 0-86400.
url:
description:
- Avi controller URL of the object.
name:
description:
- Name for the gslb service.
required: true
uuid:
description:
- Uuid of the gslb service.
state:
choices:
- absent
- present
default: present
description:
- The state that should be applied on the entity.
groups:
description:
- Select list of pools belonging to this gslb service.
hm_off:
description:
- This field is an internal field and is used in se.
- Field introduced in 18.2.2.
type: bool
tenant:
default: admin
description:
- Name of tenant used for all Avi API calls and context of object.
type: str
enabled:
description:
- 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.
type: bool
password:
default: ''
description:
- Password of Avi user in Avi controller. The default value is the environment variable
C(AVI_PASSWORD).
type: str
username:
default: ''
description:
- Username used for accessing Avi controller. The default value is the environment
variable C(AVI_USERNAME).
type: str
controller:
default: ''
description:
- IP address or hostname of the controller. The default value is the environment variable
C(AVI_CONTROLLER).
type: str
created_by:
description:
- Creator name.
- Field introduced in 17.1.2.
num_dns_ip:
description:
- 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'.
tenant_ref:
description:
- It is a reference to an object of type tenant.
api_context:
description:
- Avi API context that includes current session ID and CSRF Token.
- This allows user to perform single login and re-use the session.
type: dict
api_version:
default: 16.4.4
description:
- Avi API version of to use for Avi API and objects.
type: str
description:
description:
- User defined description for the object.
min_members:
description:
- The minimum number of members to distribute traffic to.
- Allowed values are 1-65535.
- Special values are 0 - 'disable'.
- Field introduced in 17.2.4.
- Default value when not specified in API or module is interpreted by Avi Controller
as 0.
tenant_uuid:
default: ''
description:
- UUID of tenant used for all Avi API calls and context of object.
type: str
domain_names:
description:
- Fully qualified domain name of the gslb service.
is_federated:
description:
- 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.
type: bool
down_response:
description:
- Response to the client query when the gslb service is down.
pool_algorithm:
description:
- The load balancing algorithm will pick a gslb pool within the gslb service list
of available pools.
- Enum options - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO.
- Field introduced in 17.2.3.
- Default value when not specified in API or module is interpreted by Avi Controller
as GSLB_SERVICE_ALGORITHM_PRIORITY.
wildcard_match:
description:
- 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.
type: bool
avi_credentials:
description:
- Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller
login details.
suboptions:
api_version:
default: 16.4.4
description:
- Avi controller version
controller:
description:
- Avi controller IP or SQDN
csrftoken:
description:
- Avi controller API csrftoken to reuse existing session with session id
password:
description:
- Avi controller password
port:
description:
- Avi controller port
session_id:
description:
- Avi controller API session id to reuse existing session with csrftoken
tenant:
default: admin
description:
- Avi controller tenant
tenant_uuid:
description:
- Avi controller tenant UUID
timeout:
default: 300
description:
- Avi controller request timeout
token:
description:
- Avi controller API token
username:
description:
- Avi controller username
type: dict
avi_api_patch_op:
choices:
- add
- replace
- delete
description:
- Patch operation to use when using avi_api_update_method as patch.
health_monitor_refs:
description:
- 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 healthmonitor.
health_monitor_scope:
description:
- 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.
avi_api_update_method:
choices:
- put
- patch
default: put
description:
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
use_edns_client_subnet:
description:
- 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.
type: bool
site_persistence_enabled:
description:
- Enable site-persistence for the gslbservice.
- Field introduced in 17.2.1.
- Default value when not specified in API or module is interpreted by Avi Controller
as False.
type: bool
controller_health_status_enabled:
description:
- 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.
type: bool
avi_disable_session_cache_as_fact:
description:
- It disables avi session information to be cached as a fact.
type: bool
application_persistence_profile_ref:
description:
- The federated application persistence associated with gslbservice site persistence
functionality.
- It is a reference to an object of type applicationpersistenceprofile.
- Field introduced in 17.2.1.
obj: description: GslbService (api/gslbservice) object returned: success, changed type: dict