ngine_io.vultr.vultr_region_info – Сбор информации о доступных регионах Vultr.
Примечание
Этот плагин входит в состав коллекции ngine_io.vultr (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в плейбуке укажите: ngine_io.vultr.vultr_region_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 для API Vultr. Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если она определена. | |
| api_retries целое число | Количество попыток повторного подключения в случае, если API Vultr возвращает код HTTP 503. Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 5 попыток, если не указано иначе. | |
| api_retry_max_delay целое число | Задержка повторных попыток в секундах экспоненциально увеличивается до этого максимального значения. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 12 секунд. | |
| api_timeout целое число | Таймаут HTTP для API Vultr. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 60 секунд, если не указано иначе. | |
| validate_certs булево |
| Проверять SSL-сертификаты API Vultr. |
Примечания
Примечание
- Также обратитесь к документации API на https://www.vultr.com/api/.
Примеры
- name: Gather Vultr regions information
ngine_io.vultr.vultr_region_info:
register: result
- name: Print the gathered information
debug:
var: result.vultr_region_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложное | успех | Ответ от API Vultr с некоторыми дополнениями/модификациями | |
| 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_region_info список / элементы=строка | успех | Ответ от API Vultr Пример: [{'block_storage': False, 'continent': 'Европа', 'country': 'GB', 'ddos_protection': True, 'id': 8, 'name': 'Лондон', 'regioncode': 'LHR', 'state': ''}] | |
Авторы
- 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_region_info_module.html
