ngine_io.vultr.vultr_startup_script_info – Gather information about the Vultr startup scripts available.
ngine_io.vultr.vultr_startup_script_info – Gather information about the Vultr startup scripts available.
Note
This plugin is part of the ngine_io.vultr collection (version 1.1.0).
To install it use: ansible-galaxy collection install ngine_io.vultr
.
To use it in a playbook, specify: ngine_io.vultr.vultr_startup_script_info
.
New in version 0.1.0: of ngine_io.vultr
Synopsis
- Gather information about vultr_startup_scripts 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 |
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 startup scripts information
ngine_io.vultr.vultr_startup_script_info:
register: result
- name: Print the gathered information
debug:
var: result.vultr_startup_script_info
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 |
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 | |
vultr_startup_script_info complex |
success |
Response from Vultr API
| |
date_created string |
success |
Date the startup script was created.
Sample: 2017-08-26 12:47:48 | |
date_modified string |
success |
Date the startup script was modified.
Sample: 2017-08-26 12:47:48 | |
id string |
success |
ID of the startup script.
Sample: 249395 | |
name string |
success |
Name of the startup script.
Sample: my startup script | |
script string |
success |
The source code of the startup script.
Sample:
| |
type string |
success |
The type of the startup script.
Sample: pxe |
Authors
- Yanis Guenane (@Spredzy)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/vultr/vultr_startup_script_info_module.html