Class: Ansible::Ruby::Modules::Bigip_pool

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Bigip_pool

Defined in:

lib/ansible/ruby/modules/generated/network/f5/bigip_pool.rb

Overview

Manages F5 BIG-IP LTM pools via iControl REST API.

Instance Method Summary

• #description ⇒ Object^?

  Specifies descriptive text that identifies the pool.

• #lb_method ⇒ :"dynamic-ratio-member", ...

  Load balancing method.

• #metadata ⇒ Hash^?

  Arbitrary key/value pairs that you can attach to a pool.

• #monitor_type ⇒ :and_list, ...

  Monitor rule type when C(monitors) is specified.,When creating a new pool, if this value is not specified, the default of ‘and_list’ will be used.,When C(single) ensures that all specified monitors are checked, but additionally includes checks to make sure you only specified a single monitor.,When C(and_list) ensures that B(all) monitors are checked.,When C(m_of_n) ensures that C(quorum) of C(monitors) are checked.

• #monitors ⇒ Array<String>, ...

  Monitor template name list.

• #name ⇒ String

  Pool name.

• #partition ⇒ String^?

  Device partition to manage resources on.

• #priority_group_activation ⇒ Object^?

  Specifies whether the system load balances traffic according to the priority number assigned to the pool member.,When creating a new pool, if this parameter is not specified, the default of C(0) will be used.,To disable this setting, provide the value C(0).,Once you enable this setting, you can specify pool member priority when you create a new pool or on a pool member’s properties screen.,The system treats same-priority pool members as a group.,To enable priority group activation, provide a number from C(0) to C(65535) that represents the minimum number of members that must be available in one priority group before the system directs traffic to members in a lower priority group.,When a sufficient number of members become available in the higher priority group, the system again directs traffic to the higher priority group.

• #quorum ⇒ Integer^?

  Monitor quorum value when C(monitor_type) is C(m_of_n).,Quorum must be a value of 1 or greater when C(monitor_type) is C(m_of_n).

• #reselect_tries ⇒ Object^?

  Sets the number of times the system tries to contact a pool member after a passive failure.

• #service_down_action ⇒ :none, ...

  Sets the action to take when node goes down in pool.

• #slow_ramp_time ⇒ Integer^?

  Sets the ramp-up time (in seconds) to gradually ramp up the load on newly added or freshly detected up pool members.

• #state ⇒ :absent, ...

  When C(present), guarantees that the pool exists with the provided attributes.,When C(absent), removes the pool from the system.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#description ⇒ Object^?

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

attribute :description

#lb_method ⇒ :"dynamic-ratio-member", ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_pool.rb', line 19

attribute :lb_method

#metadata ⇒ Hash^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_pool.rb', line 54

attribute :metadata

#monitor_type ⇒ :and_list, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_pool.rb', line 23

attribute :monitor_type

#monitors ⇒ Array<String>, ...

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

attribute :monitors

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_pool.rb', line 15

attribute :name

#partition ⇒ String^?

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

attribute :partition

#priority_group_activation ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_pool.rb', line 58

attribute :priority_group_activation

#quorum ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_pool.rb', line 27

attribute :quorum

#reselect_tries ⇒ Object^?

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

attribute :reselect_tries

#service_down_action ⇒ :none, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_pool.rb', line 42

attribute :service_down_action

#slow_ramp_time ⇒ Integer^?

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

attribute :slow_ramp_time

#state ⇒ :absent, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_pool.rb', line 50

attribute :state