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

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.14.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 string	URL конечной точки API (без завершающей косой черты). Резервная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key string / обязательный	Ключ API Vultr. Резервная переменная окружения `VULTR_API_KEY`.
api_results_per_page integer добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов должно возвращаться в каждом запросе к API. Этот параметр не определяет общее количество возвращаемых результатов; возвращаются все ресурсы с учётом других фильтров. Максимальное значение для API Vultr — 500. Резервная переменная окружения `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries integer	Количество повторных попыток в случае, если API Vultr возвращает код ошибки HTTP, например: 429 Too Many Requests, 500 Internal Server Error или 504 Gateway Time-out. Резервная переменная окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay integer	Экспоненциальная задержка между повторными попытками в секундах увеличивается до этого максимального значения. Резервная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout integer	Тайм-аут HTTP-запроса к API Vultr. Резервная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
validate_certs boolean	Проверять сертификаты SSL API Vultr. Варианты: `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

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

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

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

Авторы

René Moser (@resmo)

Ссылки на коллекцию

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