openstack.cloud.identity_user 模块 – 管理 OpenStack 身份 (Keystone) 用户

注意

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

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

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

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

概要 

创建、更新或删除 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 的一个部分一样。
default_project 字符串	项目名称或 ID，用户应在此项目中创建。
description 字符串	关于用户的描述。
domain 字符串	如果云支持域，则在其中创建用户的域。
email 字符串	用户的电子邮件地址。
interface 别名：endpoint_type 字符串	从服务目录中获取的端点 URL 类型。选项 `"admin"` `"internal"` `"public"` ← (默认)
is_enabled 别名：enabled 布尔值	用户是否启用。选项 `false` `true` ← (默认)
name 字符串 / 必需	用户的名称。 name 不能在不删除和重新创建用户的情况下更新。
password 字符串	用户的密码。
region_name 字符串	区域名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别选项 `"INFO"` ← (默认) `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 日志文件的路径。如果为空，则不写入日志
state 字符串	资源应存在还是不存在。选项 `"present"` ← (默认) `"absent"`
timeout 整数	ansible 应等待请求的资源多长时间。默认值： `180`
update_password 字符串	当 update_password 为 `always` 时，密码将始终更新。当 update_password 为 `on_create` 时，只有在创建用户时才设置密码。选项 `"always"` `"on_create"` ← (默认)
validate_certs 别名：verify 布尔值	是否应验证 SSL API 请求。在 Ansible 2.3 之前，默认为 `true`。选项 `false` `真`
等待布尔值	Ansible是否应等待请求的资源完成。选项 `false` `true` ← (默认)

备注 

注意

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

示例 

- name: Create a user
  openstack.cloud.identity_user:
    cloud: mycloud
    state: present
    name: demouser
    password: secret
    email: [email protected]
    domain: default
    default_project: demo

- name: Delete a user
  openstack.cloud.identity_user:
    cloud: mycloud
    state: absent
    name: demouser

- name: Create a user but don't update password if user exists
  openstack.cloud.identity_user:
    cloud: mycloud
    state: present
    name: demouser
    password: secret
    update_password: on_create
    email: [email protected]
    domain: default
    default_project: demo

- name: Create a user without password
  openstack.cloud.identity_user:
    cloud: mycloud
    state: present
    name: demouser
    email: [email protected]
    domain: default
    default_project: demo

返回值 

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

键	描述
用户字典	描述身份用户的字典。返回：当state为`present`时成功。
default_project_id 字符串	用户默认项目ID。仅在Keystone >= v3中出现。返回：成功示例：`"4427115787be45f08f0ec22a03bfc735"`
description 字符串	此用户的描述返回：成功示例：`"a user"`
domain_id 字符串	用户域ID。仅在Keystone >= v3中出现。返回：成功示例：`"default"`
email 字符串	用户邮箱地址返回：成功示例：`"[email protected]"`
id 字符串	用户ID 返回：成功示例：`"f59382db809c43139982ca4189404650"`
is_enabled 布尔值	指示用户是否已启用返回：成功
links 字典	用户资源的链接返回：成功
name 字符串	唯一的用户名，在其所属域内。返回：成功示例：`"demouser"`
password 字符串	身份验证期间使用的凭据返回：成功
password_expires_at 字符串	密码过期日期和时间。时区为UTC。无值表示密码永不过期返回：成功

作者

OpenStack Ansible SIG