community.general.hwc_vpc_security_group 模块 – 在华为云中创建 Vpc/SecurityGroup 资源

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.general。您需要其他要求才能使用此模块,有关详细信息,请参阅要求

要在 playbook 中使用它,请指定:community.general.hwc_vpc_security_group

community.general 0.2.0 中的新增功能

概要

  • VPC 安全组管理。

要求

执行此模块的主机需要以下要求。

  • keystoneauth1 >= 3.6.0

参数

参数

注释

字符串 / 必需

要将作用域限定到的域的名称(Identity v3)。

目前仅支持域名,不支持域 ID。

企业项目 ID

字符串

指定企业项目 ID。创建安全组时,将企业项目 ID 与安全组关联。

ID

字符串

要管理的资源的 ID。

身份端点

字符串 / 必需

身份验证 URL。

名称

字符串 / 必需

指定安全组名称。该值是一个 1 到 64 个字符的字符串,可以包含字母、数字、下划线(_)、连字符(-)和句点(.)。

密码

字符串 / 必需

用于登录的密码。

项目

字符串 / 必需

租户(Identity v2)或项目(Identity v3)的名称。

目前仅支持项目名称,不支持项目 ID。

区域

字符串

项目所属的区域。

状态

字符串

给定对象是否应存在于华为云中。

选择

  • "present" ←(默认)

  • "absent"

用户

字符串 / 必需

用于登录的用户名。

目前仅支持用户名,不支持用户 ID。

VPC ID

字符串

指定安全组所属的 VPC 的资源 ID。

属性

属性

支持

描述

check_mode

支持:完全支持

可以在 check_mode 中运行,并返回更改状态预测,而无需修改目标。

diff_mode

支持:不支持

在 diff 模式下,将返回有关已更改的内容的详细信息(或者可能需要在 check_mode 中更改的内容)。

注释

注意

  • 如果提供了 id 选项,它将优先于用于安全组选择的 nameenterprise_project_idvpc_id

  • nameenterprise_project_idvpc_id 用于安全组选择。如果存在多个具有此选项的安全组,则执行将中止。

  • 不支持更新参数。如果更改了其中一个选项,则模块将创建一个新资源。

  • 对于身份验证,您可以使用 ANSIBLE_HWC_IDENTITY_ENDPOINT 环境变量设置 identity_endpoint。

  • 对于身份验证,您可以使用 ANSIBLE_HWC_USER 环境变量设置用户。

  • 对于身份验证,您可以使用 ANSIBLE_HWC_PASSWORD 环境变量设置密码。

  • 对于身份验证,您可以使用 ANSIBLE_HWC_DOMAIN 环境变量设置域。

  • 对于身份验证,您可以使用 ANSIBLE_HWC_PROJECT 环境变量设置项目。

  • 对于身份验证,您可以使用 ANSIBLE_HWC_REGION 环境变量设置区域。

  • 只有在 playbook 值未设置时,才会使用环境变量的值。

示例

# create a security group
- name: Create a security group
  community.general.hwc_vpc_security_group:
    name: "ansible_network_security_group_test"

返回值

常见的返回值记录在这里,以下是此模块特有的字段

Key

描述

企业项目 ID

字符串

指定企业项目 ID。创建安全组时,将企业项目 ID 与安全组关联。

返回: 成功

名称

字符串

指定安全组名称。该值是一个 1 到 64 个字符的字符串,可以包含字母、数字、下划线(_)、连字符(-)和句点(.)。

返回: 成功

rules

复杂

指定安全组规则,以确保安全组中的资源可以相互通信。

返回: 成功

description

字符串

提供有关安全组规则的补充信息。

返回: 成功

direction

字符串

指定访问控制的方向。该值可以是 egress 或 ingress。

返回: 成功

ethertype

字符串

指定 IP 协议版本。该值可以是 IPv4 或 IPv6。

返回: 成功

ID

字符串

指定安全组规则 ID。

返回: 成功

port_range_max

整数

指定结束端口号。该值的范围为 1 到 65535。如果协议不是 icmp,则该值不能小于 port_range_min 值。空值表示所有端口。

返回: 成功

port_range_min

整数

指定起始端口号。该值的范围为 1 到 65535。该值不能大于 port_range_max 值。空值表示所有端口。

返回: 成功

protocol

字符串

指定协议类型。该值可以是 icmp、tcp、udp 或其他。如果参数留空,则安全组支持所有协议。

返回: 成功

remote_address_group_id

字符串

指定远程 IP 地址组的 ID。

返回: 成功

remote_group_id

字符串

指定对等安全组的 ID。

返回: 成功

remote_ip_prefix

字符串

指定远程 IP 地址。如果访问控制方向设置为 egress,则该参数指定源 IP 地址。如果访问控制方向设置为 ingress,则该参数指定目标 IP 地址。

返回: 成功

VPC ID

字符串

指定安全组所属的 VPC 的资源 ID。

返回: 成功

作者

  • 华为公司 (@huaweicloud)