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

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.13.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 строка	URL конечной точки API (без конечной косой черты). Значение по умолчанию из переменной окружения `VULTR_API_ENDPOINT`. Значение по умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательно	Ключ API для Vultr API. Значение по умолчанию из переменной окружения `VULTR_API_KEY`.
api_retries целое число	Количество попыток в случае, если Vultr API возвращает код HTTP-ошибки, например - 429 Слишком много запросов - 500 Внутренняя ошибка сервера - 504 Истекло время ожидания шлюза Значение по умолчанию из переменной окружения `VULTR_API_RETRIES`. Значение по умолчанию: `5`
api_retry_max_delay целое число	Задержка отката при повторных попытках в секундах, экспоненциально возрастающая до максимального значения. Значение по умолчанию из переменной окружения `VULTR_API_RETRY_MAX_DELAY`. Значение по умолчанию: `12`
api_timeout целое число	Время ожидания HTTP-запроса к Vultr API. Значение по умолчанию из переменной окружения `VULTR_API_TIMEOUT`. Значение по умолчанию: `180`
validate_certs логическое	Проверять 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 словарь	Ответ от Vultr API с несколькими добавленными/измененными элементами. Возвращается: успех
api_endpoint строка	Конечная точка, используемая для запросов API. Возвращается: успех Пример: `"https://api.vultr.com/v2"`
api_retries целое число	Максимальное количество повторов запросов API. Возвращается: успех Пример: `5`
api_retry_max_delay целое число	Экспоненциальная задержка повтора запросов в секундах до максимальной задержки. Возвращается: успех Пример: `12`
api_timeout целое число	Время ожидания, используемое для запросов API. Возвращается: успех Пример: `60`
vultr_region_info список / элементы=строка	Ответ от Vultr API. Возвращается: успех Пример: `[{"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vultr/cloud/region_info_module.html