Модуль vultr.cloud.snapshot_info – Сбор информации о снимках Vultr

Примечание

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

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

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

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

Новое в vultr.cloud 1.7.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 snapshots information
  vultr.cloud.snapshot_info:
  register: result

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

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
vultr_api словарь	Ответ от API Vultr с некоторыми дополнениями/изменениями. Возвращаемое значение: успешно
api_endpoint строка	Точка входа, используемая для запросов API. Возвращаемое значение: успешно Пример: `"https://api.vultr.com/v2"`
api_retries целое число	Максимальное количество повторных попыток для запросов API. Возвращаемое значение: успешно Пример: `5`
api_retry_max_delay целое число	Задержка экспоненциального возврата в секундах между повторными попытками до этой максимальной задержки. Возвращаемое значение: успешно Пример: `12`
api_timeout целое число	Таймаут, используемый для запросов API. Возвращаемое значение: успешно Пример: `60`
vultr_snapshot_info список / элементы=строка	Ответ от API Vultr в виде списка. Возвращаемое значение: успешно
app_id целое число	ID приложения. Возвращаемое значение: успешно Пример: `0`
compressed_size целое число	Сжатый размер снимка. Возвращаемое значение: успешно Пример: `949678560`
date_created строка	Дата создания снимка. Возвращаемое значение: успешно Пример: `"2020-10-10T01:56:20+00:00"`
description строка	Описание снимка. Возвращаемое значение: успешно Пример: `"my vpc"`
id строка	ID снимка. Возвращаемое значение: успешно Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
os_id целое число	ID операционной системы. Возвращаемое значение: успешно Пример: `215`
size целое число	Размер снимка. Возвращаемое значение: успешно Пример: `42949672960`
status строка	Состояние снимка. Возвращаемое значение: успешно Пример: `"complete"`

Авторы

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