New in version 2.0.
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.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| account | no | Account the public key is related to. |
||
| api_http_method | no | get |
| 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 |
| State of the public key. |
# create a new private / public key pair:
- local_action: cs_sshkeypair [email protected]
register: key
- debug: msg='private key is {{ key.private_key }}'
# remove a public key by its name:
- local_action: cs_sshkeypair [email protected] state=absent
# register your existing local public key:
- local_action: cs_sshkeypair [email protected] public_key='{{ lookup('file', '~/.ssh/id_rsa.pub') }}'
Common return values are documented here Common 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----- MIICXQIBAAKBgQCkeFYjI+4k8bWfIRMzp4pCzhlopNydbbwRu824P5ilD4ATWMUG vEtuCQ2Mp5k5Bma30CdYHgh2/SbxC5RxXSUKTUJtTKpoJUy8PAhb1nn9dnfkC2oU aRVi9NRUgypTIZxMpgooHOxvAzWxbZCyh1W+91Ld3FNaGxTLqTgeevY84wIDAQAB AoGAcwQwgLyUwsNB1vmjWwE0QEmvHS4FlhZyahhi4hGfZvbzAxSWHIK7YUT1c8KU 9XsThEIN8aJ3GvcoL3OAqNKRnoNb14neejVHkYRadhxqc0GVN6AUIyCqoEMpvhFI QrinM572ORzv5ffRjCTbvZcYlW+sqFKNo5e8pYIB8TigpFECQQDu7bg9vkvg8xPs kP1K+EH0vsR6vUfy+m3euXjnbJtiP7RoTkZk0JQMOmexgy1qQhISWT0e451wd62v J7M0trl5AkEAsDivJnMIlCCCypwPN4tdNUYpe9dtidR1zLmb3SA7wXk5xMUgLZI9 cWPjBCMt0KKShdDhQ+hjXAyKQLF7iAPuOwJABjdHCMwvmy2XwhrPjCjDRoPEBtFv 0sFzJE08+QBZVogDwIbwy+SlRWArnHGmN9J6N+H8dhZD3U4vxZPJ1MBAOQJBAJxO Cv1dt1Q76gbwmYa49LnWO+F+2cgRTVODpr5iYt5fOmBQQRRqzFkRMkFvOqn+KVzM Q6LKM6dn8BEl295vLhUCQQCVDWzoSk3GjL3sOjfAUTyAj8VAXM69llaptxWWySPM E9pA+8rYmHfohYFx7FD5/KWCO+sfmxTNB48X0uwyE8tO -----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 |
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.
Note
A detailed guide about cloudstack modules can be found on http://docs.ansible.com/ansible/guide_cloudstack.html
Note
This module supports check mode.
For more information on what this means please read Extras Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/cs_sshkeypair_module.html