Documentation

avi_gslbhealthmonitor - Module for setup of GslbHealthMonitor Avi RESTful Object

New in version 2.4.

Synopsis

Options

parameter required default choices comments
api_version
no
Avi API version of to use for Avi API and objects.
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 gslbhealthmonitor.
external_monitor
no
Healthmonitorexternal settings for gslbhealthmonitor.
failed_checks
no
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
no
Healthmonitorhttp settings for gslbhealthmonitor.
https_monitor
no
Healthmonitorhttp settings for gslbhealthmonitor.
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.
Allowed values are 1-65535.
Special values are 0 - 'use server port'.
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.
Allowed values are 1-300.
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.
Allowed values are 1-3600.
Default value when not specified in API or module is interpreted by Avi Controller as 5.
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.
Allowed values are 1-50.
Default value when not specified in API or module is interpreted by Avi Controller as 2.
tcp_monitor
no
Healthmonitortcp settings for gslbhealthmonitor.
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.
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
no
Healthmonitorudp settings for gslbhealthmonitor.
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: Example to create GslbHealthMonitor object
  avi_gslbhealthmonitor:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_gslbhealthmonitor

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 GslbHealthMonitor (api/gslbhealthmonitor) 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, Testing Ansible and Developing Modules.