Class: Ansible::Ruby::Modules::Bigip_gtm_monitor_tcp_half_open

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

Overview

Manages F5 BIG-IP GTM tcp half-open monitors.

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

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



43
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_tcp_half_open.rb', line 43

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.



28
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_tcp_half_open.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 ‘*’.



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

attribute :ip

#name ⇒ String

Returns Monitor name.

Returns:

  • (String) —

    Monitor name.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_tcp_half_open.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(tcp_half_open) 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(tcp_half_open) parent on the C(Common) partition.



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

attribute :parent

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



51
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_tcp_half_open.rb', line 51

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



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

attribute :port

#probe_attempts ⇒ Object?

Returns Specifies the number of times the system attempts to probe the host server, after which the system considers the host server down or unavailable.,When creating a new monitor, if this parameter is not provided, then the default value will be C(3).

Returns:

  • (Object, nil) —

    Specifies the number of times the system attempts to probe the host server, after which the system considers the host server down or unavailable.,When creating a new monitor, if this parameter is not provided, then the default value will be C(3).



40
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_tcp_half_open.rb', line 40

attribute :probe_attempts

#probe_interval ⇒ Object?

Returns Specifies the number of seconds the big3d process waits before sending out a subsequent probe attempt when a probe fails and multiple probe attempts have been requested.,When creating a new monitor, if this parameter is not provided, then the default value will be C(1).

Returns:

  • (Object, nil) —

    Specifies the number of seconds the big3d process waits before sending out a subsequent probe attempt when a probe fails and multiple probe attempts have been requested.,When creating a new monitor, if this parameter is not provided, then the default value will be C(1).



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

attribute :probe_interval

#probe_timeout ⇒ Object?

Returns Specifies the number of seconds after which the system times out the probe request to the system.,When creating a new monitor, if this parameter is not provided, then the default value will be C(5).

Returns:

  • (Object, nil) —

    Specifies the number of seconds after which the system times out the probe request to the system.,When creating a new monitor, if this parameter is not provided, then the default value will be C(5).



37
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_tcp_half_open.rb', line 37

attribute :probe_timeout

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



55
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_tcp_half_open.rb', line 55

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

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



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

attribute :timeout

#transparent ⇒ Symbol?

Returns Specifies whether the monitor operates in transparent mode.,A monitor in transparent mode directs traffic through the associated pool members or nodes (usually a router or firewall) to the aliased destination (that is, it probes the C(ip)-C(port) combination specified in the monitor).,If the monitor cannot successfully reach the aliased destination, the pool member or node through which the monitor traffic was sent is marked down.,When creating a new monitor, if this parameter is not provided, then the default value will be C(no).

Returns:

  • (Symbol, nil) —

    Specifies whether the monitor operates in transparent mode.,A monitor in transparent mode directs traffic through the associated pool members or nodes (usually a router or firewall) to the aliased destination (that is, it probes the C(ip)-C(port) combination specified in the monitor).,If the monitor cannot successfully reach the aliased destination, the pool member or node through which the monitor traffic was sent is marked down.,When creating a new monitor, if this parameter is not provided, then the default value will be C(no).



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

attribute :transparent