Documentation

scaleway_server_facts – Gather facts about the Scaleway servers available.

New in version 2.7.

Synopsis

  • Gather facts about the Scaleway servers available.

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
validate_certs
boolean
    Choices:
  • no
  • yes ←
Validate SSL certs of the Scaleway API.

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: Gather Scaleway servers facts
  scaleway_server_facts:

Return Values

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

Key Returned Description
scaleway_server_facts
complex
success
Response from Scaleway API

  scaleway_server_facts
-



Status

Authors

  • Yanis Guenane (@Spredzy)
  • Remy Leone (@sieben)

Hint

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