community.general.scaleway_snapshot_info module – Gather information about the Scaleway snapshots 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_snapshot_info.

Synopsis

  • Gather information about the Scaleway snapshot 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 region to use (for example par1).

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 snapshots information
  community.general.scaleway_snapshot_info:
    region: par1
  register: result

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

Return Values

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

Key

Description

scaleway_snapshot_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_snapshot_info": [{"base_volume": {"id": "68386fae-4f55-4fbf-aabb-953036a85872", "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42"}, "creation_date": "2018-08-14T22:34:35.299461+00:00", "id": "b61b4b03-a2e9-4da5-b5ea-e462ac0662d2", "modification_date": "2018-08-14T22:34:54.520560+00:00", "name": "snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42 snapshot", "organization": "3f709602-5e6c-4619-b80c-e841c89734af", "size": 25000000000, "state": "available", "volume_type": "l_ssd"}]}

Authors

  • Yanis Guenane (@Spredzy)

  • Remy Leone (@remyleone)