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

参数

参数

注释

domain

字符串 / 必填

要限定作用域的域的名称（Identity v3）。

当前仅支持域名，不支持域 ID。

enterprise_project_id

字符串

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

id

字符串

要管理的资源的 ID。

identity_endpoint

字符串 / 必填

身份验证 URL。

name

字符串 / 必填

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

password

字符串 / 必填

用于登录的密码。

project

字符串 / 必填

租户（Identity v2）或项目（Identity v3）的名称。

当前仅支持项目名称，不支持项目 ID。

region

字符串

项目所属的区域。

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

user

字符串 / 必填

用于登录的用户名。

当前仅支持用户名，不支持用户 ID。

vpc_id

字符串

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

属性

属性

支持

描述

check_mode

支持: 完全

可以在 check_mode 下运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持: 无

在 diff 模式下，当处于 check_mode 时，将返回有关已更改（或可能需要更改）的内容的详细信息。

备注

注意

  • 如果提供了 id 选项，则它优先于 name、enterprise_project_id 和 vpc_id 用于安全组选择。

  • name、enterprise_project_id 和 vpc_id 用于选择安全组。如果存在多个具有这些选项的安全组，则执行将中止。

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

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

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

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

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

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

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

  • 仅当 playbook 值未设置时，才会使用环境变量值。

示例

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

返回值

通用返回值已在此处记录 这里，以下是此模块独有的字段

Key

描述

enterprise_project_id

字符串

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

返回: 成功

name

字符串

指定安全组名称。该值是一个 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)