W3cubDocs

/Ansible

cs_sshkeypair - Manages SSH keys on Apache CloudStack based clouds.

New in version 2.0.

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 (on host that executes module)

  • python >= 2.6
  • cs >= 0.6.10

Options

parameter required default choices comments
account
 no
Account the public key is related to.
api_http_method
 no get
  • get
  • post
HTTP method used.
api_key
 no
API key of the CloudStack API.
api_region
 no cloudstack
Name of the ini section in the cloustack.ini file.
api_secret
 no
Secret key of the CloudStack API.
api_timeout
 no 10
HTTP timeout.
api_url
 no
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
domain
 no
Domain the public key is related to.
name
 yes
Name of public key.
project
 no
Name of the project the public key to be registered in.
public_key
 no
String of the public key.
state
 no present
  • present
  • absent
State of the public key.

Examples

# create a new private / public key pair:
- cs_sshkeypair:
    name: [email protected]
  delegate_to: localhost
  register: key
- debug:
    msg: 'Private key is {{ key.private_key }}'

# remove a public key by its name:
- cs_sshkeypair:
    name: [email protected]
    state: absent
  delegate_to: localhost

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

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
private_key
Private key of generated SSH keypair.
 changed string -----BEGIN RSA PRIVATE KEY----- MII...8tO -----END RSA PRIVATE KEY-----
id
UUID of the SSH public key.
 success string a6f7a5fc-43f8-11e5-a151-feff819cdc9f
name
Name of the SSH public key.
 success string [email protected]
fingerprint
Fingerprint of the SSH public key.
 success string 86:5e:a3:e8:bd:95:7b:07:7c:c2:5c:f7:ad:8b:09:28

Notes

Note

  • Ansible uses the cs library’s configuration method if credentials are not provided by the arguments api_url, api_key, api_secret. Configuration is read from several locations, in the following order. - The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT environment variables. - A CLOUDSTACK_CONFIG environment variable pointing to an .ini file, - A cloudstack.ini file in the current working directory. - A .cloudstack.ini file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini. Use the argument api_region to select the section name, default section is cloudstack. See https://github.com/exoscale/cs for more information.
  • A detailed guide about cloudstack modules can be found on http://docs.ansible.com/ansible/guide_cloudstack.html
  • This module supports check mode.

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/cs_sshkeypair_module.html