ansible / ansible.builtin / v2.3.3.0-1 / module / haproxy Enable, disable, and set weights for HAProxy backend servers using socket commands. | "added in version" 1.9 of ansible.builtin" Authors: Ravi Bhure (@ravibhure) preview | supported by communityansible.builtin.haproxy (v2.3.3.0-1) — module
pip
Install with pip install ansible==2.3.3.0.post1
Enable, disable, and set weights for HAProxy backend servers using socket commands.
# 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
host: default: null description: - Name of the backend host to change. required: true wait: default: false description: - Wait until the server reports a status of 'UP' when `state=enabled`, or status of 'MAINT' when `state=disabled`. required: false version_added: '2.0' version_added_collection: ansible.builtin state: choices: - enabled - disabled default: null description: - Desired state of the provided backend host. required: true socket: default: /var/run/haproxy.sock description: - Path to the HAProxy socket file. required: false weight: default: null description: - 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. required: false backend: default: auto-detected description: - Name of the HAProxy backend pool. required: false wait_retries: default: 25 description: - Number of times to check for status after changing the state. required: false version_added: '2.0' version_added_collection: ansible.builtin wait_interval: default: 5 description: - Number of seconds to wait between retries. required: false version_added: '2.0' version_added_collection: ansible.builtin fail_on_not_found: default: false description: - Fail whenever trying to enable/disable a backend host that does not exist required: false version_added: '2.2' version_added_collection: ansible.builtin shutdown_sessions: default: false description: - 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. required: false