scaleway_volume_facts - Gather facts about the Scaleway volumes 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
bool |
|
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_volume_facts
complex
|
success |
Response from Scaleway API
|
|
scaleway_volume_facts
|
|
Status¶
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance¶
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author¶
- Yanis Guenane (@Spredzy)
- Remy Leone (@sieben)
Hint
If you notice any issues in this documentation you can edit this document to improve it.