Class: Ansible::Ruby::Modules::Bigip_pool_member

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

Overview

Manages F5 BIG-IP LTM pool members via iControl SOAP 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

#address ⇒ Object?

Returns IP address of the pool member. This can be either IPv4 or IPv6. When creating a new pool member, one of either C(address) or C(fqdn) must be provided. This parameter cannot be updated after it is set.

Returns:

  • (Object, nil) —

    IP address of the pool member. This can be either IPv4 or IPv6. When creating a new pool member, one of either C(address) or C(fqdn) must be provided. This parameter cannot be updated after it is set.



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

attribute :address

#connection_limit ⇒ Integer?

Returns Pool member connection limit. Setting this to 0 disables the limit.

Returns:

  • (Integer, nil) —

    Pool member connection limit. Setting this to 0 disables the limit.



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

attribute :connection_limit

#description ⇒ String?

Returns Pool member description.

Returns:

  • (String, nil) —

    Pool member description.



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

attribute :description

#fqdn ⇒ Object?

Returns FQDN name of the pool member. This can be any name that is a valid RFC 1123 DNS name. Therefore, the only characters that can be used are “A” to “Z”, “a” to “z”, “0” to “9”, the hyphen (“-”) and the period (“.”).,FQDN names must include at lease one period; delineating the host from the domain. ex. C(host.domain).,FQDN names must end with a letter or a number.,When creating a new pool member, one of either C(address) or C(fqdn) must be provided. This parameter cannot be updated after it is set.

Returns:

  • (Object, nil) —

    FQDN name of the pool member. This can be any name that is a valid RFC 1123 DNS name. Therefore, the only characters that can be used are “A” to “Z”, “a” to “z”, “0” to “9”, the hyphen (“-”) and the period (“.”).,FQDN names must include at lease one period; delineating the host from the domain. ex. C(host.domain).,FQDN names must end with a letter or a number.,When creating a new pool member, one of either C(address) or C(fqdn) must be provided. This parameter cannot be updated after it is set.



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

attribute :fqdn

#fqdn_auto_populate ⇒ Symbol?

Returns Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN.,When C(yes), the system generates an ephemeral node for each IP address returned in response to a DNS query for the FQDN of the node. Additionally, when a DNS response indicates the IP address of an ephemeral node no longer exists, the system deletes the ephemeral node.,When C(no), the system resolves a DNS query for the FQDN of the node with the single IP address associated with the FQDN.,When creating a new pool member, the default for this parameter is C(yes).,This parameter is ignored when C(reuse_nodes) is C(yes).

Returns:

  • (Symbol, nil) —

    Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN.,When C(yes), the system generates an ephemeral node for each IP address returned in response to a DNS query for the FQDN of the node. Additionally, when a DNS response indicates the IP address of an ephemeral node no longer exists, the system deletes the ephemeral node.,When C(no), the system resolves a DNS query for the FQDN of the node with the single IP address associated with the FQDN.,When creating a new pool member, the default for this parameter is C(yes).,This parameter is ignored when C(reuse_nodes) is C(yes).



62
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_pool_member.rb', line 62

attribute :fqdn_auto_populate

#name ⇒ String?

Returns Name of the node to create, or re-use, when creating a new pool member.,This parameter is optional and, if not specified, a node name will be created automatically from either the specified C(address) or C(fqdn).,The C(enabled) state is an alias of C(present).

Returns:

  • (String, nil) —

    Name of the node to create, or re-use, when creating a new pool member.,This parameter is optional and, if not specified, a node name will be created automatically from either the specified C(address) or C(fqdn).,The C(enabled) state is an alias of C(present).



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

attribute :name

#partition ⇒ String?

Returns Partition.

Returns:

  • (String, nil) —

    Partition



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

attribute :partition

#pool ⇒ String

Returns Pool name. This pool must exist.

Returns:

  • (String) —

    Pool name. This pool must exist.



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

attribute :pool

#port ⇒ Integer

Returns Pool member port.,This value cannot be changed after it has been set.

Returns:

  • (Integer) —

    Pool member port.,This value cannot be changed after it has been set.



34
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_pool_member.rb', line 34

attribute :port

#preserve_node ⇒ Symbol?

Returns When state is C(absent) attempts to remove the node that the pool member references.,The node will not be removed if it is still referenced by other pool members. If this happens, the module will not raise an error.,Setting this to C(yes) disables this behavior.

Returns:

  • (Symbol, nil) —

    When state is C(absent) attempts to remove the node that the pool member references.,The node will not be removed if it is still referenced by other pool members. If this happens, the module will not raise an error.,Setting this to C(yes) disables this behavior.



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

attribute :preserve_node

#priority_group ⇒ String, ...

Returns Specifies a number representing the priority group for the pool member.,When adding a new member, the default is 0, meaning that the member has no priority.,To specify a priority, you must activate priority group usage when you create a new pool or when adding or removing pool members. When activated, the system load balances traffic according to the priority group number assigned to the pool member.,The higher the number, the higher the priority, so a member with a priority of 3 has higher priority than a member with a priority of 1.

Returns:

  • (String, Integer, nil) —

    Specifies a number representing the priority group for the pool member.,When adding a new member, the default is 0, meaning that the member has no priority.,To specify a priority, you must activate priority group usage when you create a new pool or when adding or removing pool members. When activated, the system load balances traffic according to the priority group number assigned to the pool member.,The higher the number, the higher the priority, so a member with a priority of 3 has higher priority than a member with a priority of 1.



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

attribute :priority_group

#rate_limit ⇒ Integer?

Returns Pool member rate limit (connections-per-second). Setting this to 0 disables the limit.

Returns:

  • (Integer, nil) —

    Pool member rate limit (connections-per-second). Setting this to 0 disables the limit.



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

attribute :rate_limit

#ratio ⇒ Integer?

Returns Pool member ratio weight. Valid values range from 1 through 100. New pool members – unless overridden with this value – default to 1.

Returns:

  • (Integer, nil) —

    Pool member ratio weight. Valid values range from 1 through 100. New pool members – unless overridden with this value – default to 1.



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

attribute :ratio

#reuse_nodes ⇒ Boolean?

Returns Reuses node definitions if requested.

Returns:

  • (Boolean, nil) —

    Reuses node definitions if requested.



66
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_pool_member.rb', line 66

attribute :reuse_nodes

#state ⇒ :present, ...

Returns Pool member state.

Returns:

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

    Pool member state.



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

attribute :state