vultr_ssh_key_facts – Gather facts about the Vultr SSH keys available.¶

New in version 2.7.

Synopsis
Requirements
Parameters
Notes
Examples
Returned Facts
Return Values
Status

Synopsis ¶

Gather facts about SSH keys available.

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 -		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 -		API key of the Vultr API. The ENV variable `VULTR_API_KEY` is used as default, when defined.
api_retries -		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_timeout -		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	Choices: no yes ←	Validate SSL certs of the Vultr API.

Notes ¶

Note

Also see the API documentation on https://www.vultr.com/api/.

Examples ¶

- name: Gather Vultr SSH keys facts
  local_action:
    module: vultr_ssh_key_facts

- name: Print the gathered facts
  debug:
    var: ansible_facts.vultr_ssh_key_facts

Returned Facts ¶

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Fact	Returned	Description
vultr_ssh_key_facts -

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: https://api.vultr.com
	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

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Yanis Guenane (@Spredzy)

Hint

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