ngine_io.vultr.vultr_os_info – Получение информации о доступных ОС Vultr.
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.1.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" | Имя раздела 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: 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–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_os_info_module.html
