community.general.scaleway_security_group module – Scaleway Security Group management module
Note
This module is part of the community.general collection (version 8.6.4).
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_security_group
.
Synopsis
This module manages Security Group on Scaleway account https://developer.scaleway.com.
Aliases: cloud.scaleway.scaleway_security_group
Parameters
Parameter |
Comments |
---|---|
HTTP timeout to Scaleway API in seconds. Default: |
|
Scaleway OAuth token. |
|
Scaleway API URL. Default: |
|
Description of the Security Group. |
|
Default policy for incoming traffic. Choices:
|
|
Name of the Security Group. |
|
Organization identifier. |
|
Create security group to be the default one. Choices:
|
|
Default policy for outcoming traffic. Choices:
|
|
List of parameters passed to the query string. Default: |
|
Scaleway region to use (for example Choices:
|
|
Indicate desired state of the Security Group. Choices:
|
|
Create a stateful security group which allows established connections in and out. Choices:
|
|
Validate SSL certs of the Scaleway API. Choices:
|
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 Security Group
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 |
---|---|
This is only present when Returned: when Sample: |