openstack.cloud.role_assignment 模块 – 将 OpenStack 身份组和用户分配到角色

注意

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

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

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

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

概要

  • 为 OpenStack 身份 (Keystone) 用户和组在项目或域上下文中授予和撤销角色。

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

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

auth

字典

包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的密码插件，这将包含 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 的一部分中一样。

domain

字符串

要将角色关联范围限定到的域的名称或 ID。

仅在 keystone 版本 3 中有效。

如果未指定 project，则为必需。

当指定 project 时，domain 将不用于限定角色关联的范围，仅用于查找资源。

在限定角色关联的范围时，project 优先于 domain，domain 优先于 system：当指定 project 时，domain 和 system 不用于角色关联。当指定 domain 时，system 将不用于角色关联。

group

字符串

组的名称或 ID。

仅在 keystone 版本 3 中有效。

如果未指定 group，则需要 user。两者不能同时指定。

interface

别名：endpoint_type

字符串

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

选项

  • "admin"

  • "internal"

  • "public" ←（默认）

project

字符串

要将角色关联范围限定到的项目的名称或 ID。

如果您使用的是 keystone 版本 2，则此值为必需。

当指定 project 时，domain 将不用于限定角色关联的范围，仅用于查找资源。

在限定角色关联的范围时，project 优先于 domain，domain 优先于 system：当指定 project 时，domain 和 system 不用于角色关联。当指定 domain 时，system 将不用于角色关联。

region_name

字符串

区域的名称。

role

字符串 / 必需

角色的名称或 ID。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ←（默认）

  • "DEBUG"

sdk_log_path

字符串

OpenStackSDK 的日志文件的路径。如果为空，则不写入日志

state

字符串

角色应在用户上存在还是不存在。

选项

  • "present" ←（默认）

  • "absent"

system

字符串

要将角色关联范围限定到的系统的名称。

仅在 keystone 版本 3 中有效。

如果未指定 project 和 domain，则为必需。

在限定角色关联的范围时，project 优先于 domain，domain 优先于 system：当指定 project 时，domain 和 system 不用于角色关联。当指定 domain 时，system 将不用于角色关联。

timeout

整数

ansible 应等待请求的资源多长时间。

默认： 180

user

字符串

用户的名称或 ID。

如果未指定 user，则需要 group。两者不能同时指定。

validate_certs

别名：verify

布尔值

是否应验证 SSL API 请求。

在 Ansible 2.3 之前，此值默认为 true。

选项

  • false

  • true

等待

布尔值

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: Grant an admin role on the user admin in the project project1
  openstack.cloud.role_assignment:
    cloud: mycloud
    user: admin
    role: admin
    project: project1

- name: Revoke the admin role from the user barney in the newyork domain
  openstack.cloud.role_assignment:
    cloud: mycloud
    state: absent
    user: barney
    role: admin
    domain: newyork

作者

  • OpenStack Ansible SIG