New in version 2.8.
Parameter | Choices/Defaults | Comments |
---|---|---|
api_timeout
integer
|
Default: 30
|
HTTP timeout to Scaleway API in seconds.
aliases: timeout |
api_token
string
|
Scaleway OAuth token.
aliases: oauth_token |
|
api_url
string
|
Default: "https://api.scaleway.com"
|
Scaleway API URL.
aliases: base_url |
description
string
|
Description of the Security Group.
|
|
inbound_default_policy
string
|
|
Default policy for incoming trafic.
|
name
string
/ required
|
Name of the Security Group.
|
|
organization
string
/ required
|
Organization identifier.
|
|
organization_default
boolean
|
|
Create security group to be the default one.
|
outbound_default_policy
string
|
|
Default policy for outcoming trafic.
|
query_parameters
dictionary
|
Default: {}
|
List of parameters passed to the query string.
|
region
string
/ required
|
|
Scaleway region to use (for example
par1 ). |
state
string
|
|
Indicate desired state of the Security Group.
|
stateful
boolean
/ required
|
|
Create a stateful security group which allows established connections in and out.
|
validate_certs
boolean
|
|
Validate SSL certs of the Scaleway API.
|
Note
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
.api_url
one can also set the SCW_API_URL
environment variable.- name: Create a Security Group
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
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
data
dictionary
|
when state=present |
This is only present when
state=present Sample:
{'scaleway_security_group': {'outbound_default_policy': 'accept', 'description': 'my security group description', 'name': 'security_group', 'servers': [], 'stateful': False, 'inbound_default_policy': 'accept', 'organization': '43a3b6c8-916f-477b-b7ec-ff1898f5fdd9', 'organization_default': False, 'id': '0168fb1f-cc46-4f69-b4be-c95d2a19bcae', 'enable_default_security': True}}
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.