Documentation

avi_healthmonitor - Module for setup of HealthMonitor Avi RESTful Object

New in version 2.3.

Synopsis

Options

parameter required default choices comments
controller
no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
description
no
User defined description for the object.
dns_monitor
no
Healthmonitordns settings for healthmonitor.
external_monitor
no
Healthmonitorexternal settings for healthmonitor.
failed_checks
no
Number of continuous failed health checks before the server is marked down.
Default value when not specified in API or module is interpreted by Avi Controller as 2.
http_monitor
no
Healthmonitorhttp settings for healthmonitor.
https_monitor
no
Healthmonitorhttp settings for healthmonitor.
monitor_port
no
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.
name
yes
A user friendly name for this health monitor.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
receive_timeout
no
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.
Default value when not specified in API or module is interpreted by Avi Controller as 4.
send_interval
no
Frequency, in seconds, that monitors are sent to a server.
Default value when not specified in API or module is interpreted by Avi Controller as 10.
state
no present
  • absent
  • present
The state that should be applied on the entity.
successful_checks
no
Number of continuous successful health checks before server is marked up.
Default value when not specified in API or module is interpreted by Avi Controller as 2.
tcp_monitor
no
Healthmonitortcp settings for healthmonitor.
tenant
no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
no
It is a reference to an object of type tenant.
tenant_uuid
no
UUID of tenant used for all Avi API calls and context of object.
type
yes
Type of the health monitor.
udp_monitor
no
Healthmonitorudp settings for healthmonitor.
url
no
Avi controller URL of the object.
username
no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
no
Uuid of the health monitor.

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 Return Values, the following are the fields unique to this module:

name description returned type sample
obj HealthMonitor (api/healthmonitor) object success, changed dict


Status

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

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.