Class: Ansible::Ruby::Modules::Bigip_gtm_monitor_external

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

Overview

Manages external GTM monitors on a BIG-IP.

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

#arguments ⇒ Object?

Returns Specifies any command-line arguments that the script requires.

Returns:

  • (Object, nil) —

    Specifies any command-line arguments that the script requires.



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

attribute :arguments

#external_program ⇒ Object?

Returns Specifies the name of the file for the monitor to use. In order to reference a file, you must first import it using options on the System > File Management > External Monitor Program File List > Import screen. The BIG-IP system automatically places the file in the proper location on the file system.

Returns:

  • (Object, nil) —

    Specifies the name of the file for the monitor to use. In order to reference a file, you must first import it using options on the System > File Management > External Monitor Program File List > Import screen. The BIG-IP system automatically places the file in the proper location on the file system.



29
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_external.rb', line 29

attribute :external_program

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



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

attribute :interval

#ip ⇒ Object?

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:

  • (Object, 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 ‘*’.



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

attribute :ip

#name ⇒ String

Returns Specifies the name of the monitor.

Returns:

  • (String) —

    Specifies the name of the monitor.



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



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

attribute :parent

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



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

attribute :partition

#port ⇒ Object?

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:

  • (Object, 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.



26
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_external.rb', line 26

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.



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

attribute :state

#timeout ⇒ Integer?

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:

  • (Integer, 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.



35
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_gtm_monitor_external.rb', line 35

attribute :timeout

#variables ⇒ Hash?

Returns Specifies any variables that the script requires.,Note that double quotes in values will be suppressed.

Returns:

  • (Hash, nil) —

    Specifies any variables that the script requires.,Note that double quotes in values will be suppressed.



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

attribute :variables