community.general.scaleway_volume_info (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

Gather information about the Scaleway volumes available.

Usage examples

Scanned by Steampunk Spotter

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

- name: Gather Scaleway volumes information
  community.general.scaleway_volume_info:
    region: par1
  register: result

Scanned by Steampunk Spotter

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

- ansible.builtin.debug:
    msg: "{{ result.scaleway_volume_info }}"

Inputs

    
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 C(par1)).
    required: true
    type: str

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

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

scaleway_volume_info:
  description:
  - Response from Scaleway API.
  - 'For more details please refer to: U(https://developers.scaleway.com/en/products/instance/api/).'
  elements: dict
  returned: success
  sample:
    scaleway_volume_info:
    - creation_date: '2018-08-14T20:56:24.949660+00:00'
      export_uri: null
      id: b8d51a06-daeb-4fef-9539-a8aea016c1ba
      modification_date: '2018-08-14T20:56:24.949660+00:00'
      name: test-volume
      organization: 3f709602-5e6c-4619-b80c-e841c89734af
      server: null
      size: 50000000000
      state: available
      volume_type: l_ssd
  type: list