vultr.cloud.startup_script module – Manages startup scripts on Vultr
Note
This module is part of the vultr.cloud collection (version 1.13.0).
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 vultr.cloud
.
To use it in a playbook, specify: vultr.cloud.startup_script
.
New in vultr.cloud 1.0.0
Synopsis
Create, update and remove startup scripts.
Parameters
Parameter |
Comments |
---|---|
URL to API endpint (without trailing slash). Fallback environment variable Default: |
|
API key of the Vultr API. Fallback environment variable |
|
Amount of retries in case of the Vultr API retuns an HTTP error code, such as - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Fallback environment variable Default: |
|
Retry backoff delay in seconds is exponential up to this max. value, in seconds. Fallback environment variable Default: |
|
HTTP timeout to Vultr API. Fallback environment variable Default: |
|
The script name. |
|
The script source code. Required if state=present. |
|
State of the script. Choices:
|
|
The script type, can not be changed once created. Choices:
|
|
Validate SSL certs of the Vultr API. Choices:
|
Notes
Note
Also see the API documentation on https://www.vultr.com/api/.
Examples
- name: ensure a pxe script exists, source from a file
vultr.cloud.startup_script:
name: my_web_script
script_type: pxe
script: "{{ lookup('file', 'path/to/script') }}"
- name: ensure a boot script exists
vultr.cloud.startup_script:
name: vultr_startup_script
script: "#!/bin/bash
echo Hello World > /root/hello"
- name: ensure a script is absent
vultr.cloud.startup_script:
name: my_web_script
state: absent
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 |
|
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. Returned: success |
|
Date the startup script was created. Returned: success Sample: |
|
Date the startup script was modified. Returned: success Sample: |
|
ID of the startup script. Returned: success Sample: |
|
Name of the startup script. Returned: success Sample: |
|
The source code of the startup script. Returned: success Sample: |
|
The type of the startup script. Returned: success Sample: |