Documentation

vr_ssh_key - Manages ssh keys on Vultr.

New in version 2.5.

Synopsis

  • Create, update and remove ssh keys.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

Parameters

Parameter
Choices/Defaults
Comments
api_account
Default:
default
Name of the ini section in the vultr.ini file.
The ENV variable VULTR_API_ACCOUNT is used as default, when defined.
api_endpoint
Default:
https://api.vultr.com
URL to API endpint (without trailing slash).
The ENV variable VULTR_API_ENDPOINT is used as default, when defined.
api_key
API key of the Vultr API.
The ENV variable VULTR_API_KEY is used as default, when defined.
api_retries
Default:
5
Amount of retries in case of the Vultr API retuns an HTTP 503 code.
The ENV variable VULTR_API_RETRIES is used as default, when defined.
api_timeout
Default:
60
HTTP timeout to Vultr API.
The ENV variable VULTR_API_TIMEOUT is used as default, when defined.
name
required
Name of the ssh key.
ssh_key
SSH public key.
Required if state=present.
state
    Choices:
  • present ←
  • absent
State of the ssh key.
validate_certs
    Choices:
  • no
  • yes ←
Validate SSL certs of the Vultr API.

Notes

Note

Examples

- name: ensure an SSH key is present
  local_action:
    module: vr_ssh_key
    name: my ssh key
    ssh_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"

- name: ensure an SSH key is absent
  local_action:
    module: vr_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_endpoint
string
success
Endpoint used for the API requests

Sample:
https://api.vultr.com
 
api_timeout
int
success
Timeout used for the API requests

Sample:
60
 
api_retries
int
success
Amount of max retries for the API requests

Sample:
5
 
api_account
string
success
Account used in the ini file to select the key

Sample:
default
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... someother@example.com


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • René Moser (@resmo)

Hint

If you notice any issues in this documentation you can edit this document to improve it.