.. Document meta

:orphan:

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

.. meta::
  :antsibull-docs: 2.26.0

.. Anchors

.. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_module:

.. Anchors: short name for ansible.builtin

.. Title

stephrobert.scaleway.lb_backend_stat_info module -- Gather information about Scaleway Load Balancer backend stats
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. 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_stat_info_module_requirements>` for details.

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

.. version_added

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

New in stephrobert.scaleway 0.1.0

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

.. Deprecated


Synopsis
--------

.. Description

- List information about your backend servers, including their state and the result of their last health check.


.. Aliases


.. Requirements

.. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_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_stat_info_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_stat_info_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_stat_info_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_stat_info_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_stat_info_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`

      .. raw:: html

        </div>

    - .. raw:: html

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

      ID of the backend.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_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-lb_id"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_module__parameter-lb_id:

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

      **lb_id**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-lb_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">

      Load Balancer ID.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_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_stat_info_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_stat_info_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-secret_key"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_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-user_agent"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_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_stat_info_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_stat_info_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">

      This module only reads, so check mode changes nothing about how it runs.


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_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-none:`none`


      .. raw:: html

        </div>

    - .. raw:: html

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

      This module changes nothing, so it has no difference to report.


      .. 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

    # This module only reads: it never changes anything, and check mode
    # is native.

    - name: List backend server statistics
      stephrobert.scaleway.lb_backend_stat_info:
        zone: fr-par-1
        lb_id: 11111111-2222-3333-4444-555555555555
      register: result
    - name: Filter Scaleway Load Balancer backend stats by backend_id
      stephrobert.scaleway.lb_backend_stat_info:
        zone: fr-par-1
        lb_id: 11111111-2222-3333-4444-555555555555
        backend_id: 11111111-2222-3333-4444-555555555555
      register: result



.. 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-backend_servers_stats"></div>

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_module__return-backend_servers_stats:

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

      **backend_servers_stats**

      .. raw:: html

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

      .. ansible-option-type-line::

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

      .. raw:: html

        </div>

    - .. raw:: html

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

      List information about your backend servers, including their state and the result of their last health check.


      .. 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-backend_servers_stats/backend_id"></div>

      .. raw:: latex

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

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_module__return-backend_servers_stats/backend_id:

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

      **backend_id**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-backend_servers_stats/backend_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-backend_servers_stats/instance_id"></div>

      .. raw:: latex

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

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_module__return-backend_servers_stats/instance_id:

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

      **instance_id**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-backend_servers_stats/instance_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">

      ID of your Load Balancer's underlying Instance.


      .. 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-backend_servers_stats/ip"></div>

      .. raw:: latex

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

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_module__return-backend_servers_stats/ip:

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

      **ip**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-backend_servers_stats/ip" 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">

      IPv4 or IPv6 address of the 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-backend_servers_stats/last_health_check_status"></div>

      .. raw:: latex

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

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_module__return-backend_servers_stats/last_health_check_status:

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

      **last_health_check_status**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-backend_servers_stats/last_health_check_status" 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">

      Last health check status (unknown/neutral/failed/passed/condpass).


      .. 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-backend_servers_stats/server_state"></div>

      .. raw:: latex

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

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_module__return-backend_servers_stats/server_state:

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

      **server_state**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-backend_servers_stats/server_state" 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">

      Server operational state (stopped/starting/running/stopping).


      .. 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-backend_servers_stats/server_state_changed_at"></div>

      .. raw:: latex

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

      .. _ansible_collections.stephrobert.scaleway.lb_backend_stat_info_module__return-backend_servers_stats/server_state_changed_at:

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

      **server_state_changed_at**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-backend_servers_stats/server_state_changed_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">

      Time since last operational change. (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