Class: Ansible::Ruby::Modules::Bigip_monitor_external
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Bigip_monitor_external
- Defined in:
- lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_external.rb
Overview
Manages external LTM monitors on a BIG-IP.
Instance Method Summary collapse
-
#arguments ⇒ Object?
Specifies any command-line arguments that the script requires.
-
#description ⇒ Object?
The description of the monitor.
-
#external_program ⇒ Object?
Specifies the name of the file for the monitor to use.
-
#interval ⇒ Object?
The interval specifying how frequently the monitor instance of this template will run.
-
#ip ⇒ Object?
IP address part of the IP/port definition.
-
#name ⇒ String
Specifies the name of the monitor.
-
#parent ⇒ String?
The parent template of this monitor template.
-
#partition ⇒ String?
Device partition to manage resources on.
-
#port ⇒ Object?
Port address part of the IP/port definition.
-
#state ⇒ :present, ...
When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed.
-
#timeout ⇒ Integer?
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 C(16).
-
#variables ⇒ Hash?
Specifies any variables that the script requires.,Note that double quotes in values will be suppressed.
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #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.
23 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_external.rb', line 23 attribute :arguments |
#description ⇒ Object?
Returns The description of the monitor.
16 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_external.rb', line 16 attribute :description |
#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.
32 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_external.rb', line 32 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 5. This value B(must) be less than the C(timeout) value.
35 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_external.rb', line 35 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 ‘*’.
26 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_external.rb', line 26 attribute :ip |
#name ⇒ String
Returns Specifies the name of the monitor.
12 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_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.
19 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_external.rb', line 19 attribute :parent |
#partition ⇒ String?
Returns Device partition to manage resources on.
46 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_external.rb', line 46 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.
29 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_external.rb', line 29 attribute :port |
#state ⇒ :present, ...
Returns When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed.
50 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_external.rb', line 50 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 C(16).
38 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_external.rb', line 38 attribute :timeout |
#variables ⇒ Hash?
Returns Specifies any variables that the script requires.,Note that double quotes in values will be suppressed.
42 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_external.rb', line 42 attribute :variables |