scaleway_volume_facts – Gather facts about the Scaleway volumes available

New in version 2.7.

Synopsis

Parameter	Choices/Defaults	Comments
api_timeout integer	Default: 30	HTTP timeout to Scaleway API in seconds. aliases: timeout
api_token string		Scaleway OAuth token. aliases: oauth_token
api_url string	Default: "https://api.scaleway.com"	Scaleway API URL. aliases: base_url
query_parameters dictionary	Default: {}	List of parameters passed to the query string.
region - / required added in 2.8	Choices: ams1 EMEA-NL-EVS par1 EMEA-FR-PAR1	Scaleway region to use (for example par1).
validate_certs boolean	Choices: no yes ←	Validate SSL certs of the Scaleway API.

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.

- name: Gather Scaleway volumes facts
  scaleway_volume_facts:
    region: par1

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
scaleway_volume_facts complex	success	Response from Scaleway API Sample: {'scaleway_volume_facts': [{'creation_date': '2018-08-14T20:56:24.949660+00:00', 'export_uri': None, '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': None, 'size': 50000000000, 'state': 'available', 'volume_type': 'l_ssd'}]}

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/scaleway_volume_facts_module.html