community.general.scaleway_volume (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

This module manages volumes on Scaleway account U(https://developer.scaleway.com).

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Make sure volume deleted
  community.general.scaleway_volume:
    name: my-volume
    state: absent
    region: par1

Inputs

    
name:
    description:
    - Name used to identify the volume.
    required: true
    type: str

size:
    description:
    - Size of the volume in bytes.
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Indicate desired state of the volume.
    type: str

region:
    choices:
    - ams1
    - EMEA-NL-EVS
    - par1
    - EMEA-FR-PAR1
    - par2
    - EMEA-FR-PAR2
    - waw1
    - EMEA-PL-WAW1
    description:
    - Scaleway region to use (for example par1).
    required: true
    type: str

api_url:
    aliases:
    - base_url
    default: https://api.scaleway.com
    description:
    - Scaleway API URL.
    type: str

project:
    description:
    - Scaleway project ID to which volume belongs.
    type: str
    version_added: 4.3.0
    version_added_collection: community.general

api_token:
    aliases:
    - oauth_token
    description:
    - Scaleway OAuth token.
    required: true
    type: str

api_timeout:
    aliases:
    - timeout
    default: 30
    description:
    - HTTP timeout to Scaleway API in seconds.
    type: int

volume_type:
    description:
    - Type of the volume (for example 'l_ssd').
    type: str

organization:
    description:
    - ScaleWay organization ID to which volume belongs.
    type: str

validate_certs:
    default: true
    description:
    - Validate SSL certs of the Scaleway API.
    type: bool

query_parameters:
    default: {}
    description:
    - List of parameters passed to the query string.
    type: dict

Outputs

data:
  description: This is only present when O(state=present).
  returned: when O(state=present)
  sample:
    volume:
      export_uri: null
      id: c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd
      name: volume-0-3
      project: 000a115d-2852-4b0a-9ce8-47f1134ba95a
      server: null
      size: 10000000000
      volume_type: l_ssd
  type: dict