scaleway_snapshot_facts – Gather facts about the Scaleway snapshots available.¶
New in version 2.7.
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_timeout
-
|
Default: 30
|
HTTP timeout to Scaleway API in seconds.
aliases: timeout |
api_token
-
|
Scaleway OAuth token.
aliases: oauth_token |
|
api_url
-
|
Default: "https://api.scaleway.com"
|
Scaleway API URL
aliases: base_url |
validate_certs
boolean
|
|
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 precedenceSCW_TOKEN
,SCW_API_KEY
,SCW_OAUTH_TOKEN
orSCW_API_TOKEN
. - If one wants to use a different
api_url
one can also set theSCW_API_URL
environment variable.
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
|
|
scaleway_snapshot_facts
-
|
|
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Yanis Guenane (@Spredzy)
- Remy Leone (@sieben)
Hint
If you notice any issues in this documentation you can edit this document to improve it.