Spec-Zone.ru › Ansible 2.11

ngine_io.vultr.vultr_startup_script – Управляет скриптами запуска на Vultr.

Примечание

Этот плагин является частью коллекции ngine_io.vultr (версия 1.1.0).

Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.

Чтобы использовать его в книге задач, укажите: ngine_io.vultr.vultr_startup_script.

Введено в версии 0.1.0: плагина ngine_io.vultr

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

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

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
api_account
строка
Значение по умолчанию:
"default"
Имя раздела ini в файле vultr.ini.
Переменная среды VULTR_API_ACCOUNT используется в качестве значения по умолчанию, если определена.
api_endpoint
строка
URL конечной точки API (без конечного слеша).
Переменная среды VULTR_API_ENDPOINT используется в качестве значения по умолчанию, если определена.
Значение по умолчанию — https://api.vultr.com, если не указано.
api_key
строка
Ключ API для Vultr API.
Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если определена.
api_retries
целое число
Количество попыток повторного выполнения, если Vultr API возвращает код HTTP 503.
Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если определена.
Значение по умолчанию — 5 попыток, если не указано.
api_retry_max_delay
целое число
Задержка повторного выполнения в секундах, экспоненциально увеличивающаяся до максимального значения.
Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если определена.
Значение по умолчанию — 12 секунд.
api_timeout
целое число
Таймаут HTTP для Vultr API.
Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если определена.
Значение по умолчанию — 60 секунд, если не указано.
name
строка / обязательно
Имя скрипта.
script
строка
Исходный код скрипта.
Требуется, если state=present.
script_type
строка
    Варианты:
  • boot ←
  • pxe
Тип скрипта, который нельзя изменить после создания.

псевдонимы: type
state
строка
    Варианты:
  • present ←
  • absent
Состояние скрипта.
validate_certs
булево
    Варианты:
  • no
  • yes ←
Проверка SSL-сертификатов Vultr API.

Примечания

Примечание

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

Примеры

- name: ensure a pxe script exists, source from a file
  ngine_io.vultr.vultr_startup_script:
    name: my_web_script
    script_type: pxe
    script: "{{ lookup('file', 'path/to/script') }}"

- name: ensure a boot script exists
  ngine_io.vultr.vultr_startup_script:
    name: vultr_startup_script
    script: "#!/bin/bash\necho Hello World > /root/hello"

- name: ensure a script is absent
  ngine_io.vultr.vultr_startup_script:
    name: my_web_script
    state: absent

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

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

Ключ Возвращаемое значение Описание
vultr_api
сложное
success
Ответ от Vultr API с некоторыми дополнениями/изменениями

api_account
строка
success
Аккаунт, используемый в файле ini для выбора ключа

Пример:
default
api_endpoint
строка
success
Конечная точка, используемая для запросов API

Пример:
https://api.vultr.com
api_retries
целое число
success
Максимальное количество попыток повторного выполнения запросов API

Пример:
5
api_retry_max_delay
целое число
success
Задержка экспоненциального уменьшения количества повторных попыток в секундах между повторными попытками до этого максимального значения задержки.

Пример:
12
api_timeout
целое число
success
Таймаут, используемый для запросов API

Пример:
60
vultr_startup_script
сложное
success
Ответ от Vultr API

date_created
строка
success
Дата создания скрипта запуска.

Пример:
2017-08-26 12:47:48
date_modified
строка
success
Дата изменения скрипта запуска.

Пример:
2017-08-26 12:47:48
id
строка
success
Идентификатор скрипта запуска.

Пример:
249395
name
строка
success
Имя скрипта запуска.

Пример:
мой скрипт запуска
script
строка
success
Исходный код скрипта запуска.

Пример:
#!/bin/bash echo Hello World > /root/hello
script_type
строка
success
Тип скрипта запуска.

Пример:
pxe


Авторы

  • René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/vultr/vultr_startup_script_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API