ngine_io.vultr.vultr_os_info – Получение информации о доступных операционных системах Vultr.
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в книге задач укажите: ngine_io.vultr.vultr_os_info.
Введено в версии 0.1.0: плагина ngine_io.vultr
Обзор
- Получение информации о доступных операционных системах для загрузки серверов.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется данный модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_account строка | По умолчанию: "default" | Имя раздела в файле 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 целое число | Количество попыток при возврате кода HTTP 503 Vultr API. Переменная среды 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: Get Vultr OSes infos
ngine_io.vultr.vultr_os_info:
register: results
- name: Print the gathered infos
debug:
var: results.vultr_os_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_os_info сложный | доступно | Ответ от Vultr API в виде списка | |
| arch строка | успешно | Архитектура ОС Пример: x64 | |
| family строка | успешно | Семейство ОС Пример: openbsd | |
| name строка | успешно | Имя ОС Пример: OpenBSD 6 x64 | |
| windows булево | успешно | ОС – MS Windows | |
Авторы
- Yanis Guenane (@Spredzy)
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ngine_io/vultr/vultr_os_info_module.html
