community.general.scaleway_volume_info module – Gather information about the Scaleway volumes available
Note
This module is part of the community.general collection (version 9.4.0).
You might already have this collection installed if you are using the ansible
package.
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 community.general
.
To use it in a playbook, specify: community.general.scaleway_volume_info
.
Synopsis
Gather information about the Scaleway volumes available.
Parameters
Parameter |
Comments |
---|---|
HTTP timeout to Scaleway API in seconds. Default: |
|
Scaleway OAuth token. |
|
Scaleway API URL. Default: |
|
List of parameters passed to the query string. Default: |
|
Scaleway region to use (for example Choices:
|
|
Validate SSL certs of the Scaleway API. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
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.
Examples
- name: Gather Scaleway volumes information
community.general.scaleway_volume_info:
region: par1
register: result
- ansible.builtin.debug:
msg: "{{ result.scaleway_volume_info }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Response from Scaleway API. For more details please refer to: https://developers.scaleway.com/en/products/instance/api/. Returned: success Sample: |