ngine_io.cloudstack.cs_sshkeypair – Manages SSH keys on Apache CloudStack based clouds.
Note
This plugin is part of the ngine_io.cloudstack collection (version 2.2.2).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ngine_io.cloudstack.
To use it in a playbook, specify: ngine_io.cloudstack.cs_sshkeypair.
New in version 0.1.0: of ngine_io.cloudstack
Synopsis
- Create, register and remove SSH keys.
- If no key was found and no public key was provided and a new SSH private/public key pair will be created and the private key will be returned.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- cs >= 0.9.0
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| account
string
|
Account the public key is related to.
|
|
| api_http_method
string
|
|
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
|
| api_key
string / required
|
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
|
|
| api_secret
string / required
|
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
|
|
| api_timeout
integer
|
Default:
10
|
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
|
| api_url
string / required
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
|
|
| api_verify_ssl_cert
string
|
Verify CA authority cert file.
If not given, the CLOUDSTACK_VERIFY env variable is considered.
|
|
| domain
string
|
Domain the public key is related to.
|
|
| name
string / required
|
Name of public key.
|
|
| project
string
|
Name of the project the public key to be registered in.
|
|
| public_key
string
|
String of the public key.
|
|
| state
string
|
|
State of the public key.
|
Notes
Note
- A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
- This module supports check mode.
Examples
- name: create a new private / public key pair
ngine_io.cloudstack.cs_sshkeypair:
name: linus@example.com
register: key
- debug:
msg: 'Private key is {{ key.private_key }}'
- name: remove a public key by its name
ngine_io.cloudstack.cs_sshkeypair:
name: linus@example.com
state: absent
- name: register your existing local public key
ngine_io.cloudstack.cs_sshkeypair:
name: linus@example.com
public_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| fingerprint
string
|
success |
Fingerprint of the SSH public key.
Sample:
86:5e:a3:e8:bd:95:7b:07:7c:c2:5c:f7:ad:8b:09:28
|
| id
string
|
success |
UUID of the SSH public key.
Sample:
a6f7a5fc-43f8-11e5-a151-feff819cdc9f
|
| name
string
|
success |
Name of the SSH public key.
Sample:
linus@example.com
|
| private_key
string
|
changed |
Private key of generated SSH keypair.
Sample:
-----BEGIN RSA PRIVATE KEY----- MII...8tO -----END RSA PRIVATE KEY-----
|
Authors
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_sshkeypair_module.html