vultr.cloud.ssh_key 模块 – 管理 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。

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`
name 字符串 / 必填	SSH 密钥的名称。
ssh_key 字符串	SSH 公钥。如果 `state=present`，则必填。
state 字符串	SSH 密钥的状态。选项 `"present"` ← (默认) `"absent"`
validate_certs 布尔值	验证 Vultr API 的 SSL 证书。选项 `false` `true` ← (默认)

备注 

注意

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

示例 

- name: ensure an SSH key is present
  vultr.cloud.ssh_key:
    name: my ssh key
    ssh_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"

- name: ensure an SSH key is absent
  vultr.cloud.ssh_key:
    name: my ssh key
    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_ssh_key 字典	来自 Vultr API 的响应。返回：成功
date_created 字符串	创建 SSH 密钥的日期。返回：成功示例： `"2020-10-10T01:56:20+00:00"`
id 字符串	SSH 密钥的 ID。返回：成功示例： `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
name 字符串	SSH 密钥的名称。返回：成功示例： `"my ssh key"`
ssh_key 字符串	SSH 公钥。返回：成功示例： `"ssh-rsa AA... [email protected]"`

作者

René Moser (@resmo)