avi_healthmonitor - Module for setup of HealthMonitor Avi RESTful Object¶

New in version 2.3.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

This module is used to configure HealthMonitor object
more examples at https://github.com/avinetworks/devops

Requirements ¶

The below requirements are needed on the host that executes this module.

avisdk

Parameters ¶

Parameter	Choices/Defaults	Comments
api_context (added in 2.5)		Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session.
api_version	Default: 16.4.4	Avi API version of to use for Avi API and objects.
avi_api_patch_op (added in 2.5)	Choices: add replace delete	Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method (added in 2.5)	Choices: put ← patch	Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH.
avi_credentials (added in 2.5)		Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
controller	Default:	IP address or hostname of the controller. The default value is the environment variable `AVI_CONTROLLER`.
description		User defined description for the object.
dns_monitor		Healthmonitordns settings for healthmonitor.
external_monitor		Healthmonitorexternal settings for healthmonitor.
failed_checks		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		Healthmonitorhttp settings for healthmonitor.
https_monitor		Healthmonitorhttp settings for healthmonitor.
is_federated bool (added in 2.4)	Choices: no yes	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		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 required		A user friendly name for this health monitor.
password	Default:	Password of Avi user in Avi controller. The default value is the environment variable `AVI_PASSWORD`.
receive_timeout		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		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	Choices: absent present ←	The state that should be applied on the entity.
successful_checks		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		Healthmonitortcp settings for healthmonitor.
tenant	Default: admin	Name of tenant used for all Avi API calls and context of object.
tenant_ref		It is a reference to an object of type tenant.
tenant_uuid	Default:	UUID of tenant used for all Avi API calls and context of object.
type required		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		Healthmonitorudp settings for healthmonitor.
url		Avi controller URL of the object.
username	Default:	Username used for accessing Avi controller. The default value is the environment variable `AVI_USERNAME`.
uuid		Uuid of the health monitor.

Notes ¶

Note

For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.

Examples ¶

- name: Create a HTTPS health monitor
  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

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
obj dict	success, changed	HealthMonitor (api/healthmonitor) object

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Gaurav Rastogi (grastogi@avinetworks.com)

Hint

If you notice any issues in this documentation you can edit this document to improve it.