Class: Ansible::Ruby::Modules::Bigip_gtm_pool_member

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

Overview

Manages a variety of settings on GTM pool members. The settings that can be adjusted with this module are much more broad that what can be done in the C(bigip_gtm_pool) module. The pool module is intended to allow you to adjust the member order in the pool, not the various settings of the members. The C(bigip_gtm_pool_member) module should be used to adjust all of the other settings.

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 The description of the pool member.

Returns:

  • (Object, nil) —

    The description of the pool member.



41
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool_member.rb', line 41

attribute :description

#limits ⇒ Object?

Returns Specifies resource thresholds or limit requirements at the pool member level.,When you enable one or more limit settings, the system then uses that data to take members in and out of service.,You can define limits for any or all of the limit settings. However, when a member does not meet the resource threshold limit requirement, the system marks the member as unavailable and directs load-balancing traffic to another resource.

Returns:

  • (Object, nil) —

    Specifies resource thresholds or limit requirements at the pool member level.,When you enable one or more limit settings, the system then uses that data to take members in and out of service.,You can define limits for any or all of the limit settings. However, when a member does not meet the resource threshold limit requirement, the system marks the member as unavailable and directs load-balancing traffic to another resource.



44
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool_member.rb', line 44

attribute :limits

#member_order ⇒ Object?

Returns Specifies the order in which the member will appear in the pool.,The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method.,When creating a new member using this module, if the C(member_order) parameter is not specified, it will default to C(0) (first member in the pool).

Returns:

  • (Object, nil) —

    Specifies the order in which the member will appear in the pool.,The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method.,When creating a new member using this module, if the C(member_order) parameter is not specified, it will default to C(0) (first member in the pool).



32
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool_member.rb', line 32

attribute :member_order

#monitor ⇒ Object?

Returns Specifies the monitor assigned to this pool member.,Pool members only support a single monitor.,If the C(port) of the C(gtm_virtual_server) is C(*), the accepted values of this parameter will be affected.,When creating a new pool member, if this parameter is not specified, the default of C(default) will be used.,To remove the monitor from the pool member, use the value C(none).,For pool members created on different partitions, you can also specify the full path to the Common monitor. For example, C(/Common/tcp).

Returns:

  • (Object, nil) —

    Specifies the monitor assigned to this pool member.,Pool members only support a single monitor.,If the C(port) of the C(gtm_virtual_server) is C(*), the accepted values of this parameter will be affected.,When creating a new pool member, if this parameter is not specified, the default of C(default) will be used.,To remove the monitor from the pool member, use the value C(none).,For pool members created on different partitions, you can also specify the full path to the Common monitor. For example, C(/Common/tcp).



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

attribute :monitor

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



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

attribute :partition

#pool ⇒ Object

Returns Name of the GTM pool.

Returns:

  • (Object) —

    Name of the GTM pool.



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

attribute :pool

#ratio ⇒ Object?

Returns Specifies the weight of the pool member for load balancing purposes.

Returns:

  • (Object, nil) —

    Specifies the weight of the pool member for load balancing purposes.



38
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool_member.rb', line 38

attribute :ratio

#server_name ⇒ Object

Returns Specifies the GTM server which contains the C(virtual_server).

Returns:

  • (Object) —

    Specifies the GTM server which contains the C(virtual_server).



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

attribute :server_name

#state ⇒ :present, ...

Returns Pool member state. When C(present), ensures that the pool member is created and enabled. When C(absent), ensures that the pool member is removed from the system. When C(enabled) or C(disabled), ensures that the pool member is enabled or disabled (respectively) on the remote device.,It is recommended that you use the C(members) parameter of the C(bigip_gtm_pool) module when adding and removing members and it provides an easier way of specifying order. If this is not possible, then the C(state) parameter here should be used.,Remember that the order of the members will be affected if you add or remove them using this method. To some extent, this can be controlled using the C(member_order) parameter.

Returns:

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

    Pool member state. When C(present), ensures that the pool member is created and enabled. When C(absent), ensures that the pool member is removed from the system. When C(enabled) or C(disabled), ensures that the pool member is enabled or disabled (respectively) on the remote device.,It is recommended that you use the C(members) parameter of the C(bigip_gtm_pool) module when adding and removing members and it provides an easier way of specifying order. If this is not possible, then the C(state) parameter here should be used.,Remember that the order of the members will be affected if you add or remove them using this method. To some extent, this can be controlled using the C(member_order) parameter.



47
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_pool_member.rb', line 47

attribute :state

#type ⇒ :a, ...

Returns The type of GTM pool that the member is in.

Returns:

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

    The type of GTM pool that the member is in.



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

attribute :type

#virtual_server ⇒ Object

Returns Specifies the name of the GTM virtual server which is assigned to the specified C(server).

Returns:

  • (Object) —

    Specifies the name of the GTM virtual server which is assigned to the specified C(server).



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

attribute :virtual_server