community.general.scaleway_image_info module – Gather information about the Scaleway images available

Note

This module is part of the community.general collection (version 9.4.0).

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

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.scaleway_image_info.

Synopsis

  • Gather information about the Scaleway images available.

Parameters

Parameter

Comments

api_timeout

aliases: timeout

integer

HTTP timeout to Scaleway API in seconds.

Default: 30

api_token

aliases: oauth_token

string / required

Scaleway OAuth token.

api_url

aliases: base_url

string

Scaleway API URL.

Default: "https://api.scaleway.com"

query_parameters

dictionary

List of parameters passed to the query string.

Default: {}

region

string / required

Scaleway compute zone.

Choices:

  • "ams1"

  • "EMEA-NL-EVS"

  • "par1"

  • "EMEA-FR-PAR1"

  • "par2"

  • "EMEA-FR-PAR2"

  • "waw1"

  • "EMEA-PL-WAW1"

validate_certs

boolean

Validate SSL certs of the Scaleway API.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

This action does not modify state.

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: N/A

This action does not modify state.

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

Examples

- name: Gather Scaleway images information
  community.general.scaleway_image_info:
    region: par1
  register: result

- ansible.builtin.debug:
    msg: "{{ result.scaleway_image_info }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

scaleway_image_info

list / elements=dictionary

Response from Scaleway API.

For more details please refer to: https://developers.scaleway.com/en/products/instance/api/.

Returned: success

Sample: {"scaleway_image_info": [{"arch": "x86_64", "creation_date": "2018-07-17T16:18:49.276456+00:00", "default_bootscript": {"architecture": "x86_64", "bootcmdargs": "LINUX_COMMON scaleway boot=local nbd.max_part=16", "default": false, "dtb": "", "id": "15fbd2f7-a0f9-412b-8502-6a44da8d98b8", "initrd": "http://169.254.42.24/initrd/initrd-Linux-x86_64-v3.14.5.gz", "kernel": "http://169.254.42.24/kernel/x86_64-mainline-lts-4.9-4.9.93-rev1/vmlinuz-4.9.93", "organization": "11111111-1111-4111-8111-111111111111", "public": true, "title": "x86_64 mainline 4.9.93 rev1"}, "extra_volumes": [], "from_server": null, "id": "00ae4a88-3252-4eda-9feb-5f6b56bf5ef0", "modification_date": "2018-07-17T16:42:06.319315+00:00", "name": "Debian Stretch", "organization": "51b656e3-4865-41e8-adbc-0c45bdd780db", "public": true, "root_volume": {"id": "da32dfbb-c5ff-476d-ae2d-c297dd09b7dd", "name": "snapshot-2a7229dc-d431-4dc5-b66e-95db08b773af-2018-07-17_16:18", "size": 25000000000, "volume_type": "l_ssd"}, "state": "available"}]}

Authors

  • Yanis Guenane (@Spredzy)

  • Remy Leone (@remyleone)