New in version 2.7.
Removed in Ansible: | |
---|---|
version: 2.13 | |
Why: | Deprecated in favour of _info module. |
Alternative: | Use scaleway_snapshot_info instead. |
Parameter | Choices/Defaults | Comments |
---|---|---|
api_timeout integer | Default: 30 | HTTP timeout to Scaleway API in seconds. aliases: timeout |
api_token string | 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 - / required added in 2.8 |
| Scaleway region to use (for example par1). |
validate_certs boolean |
| Validate SSL certs of the Scaleway API. |
Note
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
.api_url
one can also set the SCW_API_URL
environment variable.- name: Gather Scaleway snapshots facts scaleway_snapshot_facts: region: par1
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'}]} |
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/scaleway_snapshot_facts_module.html