stephrobert.scaleway.instance_snapshot_info module – Gather information about Scaleway Instance snapshots

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 ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install stephrobert.scaleway. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: stephrobert.scaleway.instance_snapshot_info.

New in stephrobert.scaleway 0.1.0

Synopsis

• Get details of a snapshot with the specified ID.

• List all snapshots of an Organization in a specified Availability Zone.

Requirements

The below requirements are needed on the host that executes this module.

• scaleway >= 2.9.0

Parameters

Parameter	Comments
access_key string	Scaleway API access key.
api_allow_insecure boolean	Allow the API endpoint to be reached without verifying its TLS certificate. Falls back to the Scaleway configuration file, then to false. Choices: false true
api_timeout integer	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. Default: 60
api_url string	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 https://api.scaleway.com. It carries no module default on purpose: a default is never unset, so it would always override the profile.
base_volume_id string	List snapshots originating only from this volume.
config_file path	Path to the Scaleway configuration file.
name string	List snapshots of the requested name.
organization string	List snapshots only for this Organization ID.
organization_id string	Default Organization ID used when an operation does not name one.
profile string	Name of the profile to read in the Scaleway configuration file.
project string	List snapshots only for this Project ID.
project_id string	Default Project ID used when an operation does not name one.
secret_key string	Scaleway API secret key.
snapshot_id string	UUID of the snapshot you want to get.
tags string	List snapshots that have the requested tag.
user_agent string	Value of the User-Agent header sent to the API.
zone string / required	The zone you want to target Choices: "fr-par-1" "fr-par-2" "fr-par-3" "nl-ams-1" "nl-ams-2" "nl-ams-3" "pl-waw-1" "pl-waw-2" "pl-waw-3" "it-mil-1"

Attributes

Attribute	Support	Description
check_mode	Support: full	This module only reads, so check mode changes nothing about how it runs.
diff_mode	Support: none	This module changes nothing, so it has no difference to report.

Notes

Note

• Every option can be set from its environment variable, respectively SCW_PROFILE, SCW_CONFIG_PATH, SCW_ACCESS_KEY, SCW_SECRET_KEY, SCW_API_URL, SCW_DEFAULT_ORGANIZATION_ID and SCW_DEFAULT_PROJECT_ID.

• Module options take precedence over environment variables, which take precedence over the configuration file.

Examples

# This module only reads: it never changes anything, and check mode
# is native.
#
# `snapshot_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 a snapshot
  stephrobert.scaleway.instance_snapshot_info:
    zone: fr-par-1
    snapshot_id: 11111111-2222-3333-4444-555555555555
  register: result
- name: List snapshots
  stephrobert.scaleway.instance_snapshot_info:
    zone: fr-par-1
  register: result
- name: Filter Scaleway Instance snapshots by tags
  stephrobert.scaleway.instance_snapshot_info:
    zone: fr-par-1
    tags:
    - production
  register: result

Return Values

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

Key	Description
snapshot dictionary	Get details of a snapshot with the specified ID. Returned: when snapshot_id is provided
base_volume dictionary	Volume on which the snapshot is based on. Returned: when the API returns it
creation_date string	Snapshot creation date. (RFC 3339 format) Returned: when the API returns it
error_reason string	Reason for the failed snapshot import. Returned: when the API returns it
id string	Snapshot ID. Returned: when the API returns it
modification_date string	Snapshot modification date. (RFC 3339 format) Returned: when the API returns it
name string	Snapshot name. Returned: when the API returns it
organization string	Snapshot Organization ID. Returned: when the API returns it
project string	Snapshot Project ID. Returned: when the API returns it
size integer	Snapshot size. (in bytes) Returned: when the API returns it
state string	Snapshot state. Returned: when the API returns it
tags list / elements=string	Snapshot tags. Returned: when the API returns it
volume_type string	Snapshot volume type. Returned: when the API returns it
zone string	Snapshot zone. Returned: when the API returns it
snapshots list / elements=dictionary	List all snapshots of an Organization in a specified Availability Zone. Returned: when snapshot_id is omitted
base_volume dictionary	Volume on which the snapshot is based on. Returned: when the API returns it
creation_date string	Snapshot creation date. (RFC 3339 format) Returned: when the API returns it
error_reason string	Reason for the failed snapshot import. Returned: when the API returns it
id string	Snapshot ID. Returned: when the API returns it
modification_date string	Snapshot modification date. (RFC 3339 format) Returned: when the API returns it
name string	Snapshot name. Returned: when the API returns it
organization string	Snapshot Organization ID. Returned: when the API returns it
project string	Snapshot Project ID. Returned: when the API returns it
size integer	Snapshot size. (in bytes) Returned: when the API returns it
state string	Snapshot state. Returned: when the API returns it
tags list / elements=string	Snapshot tags. Returned: when the API returns it
volume_type string	Snapshot volume type. Returned: when the API returns it
zone string	Snapshot zone. Returned: when the API returns it

Authors

• Stéphane Robert (@stephrobert)

Collection links

• Issue Tracker
• Repository (Sources)