vultr_region_facts – Сбор фактов о доступных регионах Vultr.
Новая в версии 2.7.
Описание
- Сбор фактов о регионах, доступных для запуска серверов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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_timeout - | Таймаут HTTP для Vultr API. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 60 секунд, если не указано. | |
| validate_certs boolean |
| Проверка SSL-сертификатов Vultr API. |
Примечания
Примечание
- Также см. документацию API на https://www.vultr.com/api/.
Примеры
- name: Gather Vultr regions facts
local_action:
module: vultr_region_facts
- name: Print the gathered facts
debug:
var: ansible_facts.vultr_region_facts
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| vultr_api complex | success | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account string | success | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint string | success | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries integer | success | Максимальное количество повторных попыток для запросов API Пример: 5 | |
| api_timeout integer | success | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_region_facts complex | success | Ответ от Vultr API | |
| vultr_region_facts - | | ||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/vultr_region_facts_module.html
