openstack.cloud.security_group_info 模块 – 列出安全组

注意

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

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

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

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

概要

  • 列出安全组

要求

以下要求需要在执行此模块的主机上满足。

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

any_tags

列表 / 元素=字符串

用于过滤列表结果的标签列表。

将返回与此列表中任何标签匹配的资源。

api_timeout

整数

套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给请求库。

auth

字典

包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的 password 插件，这将包含 auth_url、username、password、project_name 以及有关域的任何信息（例如，如果云支持它们，则为 user_domain_name 或 project_domain_name）。对于其他插件，此参数将需要包含该身份验证插件所需的任何参数。如果提供了命名的云或存在 OpenStack OS_* 环境变量，则不需要此参数。

auth_type

字符串

要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他身份验证，则应在此处指示插件的名称，并应相应地更新 auth 参数的内容。

ca_cert

别名：cacert

字符串

可以作为验证 SSL API 请求的一部分使用的 CA 证书捆绑包的路径。

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

字符串

安全组的名称或 ID。

not_any_tags

列表 / 元素=字符串

用于过滤列表结果的标签列表。

将排除与此列表中任何标签匹配的资源。

not_tags

列表 / 元素=字符串

用于过滤列表结果的标签列表。

将排除与此列表中所有标签匹配的资源。

project_id

字符串

指定项目 ID 作为筛选条件。

region_name

字符串

区域名称。

revision_number

整数

按资源的修订号筛选列表结果。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • “INFO” ← (默认)

  • “DEBUG”

sdk_log_path

字符串

OpenStackSDK 的日志文件的路径。如果为空，则不写入日志

tags

列表 / 元素=字符串

用于过滤列表结果的标签列表。

将返回与此列表中所有标签匹配的资源。

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 配置文件，然后来自标准环境变量，最后来自 playbook 中的显式参数。更多信息请访问 https://docs.openstack.org/openstacksdk/

示例

- name: Get all security groups
  openstack.cloud.security_group_info:
    cloud: devstack

- name: Get specific security group
  openstack.cloud.security_group_info:
    cloud: devstack
    name: my_sg

返回值

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

键

描述

security_groups

list / elements=dictionary

描述安全组的字典列表。

返回: 总是

created_at

字符串

安全组的创建时间

返回: 成功时

示例: "yyyy-mm-dd hh:mm:ss"

description

字符串

安全组的描述

返回: 成功时

示例: "我的安全组"

id

字符串

安全组的 ID

返回: 成功时

示例: "d90e55ba-23bd-4d97-b722-8cb6fb485d69"

name

字符串

安全组的名称。

返回: 成功时

示例: "my-sg"

project_id

字符串

安全组所在的项目的 ID。

返回: 成功时

示例: "25d24fc8-d019-4a34-9fff-0a09fde6a567"

revision_number

整数

资源的修订号。

返回: 成功时

security_group_rules

列表 / 元素=字符串

指定安全组规则列表

返回: 成功时

示例: [{"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

列表 / 元素=字符串

资源上的标签列表。

返回: 成功时

tenant_id

字符串

安全组所在的租户 ID。已弃用

返回: 成功时

示例: "25d24fc8-d019-4a34-9fff-0a09fde6a567"

updated_at

字符串

安全组的更新时间

返回: 成功时

示例: "yyyy-mm-dd hh:mm:ss"

作者

  • OpenStack Ansible SIG