Class: Ansible::Ruby::Modules::Bigip_gtm_pool

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

Overview

Manages F5 BIG-IP GTM pools.

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

#alternate_lb_method ⇒ :"round-robin", ...

Returns The load balancing mode that the system tries if the C(preferred_lb_method) is unsuccessful in picking a pool.

Returns:

  • (:"round-robin", :"return-to-dns", :none, :ratio, :topology, :"static-persistence", :"global-availability", :"virtual-server-capacity", :"packet-rate", :"drop-packet", :"fallback-ip", :"virtual-server-score", nil) —

    The load balancing mode that the system tries if the C(preferred_lb_method) is unsuccessful in picking a pool.



20
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool.rb', line 20

attribute :alternate_lb_method

#availability_requirements ⇒ Object?

Returns Specifies, if you activate more than one health monitor, the number of health monitors that must receive successful responses in order for the link to be considered available.

Returns:

  • (Object, nil) —

    Specifies, if you activate more than one health monitor, the number of health monitors that must receive successful responses in order for the link to be considered available.



49
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool.rb', line 49

attribute :availability_requirements

#fallback_ip ⇒ Object?

Returns Specifies the IPv4, or IPv6 address of the server to which the system directs requests when it cannot use one of its pools to do so. Note that the system uses the fallback IP only if you select the C(fallback_ip) load balancing method.

Returns:

  • (Object, nil) —

    Specifies the IPv4, or IPv6 address of the server to which the system directs requests when it cannot use one of its pools to do so. Note that the system uses the fallback IP only if you select the C(fallback_ip) load balancing method.



28
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool.rb', line 28

attribute :fallback_ip

#fallback_lb_method ⇒ :"round-robin", ...

Returns The load balancing mode that the system tries if both the C(preferred_lb_method) and C(alternate_lb_method)s are unsuccessful in picking a pool.

Returns:

  • (:"round-robin", :"return-to-dns", :ratio, :topology, :"static-persistence", :"global-availability", :"virtual-server-capacity", :"least-connections", :"lowest-round-trip-time", :"fewest-hops", :"packet-rate", :cpu, :"completion-rate", :"quality-of-service", :"kilobytes-per-second", :"drop-packet", :"fallback-ip", :"virtual-server-score", :none, nil) —

    The load balancing mode that the system tries if both the C(preferred_lb_method) and C(alternate_lb_method)s are unsuccessful in picking a pool.



24
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool.rb', line 24

attribute :fallback_lb_method

#members ⇒ Object?

Returns Members to assign to the pool.,The order of the members in this list is the order that they will be listed in the pool.

Returns:

  • (Object, nil) —

    Members to assign to the pool.,The order of the members in this list is the order that they will be listed in the pool.



43
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool.rb', line 43

attribute :members

#monitors ⇒ Object?

Returns Specifies the health monitors that the system currently uses to monitor this resource.,When C(availability_requirements.type) is C(require), you may only have a single monitor in the C(monitors) list.

Returns:

  • (Object, nil) —

    Specifies the health monitors that the system currently uses to monitor this resource.,When C(availability_requirements.type) is C(require), you may only have a single monitor in the C(monitors) list.



46
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool.rb', line 46

attribute :monitors

#name ⇒ String

Returns Name of the GTM pool.

Returns:

  • (String) —

    Name of the GTM pool.



35
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool.rb', line 35

attribute :name

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



39
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool.rb', line 39

attribute :partition

#preferred_lb_method ⇒ :"round-robin", ...

Returns The load balancing mode that the system tries first.

Returns:

  • (:"round-robin", :"return-to-dns", :ratio, :topology, :"static-persistence", :"global-availability", :"virtual-server-capacity", :"least-connections", :"lowest-round-trip-time", :"fewest-hops", :"packet-rate", :cpu, :"completion-rate", :"quality-of-service", :"kilobytes-per-second", :"drop-packet", :"fallback-ip", :"virtual-server-score", nil) —

    The load balancing mode that the system tries first.



16
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool.rb', line 16

attribute :preferred_lb_method

#state ⇒ :present, ...

Returns Pool state. When C(present), ensures that the pool is created and enabled. When C(absent), ensures that the pool is removed from the system. When C(enabled) or C(disabled), ensures that the pool is enabled or disabled (respectively) on the remote device.

Returns:

  • (:present, :absent, :enabled, :disabled, nil) —

    Pool state. When C(present), ensures that the pool is created and enabled. When C(absent), ensures that the pool is removed from the system. When C(enabled) or C(disabled), ensures that the pool is enabled or disabled (respectively) on the remote device.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool.rb', line 12

attribute :state

#type ⇒ :a, ...

Returns The type of GTM pool that you want to create. On BIG-IP releases prior to version 12, this parameter is not required. On later versions of BIG-IP, this is a required parameter.

Returns:

  • (:a, :aaaa, :cname, :mx, :naptr, :srv, nil) —

    The type of GTM pool that you want to create. On BIG-IP releases prior to version 12, this parameter is not required. On later versions of BIG-IP, this is a required parameter.



31
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool.rb', line 31

attribute :type