/ home / ansible / ansible.builtin / v2.9.27 / module / haproxy

ansible.builtin.haproxy (v2.9.27) — module

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 community

Install Ansible via `pip`

Install with pip install ansible==2.9.27

Description

Enable, disable, drain and set weights for HAProxy backend servers using socket commands.

Usage examples

Scanned by Steampunk Spotter

- name: Disable server in 'www' backend pool
  haproxy:
    state: disabled
    host: '{{ inventory_hostname }}'
    backend: www

Scanned by Steampunk Spotter

- name: Disable server without backend pool name (apply to all available backend pool)
  haproxy:
    state: disabled
    host: '{{ inventory_hostname }}'

Scanned by Steampunk Spotter

- name: Disable server, provide socket file
  haproxy:
    state: disabled
    host: '{{ inventory_hostname }}'
    socket: /var/run/haproxy.sock
    backend: www

Scanned by Steampunk Spotter

- name: 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

Scanned by Steampunk Spotter

# Place server in drain mode, providing a socket file.  Then check the server's
# status every minute to see if it changes to maintenance mode, continuing if it
# does in an hour and failing otherwise.
- haproxy:
    state: disabled
    host: '{{ inventory_hostname }}'
    socket: /var/run/haproxy.sock
    backend: www
    wait: yes
    drain: yes
    wait_interval: 1
    wait_retries: 60

Scanned by Steampunk Spotter

- name: 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: yes

Scanned by Steampunk Spotter

- name: 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

Scanned by Steampunk Spotter

- name: Enable server in 'www' backend pool
  haproxy:
    state: enabled
    host: '{{ inventory_hostname }}'
    backend: www

Scanned by Steampunk Spotter

- name: Enable server in 'www' backend pool wait until healthy
  haproxy:
    state: enabled
    host: '{{ inventory_hostname }}'
    backend: www
    wait: yes

Scanned by Steampunk Spotter

- name: 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

Scanned by Steampunk Spotter

- name: 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

Scanned by Steampunk Spotter

- name: Set the server in 'www' backend pool to drain mode
  haproxy:
    state: drain
    host: '{{ inventory_hostname }}'
    socket: /var/run/haproxy.sock
    backend: www

Inputs

    
host:
    description:
    - Name of the backend host to change.
    required: true
    type: str

wait:
    default: false
    description:
    - Wait until the server reports a status of 'UP' when C(state=enabled), status of
      'MAINT' when C(state=disabled) or status of 'DRAIN' when C(state=drain)
    type: bool
    version_added: '2.0'
    version_added_collection: ansible.builtin

drain:
    description:
    - Wait until the server has no active connections or until the timeout determined
      by wait_interval and wait_retries is reached.
    - Continue only after the status changes to 'MAINT'.
    - This overrides the shutdown_sessions option.
    type: bool
    version_added: '2.4'
    version_added_collection: ansible.builtin

state:
    choices:
    - disabled
    - drain
    - enabled
    description:
    - Desired state of the provided backend host.
    - Note that C(drain) state was added in version 2.4.
    - It is supported only by HAProxy version 1.5 or later,
    - When used on versions < 1.5, it will be ignored.
    required: true
    type: str

socket:
    default: /var/run/haproxy.sock
    description:
    - Path to the HAProxy socket file.
    type: path

weight:
    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.
    type: str

backend:
    description:
    - Name of the HAProxy backend pool.
    - If this parameter is unset, it will be auto-detected.
    type: str

wait_retries:
    default: 25
    description:
    - Number of times to check for status after changing the state.
    type: int
    version_added: '2.0'
    version_added_collection: ansible.builtin

wait_interval:
    default: 5
    description:
    - Number of seconds to wait between retries.
    type: int
    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
    type: bool
    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. Overridden by the drain option.
    type: bool

Install Ansible via pip

Description

Usage examples

Inputs

Install Ansible via `pip`