vultr.cloud.user_info 模块 – 获取关于 Vultr 用户的信息

注意

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

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

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

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

vultr.cloud 1.0.0 中的新功能

概要

  • 获取关于可用用户的信息。

参数

参数

注释

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

validate_certs

布尔值

验证 Vultr API 的 SSL 证书。

选项

  • false

  • true ← (默认)

说明

注意

示例

- name: Get Vultr user infos
  vultr.cloud.user_info:
  register: result

- name: Print the infos
  ansible.builtin.debug:
    var: result.vultr_user_info

返回值

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

键

描述

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_info

列表 / 元素=字符串

来自 Vultr API 的列表形式的响应。

已返回： 可用

acls

列表 / 元素=字符串

用户的 ACL 列表。

已返回： 成功

示例： ["manage_users", "support", "upgrade"]

api_enabled

布尔值

是否启用了 API。

已返回： 成功

示例： true

api_key

字符串

用户的 API 密钥。

已返回： 仅在资源创建后

示例： "567E6K567E6K567E6K567E6K567E6K"

email

字符串

用户的电子邮件。

已返回： 成功

示例： "john@example.com"

id

字符串

用户的 ID。

已返回： 成功

示例： "7d726ffe-9be2-4f88-8cda-fa7eba1da2b5"

name

字符串

用户的名称。

已返回： 成功

示例： "john"

作者

  • Yanis Guenane (@Spredzy)

  • René Moser (@resmo)