Parameter |
Choices/Defaults |
Comments |
admin_state_up
boolean
|
|
The admin state of the helath monitor true for up or false for down
|
api_timeout
integer
|
|
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
|
auth
dictionary
|
|
Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, user_domain_name or project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
|
auth_type
string
|
|
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
|
availability_zone
string
|
|
Ignored. Present for backwards compatibility
|
ca_cert
string
|
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
aliases: cacert
|
client_cert
string
|
|
A path to a client certificate to use as part of the SSL transaction.
aliases: cert
|
client_key
string
|
|
A path to a client key to use as part of the SSL transaction.
aliases: key
|
cloud
raw
|
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
|
delay
string
/ required
|
|
the interval, in seconds, between health checks.
|
expected_codes
string
|
Default:
200
|
The list of HTTP status codes expected in response from the member to declare it healthy. Specify one of the following values A single value, such as 200 A list, such as 200, 202 A range, such as 200-204
|
http_method
string
|
Choices:
GET ←
- CONNECT
- DELETE
- HEAD
- OPTIONS
- PATCH
- POST
- PUT
- TRACE
|
The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET.
|
interface
string
|
Choices:
- admin
- internal
public ←
|
Endpoint URL type to fetch from the service catalog.
aliases: endpoint_type
|
max_retries
string
/ required
|
|
The number of successful checks before changing the operating status of the member to ONLINE.
|
max_retries_down
string
|
Default:
3
|
The number of allowed check failures before changing the operating status of the member to ERROR. A valid value is from 1 to 10. The default is 3.
|
name
string
/ required
|
|
Name that has to be given to the health monitor
|
pool
string
/ required
|
|
The pool name or id to monitor by the health monitor.
|
region_name
string
|
|
Name of the region.
|
resp_timeout
integer
/ required
|
|
The time, in seconds, after which a health check times out. Must be less than delay
|
state
string
|
Choices:
present ←
- absent
|
Should the resource be present or absent.
|
timeout
integer
|
Default:
180
|
How long should ansible wait for the requested resource.
|
type
string
|
Choices:
HTTP ←
- HTTPS
- PING
- SCTP
- TCP
- TLS-HELLO
- UDP-CONNECT
|
One of HTTP, HTTPS, PING, SCTP, TCP, TLS-HELLO, or UDP-CONNECT.
|
url_path
string
|
Default:
"/"
|
The HTTP URL path of the request sent by the monitor to test the health of a backend member. Must be a string that begins with a forward slash (/). The default URL path is /.
|
validate_certs
boolean
|
|
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes .
aliases: verify
|
wait
boolean
|
|
Should ansible wait until the requested resource is complete.
|