Documentation

scaleway_volume - Scaleway volumes management module

New in version 2.7.

Synopsis

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
name
required
Name used to identify the volume.
organization
ScaleWay organization ID to which volume belongs.
region
required
    Choices:
  • ams1
  • EMEA-NL-EVS
  • par1
  • EMEA-FR-PAR1
Scaleway region to use (for example par1).
size
Size of the volume in bytes.
state
    Choices:
  • present ←
  • absent
Indicate desired state of the volume.
validate_certs
bool
    Choices:
  • no
  • yes ←
Validate SSL certs of the Scaleway API.
volume_type
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 precedence SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN or SCW_API_TOKEN.
  • If one wants to use a different api_url one can also set the SCW_API_URL environment variable.

Examples

- 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

Return Values

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}}


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

  • Henryk Konsek (@hekonsek)

Hint

If you notice any issues in this documentation you can edit this document to improve it.