Scaleway API access key.
.. 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
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
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
Filter images by CPU architecture.
.. raw:: html
* - .. raw:: html
Path to the Scaleway configuration file.
.. raw:: html
* - .. raw:: html
UUID of the image you want to get.
.. raw:: html
* - .. raw:: html
Filter images by name.
.. raw:: html
* - .. raw:: html
List only images of this Organization ID.
.. raw:: html
* - .. raw:: html
Default Organization ID used when an operation does not name one.
.. raw:: html
* - .. raw:: html
Name of the profile to read in the Scaleway configuration file.
.. raw:: html
* - .. raw:: html
List only images of this Project ID.
.. raw:: html
* - .. raw:: html
Default Project ID used when an operation does not name one.
.. raw:: html
* - .. raw:: html
Filter images on their public flag.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`false`
- :ansible-option-choices-entry:`true`
.. raw:: html
* - .. raw:: html
Scaleway API secret key.
.. raw:: html
* - .. raw:: html
List images with these exact tags.
.. raw:: html
* - .. raw:: html
Value of the User\-Agent header sent to the API.
.. 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-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-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.
#
# `image_id` decides which of the two reads runs: given, the
# module returns that one resource; omitted, it lists them all,
# walking every page rather than returning the first one in silence.
- name: Get an Instance image
stephrobert.scaleway.instance_image_info:
zone: fr-par-1
image_id: 11111111-2222-3333-4444-555555555555
register: result
- name: List Instance images
stephrobert.scaleway.instance_image_info:
zone: fr-par-1
register: result
- name: Filter Scaleway Instance images by tags
stephrobert.scaleway.instance_image_info:
zone: fr-par-1
tags:
- production
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_image_info_module__return-image:
.. rst-class:: ansible-option-title
**image**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`dictionary`
.. raw:: html
- .. raw:: html
Get details of an image with the specified ID.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` when :emphasis:`image\_id` is provided
.. raw:: html
* - .. raw:: html
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
.. _ansible_collections.stephrobert.scaleway.instance_image_info_module__return-image/arch:
.. rst-class:: ansible-option-title
**arch**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
CPU architecture of the image.
.. 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_image_info_module__return-image/creation_date:
.. rst-class:: ansible-option-title
**creation_date**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
(RFC 3339 format)
.. 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_image_info_module__return-image/default_bootscript:
.. rst-class:: ansible-option-title
**default_bootscript**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`dictionary`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Default bootscript of the image.
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_image_info_module__return-image/extra_volumes:
.. rst-class:: ansible-option-title
**extra_volumes**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`dictionary`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Extra volumes of the image.
.. 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_image_info_module__return-image/from_server:
.. rst-class:: ansible-option-title
**from_server**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Server the image comes from.
.. 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_image_info_module__return-image/id:
.. rst-class:: ansible-option-title
**id**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Unique ID of the image.
.. 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_image_info_module__return-image/modification_date:
.. rst-class:: ansible-option-title
**modification_date**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
(RFC 3339 format)
.. 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_image_info_module__return-image/name:
.. rst-class:: ansible-option-title
**name**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Name of the image.
.. 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_image_info_module__return-image/organization:
.. rst-class:: ansible-option-title
**organization**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Organization ID of the image.
.. 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_image_info_module__return-image/project:
.. rst-class:: ansible-option-title
**project**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Project ID of the image.
.. 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_image_info_module__return-image/public:
.. rst-class:: ansible-option-title
**public**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`boolean`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Whether the image is public.
.. 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_image_info_module__return-image/root_volume:
.. rst-class:: ansible-option-title
**root_volume**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`dictionary`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
UUID of the snapshot.
.. 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_image_info_module__return-image/state:
.. rst-class:: ansible-option-title
**state**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
State of the image.
.. 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_image_info_module__return-image/tags:
.. rst-class:: ansible-option-title
**tags**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Tags of the image.
.. 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_image_info_module__return-image/zone:
.. rst-class:: ansible-option-title
**zone**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
The zone you want to target
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` when the API returns it
.. raw:: html
* - .. raw:: html
.. _ansible_collections.stephrobert.scaleway.instance_image_info_module__return-images:
.. rst-class:: ansible-option-title
**images**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
.. raw:: html
- .. raw:: html
List all existing Instance images.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` when :emphasis:`image\_id` is omitted
.. raw:: html
* - .. raw:: html
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
.. _ansible_collections.stephrobert.scaleway.instance_image_info_module__return-images/arch:
.. rst-class:: ansible-option-title
**arch**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
CPU architecture of the image.
.. 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_image_info_module__return-images/creation_date:
.. rst-class:: ansible-option-title
**creation_date**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
(RFC 3339 format)
.. 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_image_info_module__return-images/default_bootscript:
.. rst-class:: ansible-option-title
**default_bootscript**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`dictionary`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Default bootscript of the image.
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_image_info_module__return-images/extra_volumes:
.. rst-class:: ansible-option-title
**extra_volumes**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`dictionary`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Extra volumes of the image.
.. 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_image_info_module__return-images/from_server:
.. rst-class:: ansible-option-title
**from_server**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Server the image comes from.
.. 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_image_info_module__return-images/id:
.. rst-class:: ansible-option-title
**id**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Unique ID of the image.
.. 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_image_info_module__return-images/modification_date:
.. rst-class:: ansible-option-title
**modification_date**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
(RFC 3339 format)
.. 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_image_info_module__return-images/name:
.. rst-class:: ansible-option-title
**name**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Name of the image.
.. 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_image_info_module__return-images/organization:
.. rst-class:: ansible-option-title
**organization**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Organization ID of the image.
.. 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_image_info_module__return-images/project:
.. rst-class:: ansible-option-title
**project**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Project ID of the image.
.. 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_image_info_module__return-images/public:
.. rst-class:: ansible-option-title
**public**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`boolean`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Whether the image is public.
.. 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_image_info_module__return-images/root_volume:
.. rst-class:: ansible-option-title
**root_volume**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`dictionary`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
UUID of the snapshot.
.. 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_image_info_module__return-images/state:
.. rst-class:: ansible-option-title
**state**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
State of the image.
.. 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_image_info_module__return-images/tags:
.. rst-class:: ansible-option-title
**tags**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`list` / :ansible-option-elements:`elements=string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Tags of the image.
.. 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_image_info_module__return-images/zone:
.. rst-class:: ansible-option-title
**zone**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
The zone you want to target
.. 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