New in version 2.7.
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 |
name required | Name used to identify the volume. | |
organization | ScaleWay organization ID to which volume belongs. | |
region required |
| Scaleway region to use (for example par1). |
size | Size of the volume in bytes. | |
state |
| Indicate desired state of the volume. |
validate_certs bool |
| Validate SSL certs of the Scaleway API. |
volume_type | Type of the volume (for example 'l_ssd'). |
Note
api_token
is not set within the module, the following environment variables can be used in decreasing order of precedence SCW_TOKEN
, SCW_API_KEY
, SCW_OAUTH_TOKEN
or SCW_API_TOKEN
.api_url
one can also set the SCW_API_URL
environment variable.- name: Create 10GB volume 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 scaleway_volume: name: my-volume state: absent region: par1
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
data dict | when state=present
| This is only present when state=present
Sample: {'volume': {'size': 10000000000, 'name': 'volume-0-3', 'organization': '000a115d-2852-4b0a-9ce8-47f1134ba95a', 'export_uri': None, 'id': 'c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd', 'volume_type': 'l_ssd', 'server': None}} |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/scaleway_volume_module.html