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.

ngine_io.vultr.vultr_startup_script module – Manages startup scripts on Vultr.

Note

This module is part of the ngine_io.vultr collection (version 1.1.2).

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 ngine_io.vultr.

To use it in a playbook, specify: ngine_io.vultr.vultr_startup_script.

New in version 0.1.0: of ngine_io.vultr

Synopsis

• Create, update and remove startup scripts.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.6

Parameters

Parameter	Comments
api_account string	Name of the ini section in the vultr.ini file. The ENV variable VULTR_API_ACCOUNT is used as default, when defined. Default: “default”
api_endpoint string	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 string	API key of the Vultr API. The ENV variable VULTR_API_KEY is used as default, when defined.
api_retries integer	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_retry_max_delay integer	Retry backoff delay in seconds is exponential up to this max. value, in seconds. The ENV variable VULTR_API_RETRY_MAX_DELAY is used as default, when defined. Fallback value is 12 seconds.
api_timeout integer	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 string / required	The script name.
script string	The script source code. Required if state=present.
script_type aliases: type string	The script type, can not be changed once created. Choices: boot ← (default) pxe
state string	State of the script. Choices: present ← (default) absent
validate_certs boolean	Validate SSL certs of the Vultr API. Choices: no yes ← (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
  ngine_io.vultr.vultr_startup_script:
    name: my_web_script
    script_type: pxe
    script: "{{ lookup('file', 'path/to/script') }}"

- name: ensure a boot script exists
  ngine_io.vultr.vultr_startup_script:
    name: vultr_startup_script
    script: "#!/bin/bash\necho Hello World > /root/hello"

- name: ensure a script is absent
  ngine_io.vultr.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	Description
vultr_api complex	Response from Vultr API with a few additions/modification Returned: success
api_account string	Account used in the ini file to select the key Returned: success Sample: “default”
api_endpoint string	Endpoint used for the API requests Returned: success Sample: “https://api.vultr.com”
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 complex	Response from Vultr API Returned: success
date_created string	Date the startup script was created. Returned: success Sample: “2017-08-26 12:47:48”
date_modified string	Date the startup script was modified. Returned: success Sample: “2017-08-26 12:47:48”
id string	ID of the startup script. Returned: success Sample: 249395
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\necho Hello World \u003e /root/hello”
script_type string	The type of the startup script. Returned: success Sample: “pxe”

Authors

• René Moser (@resmo)

Collection links

Issue Tracker Repository (Sources)