vultr.cloud.user 模块 – 管理 Vultr 上的用户

注意

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

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

要安装它，请使用：ansible-galaxy collection install vultr.cloud。

要在 playbook 中使用它，请指定：vultr.cloud.user。

vultr.cloud 1.0.0 中的新增功能

概要 

创建、更新和删除用户。

参数 

参数	注释
acls 别名：acl 列表 / 元素=字符串	此用户应具有的 ACL 列表。如果 `state=present`，则为必需项。一个或多个选择列表，有些相互依赖。选择 `"manage_users"` `"subscriptions_view"` `"subscriptions"` `"provisioning"` `"billing"` `"support"` `"abuse"` `"dns"` `"upgrade"` `"objstore"` `"loadbalancer"`
api_enabled 布尔值	是否启用 API。选择 `false` `true` ← (默认)
api_endpoint 字符串	API 端点 URL（不带尾部斜杠）。回退环境变量 `VULTR_API_ENDPOINT`。默认值： `"https://api.vultr.com/v2"`
api_key 字符串 / 必需	Vultr API 的 API 密钥。回退环境变量 `VULTR_API_KEY`。
api_retries 整数	如果 Vultr API 返回 HTTP 错误代码（例如 - 429 请求过多 - 500 内部服务器错误 - 504 网关超时），则重试的次数。回退环境变量 `VULTR_API_RETRIES`。默认值： `5`
api_retry_max_delay 整数	重试退避延迟时间（以秒为单位）呈指数增长，直到达到此最大值（以秒为单位）。回退环境变量 `VULTR_API_RETRY_MAX_DELAY`。默认值： `12`
api_timeout 整数	到 Vultr API 的 HTTP 超时。回退环境变量 `VULTR_API_TIMEOUT`。默认值： `180`
email 字符串	用户的电子邮件。如果 `state=present`，则为必需项。
force 布尔值	只有在强制执行时才会更改密码。选择 `false` ← (默认) `true`
name 字符串 / 必需	用户的名称
password 字符串	用户的密码。仅在创建用户或 `force=true` 时才考虑此选项。
state 字符串	用户的状态。选择 `"present"` ← (默认) `"absent"`
validate_certs 布尔值	验证 Vultr API 的 SSL 证书。选择 `false` `true` ← (默认)

备注 

注意

另请参阅 https://www.vultr.com/api/ 上的 API 文档。

示例 

- name: Ensure a user exists
  vultr.cloud.user:
    name: john
    email: [email protected]
    password: s3cr3t
    acls:
    - manage_users
    - subscriptions

- name: Remove a user
  vultr.cloud.user:
    name: john
    state: absent

返回值 

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

键	描述
vultr_api 字典	来自 Vultr API 的响应，进行了一些添加/修改。返回：成功
api_endpoint 字符串	用于 API 请求的端点。返回：成功示例： `"https://api.vultr.com/v2"`
api_retries 整数	API 请求的最大重试次数。返回：成功示例： `5`
api_retry_max_delay 整数	重试之间以秒为单位的指数退避延迟，直到达到此最大延迟值。返回：成功示例： `12`
api_timeout 整数	用于 API 请求的超时。返回：成功示例： `60`
vultr_user 字典	来自 Vultr API 的响应。返回：成功
acls 列表 / 元素=字符串	用户的 ACL 列表。返回：成功示例： `["manage_users", "support", "upgrade"]`
api_enabled 布尔值	是否启用 API。返回：成功示例： `true`
api_key 字符串	用户的 API 密钥。返回：仅在创建资源后返回示例： `"567E6K567E6K567E6K567E6K567E6K"`
email 字符串	用户的电子邮件。返回：成功示例： `"[email protected]"`
id 字符串	用户的 ID。返回：成功示例： `"7d726ffe-9be2-4f88-8cda-fa7eba1da2b5"`
name 字符串	用户的名称。返回：成功示例： `"john"`

作者

René Moser (@resmo)