Class: Ansible::Ruby::Modules::Avi_healthmonitor
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Avi_healthmonitor
- Defined in:
- lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb
Overview
This module is used to configure HealthMonitor object more examples at U(github.com/avinetworks/devops)
Instance Method Summary collapse
-
#avi_api_patch_op ⇒ :add, ...
Patch operation to use when using avi_api_update_method as patch.
-
#avi_api_update_method ⇒ :put, ...
Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH.
-
#description ⇒ Object?
User defined description for the object.
-
#dns_monitor ⇒ Object?
Healthmonitordns settings for healthmonitor.
-
#external_monitor ⇒ Object?
Healthmonitorexternal settings for healthmonitor.
-
#failed_checks ⇒ Integer?
Number of continuous failed health checks before the server is marked down.,Allowed values are 1-50.,Default value when not specified in API or module is interpreted by Avi Controller as 2.
-
#http_monitor ⇒ Object?
Healthmonitorhttp settings for healthmonitor.
-
#https_monitor ⇒ Hash?
Healthmonitorhttp settings for healthmonitor.
-
#is_federated ⇒ Symbol?
This field describes the object’s replication scope.,If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines.,If the field is set to true, then the object is replicated across the federation.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as False.
-
#monitor_port ⇒ Object?
Use this port instead of the port defined for the server in the pool.,If the monitor succeeds to this port, the load balanced traffic will still be sent to the port of the server defined within the pool.,Allowed values are 1-65535.,Special values are 0 - ‘use server port’.
-
#name ⇒ String
A user friendly name for this health monitor.
-
#receive_timeout ⇒ Integer?
A valid response from the server is expected within the receive timeout window.,This timeout must be less than the send interval.,If server status is regularly flapping up and down, consider increasing this value.,Allowed values are 1-2400.,Default value when not specified in API or module is interpreted by Avi Controller as 4.,Units(SEC).
-
#send_interval ⇒ Integer?
Frequency, in seconds, that monitors are sent to a server.,Allowed values are 1-3600.,Default value when not specified in API or module is interpreted by Avi Controller as 10.,Units(SEC).
-
#state ⇒ :absent, ...
The state that should be applied on the entity.
-
#successful_checks ⇒ Integer?
Number of continuous successful health checks before server is marked up.,Allowed values are 1-50.,Default value when not specified in API or module is interpreted by Avi Controller as 2.
-
#tcp_monitor ⇒ Object?
Healthmonitortcp settings for healthmonitor.
-
#tenant_ref ⇒ Object?
It is a reference to an object of type tenant.
-
#type ⇒ String
Type of the health monitor.,Enum options - HEALTH_MONITOR_PING, HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP,,HEALTH_MONITOR_DNS, HEALTH_MONITOR_GSLB.
-
#udp_monitor ⇒ Object?
Healthmonitorudp settings for healthmonitor.
-
#url ⇒ Object?
Avi controller URL of the object.
-
#uuid ⇒ Object?
Uuid of the health monitor.
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
#avi_api_patch_op ⇒ :add, ...
Returns Patch operation to use when using avi_api_update_method as patch.
21 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 21 attribute :avi_api_patch_op |
#avi_api_update_method ⇒ :put, ...
Returns Default method for object update is HTTP PUT.,Setting to patch will override that behavior to use HTTP PATCH.
17 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 17 attribute :avi_api_update_method |
#description ⇒ Object?
Returns User defined description for the object.
25 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 25 attribute :description |
#dns_monitor ⇒ Object?
Returns Healthmonitordns settings for healthmonitor.
28 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 28 attribute :dns_monitor |
#external_monitor ⇒ Object?
Returns Healthmonitorexternal settings for healthmonitor.
31 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 31 attribute :external_monitor |
#failed_checks ⇒ Integer?
Returns Number of continuous failed health checks before the server is marked down.,Allowed values are 1-50.,Default value when not specified in API or module is interpreted by Avi Controller as 2.
34 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 34 attribute :failed_checks |
#http_monitor ⇒ Object?
Returns Healthmonitorhttp settings for healthmonitor.
38 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 38 attribute :http_monitor |
#https_monitor ⇒ Hash?
Returns Healthmonitorhttp settings for healthmonitor.
41 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 41 attribute :https_monitor |
#is_federated ⇒ Symbol?
Returns This field describes the object’s replication scope.,If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines.,If the field is set to true, then the object is replicated across the federation.,Field introduced in 17.1.3.,Default value when not specified in API or module is interpreted by Avi Controller as False.
45 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 45 attribute :is_federated |
#monitor_port ⇒ Object?
Returns Use this port instead of the port defined for the server in the pool.,If the monitor succeeds to this port, the load balanced traffic will still be sent to the port of the server defined within the pool.,Allowed values are 1-65535.,Special values are 0 - ‘use server port’.
49 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 49 attribute :monitor_port |
#name ⇒ String
Returns A user friendly name for this health monitor.
52 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 52 attribute :name |
#receive_timeout ⇒ Integer?
Returns A valid response from the server is expected within the receive timeout window.,This timeout must be less than the send interval.,If server status is regularly flapping up and down, consider increasing this value.,Allowed values are 1-2400.,Default value when not specified in API or module is interpreted by Avi Controller as 4.,Units(SEC).
56 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 56 attribute :receive_timeout |
#send_interval ⇒ Integer?
Returns Frequency, in seconds, that monitors are sent to a server.,Allowed values are 1-3600.,Default value when not specified in API or module is interpreted by Avi Controller as 10.,Units(SEC).
60 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 60 attribute :send_interval |
#state ⇒ :absent, ...
Returns The state that should be applied on the entity.
13 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 13 attribute :state |
#successful_checks ⇒ Integer?
Returns Number of continuous successful health checks before server is marked up.,Allowed values are 1-50.,Default value when not specified in API or module is interpreted by Avi Controller as 2.
64 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 64 attribute :successful_checks |
#tcp_monitor ⇒ Object?
Returns Healthmonitortcp settings for healthmonitor.
68 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 68 attribute :tcp_monitor |
#tenant_ref ⇒ Object?
Returns It is a reference to an object of type tenant.
71 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 71 attribute :tenant_ref |
#type ⇒ String
Returns Type of the health monitor.,Enum options - HEALTH_MONITOR_PING, HEALTH_MONITOR_TCP, HEALTH_MONITOR_HTTP, HEALTH_MONITOR_HTTPS, HEALTH_MONITOR_EXTERNAL, HEALTH_MONITOR_UDP,,HEALTH_MONITOR_DNS, HEALTH_MONITOR_GSLB.
74 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 74 attribute :type |
#udp_monitor ⇒ Object?
Returns Healthmonitorudp settings for healthmonitor.
78 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 78 attribute :udp_monitor |
#url ⇒ Object?
Returns Avi controller URL of the object.
81 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 81 attribute :url |
#uuid ⇒ Object?
Returns Uuid of the health monitor.
84 |
# File 'lib/ansible/ruby/modules/generated/network/avi/avi_healthmonitor.rb', line 84 attribute :uuid |