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

Примечание

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

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

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

Для использования в книге задач укажите: vultr.cloud.snapshot.

Новое в 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 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Обращение к переменной окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Задержка повторной попытки в секундах экспоненциально увеличивается до этого максимального значения. Обращение к переменной окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Таймаут HTTP-запроса к Vultr API. Обращение к переменной окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
description aliases: name строка / обязательно	Описание снимка.
instance строка	Описание или ID экземпляра, для которого необходимо создать снимок. Взаимоисключающие параметры с url. instance или url требуются, если state=present.
state строка	Состояние снимка. Варианты: `"present"` ← (по умолчанию) `"absent"`
url строка	URL изображения снимка (RAW) для загрузки. Взаимоисключающие параметры с instance. instance или url требуются, если state=present.
validate_certs булево значение	Проверка SSL-сертификатов Vultr API. Варианты: `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 11 generic
    url: https://cloud.debian.org/images/cloud/bullseye/latest/debian-11-generic-amd64.raw

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

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

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

Ключ	Описание
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 словарь	Ответ от API Vultr. Возвращается: успех
app_id целое число	Идентификатор приложения. Возвращается: успех Пример: `0`
compressed_size целое число	Сжатый размер снимка. Возвращается: успех Пример: `949678560`
date_created строка	Дата создания снимка. Возвращается: успех Пример: `"2020-10-10T01:56:20+00:00"`
description строка	Описание снимка. Возвращается: успех Пример: `"my vpc"`
id строка	Идентификатор снимка. Возвращается: успех Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
os_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_module.html