community / community.general / 0.1.1 / module / vr_startup_script Manages startup scripts on Vultr. Authors: René Moser (@resmo) preview | supported by communitycommunity.general.vr_startup_script (0.1.1) — module
Install with ansible-galaxy collection install community.general:==0.1.1
collections: - name: community.general version: 0.1.1
Create, update and remove startup scripts.
- name: ensure a pxe script exists, source from a file vultr_startup_script: name: my_web_script script_type: pxe script: "{{ lookup('file', 'path/to/script') }}"
- name: ensure a boot script exists vultr_startup_script: name: vultr_startup_script script: "#!/bin/bash\necho Hello World > /root/hello"
- name: ensure a script is absent vultr_startup_script: name: my_web_script state: absent
name: description: - The script name. required: true type: str state: choices: - present - absent default: present description: - State of the script. type: str script: description: - The script source code. - Required if I(state=present). type: str 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. type: str 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: str api_endpoint: description: Endpoint used for the API requests returned: success sample: https://api.vultr.com type: str api_retries: description: Amount of max retries for the API requests returned: success sample: 5 type: int api_retry_max_delay: description: Exponential backoff delay in seconds between retries up to this max delay value. returned: success sample: 12 type: int version_added: '2.9' version_added_collection: community.general 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: str date_modified: description: Date the startup script was modified. returned: success sample: '2017-08-26 12:47:48' type: str id: description: ID of the startup script. returned: success sample: 249395 type: str name: description: Name of the startup script. returned: success sample: my startup script type: str script: description: The source code of the startup script. returned: success sample: '#!/bin/bash echo Hello World > /root/hello' type: str script_type: description: The type of the startup script. returned: success sample: pxe type: str description: Response from Vultr API returned: success type: complex