New in version 1.9.
parameter | required | default | choices | comments |
---|---|---|---|---|
backend |
no | auto-detected | Name of the HAProxy backend pool. | |
fail_on_not_found (added in 2.2) |
no | Fail whenever trying to enable/disable a backend host that does not exist | ||
host |
yes | Name of the backend host to change. | ||
shutdown_sessions |
no | When disabling a server, immediately terminate all the sessions attached to the specified server. This can be used to terminate long-running sessions after a server is put into maintenance mode. | ||
socket |
no | /var/run/haproxy.sock | Path to the HAProxy socket file. | |
state |
yes |
|
Desired state of the provided backend host. | |
wait (added in 2.0) |
no | Wait until the server reports a status of 'UP' when `state=enabled`, or status of 'MAINT' when `state=disabled`. | ||
wait_interval (added in 2.0) |
no | 5 | Number of seconds to wait between retries. | |
wait_retries (added in 2.0) |
no | 25 | Number of times to check for status after changing the state. | |
weight |
no | The value passed in argument. If the value ends with the `%` sign, then the new weight will be relative to the initially configured weight. Relative weights are only permitted between 0 and 100% and absolute weights are permitted between 0 and 256. |
# disable server in 'www' backend pool - haproxy: state: disabled host: '{{ inventory_hostname }}' backend: www # disable server without backend pool name (apply to all available backend pool) - haproxy: state: disabled host: '{{ inventory_hostname }}' # disable server, provide socket file - haproxy: state: disabled host: '{{ inventory_hostname }}' socket: /var/run/haproxy.sock backend: www # disable server, provide socket file, wait until status reports in maintenance - haproxy: state: disabled host: '{{ inventory_hostname }}' socket: /var/run/haproxy.sock backend: www wait: yes # disable backend server in 'www' backend pool and drop open sessions to it - haproxy: state: disabled host: '{{ inventory_hostname }}' backend: www socket: /var/run/haproxy.sock shutdown_sessions: true # disable server without backend pool name (apply to all available backend pool) but fail when the backend host is not found - haproxy: state: disabled host: '{{ inventory_hostname }}' fail_on_not_found: yes # enable server in 'www' backend pool - haproxy: state: enabled host: '{{ inventory_hostname }}' backend: www # enable server in 'www' backend pool wait until healthy - haproxy: state: enabled host: '{{ inventory_hostname }}' backend: www wait: yes # enable server in 'www' backend pool wait until healthy. Retry 10 times with intervals of 5 seconds to retrieve the health - haproxy: state: enabled host: '{{ inventory_hostname }}' backend: www wait: yes wait_retries: 10 wait_interval: 5 # enable server in 'www' backend pool with change server(s) weight - haproxy: state: enabled host: '{{ inventory_hostname }}' socket: /var/run/haproxy.sock weight: 10 backend: www
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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.