openstack.cloud.security_group 模块 – 管理 OpenStack 云的 Neutron 安全组。

注意

此模块是 openstack.cloud 集合 (版本 2.3.0) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install openstack.cloud。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：openstack.cloud.security_group。

概要 

向 OpenStack 云添加或删除 Neutron 安全组。

要求 

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

python >= 3.6
openstacksdk >= 1.0.0

参数 

参数	注释
api_timeout 整数	套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递到 requests 库。
auth 字典	包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的password插件，这将包含auth_url、username、password、project_name以及关于域的任何信息（例如，如果云支持域，则包含user_domain_name或project_domain_name）。对于其他插件，此参数将需要包含该身份验证插件所需的任何参数。如果提供了已命名的云或存在 OpenStack OS_* 环境变量，则不需要此参数。
auth_type 字符串	要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他身份验证，则应在此处指示插件的名称，并且应相应地更新auth参数的内容。
ca_cert 别名：cacert 字符串	CA 证书捆绑包的路径，可用作验证 SSL API 请求的一部分。
client_cert 别名：cert 字符串	要用作 SSL 事务一部分的客户端证书的路径。
client_key 别名：key 字符串	要用作 SSL 事务一部分的客户端密钥的路径。
cloud 任意	要操作的已命名云或云配置。如果 cloud 是一个字符串，它引用在 OpenStack clouds.yaml 文件中定义的已命名云配置。为 auth 和 auth_type 提供默认值。如果提供了 auth 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 cloud 是一个字典，则它包含完整的云配置，就像 clouds.yaml 的某个部分一样。
description 字符串	安全组用途的详细描述。
interface 别名：endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。选项 `"admin"` `"internal"` `"public"` ← (默认)
name 字符串 / 必需	必须提供给安全组的名称。此模块要求安全组名称是唯一的。
project 字符串	项目的唯一名称或 ID。
region_name 字符串	区域的名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别选项 `"INFO"` ← (默认) `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 的日志文件的路径。如果为空，则不写入日志
security_group_rules 列表 / 元素=字典	安全组规则列表。当未定义 security_group_rules 时，Neutron 可能会使用默认的规则集创建此安全组。将创建在 security_group_rules 中列出但未在此安全组中定义的安全组规则。当未设置 security_group_rules 时，将删除 security_group_rules 中未列出的现有安全组规则。更新安全组时，如果要保留来自 Neutron 默认值的规则，则必须在 security_group_rules 中显式列出这些规则。将删除 security_group_rules 中未列出的规则。
description 字符串	安全组规则的描述。
direction 字符串	应用安全组规则的方向。并非所有提供程序都支持 `egress`。选项 `"egress"` `"ingress"` ← (默认)
ether_type 字符串	必须是 IPv4 或 IPv6，并且以 CIDR 表示的地址必须与入口或出口规则匹配。并非所有提供商都支持 IPv6。选项 `"IPv4"` ← (默认) `"IPv6"`
port_range_max 整数	安全组规则匹配的范围中的最大端口号。如果协议是 TCP、UDP、DCCP、SCTP 或 UDP-Lite，则此值必须大于或等于 port_range_min 属性值。如果协议是 ICMP，则此值必须是 ICMP 代码。
port_range_min 整数	安全组规则匹配的范围中的最小端口号。如果协议是 TCP、UDP、DCCP、SCTP 或 UDP-Lite，则此值必须小于或等于 port_range_max 属性值。如果协议是 ICMP，则此值必须是 ICMP 类型。
protocol 字符串	IP 协议可以用字符串、整数或 null 表示。有效的字符串或整数值是 `any` 或 `0`、 `ah` 或 `51`、 `dccp` 或 `33`、 `egp` 或 `8`、 `esp` 或 `50`、 `gre` 或 `47`、 `icmp` 或 `1`、 `icmpv6` 或 `58`、 `igmp` 或 `2`、 `ipip` 或 `4`、 `ipv6-encap` 或 `41`、 `ipv6-frag` 或 `44`、 `ipv6-icmp` 或 `58`、 `ipv6-nonxt` 或 `59`、 `ipv6-opts` 或 `60`、 `ipv6-route` 或 `43`、 `ospf` 或 `89`、 `pgm` 或 `113`、 `rsvp` 或 `46`、 `sctp` 或 `132`、 `tcp` 或 `6`、 `udp` 或 `17`、 `udplite` 或 `136`、 `vrrp` 或 `112`。此外，任何介于 `[0-255]` 之间的整数值也是有效的。字符串 any （或整数 0）表示所有 IP 协议。有关支持的字符串的最新列表，请参阅 neutron_lib.constants 中的常量。
remote_group 字符串	要链接的安全组的名称或 ID。与 remote_ip_prefix 互斥。
remote_ip_prefix 字符串	以 CIDR 表示法表示的源 IP 地址。如果 remote_ip_prefix 中缺少诸如 `/32` 之类的网络掩码，则此模块将在更新时失败，并出现 OpenStack 错误消息 `安全组规则已存在。`。与 remote_group 互斥。
state 字符串	资源应该是存在还是不存在。选项 `"present"` ← (默认) `"absent"`
stateful 布尔值	资源应该是有状态还是无状态。选项 `false` `true`
timeout 整数	Ansible 应该等待请求的资源多长时间。默认值: `180`
validate_certs 别名：verify 布尔值	是否应验证 SSL API 请求。在 Ansible 2.3 之前，此默认值为 `true`。选项 `false` `true`
wait 布尔值	Ansible 是否应等待直到请求的资源完成。选项 `false` `true` ← (默认)

注释 

注意

可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而不是提供显式值。
身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自剧本中的显式参数。更多信息可以在 https://docs.openstack.org/openstacksdk/ 中找到

示例 

- name: Create a security group
  openstack.cloud.security_group:
    cloud: mordred
    state: present
    name: foo
    description: security group for foo servers

- name: Create a stateless security group
  openstack.cloud.security_group:
    cloud: mordred
    state: present
    stateful: false
    name: foo
    description: stateless security group for foo servers

- name: Update the existing 'foo' security group description
  openstack.cloud.security_group:
    cloud: mordred
    state: present
    name: foo
    description: updated description for the foo security group

- name: Create a security group for a given project
  openstack.cloud.security_group:
    cloud: mordred
    state: present
    name: foo
    project: myproj

- name: Create (or update) a security group with security group rules
  openstack.cloud.security_group:
    cloud: mordred
    state: present
    name: foo
    security_group_rules:
      - ether_type: IPv6
        direction: egress
      - ether_type: IPv4
        direction: egress

- name: Create (or update) security group without security group rules
  openstack.cloud.security_group:
    cloud: mordred
    state: present
    name: foo
    security_group_rules: []

返回值 

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

键	描述
security_group 字典	描述安全组的字典。返回：当 state 为 `present` 时成功。
created_at 字符串	安全组的创建时间返回：成功示例： `"yyyy-mm-dd hh:mm:ss"`
description 字符串	安全组的描述返回：成功示例： `"我的安全组"`
id 字符串	安全组的 ID 返回：成功示例： `"d90e55ba-23bd-4d97-b722-8cb6fb485d69"`
name 字符串	安全组的名称。返回：成功示例： `"my-sg"`
project_id 字符串	安全组所在的 Project ID。返回：成功示例： `"25d24fc8-d019-4a34-9fff-0a09fde6a567"`
revision_number 整数	资源的修订号。返回：成功
security_group_rules list / elements=string	指定安全组规则列表返回：成功示例： [{"description": null, "direction": "ingress", "ethertype": "IPv4", "id": "d90e55ba-23bd-4d97-b722-8cb6fb485d69", "port_range_max": null, "port_range_min": null, "protocol": null, "remote_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", "remote_ip_prefix": null, "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c"}, {"description": null, "direction": "egress", "ethertype": "IPv4", "id": "aecff4d4-9ce9-489c-86a3-803aedec65f7", "port_range_max": null, "port_range_min": null, "protocol": null, "remote_group_id": null, "remote_ip_prefix": null, "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c"}]
stateful 布尔值	指示安全组是有状态还是无状态。返回：成功
tags list / elements=string	资源上的标签列表。返回：成功
tenant_id 字符串	安全组所在的租户 ID。已弃用返回：成功示例： `"25d24fc8-d019-4a34-9fff-0a09fde6a567"`
updated_at 字符串	安全组的更新时间返回：成功示例： `"yyyy-mm-dd hh:mm:ss"`

作者

OpenStack Ansible SIG