vultr_ssh_key – Manages ssh keys on Vultr
vultr_ssh_key – Manages ssh keys on Vultr
New in version 2.5.
Synopsis
- Create, update and remove ssh keys.
Aliases: vr_ssh_key
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api_account string |
Default: "default" |
Name of the ini section in the The ENV variable |
api_endpoint string |
URL to API endpint (without trailing slash). The ENV variable Fallback value is https://api.vultr.com if not specified. | |
api_key string |
API key of the Vultr API. The ENV variable | |
api_retries integer |
Amount of retries in case of the Vultr API retuns an HTTP 503 code. The ENV variable Fallback value is 5 retries if not specified. | |
api_timeout integer |
HTTP timeout to Vultr API. The ENV variable Fallback value is 60 seconds if not specified. | |
name - / required |
Name of the ssh key. | |
ssh_key - |
SSH public key. Required if | |
state - |
|
State of the ssh key. |
validate_certs boolean |
|
Validate SSL certs of the Vultr API. |
Notes
Examples
- name: ensure an SSH key is present
local_action:
module: vultr_ssh_key
name: my ssh key
ssh_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
- name: ensure an SSH key is absent
local_action:
module: vultr_ssh_key
name: my ssh key
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
vultr_api complex |
success |
Response from Vultr API with a few additions/modification
| |
api_account string |
success |
Account used in the ini file to select the key
Sample: default | |
api_endpoint string |
success |
Endpoint used for the API requests
Sample: | |
api_retries integer |
success |
Amount of max retries for the API requests
Sample: 5 | |
api_timeout integer |
success |
Timeout used for the API requests
Sample: 60 | |
vultr_ssh_key complex |
success |
Response from Vultr API
| |
date_created string |
success |
Date the ssh key was created
Sample: 2017-08-26 12:47:48 | |
id string |
success |
ID of the ssh key
Sample: 5904bc6ed9234 | |
name string |
success |
Name of the ssh key
Sample: my ssh key | |
ssh_key string |
success |
SSH public key
Sample: ssh-rsa AA... [email protected] |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/vultr_ssh_key_module.html