ngine_io.vultr.vultr_startup_script_info – Сбор информации о доступных скриптах запуска Vultr.
Примечание
Этот плагин входит в состав коллекции ngine_io.vultr (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в книге задач укажите: ngine_io.vultr.vultr_startup_script_info.
Новое в версии 0.1.0: плагина ngine_io.vultr
Обзор
- Сбор информации о доступных скриптах запуска vultr_startup_scripts.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 секунд, если не указано. | |
| validate_certs булево |
| Проверять сертификаты SSL Vultr API. |
Примечания
Примечание
- См. также документацию API на https://www.vultr.com/api/.
Примеры
- name: Gather Vultr startup scripts information
ngine_io.vultr.vultr_startup_script_info:
register: result
- name: Print the gathered information
debug:
var: result.vultr_startup_script_info
Значения возврата
Общие значения возврата описаны в документе, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложный | успех | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | успех | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | успех | Максимальное количество попыток повторного выполнения запросов API Пример: 5 | |
| api_retry_max_delay целое число | успех | Экспоненциальная задержка повторного выполнения в секундах между попытками до максимальной задержки. Пример: 12 | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_startup_script_info сложный | успех | Ответ от Vultr API | |
| date_created строка | успех | Дата создания скрипта запуска. Пример: 2017-08-26 12:47:48 | |
| date_modified строка | успех | Дата изменения скрипта запуска. Пример: 2017-08-26 12:47:48 | |
| id строка | успех | ID скрипта запуска. Пример: 249395 | |
| name строка | успех | Имя скрипта запуска. Пример: мой скрипт запуска | |
| script строка | успех | Исходный код скрипта запуска. Пример: #!/bin/bash echo Hello World > /root/hello | |
| type строка | успех | Тип скрипта запуска. Пример: pxe | |
Авторы
- Yanis Guenane (@Spredzy)
© 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_info_module.html
