.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. meta:: :antsibull-docs: 2.26.0 .. Anchors .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module: .. Anchors: short name for ansible.builtin .. Title stephrobert.scaleway.instance_dashboard_info module -- Gather information about Scaleway Instance dashboards ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `stephrobert.scaleway collection `_ (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 ` for details. To use it in a playbook, specify: :code:`stephrobert.scaleway.instance_dashboard_info`. .. version_added .. rst-class:: ansible-version-added New in stephrobert.scaleway 0.1.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Return the Instance dashboard of one zone: the resource counts the API keeps for an Organization or a Project, such as \`servers\_count\`, \`running\_servers\_count\`, \`volumes\_count\`, \`images\_count\`, \`snapshots\_count\`, \`ips\_count\`, \`ips\_unused\` and \`security\_groups\_count\`. .. Aliases .. Requirements .. _ansible_collections.stephrobert.scaleway.instance_dashboard_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
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-access_key: .. rst-class:: ansible-option-title **access_key** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Scaleway API access key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-api_allow_insecure: .. rst-class:: ansible-option-title **api_allow_insecure** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-api_timeout: .. rst-class:: ansible-option-title **api_timeout** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-api_url: .. rst-class:: ansible-option-title **api_url** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-config_file: .. rst-class:: ansible-option-title **config_file** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`path` .. raw:: html
- .. raw:: html
Path to the Scaleway configuration file. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-organization: .. rst-class:: ansible-option-title **organization** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Organization ID whose dashboard is returned. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-organization_id: .. rst-class:: ansible-option-title **organization_id** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Default Organization ID used when an operation does not name one. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-profile: .. rst-class:: ansible-option-title **profile** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the profile to read in the Scaleway configuration file. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-project: .. rst-class:: ansible-option-title **project** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Project ID whose dashboard is returned. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-project_id: .. rst-class:: ansible-option-title **project_id** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Default Project ID used when an operation does not name one. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-secret_key: .. rst-class:: ansible-option-title **secret_key** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Scaleway API secret key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-user_agent: .. rst-class:: ansible-option-title **user_agent** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Value of the User\-Agent header sent to the API. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__parameter-zone: .. rst-class:: ansible-option-title **zone** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
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:`"fr\-par\-3"` - :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"` - :ansible-option-choices-entry:`"it\-mil\-1"` .. raw:: html
.. 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
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__attribute-check_mode: .. rst-class:: ansible-option-title **check_mode** .. raw:: html .. raw:: html
- .. raw:: html
:ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` .. raw:: html
- .. raw:: html
This module only reads, so check mode changes nothing about how it runs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__attribute-diff_mode: .. rst-class:: ansible-option-title **diff_mode** .. raw:: html .. raw:: html
- .. raw:: html
:ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-none:`none` .. raw:: html
- .. raw:: html
This module changes nothing, so it has no difference to report. .. raw:: html
.. 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: Read a Scaleway Instance dashboard stephrobert.scaleway.instance_dashboard_info: zone: fr-par-1 register: result .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, 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
.. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard: .. rst-class:: ansible-option-title **dashboard** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Return the Instance dashboard of one zone: the resource counts the API keeps for an Organization or a Project, such as \`servers\_count\`, \`running\_servers\_count\`, \`volumes\_count\`, \`images\_count\`, \`snapshots\_count\`, \`ips\_count\`, \`ips\_unused\` and \`security\_groups\_count\`. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/images_count: .. rst-class:: ansible-option-title **images_count** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of images. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/ips_count: .. rst-class:: ansible-option-title **ips_count** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of IPs. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/ips_unused: .. rst-class:: ansible-option-title **ips_unused** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of unused IP addresses. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/placement_groups_count: .. rst-class:: ansible-option-title **placement_groups_count** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of placement groups. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/private_nics_count: .. rst-class:: ansible-option-title **private_nics_count** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of private NICs. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/running_servers_count: .. rst-class:: ansible-option-title **running_servers_count** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of running servers. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/security_groups_count: .. rst-class:: ansible-option-title **security_groups_count** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of security groups. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/servers_by_types: .. rst-class:: ansible-option-title **servers_by_types** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`dictionary` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of servers per type. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/servers_count: .. rst-class:: ansible-option-title **servers_count** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of servers. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/snapshots_count: .. rst-class:: ansible-option-title **snapshots_count** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of snapshots. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/volumes_b_ssd_count: .. rst-class:: ansible-option-title **volumes_b_ssd_count** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of volumes b ssd. Deprecated by the Scaleway API contract. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/volumes_b_ssd_total_size: .. rst-class:: ansible-option-title **volumes_b_ssd_total_size** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
(in bytes) Deprecated by the Scaleway API contract. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/volumes_count: .. rst-class:: ansible-option-title **volumes_count** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of volumes. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/volumes_l_ssd_count: .. rst-class:: ansible-option-title **volumes_l_ssd_count** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of volumes l ssd. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/volumes_l_ssd_total_size: .. rst-class:: ansible-option-title **volumes_l_ssd_total_size** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
(in bytes) .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.stephrobert.scaleway.instance_dashboard_info_module__return-dashboard/volumes_scratch_count: .. rst-class:: ansible-option-title **volumes_scratch_count** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`integer` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Count of volumes scratch. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when the API returns it .. raw:: html
.. 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