openstack.cloud.keystone_federation_protocol_info 模块 – 获取 Keystone 联邦协议

注意

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

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

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

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

概要

  • 获取 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 的一部分所示。

idp

别名：idp_id, idp_name

字符串 / 必需

此协议关联的身份提供程序的 ID 或名称。

interface

别名：endpoint_type

字符串

要从服务目录中获取的端点 URL 类型。

选项

  • "admin"

  • "internal"

  • "public" ←（默认）

name

别名：id

字符串

联邦协议的 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 ←（默认）

说明

注意

  • 名称等于联邦协议的 ID。

  • 名称等于身份提供程序的 ID。

  • 可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而不是提供显式值。

  • 身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自 play 中的显式参数。有关更多信息，请访问 https://docs.openstack.org/openstacksdk/

示例

- name: Fetch all federation protocols attached to an identity provider
  openstack.cloud.keystone_federation_protocol_info:
    cloud: example_cloud
    idp: example_idp

- name: Fetch federation protocol by name
  openstack.cloud.keystone_federation_protocol_info:
    cloud: example_cloud
    idp: example_idp
    name: example_protocol

返回值

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

键

描述

protocols

列表 / elements=字典

联邦协议字典的列表。

已返回：始终

id

字符串

联邦协议的 ID。

已返回：成功

mapping_id

字符串

联邦协议的定义。

已返回：成功

名称

字符串

协议的名称。等同于 id。

已返回：成功

作者

  • OpenStack Ansible SIG