.. Document meta

:orphan:

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

.. meta::
  :antsibull-docs: 2.26.0

.. Anchors

.. _ansible_collections.stephrobert.scaleway.fleet_report_role:

.. Title

stephrobert.scaleway.fleet_report role -- Report on a Scaleway fleet, without touching it
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This role 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`.

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

.. contents::
   :local:
   :depth: 2

.. _ansible_collections.stephrobert.scaleway.fleet_report_role__entrypoint-main:

.. Entry point title

Entry point ``main`` -- Report on a Scaleway fleet, without touching it
-----------------------------------------------------------------------

.. version_added


.. Deprecated


Synopsis
^^^^^^^^

.. Description

- Instances by state, by zone and by tag, plus the load balancers. It creates nothing and changes nothing, which is what makes it safe to run first on an account you do not know.
- It never counts a zone it could not read. A zone that does not answer is named as unmeasured rather than contributing a zero, and the totals are :literal:`null` rather than :literal:`0` when no zone answered at all.
- The report is left in :literal:`scaleway\_fleet\_report\_result` so a calling playbook can use it rather than read it.

.. Requirements


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

      .. _ansible_collections.stephrobert.scaleway.fleet_report_role__parameter-main__scaleway_fleet_report_output:

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

      **scaleway_fleet_report_output**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`string`




      .. raw:: html

        </div>

    - .. raw:: html

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

      Which rendering to print. The report itself is returned whatever this says.


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

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry-default:`"text"` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`"json"`
      - :ansible-option-choices-entry:`"markdown"`


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.stephrobert.scaleway.fleet_report_role__parameter-main__scaleway_fleet_report_zones:

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

      **scaleway_fleet_report_zones**

      .. raw:: html

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

      .. ansible-option-type-line::

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




      .. raw:: html

        </div>

    - .. raw:: html

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

      The zones to ask. Defaults to what the contract declares.


      .. raw:: html

        </div>


.. Attributes


.. Notes


.. Seealso





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