community.general.scaleway_ip – Scaleway IP management module
Note
This plugin is part of the community.general collection (version 3.8.3).
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_ip
.
Synopsis
This module manages IP on Scaleway account https://developer.scaleway.com
Parameters
Parameter |
Comments |
---|---|
HTTP timeout to Scaleway API in seconds. Default: 30 |
|
Scaleway OAuth token. |
|
Scaleway API URL. Default: “https://api.scaleway.com” |
|
id of the Scaleway IP (UUID) |
|
Scaleway organization identifier |
|
List of parameters passed to the query string. Default: {} |
|
Scaleway region to use (for example par1). Choices:
|
|
Reverse to assign to the IP |
|
id of the server you want to attach an IP to. To unattach an IP don’t specify this option |
|
Indicate desired state of the IP. Choices:
|
|
Validate SSL certs of the Scaleway API. Choices:
|
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 an IP
community.general.scaleway_ip:
organization: '{{ scw_org }}'
state: present
region: par1
register: ip_creation_task
- name: Make sure IP deleted
community.general.scaleway_ip:
id: '{{ ip_creation_task.scaleway_ip.id }}'
state: absent
region: par1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
This is only present when Returned: when Sample: {“ips”: [{“address”: “212.47.232.136”, “id”: “dd9e8df6-6775-4863-b517-e0b0ee3d7477”, “organization”: “951df375-e094-4d26-97c1-ba548eeb9c42”, “reverse”: null, “server”: {“id”: “3f1568ca-b1a2-4e98-b6f7-31a0588157f1”, “name”: “ansible_tuto-1”}}]} |
Authors
Remy Leone (@remyleone)