W3cubDocs

/Ansible

community.general.scaleway_user_data – Scaleway user_data management module

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.scaleway_user_data.

Synopsis

  • This module manages user_data on compute instances on Scaleway.
  • It can be used to configure cloud-init for instance

Parameters

Parameter Choices/Defaults Comments
api_timeout
integer
Default:
30
HTTP timeout to Scaleway API in seconds.

aliases: timeout
api_token
string / required
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
string / required
    Choices:
  • ams1
  • EMEA-NL-EVS
  • par1
  • EMEA-FR-PAR1
  • par2
  • EMEA-FR-PAR2
  • waw1
  • EMEA-PL-WAW1
Scaleway compute zone
server_id
string / required
Scaleway Compute instance ID of the server
user_data
dictionary
User defined data. Typically used with `cloud-init`.
Pass your cloud-init script here as a string
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: Update the cloud-init
  community.general.scaleway_user_data:
    server_id: '5a33b4ab-57dd-4eb6-8b0a-d95eb63492ce'
    region: ams1
    user_data:
      cloud-init: 'final_message: "Hello World!"'

Authors

  • Remy Leone (@sieben)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/scaleway_user_data_module.html