community.general.scaleway_compute module – Scaleway compute management module
Note
This module is part of the community.general collection (version 10.0.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_compute
.
Synopsis
This module manages compute instances on Scaleway.
Parameters
Parameter |
Comments |
---|---|
HTTP timeout to Scaleway API in seconds. Default: |
|
Scaleway OAuth token. |
|
Scaleway API URL. Default: |
|
Commercial name of the compute node |
|
Enable public IPv6 connectivity on the instance Choices:
|
|
Image identifier used to start the instance with |
|
Name of the instance |
|
Organization identifier. Exactly one of |
|
Project identifier. Exactly one of |
|
Manage public IP on a Scaleway server Could be Scaleway IP address UUID
Default: |
|
List of parameters passed to the query string. Default: |
|
Scaleway compute zone Choices:
|
|
Security group unique identifier If no value provided, the default security group or current security group will be used |
|
Indicate desired state of the instance. Choices:
|
|
List of tags to apply to the instance (5 max) Default: |
|
Validate SSL certs of the Scaleway API. Choices:
|
|
Wait for the instance to reach its desired state before returning. Choices:
|
|
Time to wait before every attempt to check the state of the server Default: |
|
Time to wait for the server to reach the expected state Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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: Create a server
community.general.scaleway_compute:
name: foobar
state: present
image: 89ee4018-f8c3-4dc4-a6b5-bca14f985ebe
project: 951df375-e094-4d26-97c1-ba548eeb9c42
region: ams1
commercial_type: VC1S
tags:
- test
- www
- name: Create a server attached to a security group
community.general.scaleway_compute:
name: foobar
state: present
image: 89ee4018-f8c3-4dc4-a6b5-bca14f985ebe
project: 951df375-e094-4d26-97c1-ba548eeb9c42
region: ams1
commercial_type: VC1S
security_group: 4a31b633-118e-4900-bd52-facf1085fc8d
tags:
- test
- www
- name: Destroy it right after
community.general.scaleway_compute:
name: foobar
state: absent
image: 89ee4018-f8c3-4dc4-a6b5-bca14f985ebe
project: 951df375-e094-4d26-97c1-ba548eeb9c42
region: ams1
commercial_type: VC1S