Class: Ansible::Ruby::Modules::Bigip_gtm_monitor_firepass

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

Overview

Manages F5 BIG-IP GTM FirePass 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

#cipher_list ⇒ Object?

Returns Specifies the list of ciphers for this monitor.,The items in the cipher list are separated with the colon C(:) symbol.,When creating a new monitor, if this parameter is not specified, the default list is C(HIGH:!ADH).

Returns:

  • (Object, nil) —

    Specifies the list of ciphers for this monitor.,The items in the cipher list are separated with the colon C(:) symbol.,When creating a new monitor, if this parameter is not specified, the default list is C(HIGH:!ADH).



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

attribute :cipher_list

#concurrency_limit ⇒ Object?

Returns Specifies the maximum percentage of licensed connections currently in use under which the monitor marks the Secure Access Manager system up.,As an example, a setting of 95 percent means that the monitor marks the Secure Access Manager system up until 95 percent of licensed connections are in use.,When the number of in-use licensed connections exceeds 95 percent, the monitor marks the Secure Access Manager system down.,When creating a new monitor, if this parameter is not specified, the default is C(95).

Returns:

  • (Object, nil) —

    Specifies the maximum percentage of licensed connections currently in use under which the monitor marks the Secure Access Manager system up.,As an example, a setting of 95 percent means that the monitor marks the Secure Access Manager system up until 95 percent of licensed connections are in use.,When the number of in-use licensed connections exceeds 95 percent, the monitor marks the Secure Access Manager system down.,When creating a new monitor, if this parameter is not specified, the default is C(95).



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

attribute :concurrency_limit

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



45
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_firepass.rb', line 45

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.



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



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

attribute :ip

#max_load_average ⇒ Object?

Returns Specifies the number that the monitor uses to mark the Secure Access Manager system up or down.,The system compares the Max Load Average setting against a one-minute average of the Secure Access Manager system load.,When the Secure Access Manager system-load average falls within the specified Max Load Average, the monitor marks the Secure Access Manager system up.,When the average exceeds the setting, the monitor marks the system down.,When creating a new monitor, if this parameter is not specified, the default is C(12).

Returns:

  • (Object, nil) —

    Specifies the number that the monitor uses to mark the Secure Access Manager system up or down.,The system compares the Max Load Average setting against a one-minute average of the Secure Access Manager system load.,When the Secure Access Manager system-load average falls within the specified Max Load Average, the monitor marks the Secure Access Manager system up.,When the average exceeds the setting, the monitor marks the system down.,When creating a new monitor, if this parameter is not specified, the default is C(12).



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

attribute :max_load_average

#name ⇒ String

Returns Monitor name.

Returns:

  • (String) —

    Monitor name.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_firepass.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_firepass.rb', line 16

attribute :parent

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



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

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_firepass.rb', line 24

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



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

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.



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

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.



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

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.



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

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

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



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

attribute :timeout

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



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

attribute :update_password