Class: Ansible::Ruby::Modules::Bigip_node

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

Overview

Manages F5 BIG-IP LTM nodes.

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 node. This can be either IPv4 or IPv6. When creating a new node, 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 node. This can be either IPv4 or IPv6. When creating a new node, 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_node.rb', line 31

attribute :address

#connection_limit ⇒ Object?

Returns Node connection limit. Setting this to 0 disables the limit.

Returns:

  • (Object, nil) —

    Node connection limit. Setting this to 0 disables the limit.



56
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_node.rb', line 56

attribute :connection_limit

#description ⇒ String?

Returns Specifies descriptive text that identifies the node.,You can remove a description by either specifying an empty string, or by specifying the special value C(none).

Returns:

  • (String, nil) —

    Specifies descriptive text that identifies the node.,You can remove a description by either specifying an empty string, or by specifying the special value C(none).



52
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_node.rb', line 52

attribute :description

#dynamic_ratio ⇒ Object?

Returns The dynamic ratio number for the node. Used for dynamic ratio load balancing.,When creating a new node, if this parameter is not specified, the default of C(1) will be used.

Returns:

  • (Object, nil) —

    The dynamic ratio number for the node. Used for dynamic ratio load balancing.,When creating a new node, if this parameter is not specified, the default of C(1) will be used.



65
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_node.rb', line 65

attribute :dynamic_ratio

#fqdn ⇒ String?

Returns FQDN name of the node. 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 node, one of either C(address) or C(fqdn) must be provided. This parameter cannot be updated after it is set.

Returns:

  • (String, nil) —

    FQDN name of the node. 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 node, one of either C(address) or C(fqdn) must be provided. This parameter cannot be updated after it is set.



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

attribute :fqdn

#fqdn_address_type ⇒ :ipv4, ...

Returns Specifies whether the FQDN of the node resolves to an IPv4 or IPv6 address.,When creating a new node, if this parameter is not specified and C(fqdn) is specified, this parameter will default to C(ipv4).,This parameter cannot be changed after it has been set.

Returns:

  • (:ipv4, :ipv6, :all, nil) —

    Specifies whether the FQDN of the node resolves to an IPv4 or IPv6 address.,When creating a new node, if this parameter is not specified and C(fqdn) is specified, this parameter will default to C(ipv4).,This parameter cannot be changed after it has been set.



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

attribute :fqdn_address_type

#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 node, if this parameter is not specified and C(fqdn) is specified, this parameter will default to C(yes).,This parameter cannot be changed after it has been set.

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 node, if this parameter is not specified and C(fqdn) is specified, this parameter will default to C(yes).,This parameter cannot be changed after it has been set.



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

attribute :fqdn_auto_populate

#fqdn_down_interval ⇒ Object?

Returns Specifies the interval in which a query occurs, when the DNS server is down. The associated monitor continues polling as long as the DNS server is down.,When creating a new node, if this parameter is not specified and C(fqdn) is specified, this parameter will default to C(5).

Returns:

  • (Object, nil) —

    Specifies the interval in which a query occurs, when the DNS server is down. The associated monitor continues polling as long as the DNS server is down.,When creating a new node, if this parameter is not specified and C(fqdn) is specified, this parameter will default to C(5).



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

attribute :fqdn_down_interval

#fqdn_up_interval ⇒ Object?

Returns Specifies the interval in which a query occurs, when the DNS server is up. The associated monitor attempts to probe three times, and marks the server down if it there is no response within the span of three times the interval value, in seconds.,This parameter accepts a value of C(ttl) to query based off of the TTL of the FQDN. The default TTL interval is akin to specifying C(3600).,When creating a new node, if this parameter is not specified and C(fqdn) is specified, this parameter will default to C(3600).

Returns:

  • (Object, nil) —

    Specifies the interval in which a query occurs, when the DNS server is up. The associated monitor attempts to probe three times, and marks the server down if it there is no response within the span of three times the interval value, in seconds.,This parameter accepts a value of C(ttl) to query based off of the TTL of the FQDN. The default TTL interval is akin to specifying C(3600).,When creating a new node, if this parameter is not specified and C(fqdn) is specified, this parameter will default to C(3600).



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

attribute :fqdn_up_interval

#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.,Both C(single) and C(and_list) are functionally identical since BIG-IP considers all monitors as “a list”. BIG=IP either has a list of many, or it has a list of one. Where they differ is in the extra guards that C(single) provides; namely that it only allows a single monitor.

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.,Both C(single) and C(and_list) are functionally identical since BIG-IP considers all monitors as “a list”. BIG=IP either has a list of many, or it has a list of one. Where they differ is in the extra guards that C(single) provides; namely that it only allows a single monitor.



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

attribute :monitor_type

#monitors ⇒ Array<String>, ...

Returns Specifies the health monitors that the system currently uses to monitor this node.

Returns:

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

    Specifies the health monitors that the system currently uses to monitor this node.



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

attribute :monitors

#name ⇒ String

Returns Specifies the name of the node.

Returns:

  • (String) —

    Specifies the name of the node.



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

attribute :name

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



68
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_node.rb', line 68

attribute :partition

#quorum ⇒ Object?

Returns Monitor quorum value when C(monitor_type) is C(m_of_n).

Returns:

  • (Object, nil) —

    Monitor quorum value when C(monitor_type) is C(m_of_n).



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

attribute :quorum

#rate_limit ⇒ Object?

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

Returns:

  • (Object, nil) —

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



59
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_node.rb', line 59

attribute :rate_limit

#ratio ⇒ Object?

Returns Node ratio weight. Valid values range from 1 through 100.,When creating a new node, if this parameter is not specified, the default of C(1) will be used.

Returns:

  • (Object, nil) —

    Node ratio weight. Valid values range from 1 through 100.,When creating a new node, if this parameter is not specified, the default of C(1) will be used.



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

attribute :ratio

#state ⇒ :present, ...

Returns Specifies the current state of the node. C(enabled) (All traffic allowed), specifies that system sends traffic to this node regardless of the node’s state. C(disabled) (Only persistent or active connections allowed), Specifies that the node can handle only persistent or active connections. C(offline) (Only active connections allowed), Specifies that the node can handle only active connections. In all cases except C(absent), the node will be created if it does not yet exist.,Be particularly careful about changing the status of a node whose FQDN cannot be resolved. These situations disable your ability to change their C(state) to C(disabled) or C(offline). They will remain in an *Unavailable - Enabled* state.

Returns:

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

    Specifies the current state of the node. C(enabled) (All traffic allowed), specifies that system sends traffic to this node regardless of the node’s state. C(disabled) (Only persistent or active connections allowed), Specifies that the node can handle only persistent or active connections. C(offline) (Only active connections allowed), Specifies that the node can handle only active connections. In all cases except C(absent), the node will be created if it does not yet exist.,Be particularly careful about changing the status of a node whose FQDN cannot be resolved. These situations disable your ability to change their C(state) to C(disabled) or C(offline). They will remain in an *Unavailable - Enabled* state.



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

attribute :state