a10_health_monitor¶

Synopsis
Parameters
Examples
Status

Synopsis ¶

Define the Health Monitor object

Parameters ¶

Parameters		Choices/Defaults	Comment
state str/required		[‘noop’, ‘present’, ‘absent’]	State of the object to be created.
ansible_host str/required			Host for AXAPI authentication
ansible_username str/required			Username for AXAPI authentication
ansible_password str/required			Password for AXAPI authentication
ansible_port int/required			Port for AXAPI authentication
a10_device_context_id int		[‘1-8’]	Device ID for aVCS configuration
a10_partition str			Destination/target partition for object/command
name str/required			Monitor Name
dsr_l2_strict bool			Enable strict L2dsr health-check
retry int			Specify the Healthcheck Retries (Retry Count (default 3))
up_retry int			Specify the Healthcheck Retries before declaring target up (Up-retry count (default 1))
override_ipv4 str			Override implicitly inherited IPv4 address from target
override_ipv6 str			Override implicitly inherited IPv6 address from target
override_port int			Override implicitly inherited port from target (Port number (1-65534))
passive bool			Specify passive mode
status_code str			‘status-code-2xx’= Enable passive mode with 2xx http status code; ‘status-code- non-5xx’= Enable passive mode with non-5xx http status code;
passive_interval int			Interval to do manual health checking while in passive mode (Specify value in seconds (Default is 10 s))
sample_threshold int			Number of samples in one epoch above which passive HC is enabled. If below or equal to the threshold, passive HC is disabled (Specify number of samples in one second (Default is 50). If the number of samples is 0, no action is taken)
threshold int			Threshold percentage above which passive mode is enabled (Specify percentage (Default is 75%))
strict_retry_on_server_err_resp bool			Require strictly retry
disable_after_down bool			Disable the target if health check failed
interval int			Specify the Healthcheck Interval (Interval Value, in seconds (default 5))
timeout int			Specify the Healthcheck Timeout (Timeout Value, in seconds(default 5), Timeout should be less than or equal to interval)
ssl_ciphers str			Specify OpenSSL Cipher Suite name(s) for Health check (OpenSSL Cipher Suite(s) (Eg= AES128-SHA256), if the cipher is invalid, would give information at HM down reason)
uuid str			uuid of the object
user_tag str			Customized tag
method dict			Field method
	icmp dict		Field icmp
	tcp dict		Field tcp
	udp dict		Field udp
	http dict		Field http
	ftp dict		Field ftp
	snmp dict		Field snmp
	smtp dict		Field smtp
	dns dict		Field dns
	pop3 dict		Field pop3
	imap dict		Field imap
	sip dict		Field sip
	radius dict		Field radius
	ldap dict		Field ldap
	rtsp dict		Field rtsp
	database dict		Field database
	external dict		Field external
	ntp dict		Field ntp
	kerberos_kdc dict		Field kerberos_kdc
	https dict		Field https
	tacplus dict		Field tacplus
	compound dict		Field compound

Examples ¶

- name: Create a TCP health monitor
  a10.acos_axapi.a10_health_monitor:
    up_retry: 1
    retry: 1
    method:
      tcp:
        method_tcp: 1
        tcp_port: 80
    name: my_tcp_monitor

- name: Create an HTTP health monitor
  a10.acos_axapi.a10_health_monitor:
    up_retry: 1
    retry: 1
    method:
      http:
        http: 1
        http_port: 80
    name: my_http_monitor

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by community.

Authors¶

A10 Networks 2021