ansible.builtin.scaleway_volume (v2.9.27) — module

Scaleway volumes management module

| "added in version" 2.7 of ansible.builtin"

Authors: Henryk Konsek (@hekonsek)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Make sure volume deleted
    scaleway_volume:
      name: my-volume
      state: absent
      region: par1

Inputs

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

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

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

region:
    choices:
    - ams1
    - EMEA-NL-EVS
    - par1
    - EMEA-FR-PAR1
    description:
    - Scaleway region to use (for example par1).
    required: true

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

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').

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

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 C(state=present)
  returned: when C(state=present)
  sample:
    volume:
      export_uri: null
      id: c675f420-cfeb-48ff-ba2a-9d2a4dbe3fcd
      name: volume-0-3
      organization: 000a115d-2852-4b0a-9ce8-47f1134ba95a
      server: null
      size: 10000000000
      volume_type: l_ssd
  type: dict