ngine_io.vultr.vultr_ssh_key_info module – Get information about the Vultr SSH keys available.

Note

This module is part of the ngine_io.vultr collection (version 1.1.3).

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.vultr. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ngine_io.vultr.vultr_ssh_key_info.

New in ngine_io.vultr 0.1.0

Synopsis

  • Get infos about SSH keys available.

Requirements

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

  • python >= 2.6

Parameters

Parameter

Comments

api_account

string

Name of the ini section in the vultr.ini file.

The ENV variable VULTR_API_ACCOUNT is used as default, when defined.

Default: "default"

api_endpoint

string

URL to API endpint (without trailing slash).

The ENV variable VULTR_API_ENDPOINT is used as default, when defined.

Fallback value is https://api.vultr.com if not specified.

api_key

string

API key of the Vultr API.

The ENV variable VULTR_API_KEY is used as default, when defined.

api_retries

integer

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.

Fallback value is 5 retries if not specified.

api_retry_max_delay

integer

Retry backoff delay in seconds is exponential up to this max. value, in seconds.

The ENV variable VULTR_API_RETRY_MAX_DELAY is used as default, when defined.

Fallback value is 12 seconds.

api_timeout

integer

HTTP timeout to Vultr API.

The ENV variable VULTR_API_TIMEOUT is used as default, when defined.

Fallback value is 60 seconds if not specified.

validate_certs

boolean

Validate SSL certs of the Vultr API.

Choices:

  • false

  • true ← (default)

Notes

Note

Examples

- name: Get Vultr SSH keys infos
  ngine_io.vultr.vultr_ssh_key_info:
  register: result

- name: Print the infos
  debug:
    var: result.vultr_ssh_key_info

Return Values

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

Key

Description

vultr_api

complex

Response from Vultr API with a few additions/modification

Returned: success

api_account

string

Account used in the ini file to select the key

Returned: success

Sample: "default"

api_endpoint

string

Endpoint used for the API requests

Returned: success

Sample: "https://api.vultr.com"

api_retries

integer

Amount of max retries for the API requests

Returned: success

Sample: 5

api_retry_max_delay

integer

Exponential backoff delay in seconds between retries up to this max delay value.

Returned: success

Sample: 12

api_timeout

integer

Timeout used for the API requests

Returned: success

Sample: 60

vultr_ssh_key_info

complex

Response from Vultr API as list

Returned: success

date_created

string

Date the ssh key was created

Returned: success

Sample: "2017-08-26 12:47:48"

id

string

ID of the ssh key

Returned: success

Sample: "5904bc6ed9234"

name

string

Name of the ssh key

Returned: success

Sample: "my ssh key"

ssh_key

string

SSH public key

Returned: success

Sample: "ssh-rsa AA... someother@example.com"

Authors

  • Yanis Guenane (@Spredzy)

  • René Moser (@resmo)