ansible / ansible.builtin / v2.5.11 / module / vr_startup_script Manages startup scripts on Vultr. | "added in version" 2.5 of ansible.builtin" Authors: René Moser (@resmo) preview | supported by communityansible.builtin.vr_startup_script (v2.5.11) — module
pip
Install with pip install ansible==2.5.11
Create, update and remove startup scripts.
- 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
name: description: - The script name. required: true state: choices: - present - absent default: present description: - State of the script. script: description: - The script source code. - Required if (state=present). api_key: description: - API key of the Vultr API. - The ENV variable C(VULTR_API_KEY) is used as default, when defined. type: str api_account: default: default description: - Name of the ini section in the C(vultr.ini) file. - The ENV variable C(VULTR_API_ACCOUNT) is used as default, when defined. type: str api_retries: description: - Amount of retries in case of the Vultr API retuns an HTTP 503 code. - The ENV variable C(VULTR_API_RETRIES) is used as default, when defined. - Fallback value is 5 retries if not specified. type: int api_timeout: description: - HTTP timeout to Vultr API. - The ENV variable C(VULTR_API_TIMEOUT) is used as default, when defined. - Fallback value is 60 seconds if not specified. type: int script_type: aliases: - type choices: - boot - pxe default: boot description: - The script type, can not be changed once created. api_endpoint: description: - URL to API endpint (without trailing slash). - The ENV variable C(VULTR_API_ENDPOINT) is used as default, when defined. - Fallback value is U(https://api.vultr.com) if not specified. type: str validate_certs: default: true description: - Validate SSL certs of the Vultr API. type: bool api_retry_max_delay: description: - Retry backoff delay in seconds is exponential up to this max. value, in seconds. - The ENV variable C(VULTR_API_RETRY_MAX_DELAY) is used as default, when defined. - Fallback value is 12 seconds. type: int
vultr_api: contains: api_account: description: Account used in the ini file to select the key returned: success sample: default type: string api_endpoint: description: Endpoint used for the API requests returned: success sample: https://api.vultr.com type: string api_retries: description: Amount of max retries for the API requests returned: success sample: 5 type: int api_timeout: description: Timeout used for the API requests returned: success sample: 60 type: int description: Response from Vultr API with a few additions/modification returned: success type: complex vultr_startup_script: contains: date_created: description: Date the startup script was created. returned: success sample: '2017-08-26 12:47:48' type: string date_modified: description: Date the startup script was modified. returned: success sample: '2017-08-26 12:47:48' type: string id: description: ID of the startup script. returned: success sample: 249395 type: string name: description: Name of the startup script. returned: success sample: my startup script type: string script: description: The source code of the startup script. returned: success sample: '#!/bin/bash echo Hello World > /root/hello' type: string script_type: description: The type of the startup script. returned: success sample: pxe type: string description: Response from Vultr API returned: success type: complex