community.general.scaleway_sshkey 模块 – Scaleway SSH 密钥管理模块

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

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

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

要在剧本中使用它，请指定： community.general.scaleway_sshkey。

概要 

此模块管理 Scaleway 帐户上的 SSH 密钥 https://developer.scaleway.com。

参数 

参数	注释
api_timeout 别名：timeout 整数	以秒为单位的 Scaleway API HTTP 超时。默认值： `30`
api_token 别名：oauth_token 字符串 / 必需	Scaleway OAuth 令牌。
api_url 别名：base_url 字符串	Scaleway API URL。默认值： `"https://account.scaleway.com"`
query_parameters 字典	传递给查询字符串的参数列表。默认值： `{}`
ssh_pub_key 字符串 / 必需	要添加的公共 SSH 密钥字符串。
state 字符串	指示 SSH 密钥的所需状态。选项 `"present"` ← (默认) `"absent"`
validate_certs 布尔值	验证 Scaleway API 的 SSL 证书。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在 `check_mode` 中运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	处于 diff 模式时，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

备注 

注意

另请参阅 https://developer.scaleway.com/ 上的 API 文档。
如果模块中未设置 api_token，则可以使用以下环境变量，其优先级按递减顺序排列：SCW_TOKEN、SCW_API_KEY、SCW_OAUTH_TOKEN 或 SCW_API_TOKEN。
如果要使用不同的 api_url，还可以设置 SCW_API_URL 环境变量。

示例 

- name: "Add SSH key"
  community.general.scaleway_sshkey:
    ssh_pub_key: "ssh-rsa AAAA..."
    state: "present"

- name: "Delete SSH key"
  community.general.scaleway_sshkey:
    ssh_pub_key: "ssh-rsa AAAA..."
    state: "absent"

- name: "Add SSH key with explicit token"
  community.general.scaleway_sshkey:
    ssh_pub_key: "ssh-rsa AAAA..."
    state: "present"
    oauth_token: "6ecd2c9b-6f4f-44d4-a187-61a92078d08c"

返回值 

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

键	描述
数据字典	只有在 `state=present` 时才出现。返回：当 `state=present` 时示例： `{"ssh_public_keys": [{"key": "ssh-rsa AAAA...."}]}`

作者

Remy Leone (@remyleone)