community.general.scaleway_security_group module – Scaleway Security Group 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_security_group.

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module manages Security Group 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"`
description string	Description of the Security Group.
inbound_default_policy string	Default policy for incoming traffic. Choices: `"accept"` `"drop"`
name string / required	Name of the Security Group.
organization string	Organization identifier. Exactly one of `project` and `organization` must be specified.
organization_default boolean	Create security group to be the default one. Choices: `false` `true`
outbound_default_policy string	Default policy for outcoming traffic. Choices: `"accept"` `"drop"`
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"`
state string	Indicate desired state of the Security Group. Choices: `"absent"` `"present"` ← (default)
stateful boolean / required	Create a stateful security group which allows established connections in and out. Choices: `false` `true`
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 a Security Group using a project ID
  community.general.scaleway_security_group:
    state: present
    region: par1
    name: security_group
    description: "my security group description"
    stateful: false
    inbound_default_policy: accept
    outbound_default_policy: accept
    organization_default: false
    project: 951df375-e094-4d26-97c1-ba548eeb9c42
  register: security_group_creation_task

- name: Create a Security Group in the default project using an organization ID (deprecated)
  community.general.scaleway_security_group:
    state: present
    region: par1
    name: security_group
    description: "my security group description"
    organization: 43a3b6c8-916f-477b-b7ec-ff1898f5fdd9
    stateful: false
    inbound_default_policy: accept
    outbound_default_policy: accept
    organization_default: false
  register: security_group_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: `{"scaleway_security_group": {"description": "my security group description", "enable_default_security": true, "id": "0168fb1f-cc46-4f69-b4be-c95d2a19bcae", "inbound_default_policy": "accept", "name": "security_group", "organization": "43a3b6c8-916f-477b-b7ec-ff1898f5fdd9", "organization_default": false, "outbound_default_policy": "accept", "servers": [], "stateful": false}}`

Key

Description

data

dictionary

This is only present when state=present.

Returned: when state=present

Sample: {"scaleway_security_group": {"description": "my security group description", "enable_default_security": true, "id": "0168fb1f-cc46-4f69-b4be-c95d2a19bcae", "inbound_default_policy": "accept", "name": "security_group", "organization": "43a3b6c8-916f-477b-b7ec-ff1898f5fdd9", "organization_default": false, "outbound_default_policy": "accept", "servers": [], "stateful": false}}

Authors

Antoine Barbare (@abarbare)

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_security_group_module.html