Class: Ansible::Ruby::Modules::Bigip_monitor_tcp_echo

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

Overview

Manages F5 BIG-IP LTM tcp echo 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

#description ⇒ Object?

Returns The description of the monitor.

Returns:

  • (Object, nil) —

    The description of the monitor.



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

attribute :description

#interval ⇒ Object?

Returns The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, then the default value will be 5. This value B(must) be less than the C(timeout) value.

Returns:

  • (Object, nil) —

    The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, then the default value will be 5. This value B(must) be less than the C(timeout) value.



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

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 ‘*’.,If this value is an IP address, and the C(type) is C(tcp) (the default), then a C(port) number must be specified.

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 ‘*’.,If this value is an IP address, and the C(type) is C(tcp) (the default), then a C(port) number must be specified.



23
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_tcp_echo.rb', line 23

attribute :ip

#name ⇒ String

Returns Monitor name.

Returns:

  • (String) —

    Monitor name.



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



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

attribute :parent

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



36
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_tcp_echo.rb', line 36

attribute :partition

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



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

attribute :state

#time_until_up ⇒ Object?

Returns Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, then the default value will be 0.

Returns:

  • (Object, nil) —

    Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, then the default value will be 0.



33
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_tcp_echo.rb', line 33

attribute :time_until_up

#timeout ⇒ Object?

Returns The number of seconds in which the node or service must 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. You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, then the default value will be 16.

Returns:

  • (Object, nil) —

    The number of seconds in which the node or service must 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. You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, then the default value will be 16.



30
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_tcp_echo.rb', line 30

attribute :timeout