Class: Ansible::Ruby::Modules::Bigip_gtm_monitor_http

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

Overview

Manages F5 BIG-IP GTM http 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).



53
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_http.rb', line 53

attribute :ignore_down_response

#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 30.,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 30.,This value B(must) be less than the C(timeout) value.



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

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, 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, then a C(port) number must be specified.



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

attribute :ip

#name ⇒ String

Returns Monitor name.

Returns:

  • (String) —

    Monitor name.



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



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

attribute :parent

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



42
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_http.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



32
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_http.rb', line 32

attribute :port

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



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

attribute :probe_timeout

#receive ⇒ String?

Returns The receive string for the monitor call.

Returns:

  • (String, nil) —

    The receive string for the monitor call.



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

attribute :receive

#reverse ⇒ Symbol?

Returns Instructs the system to mark the target resource down when the test is successful. This setting is useful, for example, if the content on your web site home page is dynamic and changes frequently, you may want to set up a reverse ECV service check that looks for the string Error.,A match for this string means that the web server was down.,To use this option, you must specify values for C(send) and C(receive).

Returns:

  • (Symbol, nil) —

    Instructs the system to mark the target resource down when the test is successful. This setting is useful, for example, if the content on your web site home page is dynamic and changes frequently, you may want to set up a reverse ECV service check that looks for the string Error.,A match for this string means that the web server was down.,To use this option, you must specify values for C(send) and C(receive).



61
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_http.rb', line 61

attribute :reverse

#send ⇒ String?

Returns The send string for the monitor call.,When creating a new monitor, if this parameter is not provided, the default of C(GET /rn) will be used.

Returns:

  • (String, nil) —

    The send string for the monitor call.,When creating a new monitor, if this parameter is not provided, the default of C(GET /rn) will be used.



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

attribute :send

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



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

attribute :state

#target_password ⇒ Object?

Returns Specifies the password, if the monitored target requires authentication.

Returns:

  • (Object, nil) —

    Specifies the password, if the monitored target requires authentication.



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

attribute :target_password

#target_username ⇒ Object?

Returns Specifies the user name, if the monitored target requires authentication.

Returns:

  • (Object, nil) —

    Specifies the user name, if the monitored target requires authentication.



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

attribute :target_username

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

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



39
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_http.rb', line 39

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



57
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_http.rb', line 57

attribute :transparent

#update_password ⇒ :always, ...

Returns C(always) will update passwords if the C(target_password) is specified.,C(on_create) will only set the password for newly created monitors.

Returns:

  • (:always, :on_create, nil) —

    C(always) will update passwords if the C(target_password) is specified.,C(on_create) will only set the password for newly created monitors.



71
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_http.rb', line 71

attribute :update_password