openstack.cloud.federation_idp 模块 – 在 OpenStack 云中管理身份提供程序

注意

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

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

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

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

概要 

创建、更新或删除 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 字符串	一个 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 字符串	身份提供程序的描述。
domain_id 字符串	与身份提供程序关联的域的 ID。使用身份提供程序进行身份验证的联合用户将在指定的域下创建。创建新的身份提供程序时是必需的。
id 别名：name 字符串 / 必需	身份提供程序的 ID（和名称）。
interface 别名：endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。选择 `"admin"` `"internal"` `"public"` ←（默认）
is_enabled 别名：enabled 布尔值	身份提供程序是否启用。创建新的身份提供程序时，将默认为 `false`。选择 `false` `true`
region_name 字符串	区域的名称。
remote_ids 列表 / 元素=字符串	唯一身份提供程序的远程 ID 列表。创建新的身份提供程序时，将默认为空列表。
sdk_log_level 字符串	OpenStackSDK 的日志级别选择 `"INFO"` ←（默认） `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 的日志文件的路径。如果为空，则不写入日志
state 字符串	身份提供程序应为 `present` 或 `absent`。选择 `"present"` ← (默认) `"absent"`
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 配置文件，然后来自标准环境变量，最后来自 plays 中的显式参数。更多信息可以在 https://docs.openstack.org/openstacksdk/ 中找到。

示例 

- name: Create an identity provider
  openstack.cloud.federation_idp:
    cloud: example_cloud
    name: example_provider
    domain_id: 0123456789abcdef0123456789abcdef
    description: 'My example IDP'
    remote_ids:
      - 'https://auth.example.com/auth/realms/ExampleRealm'

- name: Delete an identity provider
  openstack.cloud.federation_idp:
    cloud: example_cloud
    name: example_provider
    state: absent

返回值 

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

键	描述
identity_provider 字典	描述身份提供程序的字典返回值: 当 state 为 `present` 时成功返回。
description 字符串	身份提供程序描述返回值: 成功示例: `"demodescription"`
domain_id 字符串	身份提供程序所属的域返回值: 成功示例: `"default"`
id 字符串	身份提供程序 ID 返回值: 成功示例: `"test-idp"`
is_enabled 布尔值	指示是否启用身份提供程序返回值: 成功
name 字符串	身份提供程序的名称，等于其 ID。返回值: 成功示例: `"test-idp"`
remote_ids 列表 / 元素=字符串	与身份提供程序关联的远程 ID 返回值: 成功

作者

OpenStack Ansible SIG