scaleway_user_data – Scaleway user_data management module
scaleway_user_data – Scaleway user_data management module
New in version 2.8.
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.
|
api_token string |
Scaleway OAuth token.
| |
api_url string |
Default: |
Scaleway API URL.
|
query_parameters dictionary |
Default: {} |
List of parameters passed to the query string. |
region - / required |
|
Scaleway compute zone |
server_id - / required |
Scaleway Compute instance ID of the server | |
user_data - |
User defined data. Typically used with `cloud-init`. Pass your cloud-init script here as a string | |
validate_certs boolean |
|
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 precedenceSCW_TOKEN
,SCW_API_KEY
,SCW_OAUTH_TOKEN
orSCW_API_TOKEN
. - If one wants to use a different
api_url
one can also set theSCW_API_URL
environment variable.
Examples
- name: Update the cloud-init
scaleway_user_data:
server_id: '5a33b4ab-57dd-4eb6-8b0a-d95eb63492ce'
region: ams1
user_data:
cloud-init: 'final_message: "Hello World!"'
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Remy Leone (@sieben)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/scaleway_user_data_module.html