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

Inherits:
Base show all
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 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

#description ⇒ Object?

Returns Specifies descriptive text that identifies the pool.

Returns:

  • (Object, nil) —

    Specifies descriptive text that identifies the pool.



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

attribute :description

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

Returns Load balancing method. When creating a new pool, if this value is not specified, the default of C(round-robin) will be used.

Returns:

  • (:"dynamic-ratio-member", :"dynamic-ratio-node", :"fastest-app-response", :"fastest-node", :"least-connections-member", :"least-connections-node", :"least-sessions", :"observed-member", :"observed-node", :"predictive-member", :"predictive-node", :"ratio-least-connections-member", :"ratio-least-connections-node", :"ratio-member", :"ratio-node", :"ratio-session", :"round-robin", :"weighted-least-connections-member", :"weighted-least-connections-node", nil) —

    Load balancing method. When creating a new pool, if this value is not specified, the default of C(round-robin) will be used.



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

attribute :lb_method

#metadata ⇒ Hash?

Returns Arbitrary key/value pairs that you can attach to a pool. This is useful in situations where you might want to annotate a pool to me managed by Ansible.,Key names will be stored as strings; this includes names that are numbers.,Values for all of the keys will be stored as strings; this includes values that are numbers.,Data will be persisted, not ephemeral.

Returns:

  • (Hash, nil) —

    Arbitrary key/value pairs that you can attach to a pool. This is useful in situations where you might want to annotate a pool to me managed by Ansible.,Key names will be stored as strings; this includes names that are numbers.,Values for all of the keys will be stored as strings; this includes values that are numbers.,Data will be persisted, not ephemeral.



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

attribute :metadata

#monitor_type ⇒ :and_list, ...

Returns 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. C(m_of_n) B(requires) that a C(quorum) of 1 or greater be set either in the playbook, or already existing on the device.,Both C(single) and C(and_list) are functionally identical since BIG-IP considers all monitors as “a list”.

Returns:

  • (:and_list, :m_of_n, :single, nil) —

    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. C(m_of_n) B(requires) that a C(quorum) of 1 or greater be set either in the playbook, or already existing on the device.,Both C(single) and C(and_list) are functionally identical since BIG-IP considers all monitors as “a list”.



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

attribute :monitor_type

#monitors ⇒ Array<String>, ...

Returns Monitor template name list. If the partition is not provided as part of the monitor name, then the C(partition) option will be used instead.

Returns:

  • (Array<String>, String, nil) —

    Monitor template name list. If the partition is not provided as part of the monitor name, then the C(partition) option will be used instead.



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

attribute :monitors

#name ⇒ String

Returns Pool name.

Returns:

  • (String) —

    Pool name



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

attribute :name

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



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

attribute :partition

#priority_group_activation ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



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

attribute :priority_group_activation

#quorum ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :quorum

#reselect_tries ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :reselect_tries

#service_down_action ⇒ :none, ...

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

Returns:

  • (:none, :reset, :drop, :reselect, nil) —

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



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

attribute :service_down_action

#slow_ramp_time ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :slow_ramp_time

#state ⇒ :absent, ...

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

Returns:

  • (:absent, :present, nil) —

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



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

attribute :state