openstack.cloud.identity_group_info 模块 – 获取 OpenStack 身份 (Keystone) 组

注意

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

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

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

要在剧本中使用它，请指定：openstack.cloud.identity_group_info。

摘要 

获取 OpenStack 身份 (Keystone) 组。

要求 

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

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 字符串	可用于验证 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 的一部分一样。
domain 字符串	包含该组的域的名称或 ID。
filters 字典	用于进一步过滤的元数据字典。此字典的元素可能是其他字典。
interface 别名：endpoint_type 字符串	从服务目录中获取的端点 URL 类型。选项 `"admin"` `"internal"` `"public"` ← (默认)
name 字符串	组的名称或 ID。
region_name 字符串	区域的名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别选项 `"INFO"` ← (默认) `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 日志文件的路径。如果为空，则不写入日志
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: Gather previously created groups
  openstack.cloud.identity_group_info:
    cloud: awesomecloud

- name: Gather previously created groups by name
  openstack.cloud.identity_group_info:
    cloud: awesomecloud
    name: demogroup

- name: Gather previously created groups in a specific domain
  openstack.cloud.identity_group_info:
    cloud: awesomecloud
    domain: admindomain

- name: Gather and filter previously created groups
  openstack.cloud.identity_group_info:
    cloud: awesomecloud
    name: demogroup
    domain: admindomain
    filters:
      is_enabled: False

返回值 

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

键	描述
groups 列表 / 元素=字典	描述所有匹配的身份组的字典。返回：始终
description 字符串	组的描述。返回：成功
domain_id 布尔值	包含该组的域 ID（仅限 keystone v3 云）返回：成功
id 字符串	唯一的 UUID。返回：成功
name 字符串	赋予组的名称。返回：成功

作者

OpenStack Ansible SIG