Class: Ansible::Ruby::Modules::Avi_gslbservice

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb

Overview

This module is used to configure GslbService object more examples at U(github.com/avinetworks/devops)

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#application_persistence_profile_ref ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



25
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 25

attribute :application_persistence_profile_ref

#avi_api_patch_op ⇒ :add, ...

Returns Patch operation to use when using avi_api_update_method as patch.

Returns:

  • (:add, :replace, :delete, nil) —

    Patch operation to use when using avi_api_update_method as patch.



21
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 21

attribute :avi_api_patch_op

#avi_api_update_method ⇒ :put, ...

Returns Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH.

Returns:

  • (:put, :patch, nil) —

    Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH.



17
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 17

attribute :avi_api_update_method

#controller_health_status_enabled ⇒ Symbol?

Returns 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.

Returns:

  • (Symbol, nil) —

    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.



28
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 28

attribute :controller_health_status_enabled

#created_by ⇒ Object?

Returns Creator name.,Field introduced in 17.1.2.

Returns:

  • (Object, nil) —

    Creator name.,Field introduced in 17.1.2.



32
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 32

attribute :created_by

#description ⇒ Object?

Returns User defined description for the object.

Returns:

  • (Object, nil) —

    User defined description for the object.



35
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 35

attribute :description

#domain_names ⇒ Object?

Returns Fully qualified domain name of the gslb service.

Returns:

  • (Object, nil) —

    Fully qualified domain name of the gslb service.



38
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 38

attribute :domain_names

#down_response ⇒ Object?

Returns Response to the client query when the gslb service is down.

Returns:

  • (Object, nil) —

    Response to the client query when the gslb service is down.



41
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 41

attribute :down_response

#enabled ⇒ Symbol?

Returns 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.

Returns:

  • (Symbol, nil) —

    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.



44
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 44

attribute :enabled

#groups ⇒ Object?

Returns Select list of pools belonging to this gslb service.

Returns:

  • (Object, nil) —

    Select list of pools belonging to this gslb service.



48
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 48

attribute :groups

#health_monitor_refs ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



51
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 51

attribute :health_monitor_refs

#health_monitor_scope ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



54
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 54

attribute :health_monitor_scope

#is_federated ⇒ Symbol?

Returns 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.

Returns:

  • (Symbol, nil) —

    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.



57
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 57

attribute :is_federated

#min_members ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



61
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 61

attribute :min_members

#name ⇒ String

Returns Name for the gslb service.

Returns:

  • (String) —

    Name for the gslb service.



64
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 64

attribute :name

#num_dns_ip ⇒ Object?

Returns 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’.

Returns:

  • (Object, nil) —

    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’.



68
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 68

attribute :num_dns_ip

#pool_algorithm ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



71
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 71

attribute :pool_algorithm

#site_persistence_enabled ⇒ Symbol?

Returns 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.

Returns:

  • (Symbol, nil) —

    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.



74
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 74

attribute :site_persistence_enabled

#state ⇒ :absent, ...

Returns The state that should be applied on the entity.

Returns:

  • (:absent, :present, nil) —

    The state that should be applied on the entity.



13
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 13

attribute :state

#tenant_ref ⇒ Object?

Returns It is a reference to an object of type tenant.

Returns:

  • (Object, nil) —

    It is a reference to an object of type tenant.



78
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 78

attribute :tenant_ref

#ttl ⇒ Object?

Returns Ttl value (in seconds) for records served for this gslb service by the dns service.,Allowed values are 1-86400.,Units(SEC).

Returns:

  • (Object, nil) —

    Ttl value (in seconds) for records served for this gslb service by the dns service.,Allowed values are 1-86400.,Units(SEC).



81
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 81

attribute :ttl

#url ⇒ Object?

Returns Avi controller URL of the object.

Returns:

  • (Object, nil) —

    Avi controller URL of the object.



84
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 84

attribute :url

#use_edns_client_subnet ⇒ Symbol?

Returns 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.

Returns:

  • (Symbol, nil) —

    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.



87
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 87

attribute :use_edns_client_subnet

#uuid ⇒ Object?

Returns Uuid of the gslb service.

Returns:

  • (Object, nil) —

    Uuid of the gslb service.



91
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 91

attribute :uuid

#wildcard_match ⇒ Symbol?

Returns 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.

Returns:

  • (Symbol, nil) —

    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.



94
 
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_gslbservice.rb', line 94

attribute :wildcard_match