community.general.scaleway_security_group 模块 – Scaleway 安全组管理模块

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.scaleway_security_group。

概要 

此模块管理 Scaleway 帐户上的安全组 https://developer.scaleway.com。

参数 

参数	注释
api_timeout 别名：timeout 整数	与 Scaleway API 的 HTTP 超时（秒）。默认值: `30`
api_token 别名：oauth_token 字符串 / 必需	Scaleway OAuth 令牌。
api_url 别名：base_url 字符串	Scaleway API URL。默认值: `"https://api.scaleway.com"`
description 字符串	安全组的描述。
inbound_default_policy 字符串	入站流量的默认策略。选择 `"accept"` `"drop"`
name 字符串 / 必需	安全组的名称。
organization 字符串 / 必需	组织标识符。
organization_default 布尔值	创建安全组作为默认安全组。选择 `false` `true`
outbound_default_policy 字符串	出站流量的默认策略。选择 `"accept"` `"drop"`
query_parameters 字典	传递给查询字符串的参数列表。默认值: `{}`
region 字符串 / 必需	要使用的 Scaleway 区域（例如 `par1`）。选择 `"ams1"` `"EMEA-NL-EVS"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"waw1"` `"EMEA-PL-WAW1"`
state 字符串	指示安全组的期望状态。选择 `"absent"` `"present"` ← (默认值)
stateful 布尔值 / 必需	创建允许建立入站和出站连接的有状态安全组。选择 `false` `true`
validate_certs 布尔值	验证 Scaleway API 的 SSL 证书。选择 `false` `true` ← (默认值)

属性 

属性	支持	描述
check_mode	支持: 完全	可以在 `check_mode` 中运行，并返回更改状态预测，而无需修改目标。
diff_mode	支持: 无	当处于 diff 模式时，将返回已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

说明 

注意

另请参阅 https://developer.scaleway.com/ 上的 API 文档。
如果未在模块中设置 api_token，则可以使用以下环境变量，其优先级依次递减 SCW_TOKEN、SCW_API_KEY、SCW_OAUTH_TOKEN 或 SCW_API_TOKEN。
如果要使用不同的 api_url，也可以设置 SCW_API_URL 环境变量。

示例 

- 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

返回值 

此处记录了常见的返回值此处，以下是此模块独有的字段

键

描述

数据

字典

仅当 state=present 时才存在。

返回: 当 state=present 时

示例： {"scaleway_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}}

作者

Antoine Barbare (@abarbare)