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 |
---|---|
Name of the ini section in the The ENV variable Default: |
|
URL to API endpint (without trailing slash). The ENV variable Fallback value is https://api.vultr.com if not specified. |
|
API key of the Vultr API. The ENV variable |
|
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. |
|
Retry backoff delay in seconds is exponential up to this max. value, in seconds. The ENV variable Fallback value is 12 seconds. |
|
HTTP timeout to Vultr API. The ENV variable Fallback value is 60 seconds if not specified. |
|
Validate SSL certs of the Vultr API. Choices:
|
Notes
Note
Also see the API documentation on https://www.vultr.com/api/.
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 |
---|---|
Response from Vultr API with a few additions/modification Returned: success |
|
Account used in the ini file to select the key Returned: success Sample: |
|
Endpoint used for the API requests Returned: success Sample: |
|
Amount of max retries for the API requests Returned: success Sample: |
|
Exponential backoff delay in seconds between retries up to this max delay value. Returned: success Sample: |
|
Timeout used for the API requests Returned: success Sample: |
|
Response from Vultr API as list Returned: success |
|
Date the ssh key was created Returned: success Sample: |
|
ID of the ssh key Returned: success Sample: |
|
Name of the ssh key Returned: success Sample: |
|
SSH public key Returned: success Sample: |