openstack.cloud.keystone_federation_protocol 模块 – 管理 Keystone 联邦协议

注意

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

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

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

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

概要 

管理 Keystone 联邦协议。

要求 

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

python >= 3.6
openstacksdk >= 1.0.0

参数 

参数	注释
api_timeout 整数	套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给请求库。
auth 字典	包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的密码插件，这将包含 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 的一部分。
idp 别名：idp_id、idp_name 字符串 / 必需	与此协议关联的身份提供程序的 ID 或名称。此属性无法更新。
interface 别名：endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。选项 `"admin"` `"internal"` `"public"` ←（默认）
mapping 别名：mapping_id、mapping_name 字符串	要用于此协议的映射的 ID 或名称。创建新协议时需要。
name 别名：id 字符串 / 必需	联邦协议的 ID 或名称。此属性无法更新。
region_name 字符串	区域的名称。
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` ←（默认）

注释 

注意

名称等于联邦协议的 ID。
名称等于身份提供程序的 ID。
名称等于映射的 ID。
可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而不是提供显式值。
身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自剧本中的显式参数。有关更多信息，请访问 https://docs.openstack.org/openstacksdk/

示例 

- name: Create a protocol
  openstack.cloud.keystone_federation_protocol:
    cloud: example_cloud
    name: example_protocol
    idp: example_idp
    mapping: example_mapping

- name: Delete a protocol
  openstack.cloud.keystone_federation_protocol:
    cloud: example_cloud
    name: example_protocol
    idp: example_idp
    state: absent

返回值 

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

键	描述
protocol 字典	描述联邦协议的字典。返回：始终
id 字符串	联邦协议的 ID。返回：成功
mapping_id 字符串	联邦协议的定义。返回：成功
name 字符串	协议名称。等于 `id`。返回：成功

作者

OpenStack Ansible SIG