openstack.cloud.group_assignment 模块 – 将 OpenStack 身份用户分配到组

注意

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

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

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

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

概要

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

group

字符串 / 必填

组的名称或 ID。

interface

别名: endpoint_type

字符串

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

选项

  • "admin"

  • "internal"

  • "public" ← (默认)

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

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

state

字符串

用户应在组中存在还是不存在。

选项

  • "present" ← (默认)

  • "absent"

timeout

整数

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

默认: 180

user

字符串 / 必填

用户的名称或 ID。

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 配置文件，然后来自标准环境变量，最后来自剧本中的显式参数。更多信息可以在 https://docs.openstack.org/openstacksdk/ 找到。

示例

- name: Add demo_user user to demo_group group
  openstack.cloud.group_assignment:
    cloud: mycloud
    user: demo_user
    group: demo_group

作者

  • OpenStack Ansible SIG