community.general.scaleway_ip module – Scaleway IP management module

Note

This module is part of the community.general collection (version 12.6.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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module manages IP on Scaleway account https://developer.scaleway.com.

Requirements

The below requirements are needed on the host that executes this module.

PyYAML (when profile is used)

Parameters

Parameter	Comments
api_timeout aliases: timeout integer	HTTP timeout to Scaleway API in seconds. Default: `30`
api_token aliases: oauth_token string	Scaleway OAuth token. This is required if `profile` is not specified.
api_url aliases: base_url string	Scaleway API URL. Default: `"https://api.scaleway.com"`
id string	ID of the Scaleway IP (UUID).
organization string	Scaleway organization identifier. Exactly one of `project` and `organization` must be specified.
profile aliases: scw_profile string added in community.general 12.2.0	The config profile in config file to load the Scaleway OAuth token from, use instead of `api_token`. It is also possible to set `SCW_PROFILE` to use a SCW CLI config profile.
project string added in community.general 12.3.0	Project identifier. Exactly one of `project` and `organization` must be specified.
query_parameters dictionary	List of parameters passed to the query string. Default: `{}`
region string / required	Scaleway region to use (for example par1). Choices: `"ams1"` `"EMEA-NL-EVS"` `"ams2"` `"ams3"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"par3"` `"waw1"` `"EMEA-PL-WAW1"` `"waw2"` `"waw3"`
reverse string	Reverse to assign to the IP.
server string	ID of the server you want to attach an IP to. To unattach an IP do not specify this option.
state string	Indicate desired state of the IP. Choices: `"present"` ← (default) `"absent"`
validate_certs boolean	Validate SSL certs of the Scaleway API. Choices: `false` `true` ← (default)

Attributes

Attribute	Support	Description
action_group	Action group: community.general.scaleway added in community.general 11.3.0	Use `group/community.general.scaleway` in `module_defaults` to set defaults for this module.
check_mode	Support: full	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: none	Returns details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

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: Create an IP with a project ID
  community.general.scaleway_ip:
    project: '{{ project_id }}'
    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

- name: Create an IP in the default project with an organization ID (deprecated)
  community.general.scaleway_ip:
    organization: '{{ scw_org }}'
    state: present
    region: par1
  register: ip_creation_task

Return Values

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

Key	Description
data dictionary	This is only present when `state=present`. Returned: when `state=present` 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)

Collection links

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