You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

vultr.cloud.startup_script module – Manages startup scripts on Vultr

Note

This module is part of the vultr.cloud collection (version 1.3.1).

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
api_endpoint string	URL to API endpint (without trailing slash). Fallback environment variable VULTR_API_ENDPOINT. Default: "https://api.vultr.com/v2"
api_key string / required	API key of the Vultr API. Fallback environment variable VULTR_API_KEY.
api_retries integer	Amount of retries in case of the Vultr API retuns an HTTP 503 code. Fallback environment variable VULTR_API_RETRIES. Default: 5
api_retry_max_delay integer	Retry backoff delay in seconds is exponential up to this max. value, in seconds. Fallback environment variable VULTR_API_RETRY_MAX_DELAY. Default: 12
api_timeout integer	HTTP timeout to Vultr API. Fallback environment variable VULTR_API_TIMEOUT. Default: 60
name string / required	The script name.
script string	The script source code. Required if state=present.
state string	State of the script. Choices: "present" ← (default) "absent"
type aliases: script_type string	The script type, can not be changed once created. Choices: "boot" ← (default) "pxe"
validate_certs boolean	Validate SSL certs of the Vultr API. Choices: false true ← (default)

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
vultr_api dictionary	Response from Vultr API with a few additions/modification. Returned: success
api_endpoint string	Endpoint used for the API requests. Returned: success Sample: "https://api.vultr.com/v2"
api_retries integer	Amount of max retries for the API requests. Returned: success Sample: 5
api_retry_max_delay integer	Exponential backoff delay in seconds between retries up to this max delay value. Returned: success Sample: 12
api_timeout integer	Timeout used for the API requests. Returned: success Sample: 60
vultr_startup_script dictionary	Response from Vultr API. Returned: success
date_created string	Date the startup script was created. Returned: success Sample: "2020-10-10T01:56:20+00:00"
date_modified string	Date the startup script was modified. Returned: success Sample: "2020-10-10T01:56:20+00:00"
id string	ID of the startup script. Returned: success Sample: "7d726ffe-9be2-4f88-8cda-fa7eba1da2b5"
name string	Name of the startup script. Returned: success Sample: "my startup script"
script string	The source code of the startup script. Returned: success Sample: "#!/bin/bash echo Hello World > /root/hello"
type string	The type of the startup script. Returned: success Sample: "pxe"

Authors

• René Moser (@resmo)

Collection links

Issue Tracker Repository (Sources)