openstack.cloud.identity_role_info 模块 – 获取 OpenStack 身份 (Keystone) 角色

注意

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

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

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

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

概要

  • 获取 OpenStack 身份 (Keystone) 角色。

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递到请求库。

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

domain_id

字符串

拥有该角色的域 ID。

interface

别名: endpoint_type

字符串

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

选择

  • "admin"

  • "internal"

  • "public" ← (默认)

name

字符串

角色的名称或 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 ← (默认)

注意

注意

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

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

示例

- name: Retrieve info about all roles
  openstack.cloud.identity_role_info:
    cloud: mycloud

- name: Retrieve info about all roles in specific domain
  openstack.cloud.identity_role_info:
    cloud: mycloud
    domain_id: some_domain_id

- name: Retrieve info about role 'admin'
  openstack.cloud.identity_role_info:
    cloud: mycloud
    name: admin

返回值

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

键

描述

roles

列表 / 元素=字典

描述匹配身份角色的字典列表。

返回: 总是

description

字符串

角色面向用户的描述。

返回: 成功

domain_id

字符串

引用拥有该角色的域 ID。

返回: 成功

id

字符串

角色的唯一 ID

返回: 成功

字典

服务资源的链接

返回: 成功

name

字符串

拥有域内的唯一角色名称。

返回: 成功

作者

  • OpenStack Ansible SIG