Модуль vultr.cloud.instance_info — получение информации об экземплярах Vultr
Примечание
Этот модуль входит в коллекцию vultr.cloud (версия 1.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install vultr.cloud.
Чтобы использовать её в плейбуке, укажите: vultr.cloud.instance_info.
Добавлено в vultr.cloud 1.5.0
Краткое описание
- Получение информации о доступных экземплярах.
Параметры
Параметр | Комментарии |
|---|---|
api_endpoint string | URL конечной точки API (без завершающей косой черты). Резервная переменная окружения По умолчанию: |
api_key string / обязательный | Ключ API Vultr. Резервная переменная окружения |
api_results_per_page integer добавлено в vultr.cloud 1.14.0 | При получении большого количества ресурсов укажите, сколько результатов должно возвращаться за один вызов API. Этот параметр не определяет общее количество возвращаемых результатов: возвращаются все ресурсы, соответствующие другим фильтрам. Максимальное значение для API Vultr — 500. Резервная переменная окружения По умолчанию: |
api_retries integer | Количество повторных попыток в случае, если API Vultr возвращает код ошибки HTTP, например: 429 Too Many Requests, 500 Internal Server Error, 504 Gateway Time-out. Резервная переменная окружения По умолчанию: |
api_retry_max_delay integer | Экспоненциальная задержка перед повторной попыткой (в секундах) увеличивается до этого максимального значения. Резервная переменная окружения По умолчанию: |
api_timeout integer | Тайм-аут HTTP-запроса к API Vultr. Резервная переменная окружения По умолчанию: |
label псевдонимы: name string | Имя экземпляра. |
region string | Фильтрация экземпляров по региону. |
validate_certs boolean | Проверять SSL-сертификаты API Vultr. Варианты:
|
Примечания
Примечание
- См. также документацию API: https://www.vultr.com/api/.
Примеры
- name: Get Vultr instance infos of region ams
vultr.cloud.instance_info:
region: ams
- name: Get Vultr instance infos of a single host
vultr.cloud.instance_info:
label: myhost
- name: Get all Vultr instance infos
vultr.cloud.instance_info:
register: results
- name: Print the gathered infos
ansible.builtin.debug:
var: results.vultr_instance_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
vultr_api dictionary | Ответ API Vultr с несколькими дополнениями и изменениями. Возвращается: success |
|
api_endpoint string |
Конечная точка, использованная для запросов API. Возвращается: success Пример: |
|
api_results_per_page integer |
Количество результатов, возвращаемых за один вызов API. Возвращается: success Пример: |
|
api_retries integer |
Максимальное количество повторных попыток для запросов API. Возвращается: success Пример: |
|
api_retry_max_delay integer |
Максимальная задержка экспоненциального ожидания (в секундах) между повторными попытками. Возвращается: success Пример: |
|
api_timeout integer |
Тайм-аут, используемый для запросов API. Возвращается: success Пример: |
vultr_instance_info list / elements=string | Ответ API Vultr в виде списка. Возвращается: available |
|
allowed_bandwidth integer |
Допустимая пропускная способность экземпляра. Возвращается: success Пример: |
|
app_id integer |
ID приложения экземпляра. Возвращается: success Пример: |
|
date_created string |
Дата создания экземпляра. Возвращается: success Пример: |
|
disk integer |
Размер диска экземпляра. Возвращается: success Пример: |
|
features list / elements=string |
Возможности экземпляра. Возвращается: success Пример: |
|
firewall_group_id string |
ID группы брандмауэра экземпляра. Возвращается: success Пример: |
|
gateway_v4 string |
Шлюз IPv4. Возвращается: success Пример: |
|
hostname string |
Имя узла экземпляра. Возвращается: success Пример: |
|
id string |
ID экземпляра. Возвращается: success Пример: |
|
image_id string |
ID образа экземпляра. Возвращается: success Пример: |
|
internal_ip string |
Внутренний IP-адрес экземпляра. Возвращается: success Пример: |
|
kvm string |
KVM экземпляра. Возвращается: success Пример: |
|
label string |
Метка экземпляра. Возвращается: success Пример: |
|
main_ip string |
IPv4-адрес экземпляра. Возвращается: success Пример: |
|
netmask_v4 string |
Маска подсети IPv4 экземпляра. Возвращается: success Пример: |
|
os string |
ОС экземпляра. Возвращается: success Пример: |
|
os_id integer |
ID ОС экземпляра. Возвращается: success Пример: |
|
plan string |
Тарифный план экземпляра. Возвращается: success Пример: |
|
power_status string |
Состояние питания экземпляра. Возвращается: success Пример: |
|
ram integer |
Объём оперативной памяти экземпляра в МБ. Возвращается: success Пример: |
|
region string |
Регион, в котором был развёрнут экземпляр. Возвращается: success Пример: |
|
server_status string |
Состояние сервера экземпляра. Возвращается: success Пример: |
|
status string |
Состояние развёртывания экземпляра. Возвращается: success Пример: |
|
tags list / elements=string |
Теги экземпляра. Возвращается: success Пример: |
|
user_data string |
Данные пользователя экземпляра (cloud-init), закодированные в Base64. Возвращается: success Пример: |
|
v6_main_ip string |
IPv6-адрес экземпляра. Возвращается: success Пример: |
|
v6_network string |
Сеть IPv6 экземпляра. Возвращается: success Пример: |
|
v6_network_size integer |
Размер сети IPv6 экземпляра. Возвращается: success Пример: |
|
vcpu_count integer |
Количество виртуальных ЦП экземпляра. Возвращается: success Пример: |
Ссылки на коллекцию
© 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/instance_info_module.html
