vultr_region_info – Сбор информации о доступных регионах Vultr
Новое в версии 2.9.
Обзор
- Сбор информации о доступных регионах для запуска серверов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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 целое число добавлено в 2.9 | Задержка повторных попыток в секундах экспоненциально возрастает до этого максимального значения. Переменная окружения 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 regions information
local_action:
module: vultr_region_info
register: result
- name: Print the gathered information
debug:
var: result.vultr_region_info
Возвращаемые значения
Общие значения возврата описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложный тип | успех | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | успех | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | успех | Максимальное количество попыток повторного выполнения запросов к API Пример: 5 | |
| api_retry_max_delay целое число добавлено в 2.9 | успех | Экспоненциальная задержка повторных попыток в секундах между повторами до этого максимального значения задержки. Пример: 12 | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_region_info сложный тип | успех | Ответ от Vultr API Пример: {'vultr_region_info': [{'block_storage': False, 'continent': 'Европа', 'country': 'Великобритания', 'ddos_protection': True, 'id': 8, 'name': 'Лондон', 'regioncode': 'LHR', 'state': ''}]} | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Yanis Guenane (@Spredzy)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vultr_region_info_module.html
