vultr.cloud.ssh_key_info 模块 – 获取 Vultr SSH 密钥信息

注意

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

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

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

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

vultr.cloud 1.0.0 中的新增功能

概要 

获取可用 SSH 密钥的信息。

参数 

参数	注释
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` ← (默认)

备注 

注意

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

示例 

- name: Get Vultr SSH keys infos
  vultr.cloud.ssh_key_info:
  register: result

- name: Print the infos
  ansible.builtin.debug:
    var: result.vultr_ssh_key_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_ssh_key_info 列表 / 元素=字符串	来自 Vultr API 的响应，以列表形式呈现。返回：成功
date_created 字符串	创建 SSH 密钥的日期。返回：成功示例： `"2021-11-07T05:57:59-05:00"`
id 字符串	SSH 密钥的 ID。返回：成功示例： `"7d726ffe-9be2-4f88-8cda-fa7eba1da2b5"`
name 字符串	SSH 密钥的名称。返回：成功示例： `"my ssh key"`
ssh_key 字符串	SSH 公钥。返回：成功示例： `"ssh-rsa AA... [email protected]"`

作者

Yanis Guenane (@Spredzy)
René Moser (@resmo)