Модуль vultr.cloud.region_info — сбор информации о регионах Vultr

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install vultr.cloud.

Чтобы использовать коллекцию в плейбуке, укажите: vultr.cloud.region_info.

Добавлено в vultr.cloud 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Сбор информации о регионах, доступных для загрузки серверов.

Параметры

Параметр	Комментарии
api_endpoint string	URL конечной точки API (без завершающей косой черты). Резервная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key string / обязательный	Ключ API для Vultr API. Резервная переменная окружения `VULTR_API_KEY`.
api_results_per_page integer добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов должно возвращаться в каждом запросе к API. Это значение не определяет общее количество возвращаемых результатов: возвращаются все ресурсы, соответствующие другим фильтрам. Максимальное значение для Vultr API — 500. Резервная переменная окружения `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries integer	Количество повторных попыток в случае, если Vultr API возвращает код ошибки HTTP, например: - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Резервная переменная окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay integer	Задержка между повторными попытками увеличивается экспоненциально и не превышает указанное максимальное значение в секундах. Резервная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout integer	Тайм-аут HTTP-запроса к Vultr API. Резервная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
validate_certs boolean	Проверять SSL-сертификаты Vultr API. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

См. также документацию API: https://www.vultr.com/api/.

Примеры

- name: Gather Vultr regions information
  vultr.cloud.region_info:
  register: result

- name: Print the gathered information
  ansible.builtin.debug:
    var: result.vultr_region_info

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
vultr_api dictionary	Ответ Vultr API с некоторыми дополнениями и изменениями. Возвращается: success
api_endpoint string	Конечная точка, используемая для запросов к API. Возвращается: success Пример: `"https://api.vultr.com/v2"`
api_results_per_page integer	Количество результатов, возвращаемых в каждом запросе к API. Возвращается: success Пример: `100`
api_retries integer	Максимальное количество повторных попыток для запросов к API. Возвращается: success Пример: `5`
api_retry_max_delay integer	Максимальная задержка в секундах между повторными попытками при экспоненциальном увеличении интервала. Возвращается: success Пример: `12`
api_timeout integer	Тайм-аут, используемый для запросов к API. Возвращается: success Пример: `60`
vultr_region_info list / elements=string	Ответ Vultr API. Возвращается: success Пример: `[{"block_storage": false, "continent": "Europe", "country": "GB", "ddos_protection": true, "id": 8, "name": "London", "regioncode": "LHR", "state": ""}]`

Авторы

Yanis Guenane (@Spredzy)
René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/vultr/cloud/region_info_module.html