vultr_ssh_key_facts – Gather facts about the Vultr SSH keys available
vultr_ssh_key_facts – Gather facts about the Vultr SSH keys available
New in version 2.7.
DEPRECATED
Removed in Ansible: | |
---|---|
version: 2.12 | |
Why: | Transformed into an info module. |
Alternative: | Use vultr_ssh_key_info instead. |
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 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_retry_max_delay integer added in 2.9 |
Retry backoff delay in seconds is exponential up to this max. value, in seconds. The ENV variable Fallback value is 12 seconds. | |
api_timeout integer |
HTTP timeout to Vultr API. The ENV variable Fallback value is 60 seconds if not specified. | |
validate_certs boolean |
|
Validate SSL certs of the Vultr API. |
Notes
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
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_retry_max_delay integer added in 2.9 |
success |
Exponential backoff delay in seconds between retries up to this max delay value.
Sample: 12 | |
api_timeout integer |
success |
Timeout used for the API requests
Sample: 60 |
Status
- This module will be removed in version 2.12. [deprecated]
- For more information see DEPRECATED.
Authors
- Yanis Guenane (@Spredzy)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vultr_ssh_key_facts_module.html