.. Document meta

:orphan:

.. |antsibull-internal-nbsp| unicode:: 0xA0
    :trim:

.. meta::
  :antsibull-docs: 2.26.0

.. Anchors

.. _ansible_collections.stephrobert.scaleway.lb_backend_module:

.. Anchors: short name for ansible.builtin

.. Title

stephrobert.scaleway.lb_backend module -- Manage a Scaleway Load Balancer backend
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This module is part of the `stephrobert.scaleway collection <https://galaxy.ansible.com/ui/repo/published/stephrobert/scaleway/>`_ (version 0.7.0).

    It is not included in ``ansible-core``.
    To check whether it is installed, run :code:`ansible-galaxy collection list`.

    To install it, use: :code:`ansible\-galaxy collection install stephrobert.scaleway`.
    You need further requirements to be able to use this module,
    see :ref:`Requirements <ansible_collections.stephrobert.scaleway.lb_backend_module_requirements>` for details.

    To use it in a playbook, specify: :code:`stephrobert.scaleway.lb_backend`.

.. version_added

.. rst-class:: ansible-version-added

New in stephrobert.scaleway 0.1.0

.. contents::
   :local:
   :depth: 1

.. Deprecated


Synopsis
--------

.. Description

- Update a backend of a given Load Balancer, specified by its backend ID.
- The module reads the resource first and writes the whole body, because this operation replaces the resource: fields you do not set keep the value the API returns. A second run reports no change.


.. Aliases


.. Requirements

.. _ansible_collections.stephrobert.scaleway.lb_backend_module_requirements:

Requirements
------------
The below requirements are needed on the host that executes this module.

- scaleway \>= 2.9.0






.. Options

Parameters
----------

