Skip to content

Latest commit

 

History

History
892 lines (872 loc) · 40.3 KB

avi_gslbservice.rst

File metadata and controls

892 lines (872 loc) · 40.3 KB

vmware.alb.avi_gslbservice

Module for setup of GslbService Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
application_persistence_profile_ref
str
- 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.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
configpb_attributes
dict
- Protobuf versioning for config pbs.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
controller_health_status_enabled
bool
- 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.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
created_by
str
- Creator name.
- Field introduced in 17.1.2.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
description
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
domain_names
list
required: true
- Fully qualified domain name of the gslb service.
- Minimum of 1 items required.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
down_response
dict
- Response to the client query when the gslb service is down.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
enabled
bool
- 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.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
groups
list
required: true
- Select list of pools belonging to this gslb service.
- Minimum of 1 items required.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
health_monitor_refs
list
- 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.
- Maximum of 6 items allowed.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
health_monitor_scope
str
- 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.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS.
hm_off
bool
- This field is an internal field and is used in se.
- Field introduced in 18.2.2.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
is_federated
bool
- This field indicates that this object is replicated across gslb federation.
- Field introduced in 17.1.3.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
markers
list
- List of labels to be used for granular rbac.
- Field introduced in 20.1.5.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
min_members
int
- 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.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 0.
name
str
required: true
- Name for the gslb service.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
num_dns_ip
int
- 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.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
pki_profile_ref
str
- Pki profile associated with the gslb service.
- It is a reference to an object of type pkiprofile.
- Field introduced in 22.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
pool_algorithm
str
- 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.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as GSLB_SERVICE_ALGORITHM_PRIORITY.
resolve_cname
bool
- This field indicates that for a cname query, respond with resolved cnames in the additional section with a records.
- Field introduced in 18.2.5.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
site_persistence_enabled
bool
- Enable site-persistence for the gslbservice.
- Field introduced in 17.2.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
tenant_ref
str
- It is a reference to an object of type tenant.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
topology_policy_enabled
bool
- When enabled, topology policy rules are used for member selection first.
- If no valid member is found using the topology policy rules, configured gslb algorithms for pool selection and member selection are used.
- Field introduced in 22.1.1.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
ttl
int
- Ttl value (in seconds) for records served for this gslb service by the dns service.
- Allowed values are 0-86400.
- Unit is sec.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
use_edns_client_subnet
bool
- 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.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
uuid
str
- Uuid of the gslb service.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
wildcard_match
bool
- 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.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "avi_user"
      password: "avi_password"
      controller: "192.168.138.18"
      api_version: "21.1.1"
  tasks:
    - name: Example to create GslbService object
      avi_gslbservice:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_gslbservice

Authors