Модуль vultr.cloud.instance_info – Получение информации о виртуальных машинах Vultr

Примечание

Этот модуль является частью коллекции vultr.cloud (версия 1.13.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 строка	URL конечной точки API (без конечной косой черты). Значение по умолчанию из переменной окружения `VULTR_API_ENDPOINT`. Значение по умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательный	Ключ API для доступа к API Vultr. Значение по умолчанию из переменной окружения `VULTR_API_KEY`.
api_retries целое число	Количество попыток в случае, если API Vultr возвращает HTTP-код ошибки, например, 429 (слишком много запросов), 500 (внутренняя ошибка сервера) или 504 (timeout). Значение по умолчанию из переменной окружения `VULTR_API_RETRIES`. Значение по умолчанию: `5`
api_retry_max_delay целое число	Максимальная задержка повторной попытки в секундах, экспоненциально увеличивающаяся до этого значения. Значение по умолчанию из переменной окружения `VULTR_API_RETRY_MAX_DELAY`. Значение по умолчанию: `12`
api_timeout целое число	Таймаут HTTP-запроса к API Vultr. Значение по умолчанию из переменной окружения `VULTR_API_TIMEOUT`. Значение по умолчанию: `180`
label aliases: name строка	Имя виртуальной машины.
region строка	Фильтр виртуальных машин по региону.
validate_certs булево	Проверка SSL-сертификатов API Vultr. Возможные значения: `false` `true` ← (значение по умолчанию)

Примечания

Примечание

См. также документацию 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

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

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

END_OF_DOCUMENT_MARKER

Ключ	Описание
vultr_api dictionary	Ответ от Vultr API с некоторыми дополнениями/изменениями. Возвращено: success
api_endpoint string	Конечная точка, используемая для запросов API. Возвращено: success Пример: `"https://api.vultr.com/v2"`
api_retries integer	Максимальное количество попыток для запросов API. Возвращено: success Пример: `5`
api_retry_max_delay integer	Задержка экспоненциального отката в секундах между повторными попытками до этого максимального значения задержки. Возвращено: success Пример: `12`
api_timeout integer	Тайм-аут, используемый для запросов API. Возвращено: success Пример: `60`
vultr_instance_info list / elements=string	Ответ от Vultr API в виде списка. Возвращено: available
allowed_bandwidth integer	Допустимая пропускная способность экземпляра. Возвращено: success Пример: `1000`
app_id integer	ID приложения экземпляра. Возвращено: success Пример: `37`
date_created string	Дата создания экземпляра. Возвращено: success Пример: `"2020-10-10T01:56:20+00:00"`
disk integer	Размер диска экземпляра. Возвращено: success Пример: `25`
features list / elements=string	Функции экземпляра. Возвращено: success Пример: `["ddos_protection", "ipv6", "auto_backups"]`
firewall_group_id string	ID группы брандмауэра экземпляра. Возвращено: success Пример: `""`
gateway_v4 string	Шлюз IPv4. Возвращено: success Пример: `"95.179.188.1"`
hostname string	Имя хоста экземпляра. Возвращено: success Пример: `"vultr.guest"`
id string	ID экземпляра. Возвращено: success Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
image_id string	ID образа экземпляра. Возвращено: success Пример: `""`
internal_ip string	Внутренний IP-адрес экземпляра. Возвращено: success Пример: `""`
kvm string	KVM экземпляра. Возвращено: success Пример: `"https://my.vultr.com/subs/vps/novnc/api.php?data=..."`

label string	Метка экземпляра. Returned: success Sample: `"my instance"`
main_ip string	IPv4 экземпляра. Returned: success Sample: `"95.179.189.95"`
netmask_v4 string	Netmask IPv4 экземпляра. Returned: success Sample: `"255.255.254.0"`
os string	ОС экземпляра. Returned: success Sample: `"Application"`
os_id integer	ID ОС экземпляра. Returned: success Sample: `186`
plan string	План экземпляра. Returned: success Sample: `"vc2-1c-1gb"`
power_status string	Состояние питания экземпляра. Returned: success Sample: `"running"`
ram integer	RAM в МБ экземпляра. Returned: success Sample: `1024`
region string	Регион, в котором был развернут экземпляр. Returned: success Sample: `"ews"`
server_status string	Состояние сервера экземпляра. Returned: success Sample: `"installingbooting"`
status string	Статус развертывания экземпляра. Returned: success Sample: `"active"`
tags list / elements=string	Теги экземпляра. Returned: success Sample: `["my-tag"]`
user_data string	Закодированные в Base64 пользовательские данные (cloud init) экземпляра. Returned: success Sample: `"I2Nsb3VkLWNvbmZpZwpwYWNrYWdlczoKICAtIGh0b3AK"`
v6_main_ip string	IPv6 экземпляра. Returned: success Sample: `""`
v6_network string	IPv6 сеть экземпляра. Returned: success Sample: `""`
v6_network_size integer	Размер IPv6 сети экземпляра. Returned: success Sample: `0`
vcpu_count integer	vCPUs экземпляра. Returned: success Sample: `1`

Авторы

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/instance_info_module.html