community.general.scaleway_volume – Scaleway volumes management module
community.general.scaleway_volume – Scaleway volumes management module
Note
This plugin is part of the community.general collection (version 1.3.2).
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
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api_timeout integer |
Default: 30 |
HTTP timeout to Scaleway API in seconds.
|
api_token string / required |
Scaleway OAuth token.
| |
api_url string |
Default: |
Scaleway API URL.
|
name string / required |
Name used to identify the volume. | |
organization string |
ScaleWay organization ID to which volume belongs. | |
query_parameters dictionary |
Default: {} |
List of parameters passed to the query string. |
region string / required |
|
Scaleway region to use (for example par1). |
size integer |
Size of the volume in bytes. | |
state string |
|
Indicate desired state of the volume. |
validate_certs boolean |
|
Validate SSL certs of the Scaleway API. |
volume_type string |
Type of the volume (for example 'l_ssd'). |
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
organization: "{{ 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 | Returned | Description |
---|---|---|
data dictionary |
when state=present
|
This is only present when
Sample: {'volume': {'export_uri': None, 'id': 'c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd', 'name': 'volume-0-3', 'organization': '000a115d-2852-4b0a-9ce8-47f1134ba95a', 'server': None, 'size': 10000000000, 'volume_type': 'l_ssd'}} |
Authors
- Henryk Konsek (@hekonsek)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/scaleway_volume_module.html