community.general.scaleway_volume module – Scaleway volumes management module
Note
This module is part of the community.general collection (version 8.6.4).
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
.
Synopsis
This module manages volumes on Scaleway account https://developer.scaleway.com.
Aliases: cloud.scaleway.scaleway_volume
Parameters
Parameter |
Comments |
---|---|
HTTP timeout to Scaleway API in seconds. Default: |
|
Scaleway OAuth token. |
|
Scaleway API URL. Default: |
|
Name used to identify the volume. |
|
ScaleWay organization ID to which volume belongs. |
|
Scaleway project ID to which volume belongs. |
|
List of parameters passed to the query string. Default: |
|
Scaleway region to use (for example par1). Choices:
|
|
Size of the volume in bytes. |
|
Indicate desired state of the volume. Choices:
|
|
Validate SSL certs of the Scaleway API. Choices:
|
|
Type of the volume (for example ‘l_ssd’). |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
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: Create 10GB volume
community.general.scaleway_volume:
name: my-volume
state: present
region: par1
project: "{{ scw_org }}"
"size": 10000000000
volume_type: l_ssd
register: server_creation_check_task
- name: Make sure volume deleted
community.general.scaleway_volume:
name: my-volume
state: absent
region: par1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
This is only present when Returned: when Sample: |