community / community.network / 2.3.0 / module / avi_healthmonitor Module for setup of HealthMonitor Avi RESTful Object Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>community.network.avi_healthmonitor (2.3.0) — module
Install with ansible-galaxy collection install community.network:==2.3.0
collections: - name: community.network version: 2.3.0
This module is used to configure HealthMonitor object
more examples at U(https://github.com/avinetworks/devops)
- name: Create a HTTPS health monitor community.network.avi_healthmonitor: controller: 10.10.27.90 username: admin password: AviNetworks123! https_monitor: http_request: HEAD / HTTP/1.0 http_response_code: - HTTP_2XX - HTTP_3XX receive_timeout: 4 failed_checks: 3 send_interval: 10 successful_checks: 3 type: HEALTH_MONITOR_HTTPS name: MyWebsite-HTTPS
url: description: - Avi controller URL of the object. name: description: - A user friendly name for this health monitor. required: true type: description: - 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, HEALTH_MONITOR_SIP, HEALTH_MONITOR_RADIUS. required: true uuid: description: - Uuid of the health monitor. state: choices: - absent - present default: present description: - The state that should be applied on the entity. tenant: default: admin description: - Name of tenant used for all Avi API calls and context of object. type: str password: default: '' description: - Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). type: str username: default: '' description: - Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). type: str controller: default: '' description: - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). type: str tenant_ref: description: - It is a reference to an object of type tenant. api_context: description: - Avi API context that includes current session ID and CSRF Token. - This allows user to perform single login and re-use the session. type: dict api_version: default: 16.4.4 description: - Avi API version of to use for Avi API and objects. type: str description: description: - User defined description for the object. dns_monitor: description: - Healthmonitordns settings for healthmonitor. sip_monitor: description: - Health monitor for sip. - Field introduced in 17.2.8, 18.1.3, 18.2.1. tcp_monitor: description: - Healthmonitortcp settings for healthmonitor. tenant_uuid: default: '' description: - UUID of tenant used for all Avi API calls and context of object. type: str udp_monitor: description: - Healthmonitorudp settings for healthmonitor. http_monitor: description: - Healthmonitorhttp settings for healthmonitor. is_federated: description: - 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. type: bool monitor_port: description: - 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'. failed_checks: description: - 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. https_monitor: description: - Healthmonitorhttp settings for healthmonitor. send_interval: description: - 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. radius_monitor: description: - Health monitor for radius. - Field introduced in 18.2.3. avi_credentials: description: - Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. suboptions: api_version: default: 16.4.4 description: - Avi controller version controller: description: - Avi controller IP or SQDN csrftoken: description: - Avi controller API csrftoken to reuse existing session with session id password: description: - Avi controller password port: description: - Avi controller port session_id: description: - Avi controller API session id to reuse existing session with csrftoken tenant: default: admin description: - Avi controller tenant tenant_uuid: description: - Avi controller tenant UUID timeout: default: 300 description: - Avi controller request timeout token: description: - Avi controller API token username: description: - Avi controller username type: dict receive_timeout: description: - 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. avi_api_patch_op: choices: - add - replace - delete description: - Patch operation to use when using avi_api_update_method as patch. external_monitor: description: - Healthmonitorexternal settings for healthmonitor. successful_checks: description: - 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. avi_api_update_method: choices: - put - patch default: put description: - Default method for object update is HTTP PUT. - Setting to patch will override that behavior to use HTTP PATCH. avi_disable_session_cache_as_fact: default: false description: - It disables avi session information to be cached as a fact. type: bool
obj: description: HealthMonitor (api/healthmonitor) object returned: success, changed type: dict