Модуль vultr.cloud.snapshot — управление снимками в Vultr

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install vultr.cloud.

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

Добавлено в 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`
description псевдонимы: name string / обязательный	Описание снимка.
instance string	Описание или ID экземпляра, снимок которого нужно создать. Взаимоисключающий параметр с url. Если указано state=present, необходимо задать instance или url.
state string	Состояние снимка. Варианты: `"present"` ← (по умолчанию) `"absent"`
uefi boolean добавлено в vultr.cloud 1.14.0	Использует ли снимок UEFI. Учитывается только при создании, если указан параметр url. Варианты: `false` ← (по умолчанию) `true`
url string	URL загружаемого образа снимка (RAW). Взаимоисключающий параметр с instance. Если указано state=present, необходимо задать instance или url.
validate_certs boolean	Проверять сертификаты SSL API Vultr. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

См. также документацию API: https://www.vultr.com/api/.

Примеры

- name: Ensure a snapshot is present
  vultr.cloud.snapshot:
    description: my snapshot of my instance
    instance: my instance

- name: Ensure a snapshot is present
  vultr.cloud.snapshot:
    description: debian 13 generic
    url: https://cloud.debian.org/images/cloud/trixie/latest/debian-13-generic-amd64.raw

- name: Ensure a snapshot is present with UEFI
  vultr.cloud.snapshot:
    description: debian 13 generic
    url: https://cloud.debian.org/images/cloud/trixie/latest/debian-13-generic-amd64.raw
    uefi: true

- name: Ensure a snapshot is absent
  vultr.cloud.snapshot:
    description: my snapshot of my instance
    state: absent

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

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

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