ngine_io.cloudstack.cs_sshkeypair 模块 – 管理基于 Apache CloudStack 的云上的 SSH 密钥。

注意

此模块是 ngine_io.cloudstack 集合(版本 2.5.0)的一部分。

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

要安装它,请使用:ansible-galaxy collection install ngine_io.cloudstack。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求

要在 playbook 中使用它,请指定:ngine_io.cloudstack.cs_sshkeypair

ngine_io.cloudstack 0.1.0 中的新功能

概要

  • 创建、注册和删除 SSH 密钥。

  • 如果没有找到密钥,并且没有提供公钥,则将创建新的 SSH 私钥/公钥对,并且将返回私钥。

要求

执行此模块的主机需要满足以下要求。

  • python >= 2.6

  • cs >= 0.9.0

参数

参数

注释

account

string

公钥与之关联的帐户。

api_http_method

string

用于查询 API 端点的 HTTP 方法。

如果未给定,则考虑 CLOUDSTACK_METHOD 环境变量。

选择

  • "get" ← (默认)

  • "post"

api_key

string / 必需

CloudStack API 的 API 密钥。

如果未给定,则考虑 CLOUDSTACK_KEY 环境变量。

api_secret

string / 必需

CloudStack API 的密钥。

如果未设置,则考虑 CLOUDSTACK_SECRET 环境变量。

api_timeout

integer

HTTP 超时(以秒为单位)。

如果未给定,则考虑 CLOUDSTACK_TIMEOUT 环境变量。

默认: 10

api_url

string / 必需

CloudStack API 的 URL,例如 https://cloud.example.com/client/api

如果未给定,则考虑 CLOUDSTACK_ENDPOINT 环境变量。

api_verify_ssl_cert

string

验证 CA 授权证书文件。

如果未给定,则考虑 CLOUDSTACK_VERIFY 环境变量。

domain

string

公钥与之关联的域。

name

string / 必需

公钥的名称。

project

string

要在其中注册公钥的项目名称。

public_key

string

公钥的字符串。

state

string

公钥的状态。

选择

  • "present" ← (默认)

  • "absent"

validate_certs

boolean

在 ngine_io.cloudstack 2.4.0 中添加

如果 false,则不会验证 SSL 证书。

如果未给定,则考虑 CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY 环境变量。

这应该只在个人控制的站点上使用自签名证书。

选择

  • false

  • true ← (默认)

注释

注意

  • 有关 cloudstack 模块的详细指南,请参阅 CloudStack 云指南

  • 此模块支持检查模式。

示例

- name: create a new private / public key pair
  ngine_io.cloudstack.cs_sshkeypair:
    name: [email protected]
  register: key

- debug:
    msg: 'Private key is {{ key.private_key }}'

- name: remove a public key by its name
  ngine_io.cloudstack.cs_sshkeypair:
    name: [email protected]
    state: absent

- name: register your existing local public key
  ngine_io.cloudstack.cs_sshkeypair:
    name: [email protected]
    public_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"

返回值

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

描述

fingerprint

string

SSH 公钥的指纹。

返回: 成功

示例: "86:5e:a3:e8:bd:95:7b:07:7c:c2:5c:f7:ad:8b:09:28"

id

string

SSH 公钥的 UUID。

返回: 成功

示例: "a6f7a5fc-43f8-11e5-a151-feff819cdc9f"

name

string

SSH 公钥的名称。

返回: 成功

示例: "[email protected]"

private_key

string

生成的 SSH 密钥对的私钥。

返回: 已更改

示例: "-----BEGIN RSA PRIVATE KEY----- MII...8tO -----END RSA PRIVATE KEY----- "

作者

  • René Moser (@resmo)