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

Примечание

Этот модуль является частью коллекции vultr.cloud (версия 1.13.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 API. Дополнительная переменная окружения `VULTR_API_KEY`.
api_retries целое число	Количество попыток повторного выполнения в случае, если Vultr API возвращает код HTTP-ошибки, например - 429 Слишком много запросов - 500 Внутренняя ошибка сервера - 504 Таймаут шлюза Дополнительная переменная окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Задержка повторного выполнения в секундах, экспоненциально возрастающая до этого максимального значения. Дополнительная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Таймаут HTTP для Vultr API. Дополнительная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
name строка / обязательно	Имя скрипта.
script строка	Исходный код скрипта. Требуется, если state=present.
state строка	Состояние скрипта. Варианты: `"present"` ← (по умолчанию) `"absent"`
type псевдонимы: script_type строка	Тип скрипта, который нельзя изменить после создания. Варианты: `"boot"` ← (по умолчанию) `"pxe"`
validate_certs логический	Проверка SSL-сертификатов Vultr API. Варианты: `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

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
vultr_api словарь	Ответ от API Vultr с некоторыми дополнениями/изменениями. Возвращено: успешно
api_endpoint строка	Используемый конечный пункт API-запросов. Возвращено: успешно Пример: `"https://api.vultr.com/v2"`
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 строка	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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vultr/cloud/startup_script_module.html