Модуль vultr.cloud.startup_script — управление сценариями запуска на Vultr

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install vultr.cloud.

Чтобы использовать ее в плейбуке, укажите: vultr.cloud.startup_script.

Добавлено в vultr.cloud 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создание, обновление и удаление сценариев запуска.

Параметры

Параметр	Комментарии
api_endpoint строка	URL конечной точки API (без завершающей косой черты). Резервная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательный	Ключ API Vultr. Резервная переменная окружения `VULTR_API_KEY`.
api_results_per_page целое число добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов должно возвращаться за один вызов API. Это не определяет количество возвращаемых результатов: все ресурсы возвращаются с учетом остальных фильтров. Максимальное значение для API Vultr — 500. Резервная переменная окружения `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries целое число	Количество повторных попыток в случае, если API Vultr возвращает код ошибки HTTP, например: 429 Too Many Requests, 500 Internal Server Error или 504 Gateway Time-out. Резервная переменная окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Задержка между повторными попытками увеличивается экспоненциально до этого максимального значения в секундах. Резервная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Тайм-аут HTTP-запроса к API Vultr. Резервная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
name строка / обязательный	Имя сценария.
script строка	Исходный код сценария. Обязателен, если state=present.
state строка	Состояние сценария. Варианты: `"present"` ← (по умолчанию) `"absent"`
type псевдонимы: script_type строка	Тип сценария. После создания изменить его нельзя. Варианты: `"boot"` ← (по умолчанию) `"pxe"`
validate_certs логическое значение	Проверять SSL-сертификаты API Vultr. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

См. также документацию API: https://www.vultr.com/api/.

Примеры

- 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
vultr_api словарь	Ответ API Vultr с несколькими дополнениями/изменениями. Возвращается: при успешном выполнении
api_endpoint строка	Конечная точка, использованная для запросов API. Возвращается: при успешном выполнении Пример: `"https://api.vultr.com/v2"`
api_results_per_page целое число	Количество результатов, возвращаемых за один вызов API. Возвращается: при успешном выполнении Пример: `100`
api_retries целое число	Максимальное количество повторных попыток запросов API. Возвращается: при успешном выполнении Пример: `5`
api_retry_max_delay целое число	Максимальная экспоненциально увеличивающаяся задержка в секундах между повторными попытками. Возвращается: при успешном выполнении Пример: `12`
api_timeout целое число	Тайм-аут, используемый для запросов API. Возвращается: при успешном выполнении Пример: `60`
vultr_startup_script словарь	Ответ API Vultr. Возвращается: при успешном выполнении
date_created строка	Дата создания сценария запуска. Возвращается: при успешном выполнении Пример: `"2020-10-10T01:56:20+00:00"`
date_modified строка	Дата изменения сценария запуска. Возвращается: при успешном выполнении Пример: `"2020-10-10T01:56:20+00:00"`
id строка	Идентификатор сценария запуска. Возвращается: при успешном выполнении Пример: `"7d726ffe-9be2-4f88-8cda-fa7eba1da2b5"`
name строка	Имя сценария запуска. Возвращается: при успешном выполнении Пример: `"my startup script"`
script строка	Исходный код сценария запуска. Возвращается: при успешном выполнении Пример: `"#!/bin/bash echo Hello World > /root/hello"`
type строка	Тип сценария запуска. Возвращается: при успешном выполнении Пример: `"pxe"`

Авторы

René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/vultr/cloud/startup_script_module.html