Class: Ansible::Ruby::Modules::Bigip_gtm_monitor_bigip

Inherits:

Base

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

Defined in:

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

Overview

Manages F5 BIG-IP GTM BIG-IP monitors. This monitor is used by GTM to monitor BIG-IPs themselves.

Instance Method Summary

• #aggregate_dynamic_ratios ⇒ :none, ...

  Specifies how the system combines the module values to create the proportion (score) for the load balancing operation.,The score represents the module’s estimated capacity for handing traffic.,Averaged values are appropriate for downstream Web Accelerator or Application Security Manager virtual servers.,When creating a new monitor, if this parameter is not specified, the default of C(none) is used, meaning that the system does not use the scores in the load balancing operation.,When C(none), specifies that the monitor ignores the nodes and pool member scores.,When C(average-nodes), specifies that the system averages the dynamic ratios on the nodes associated with the monitor’s target virtual servers and returns that average as the virtual servers’ score.,When C(sum-nodes), specifies that the system adds together the scores of the nodes associated with the monitor’s target virtual servers and uses that value in the load balancing operation.,When C(average-members), specifies that the system averages the dynamic ratios on the pool members associated with the monitor’s target virtual servers and returns that average as the virtual servers’ score.,When C(sum-members), specifies that the system adds together the scores of the pool members associated with the monitor’s target virtual servers and uses that value in the load balancing operation.

• #ignore_down_response ⇒ Symbol^?

  Specifies that the monitor allows more than one probe attempt per interval.,When C(yes), specifies that the monitor ignores down responses for the duration of the monitor timeout.

• #interval ⇒ Object^?

  Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown.,When creating a new monitor, if this parameter is not provided, then the default value will be C(30).

• #ip ⇒ String^?

  IP address part of the IP/port definition.

• #name ⇒ String

  Monitor name.

• #parent ⇒ String^?

  The parent template of this monitor template.

• #partition ⇒ String^?

  Device partition to manage resources on.

• #port ⇒ Integer^?

  Port address part of the IP/port definition.

• #state ⇒ :present, ...

  When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed.

• #timeout ⇒ Object^?

  Specifies the number of seconds the target has in which to respond to the monitor request.,If the target responds within the set time period, it is considered up.,If the target does not respond within the set time period, it is considered down.,When this value is set to 0 (zero), the system uses the interval from the parent monitor.,When creating a new monitor, if this parameter is not provided, then the default value will be C(90).

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

#aggregate_dynamic_ratios ⇒ :none, ...

Returns Specifies how the system combines the module values to create the proportion (score) for the load balancing operation.,The score represents the module’s estimated capacity for handing traffic.,Averaged values are appropriate for downstream Web Accelerator or Application Security Manager virtual servers.,When creating a new monitor, if this parameter is not specified, the default of C(none) is used, meaning that the system does not use the scores in the load balancing operation.,When C(none), specifies that the monitor ignores the nodes and pool member scores.,When C(average-nodes), specifies that the system averages the dynamic ratios on the nodes associated with the monitor’s target virtual servers and returns that average as the virtual servers’ score.,When C(sum-nodes), specifies that the system adds together the scores of the nodes associated with the monitor’s target virtual servers and uses that value in the load balancing operation.,When C(average-members), specifies that the system averages the dynamic ratios on the pool members associated with the monitor’s target virtual servers and returns that average as the virtual servers’ score.,When C(sum-members), specifies that the system adds together the scores of the pool members associated with the monitor’s target virtual servers and uses that value in the load balancing operation.

Returns:

• (:none, :"average-nodes", :"sum-nodes", :"average-members", :"sum-members", nil) —

  Specifies how the system combines the module values to create the proportion (score) for the load balancing operation.,The score represents the module’s estimated capacity for handing traffic.,Averaged values are appropriate for downstream Web Accelerator or Application Security Manager virtual servers.,When creating a new monitor, if this parameter is not specified, the default of C(none) is used, meaning that the system does not use the scores in the load balancing operation.,When C(none), specifies that the monitor ignores the nodes and pool member scores.,When C(average-nodes), specifies that the system averages the dynamic ratios on the nodes associated with the monitor’s target virtual servers and returns that average as the virtual servers’ score.,When C(sum-nodes), specifies that the system adds together the scores of the nodes associated with the monitor’s target virtual servers and uses that value in the load balancing operation.,When C(average-members), specifies that the system averages the dynamic ratios on the pool members associated with the monitor’s target virtual servers and returns that average as the virtual servers’ score.,When C(sum-members), specifies that the system adds together the scores of the pool members associated with the monitor’s target virtual servers and uses that value in the load balancing operation.

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

attribute :aggregate_dynamic_ratios

#ignore_down_response ⇒ Symbol^?

Returns Specifies that the monitor allows more than one probe attempt per interval.,When C(yes), specifies that the monitor ignores down responses for the duration of the monitor timeout. Once the monitor timeout is reached without the system receiving an up response, the system marks the object down.,When C(no), specifies that the monitor immediately marks an object down when it receives a down response.,When creating a new monitor, if this parameter is not provided, then the default value will be C(no).

Returns:

• (Symbol, nil) —

  Specifies that the monitor allows more than one probe attempt per interval.,When C(yes), specifies that the monitor ignores down responses for the duration of the monitor timeout. Once the monitor timeout is reached without the system receiving an up response, the system marks the object down.,When C(no), specifies that the monitor immediately marks an object down when it receives a down response.,When creating a new monitor, if this parameter is not provided, then the default value will be C(no).

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

attribute :ignore_down_response

#interval ⇒ Object^?

Returns Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown.,When creating a new monitor, if this parameter is not provided, then the default value will be C(30). This value B(must) be less than the C(timeout) value.

Returns:

• (Object, nil) —

  Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown.,When creating a new monitor, if this parameter is not provided, then the default value will be C(30). This value B(must) be less than the C(timeout) value.

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

attribute :interval

#ip ⇒ String^?

Returns IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be ‘*’.

Returns:

• (String, nil) —

  IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be ‘*’.

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

attribute :ip

#name ⇒ String

Returns Monitor name.

Returns:

• (String) —

  Monitor name.

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

attribute :name

#parent ⇒ String^?

Returns The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(bigip) parent on the C(Common) partition.

Returns:

• (String, nil) —

  The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the C(bigip) parent on the C(Common) partition.

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

attribute :parent

#partition ⇒ String^?

Returns Device partition to manage resources on.

Returns:

• (String, nil) —

  Device partition to manage resources on.

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

attribute :partition

#port ⇒ Integer^?

Returns Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be ‘*’. Note that if specifying an IP address, a value between 1 and 65535 must be specified.

Returns:

• (Integer, nil) —

  Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be ‘*’. Note that if specifying an IP address, a value between 1 and 65535 must be specified

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

attribute :port

#state ⇒ :present, ...

Returns When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed.

Returns:

• (:present, :absent, nil) —

  When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed.

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

attribute :state

#timeout ⇒ Object^?

Returns Specifies the number of seconds the target has in which to respond to the monitor request.,If the target responds within the set time period, it is considered up.,If the target does not respond within the set time period, it is considered down.,When this value is set to 0 (zero), the system uses the interval from the parent monitor.,When creating a new monitor, if this parameter is not provided, then the default value will be C(90).

Returns:

• (Object, nil) —

  Specifies the number of seconds the target has in which to respond to the monitor request.,If the target responds within the set time period, it is considered up.,If the target does not respond within the set time period, it is considered down.,When this value is set to 0 (zero), the system uses the interval from the parent monitor.,When creating a new monitor, if this parameter is not provided, then the default value will be C(90).

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

attribute :timeout