openstack.cloud.federation_idp_info 模块 – 获取 OpenStack 联邦身份提供者

注意

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

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

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

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

概要

  • 获取 OpenStack 联邦身份提供者。

要求

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

  • 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 的一部分一样。

id

别名: name

字符串

要获取的身份提供者的 ID（和名称）。

interface

别名: endpoint_type

字符串

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

选择

  • "admin"

  • "internal"

  • "public" ← (默认)

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

示例

- name: Fetch a specific identity provider
  openstack.cloud.federation_idp_info:
    cloud: example_cloud
    name: example_provider

- name: Fetch all providers
  openstack.cloud.federation_idp_info:
    cloud: example_cloud

返回值

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

键

描述

identity_providers

列表 / 元素=字典

描述身份提供者的字典

返回: 总是

description

字符串

身份提供者描述

返回: 成功

示例: "demodescription"

domain_id

字符串

身份提供者所属的域

返回: 成功

示例: "default"

id

字符串

身份提供者 ID

返回: 成功

示例: "test-idp"

is_enabled

布尔值

指示是否启用身份提供者

返回: 成功

name

字符串

身份提供者的名称，等于其 ID。

返回: 成功

示例: "test-idp"

remote_ids

列表 / 元素=字符串

与身份提供者关联的远程 ID

返回: 成功

作者

  • OpenStack Ansible SIG