vultr_startup_script – Manages startup scripts on Vultr.
New in version 2.5.
Synopsis
- Create, update and remove startup scripts.
Aliases: vr_startup_script
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. | |
| name - / required | The script name. | |
| script - | The script source code. Required if (state=present). | |
| script_type - |
| The script type, can not be changed once created. aliases: type |
| state - |
| State of the script. |
| validate_certs boolean |
| Validate SSL certs of the Vultr API. |
Notes
Note
- Also see the API documentation on https://www.vultr.com/api/.
Examples
- name: ensure a pxe script exists, source from a file
local_action:
module: vultr_startup_script
name: my_web_script
script_type: pxe
script: "{{ lookup('file', 'path/to/script') }}"
- name: ensure a boot script exists
local_action:
module: vultr_startup_script
name: vultr_startup_script
script: "#!/bin/bash\necho Hello World > /root/hello"
- name: ensure a script is absent
local_action:
module: vultr_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 | 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 | |
| vultr_startup_script 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: #!/bin/bash echo Hello World > /root/hello | |
| script_type string | success | The type of the startup script. Sample: pxe | |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- René Moser (@resmo)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vultr_startup_script_module.html