openstack.cloud.auth 模块 – 从 OpenStack 云检索身份验证令牌

注意

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

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

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

要在 playbook 中使用它,请指定:openstack.cloud.auth

概要

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

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

示例

- name: Authenticate to cloud and return auth token
  openstack.cloud.auth:
    cloud: rax-dfw

返回值

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

描述

auth_token

字符串

Openstack API 身份验证令牌

已返回: 成功

作者

  • OpenStack Ansible SIG