openstack.cloud.lb_health_monitor – Add/Delete a health m nonitor to a pool in the load balancing service from OpenStack Cloud
Note
This plugin is part of the openstack.cloud collection (version 1.5.1).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install openstack.cloud
.
To use it in a playbook, specify: openstack.cloud.lb_health_monitor
.
Synopsis
- Add or Remove a health monitor to/from a pool in the OpenStack load-balancer service.
Requirements
The below requirements are needed on the host that executes this module.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Parameters
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 |
| 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 |
| 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 |
| Should the resource be present or absent. |
timeout integer | Default: 180 | How long should ansible wait for the requested resource. |
type string |
| 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. |
Notes
Note
- The standard OpenStack environment variables, such as
OS_USERNAME
may be used instead of providing explicit values. - Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/
Examples
#Create a healtmonitor named healthmonitor01 with method HEAD url_path /status and expect code 200 - openstack.cloud.lb_health_monitor: auth: auth_url: "{{keystone_url}}" username: "{{username}}" password: "{{password}}" project_domain_name: "{{domain_name}}" user_domain_name: "{{domain_name}}" project_name: "{{project_name}}" wait: true admin_state_up: True expected_codes: '200' max_retries_down: '4' http_method: GET url_path: "/status" pool: '{{pool_id}}' name: 'healthmonitor01' delay: '10' max_retries: '3' resp_timeout: '5' state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
health_monitor complex | On success when state=present
| Dictionary describing the health monitor. | |
admin_state_up boolean | On success when state=present
| The administrative state of the resource. | |
created_at string | On success when state=present
| The UTC date and timestamp when the resource was created. | |
delay integer | On success when state=present
| The time, in seconds, between sending probes to members. | |
expected_codes string | On success when state=present
| The list of HTTP status codes expected in response from the member to declare it healthy. | |
http_method string | On success when state=present
| The HTTP method that the health monitor uses for requests. | |
id string | On success when state=present
| The health monitor UUID. | |
max_retries string | On success when state=present
| The number of successful checks before changing the operating status of the member to ONLINE. | |
max_retries_down string | On success when state=present
| The number of allowed check failures before changing the operating status of the member to ERROR. | |
name string | On success when state=present
| Human-readable name of the resource. | |
operating_status string | On success when state=present
| The operating status of the resource. | |
pool_id string | On success when state=present
| The id of the pool. | |
project_id string | On success when state=present
| The ID of the project owning this resource. | |
provisioning_status string | On success when state=present
| The provisioning status of the resource. | |
timeout integer | On success when state=present
| The maximum time, in seconds, that a monitor waits to connect before it times out. | |
type string | On success when state=present
| The type of health monitor. | |
updated_at string | On success when state=present
| The UTC date and timestamp when the resource was last updated. | |
url_path string | On success when state=present
| The HTTP URL path of the request sent by the monitor to test the health of a backend member. |
Authors
- OpenStack Ansible SIG
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/lb_health_monitor_module.html