.. tabularcolumns:: \X{1}{3}\X{2}{3}

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1
  :class: longtable ansible-option-table

  * - Parameter
    - Comments

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-access_key"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-access_key:

      .. rst-class:: ansible-option-title

      **access_key**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-access_key" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Scaleway API access key.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-api_allow_insecure"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-api_allow_insecure:

      .. rst-class:: ansible-option-title

      **api_allow_insecure**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-api_allow_insecure" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Allow the API endpoint to be reached without verifying its TLS certificate.

      Falls back to the Scaleway configuration file, then to :literal:`false`.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-api_timeout"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-api_timeout:

      .. rst-class:: ansible-option-title

      **api_timeout**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-api_timeout" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Seconds allowed for a single API call, connection and read.

      Without a limit a silent connection would hang the module forever: the Scaleway SDK issues its requests with no timeout at all.

      This bounds a single call, not a whole wait. Modules that can wait for a state bound the overall wait separately.


      .. rst-class:: ansible-option-line

      :ansible-option-default-bold:`Default:` :ansible-option-default:`60`

      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-api_url"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-api_url:

      .. rst-class:: ansible-option-title

      **api_url**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-api_url" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      URL of the Scaleway API endpoint.

      Point it at a local emulator to exercise a playbook without credentials.

      Falls back to the Scaleway configuration file, then to :literal:`https://api.scaleway.com`. It carries no module default on purpose: a default is never unset, so it would always override the profile.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-backend_id"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-backend_id:

      .. rst-class:: ansible-option-title

      **backend_id**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-backend_id" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string` / :ansible-option-required:`required`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Backend ID.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-config_file"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-config_file:

      .. rst-class:: ansible-option-title

      **config_file**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config_file" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`path`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Path to the Scaleway configuration file.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-failover_host"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-failover_host:

      .. rst-class:: ansible-option-title

      **failover_host**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-failover_host" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover\-website.s3\-website.fr\-par.scw.cloud.

      To clear this field, write \`failover\_host: ""\`; omit the option to leave the current value untouched.

      Setting it to null is refused: this API reads null as "field not provided" and would change nothing.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-forward_port"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-forward_port:

      .. rst-class:: ansible-option-title

      **forward_port**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-forward_port" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer` / :ansible-option-required:`required`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Port to be used by the backend when forwarding traffic to backend servers.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-forward_port_algorithm"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-forward_port_algorithm:

      .. rst-class:: ansible-option-title

      **forward_port_algorithm**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-forward_port_algorithm" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string` / :ansible-option-required:`required`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Load balancing algorithm to be used when determining which backend server to forward new traffic to.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"roundrobin"`
      - :ansible-option-choices-entry:`"leastconn"`
      - :ansible-option-choices-entry:`"first"`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-forward_protocol"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-forward_protocol:

      .. rst-class:: ansible-option-title

      **forward_protocol**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-forward_protocol" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string` / :ansible-option-required:`required`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Protocol to be used by the backend when forwarding traffic to backend servers.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"tcp"`
      - :ansible-option-choices-entry:`"http"`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-host"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-host:

      .. rst-class:: ansible-option-title

      **host**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-host" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      :ansible-option-versionadded:`added in stephrobert.scaleway 0.5.0`


      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Host value to use when connecting to backend servers.
      When connecting to backend servers, use this value as the HTTP Host header or TLS SNI. This allows routing to specific services on the backend server that are configured to respond to particular hostnames.

      To clear this field, write \`host: ""\`; omit the option to leave the current value untouched.

      Setting it to null is refused: this API reads null as "field not provided" and would change nothing.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-ignore_ssl_server_verify"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-ignore_ssl_server_verify:

      .. rst-class:: ansible-option-title

      **ignore_ssl_server_verify**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-ignore_ssl_server_verify" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Defines whether the server certificate verification should be ignored.

      The contract marks this field clearable, but bool has no empty value, so the API cannot clear it. Setting it to null is refused: this API reads null as "field not provided" and would change nothing.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-max_connections"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-max_connections:

      .. rst-class:: ansible-option-title

      **max_connections**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-max_connections" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Maximum number of connections allowed per backend server.

      The contract marks this field clearable, but int has no empty value, so the API cannot clear it. Setting it to null is refused: this API reads null as "field not provided" and would change nothing.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-max_retries"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-max_retries:

      .. rst-class:: ansible-option-title

      **max_retries**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-max_retries" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Number of retries when a backend server connection failed.

      The contract marks this field clearable, but int has no empty value, so the API cannot clear it. Setting it to null is refused: this API reads null as "field not provided" and would change nothing.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-name"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-name:

      .. rst-class:: ansible-option-title

      **name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string` / :ansible-option-required:`required`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Backend name.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-on_marked_down_action"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-on_marked_down_action:

      .. rst-class:: ansible-option-title

      **on_marked_down_action**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-on_marked_down_action" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Action to take when a backend server is marked as down.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"on\_marked\_down\_action\_none"`
      - :ansible-option-choices-entry:`"shutdown\_sessions"`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-organization_id"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-organization_id:

      .. rst-class:: ansible-option-title

      **organization_id**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-organization_id" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Default Organization ID used when an operation does not name one.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-profile"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-profile:

      .. rst-class:: ansible-option-title

      **profile**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-profile" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Name of the profile to read in the Scaleway configuration file.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-project_id"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-project_id:

      .. rst-class:: ansible-option-title

      **project_id**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-project_id" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Default Project ID used when an operation does not name one.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-proxy_protocol"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-proxy_protocol:

      .. rst-class:: ansible-option-title

      **proxy_protocol**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-proxy_protocol" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"proxy\_protocol\_unknown"`
      - :ansible-option-choices-entry:`"proxy\_protocol\_none"`
      - :ansible-option-choices-entry:`"proxy\_protocol\_v1"`
      - :ansible-option-choices-entry:`"proxy\_protocol\_v2"`
      - :ansible-option-choices-entry:`"proxy\_protocol\_v2\_ssl"`
      - :ansible-option-choices-entry:`"proxy\_protocol\_v2\_ssl\_cn"`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-redispatch_attempt_count"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-redispatch_attempt_count:

      .. rst-class:: ansible-option-title

      **redispatch_attempt_count**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-redispatch_attempt_count" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Whether to use another backend server on each attempt.

      The contract marks this field clearable, but int has no empty value, so the API cannot clear it. Setting it to null is refused: this API reads null as "field not provided" and would change nothing.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-secret_key"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-secret_key:

      .. rst-class:: ansible-option-title

      **secret_key**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-secret_key" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Scaleway API secret key.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-send_proxy_v2"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-send_proxy_v2:

      .. rst-class:: ansible-option-title

      **send_proxy_v2**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-send_proxy_v2" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Deprecated in favor of proxy\_protocol field.

      Deprecated by the Scaleway API contract.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-ssl_bridging"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-ssl_bridging:

      .. rst-class:: ansible-option-title

      **ssl_bridging**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-ssl_bridging" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Defines whether to enable SSL bridging between the Load Balancer and backend servers.

      The contract marks this field clearable, but bool has no empty value, so the API cannot clear it. Setting it to null is refused: this API reads null as "field not provided" and would change nothing.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-sticky_sessions"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-sticky_sessions:

      .. rst-class:: ansible-option-title

      **sticky_sessions**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-sticky_sessions" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string` / :ansible-option-required:`required`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie\-based uses an HTTP cookie to stick a session to a backend server. Table\-based uses the source (client) IP address to stick a session to a backend server.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"none"`
      - :ansible-option-choices-entry:`"cookie"`
      - :ansible-option-choices-entry:`"table"`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-sticky_sessions_cookie_name"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-sticky_sessions_cookie_name:

      .. rst-class:: ansible-option-title

      **sticky_sessions_cookie_name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-sticky_sessions_cookie_name" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Cookie name for cookie\-based sticky sessions.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-timeout_connect"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-timeout_connect:

      .. rst-class:: ansible-option-title

      **timeout_connect**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-timeout_connect" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`float`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Maximum allowed time for establishing a connection to a backend server. (in milliseconds)


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-timeout_queue"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-timeout_queue:

      .. rst-class:: ansible-option-title

      **timeout_queue**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-timeout_queue" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Maximum time for a request to be left pending in queue when \`max\_connections\` is reached. (in seconds)

      To clear this field, write \`timeout\_queue: ""\`; omit the option to leave the current value untouched.

      Setting it to null is refused: this API reads null as "field not provided" and would change nothing.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-timeout_server"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-timeout_server:

      .. rst-class:: ansible-option-title

      **timeout_server**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-timeout_server" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`float`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Maximum allowed time for a backend server to process a request. (in milliseconds)


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-timeout_tunnel"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-timeout_tunnel:

      .. rst-class:: ansible-option-title

      **timeout_tunnel**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-timeout_tunnel" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`float`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). (in milliseconds)


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-user_agent"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-user_agent:

      .. rst-class:: ansible-option-title

      **user_agent**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-user_agent" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Value of the User\-Agent header sent to the API.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-zone"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__parameter-zone:

      .. rst-class:: ansible-option-title

      **zone**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-zone" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string` / :ansible-option-required:`required`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The zone you want to target


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"fr\-par\-1"`
      - :ansible-option-choices-entry:`"fr\-par\-2"`
      - :ansible-option-choices-entry:`"nl\-ams\-1"`
      - :ansible-option-choices-entry:`"nl\-ams\-2"`
      - :ansible-option-choices-entry:`"nl\-ams\-3"`
      - :ansible-option-choices-entry:`"pl\-waw\-1"`
      - :ansible-option-choices-entry:`"pl\-waw\-2"`
      - :ansible-option-choices-entry:`"pl\-waw\-3"`


      .. raw:: html

        </div>


.. Attributes


Attributes
----------

.. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10}

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1
  :class: longtable ansible-option-table

  * - Attribute
    - Support
    - Description

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="attribute-check_mode"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__attribute-check_mode:

      .. rst-class:: ansible-option-title

      **check_mode**

      .. raw:: html

        <a class="ansibleOptionLink" href="#attribute-check_mode" title="Permalink to this attribute"></a>

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`


      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      In check mode the module reads the resource and compares it, then reports what it would write without writing it.


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="attribute-diff_mode"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__attribute-diff_mode:

      .. rst-class:: ansible-option-title

      **diff_mode**

      .. raw:: html

        <a class="ansibleOptionLink" href="#attribute-diff_mode" title="Permalink to this attribute"></a>

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`


      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      The module reports the fields that differ, read through the same projection the comparison uses.


      .. raw:: html

        </div>



.. Notes

Notes
-----

.. note::
   - Every option can be set from its environment variable, respectively :literal:`SCW\_PROFILE`\ , :literal:`SCW\_CONFIG\_PATH`\ , :literal:`SCW\_ACCESS\_KEY`\ , :literal:`SCW\_SECRET\_KEY`\ , :literal:`SCW\_API\_URL`\ , :literal:`SCW\_DEFAULT\_ORGANIZATION\_ID` and :literal:`SCW\_DEFAULT\_PROJECT\_ID`.
   - Module options take precedence over environment variables, which take precedence over the configuration file.

.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    # The module reads the resource, compares, and writes only what
    # differs: run it twice and the second run reports no change.
    #
    # Check mode compares without writing, and `--diff` shows what would
    # change. A parameter you do not pass is a parameter the module does
    # not touch.

    - name: Update a Scaleway Load Balancer backend
      stephrobert.scaleway.lb_backend:
        zone: fr-par-1
        backend_id: 11111111-2222-3333-4444-555555555555
        forward_port: 80
        forward_port_algorithm: roundrobin
        forward_protocol: tcp
        name: my-backend
        sticky_sessions: none
      register: result
    - name: Preview the change on a Scaleway Load Balancer backend without writing
      stephrobert.scaleway.lb_backend:
        zone: fr-par-1
        backend_id: 11111111-2222-3333-4444-555555555555
        forward_port: 80
        forward_port_algorithm: roundrobin
        forward_protocol: tcp
        name: my-backend
        sticky_sessions: none
      register: result
      check_mode: true
      diff: true



.. Facts


.. Return values

Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. tabularcolumns:: \X{1}{3}\X{2}{3}

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1
  :class: longtable ansible-option-table

  * - Key
    - Description

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource:

      .. rst-class:: ansible-option-title

      **resource**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Get the full details of a given backend, specified by its backend ID. The response contains the backend's full configuration parameters including protocol, port and forwarding algorithm.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` success


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/created_at"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/created_at:

      .. rst-class:: ansible-option-title

      **created_at**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/created_at" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Date at which the backend was created. (RFC 3339 format)


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/failover_host"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/failover_host:

      .. rst-class:: ansible-option-title

      **failover_host**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/failover_host" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover\-website.s3\-website.fr\-par.scw.cloud.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/forward_port"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/forward_port:

      .. rst-class:: ansible-option-title

      **forward_port**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/forward_port" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Port used by the backend when forwarding traffic to backend servers.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/forward_port_algorithm"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/forward_port_algorithm:

      .. rst-class:: ansible-option-title

      **forward_port_algorithm**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/forward_port_algorithm" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Load balancing algorithm to use when determining which backend server to forward new traffic to.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/forward_protocol"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/forward_protocol:

      .. rst-class:: ansible-option-title

      **forward_protocol**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/forward_protocol" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Protocol used by the backend when forwarding traffic to backend servers.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/health_check"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/health_check:

      .. rst-class:: ansible-option-title

      **health_check**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/health_check" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Object defining the health check to be carried out by the backend when checking the status and health of backend servers.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/host"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/host:

      .. rst-class:: ansible-option-title

      **host**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/host" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Host value to use when connecting to backend servers.
      When connecting to backend servers, use this value as the HTTP Host header or TLS SNI. This allows routing to specific services on the backend server that are configured to respond to particular hostnames.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/id"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/id:

      .. rst-class:: ansible-option-title

      **id**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/id" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Backend ID.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/ignore_ssl_server_verify"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/ignore_ssl_server_verify:

      .. rst-class:: ansible-option-title

      **ignore_ssl_server_verify**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/ignore_ssl_server_verify" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Defines whether the server certificate verification should be ignored.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/lb"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/lb:

      .. rst-class:: ansible-option-title

      **lb**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/lb" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Load Balancer the backend is attached to.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/max_connections"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/max_connections:

      .. rst-class:: ansible-option-title

      **max_connections**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/max_connections" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Maximum number of connections allowed per backend server.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/max_retries"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/max_retries:

      .. rst-class:: ansible-option-title

      **max_retries**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/max_retries" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Number of retries when a backend server connection failed.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/name"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/name:

      .. rst-class:: ansible-option-title

      **name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/name" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Name of the backend.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/on_marked_down_action"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/on_marked_down_action:

      .. rst-class:: ansible-option-title

      **on_marked_down_action**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/on_marked_down_action" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Action to take when a backend server is marked as down.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/pool"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/pool:

      .. rst-class:: ansible-option-title

      **pool**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/pool" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`list` / :ansible-option-elements:`elements=string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      List of IP addresses of backend servers attached to this backend.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/proxy_protocol"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/proxy_protocol:

      .. rst-class:: ansible-option-title

      **proxy_protocol**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/proxy_protocol" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/redispatch_attempt_count"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/redispatch_attempt_count:

      .. rst-class:: ansible-option-title

      **redispatch_attempt_count**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/redispatch_attempt_count" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Whether to use another backend server on each attempt.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/send_proxy_v2"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/send_proxy_v2:

      .. rst-class:: ansible-option-title

      **send_proxy_v2**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/send_proxy_v2" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Deprecated in favor of proxy\_protocol field.

      Deprecated by the Scaleway API contract.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/ssl_bridging"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/ssl_bridging:

      .. rst-class:: ansible-option-title

      **ssl_bridging**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/ssl_bridging" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Defines whether to enable SSL bridging between the Load Balancer and backend servers.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/sticky_sessions"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/sticky_sessions:

      .. rst-class:: ansible-option-title

      **sticky_sessions**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/sticky_sessions" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Defines whether sticky sessions (binding a particular session to a particular backend server) are activated and the method to use if so. None disables sticky sessions. Cookie\-based uses an HTTP cookie to stick a session to a backend server. Table\-based uses the source (client) IP address to stick a session to a backend server.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/sticky_sessions_cookie_name"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/sticky_sessions_cookie_name:

      .. rst-class:: ansible-option-title

      **sticky_sessions_cookie_name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/sticky_sessions_cookie_name" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Cookie name for cookie\-based sticky sessions.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/timeout_connect"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/timeout_connect:

      .. rst-class:: ansible-option-title

      **timeout_connect**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/timeout_connect" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`float`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Maximum allowed time for establishing a connection to a backend server. (in milliseconds)


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/timeout_queue"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/timeout_queue:

      .. rst-class:: ansible-option-title

      **timeout_queue**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/timeout_queue" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Maximum time for a request to be left pending in queue when \`max\_connections\` is reached. (in seconds)


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/timeout_server"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/timeout_server:

      .. rst-class:: ansible-option-title

      **timeout_server**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/timeout_server" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`float`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Maximum allowed time for a backend server to process a request. (in milliseconds)


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/timeout_tunnel"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/timeout_tunnel:

      .. rst-class:: ansible-option-title

      **timeout_tunnel**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/timeout_tunnel" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`float`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). (in milliseconds)


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-indent"></div><div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-resource/updated_at"></div>

      .. raw:: latex

        \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}

      .. _ansible_collections.stephrobert.scaleway.lb_backend_module__return-resource/updated_at:

      .. rst-class:: ansible-option-title

      **updated_at**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-resource/updated_at" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

      .. raw:: latex

        \end{minipage}

    - .. raw:: html

        <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">

      Date at which the backend was updated. (RFC 3339 format)


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` when the API returns it


      .. raw:: html

        </div>




..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Stéphane Robert (@stephrobert)


.. Extra links

Collection links
~~~~~~~~~~~~~~~~

.. ansible-links::

  - title: "Issue Tracker"
    url: "https://github.com/stephrobert/collection-scaleway/issues"
    external: true
  - title: "Repository (Sources)"
    url: "https://github.com/stephrobert/collection-scaleway"
    external: true


.. Parsing errors