Documentation

vr_startup_script - Manages startup scripts on Vultr.

New in version 2.5.

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
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
Default:
https://api.vultr.com
URL to API endpint (without trailing slash).
The ENV variable VULTR_API_ENDPOINT is used as default, when defined.
api_key
API key of the Vultr API.
The ENV variable VULTR_API_KEY is used as default, when defined.
api_retries
Default:
5
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.
api_timeout
Default:
60
HTTP timeout to Vultr API.
The ENV variable VULTR_API_TIMEOUT is used as default, when defined.
name
required
The script name.
script
The script source code.
Required if (state=present).
script_type
    Choices:
  • boot ←
  • pxe
The script type, can not be changed once created.

aliases: type
state
    Choices:
  • present ←
  • absent
State of the script.
validate_certs
    Choices:
  • no
  • yes ←
Validate SSL certs of the Vultr API.

Notes

Note

Examples

- name: ensure a pxe script exists, source from a file
  local_action:
    module: vr_startup_script
    name: my_web_script
    script_type: pxe
    script: "{{ lookup('file', 'path/to/script') }}"

- name: ensure a boot script exists
  local_action:
    module: vr_startup_script
    name: vr_startup_script
    script: "#!/bin/bash\necho Hello World > /root/hello"

- name: ensure a script is absent
  local_action:
    module: vr_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_endpoint
string
success
Endpoint used for the API requests

Sample:
https://api.vultr.com
 
api_timeout
int
success
Timeout used for the API requests

Sample:
60
 
api_retries
int
success
Amount of max retries for the API requests

Sample:
5
 
api_account
string
success
Account used in the ini file to select the key

Sample:
default
vultr_startup_script
complex
success
Response from Vultr API
 
name
string
success
Name of the startup script.

Sample:
my startup script
 
date_modified
string
success
Date the startup script was modified.

Sample:
2017-08-26 12:47:48
 
date_created
string
success
Date the startup script was created.

Sample:
2017-08-26 12:47:48
 
script
string
success
The source code of the startup script.

Sample:
#!/bin/bash echo Hello World > /root/hello
 
id
string
success
ID of the startup script.

Sample:
249395
 
script_type
string
success
The type of the startup script.

Sample:
pxe


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • René Moser (@resmo)

Hint

If you notice any issues in this documentation you can edit this document to improve it.