community.general.scaleway_security_group_rule – Scaleway Security Group Rule 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_security_group_rule
.
Synopsis
This module manages Security Group Rule on Scaleway account https://developer.scaleway.com
Parameters
Parameter |
Comments |
---|---|
Rule action Choices:
|
|
HTTP timeout to Scaleway API in seconds. Default: 30 |
|
Scaleway OAuth token. |
|
Scaleway API URL. Default: “https://api.scaleway.com” |
|
Rule direction Choices:
|
|
IPV4 CIDR notation to apply to the rule Default: “0.0.0.0/0” |
|
Port related to the rule, null value for all the ports |
|
Network protocol to use Choices:
|
|
List of parameters passed to the query string. Default: {} |
|
Scaleway region to use (for example Choices:
|
|
Security Group unique identifier |
|
Indicate desired state of the Security Group Rule. 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 a Security Group Rule
community.general.scaleway_security_group_rule:
state: present
region: par1
protocol: TCP
port: 80
ip_range: 0.0.0.0/0
direction: inbound
action: accept
security_group: b57210ee-1281-4820-a6db-329f78596ecb
register: security_group_rule_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: {“scaleway_security_group_rule”: {“action”: “accept”, “dest_port_from”: 80, “dest_port_to”: null, “direction”: “inbound”, “editable”: null, “id”: “10cb0b9a-80f6-4830-abd7-a31cd828b5e9”, “ip_range”: “0.0.0.0/0”, “position”: 2, “protocol”: “TCP”}} |
Authors
Antoine Barbare (@abarbare)