Class: Ansible::Ruby::Modules::Bigip_monitor_https
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Bigip_monitor_https
- Defined in:
- lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb
Overview
Manages F5 BIG-IP LTM https monitors.
Instance Method Summary collapse
-
#description ⇒ Object?
The description of the monitor.
-
#interval ⇒ Object?
The interval specifying how frequently the monitor instance of this template will run.
-
#ip ⇒ String?
IP address part of the IP/port definition.
-
#name ⇒ String
Monitor name.
-
#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.
-
#receive ⇒ Object?
The receive string for the monitor call.
-
#receive_disable ⇒ Object?
This setting works like C(receive), except that the system marks the node or pool member disabled when its response matches the C(receive_disable) string but not C(receive).
-
#send ⇒ Object?
The send string for the monitor call.
-
#state ⇒ :present, ...
When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed.
-
#target_password ⇒ Object?
Specifies the password, if the monitored target requires authentication.
-
#target_username ⇒ Object?
Specifies the user name, if the monitored target requires authentication.
-
#time_until_up ⇒ Object?
Specifies the amount of time in seconds after the first successful response before a node will be marked up.
-
#timeout ⇒ Object?
The number of seconds in which the node or service must respond to the monitor request.
Methods inherited from Base
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.
16 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 16 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.
39 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 39 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 ‘*’.
32 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 32 attribute :ip |
#name ⇒ String
Returns Monitor name.
12 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.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(https) parent on the C(Common) partition.
19 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 19 attribute :parent |
#partition ⇒ String?
Returns Device partition to manage resources on.
54 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 54 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.
36 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 36 attribute :port |
#receive ⇒ Object?
Returns The receive string for the monitor call.
26 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 26 attribute :receive |
#receive_disable ⇒ Object?
Returns This setting works like C(receive), except that the system marks the node or pool member disabled when its response matches the C(receive_disable) string but not C(receive). To use this setting, you must specify both C(receive_disable) and C(receive).
29 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 29 attribute :receive_disable |
#send ⇒ Object?
Returns The send string for the monitor call. When creating a new monitor, if this value is not provided, the default C(GET /\r\n) will be used.
23 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 23 attribute :send |
#state ⇒ :present, ...
Returns When C(present), ensures that the monitor exists.,When C(absent), ensures the monitor is removed.
58 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 58 attribute :state |
#target_password ⇒ Object?
Returns Specifies the password, if the monitored target requires authentication.
51 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 51 attribute :target_password |
#target_username ⇒ Object?
Returns Specifies the user name, if the monitored target requires authentication.
48 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 48 attribute :target_username |
#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.
45 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 45 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.
42 |
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_monitor_https.rb', line 42 attribute :timeout |