Модуль hetzner.hcloud.storage_box_snapshot — создание снимков Storage Box в Hetzner и управление ими.

Примечание

Этот модуль входит в коллекцию hetzner.hcloud (версия 6.9.0).

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

Для установки используйте: ansible-galaxy collection install hetzner.hcloud. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: hetzner.hcloud.storage_box_snapshot.

Краткое описание
Требования
Параметры
См. также
Примеры
Возвращаемые значения

Краткое описание

Создание, обновление и удаление снимков Storage Box в Hetzner.
Подробнее см. в документации API снимков Storage Box.

Псевдонимы: hcloud_storage_box_snapshot

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python-dateutil >= 2.7.5
requests >=2.20

Параметры

Параметр	Описание
api_endpoint псевдонимы: endpoint строка	Адрес конечной точки API Hetzner Cloud. Это значение также можно задать с помощью переменной окружения `HCLOUD_ENDPOINT`. По умолчанию: `"https://api.hetzner.cloud/v1"`
api_endpoint_hetzner строка	Адрес конечной точки API Hetzner. Это значение также можно задать с помощью переменной окружения `HETZNER_ENDPOINT`. По умолчанию: `"https://api.hetzner.com/v1"`
api_token строка / обязательный	Токен для API Hetzner Cloud. Это значение также можно задать с помощью переменной окружения `HCLOUD_TOKEN`.
description строка	Описание снимка Storage Box.
id целое число	Идентификатор снимка Storage Box, которым нужно управлять. Обязателен при обновлении или удалении, если не указан `name` снимка Storage Box. Если идентификатор недействителен, выполнение модуля завершится ошибкой.
labels словарь	Метки снимка Storage Box, заданные пользователем (пары «ключ — значение»).
name строка	Имя снимка Storage Box, которым нужно управлять. Имена снимков Storage Box задаются API и не могут быть изменены. Обязательно при обновлении или удалении, если не указано `id` снимка Storage Box.
state строка	Состояние снимка Storage Box. Варианты: `"absent"` `"present"` ← (по умолчанию)
storage_box строка / обязательный	Идентификатор или имя родительского Storage Box. Предпочтительно использовать идентификатор, чтобы сократить количество запросов к API.

См. также

Документация по API Hetzner: Полный справочник по API Hetzner.

Примеры

- name: Create a Storage Box Snapshot
  hetzner.hcloud.storage_box_snapshot:
    storage_box: my-storage-box
    description: before app migration
    labels:
      env: prod
    state: present

- name: Delete a Storage Box Snapshot by name
  hetzner.hcloud.storage_box_snapshot:
    storage_box: my-storage-box
    name: 2025-12-03T13-47-47
    state: absent

- name: Delete a Storage Box Snapshot by id
  hetzner.hcloud.storage_box_snapshot:
    storage_box: 497436
    id: 405920
    state: absent

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

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

Ключ	Описание
hcloud_storage_box_snapshot словарь	Сведения о снимке Storage Box. Возвращается: всегда
created строка	Время создания снимка Storage Box (в формате RFC3339). Возвращается: всегда Пример: `"2025-12-03T13:47:47Z"`
description строка	Описание снимка Storage Box. Возвращается: всегда Пример: `"before app migration"`
id целое число	Идентификатор снимка Storage Box. Возвращается: всегда Пример: `405920`
is_automatic логическое значение	Указывает, был ли снимок Storage Box создан автоматически. Возвращается: всегда Пример: `false`
labels словарь	Метки снимка Storage Box, заданные пользователем (пары «ключ — значение»). Возвращается: всегда Пример: `{"env": "prod"}`
name строка	Имя снимка Storage Box. Возвращается: всегда Пример: `"2025-02-12T11-35-19"`
stats словарь	Статистика снимка Storage Box. Возвращается: всегда
size целое число	Текущий объём хранилища, занимаемый снимком, в байтах. Возвращается: всегда Пример: `10485760`
size_filesystem целое число	Размер сжатой файловой системы, содержащейся в снимке, в байтах. Возвращается: всегда Пример: `10485760`
storage_box целое число	Идентификатор родительского Storage Box. Возвращается: всегда Пример: `497436`

Авторы

Jonas Lammler (@jooola)

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

© 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/hetzner/hcloud/storage_box_snapshot_module.html