Docs4dev
Docs
ansible / 2.10 / collections / community / general / scaleway_snapshot_facts_module.html

community.general.scaleway_snapshot_facts – Gather facts about the Scaleway snapshots available.

Note

This plugin is part of the community.general collection (version 1.3.2).

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

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

DEPRECATED

Removed in

version 3.0.0

Why

Deprecated in favour of _info module.

Alternative

Use community.general.scaleway_snapshot_info instead.

Synopsis

  • Gather facts about the Scaleway snapshot available.

Parameters

Parameter Choices/Defaults Comments
api_timeout
integer
Default:
30
HTTP timeout to Scaleway API in seconds.

aliases: timeout
api_token
string / required
Scaleway OAuth token.

aliases: oauth_token
api_url
string
Default:
"https://api.scaleway.com"
Scaleway API URL.

aliases: base_url
query_parameters
dictionary
Default:
{}
List of parameters passed to the query string.
region
string / required
    Choices:
  • ams1
  • EMEA-NL-EVS
  • par1
  • EMEA-FR-PAR1
Scaleway region to use (for example par1).
validate_certs
boolean
    Choices:
  • no
  • yes ←
Validate SSL certs of the Scaleway API.

Notes

Note

  • Also see the API documentation on https://developer.scaleway.com/
  • If api_token is not set within the module, the following environment variables can be used in decreasing order of precedence SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN or SCW_API_TOKEN.
  • If one wants to use a different api_url one can also set the SCW_API_URL environment variable.

Examples

- name: Gather Scaleway snapshots facts
  community.general.scaleway_snapshot_facts:
    region: par1

Return Values

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

Key Returned Description
scaleway_snapshot_facts
complex
success
Response from Scaleway API

Sample:
{'scaleway_snapshot_facts': [{'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'}]}


Status

  • This module will be removed in version 3.0.0. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Yanis Guenane (@Spredzy)
  • Remy Leone (@sieben)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/scaleway_snapshot_facts_module.html