Модуль community.hrobot.storagebox_snapshot – создание, обновление или удаление снимка хранилища

Примечание

Этот модуль входит в коллекцию community.hrobot (версия 2.7.2).

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

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

Чтобы использовать её в плейбуке, укажите: community.hrobot.storagebox_snapshot.

Добавлено в community.hrobot 2.3.0

Краткое описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

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

Создаёт снимок хранилища, обновляет комментарий или удаляет снимок.

Параметры

Параметр	Комментарии
hetzner_password строка	Пароль пользователя веб-службы Robot. Если указан `hetzner_password`, необходимо также указать `hetzner_user`, а `hetzner_token` указывать нельзя. Этот параметр устарел для данного модуля, и его поддержка будет удалена в community.hrobot 3.0.0.
hetzner_token строка добавлено в community.hrobot 2.5.0	Токен API пользователя веб-службы Robot. Необходимо указать один из параметров: `hetzner_token` или `hetzner_user`. Начиная с community.hrobot 3.0.0 этот параметр станет обязательным.
hetzner_user строка	Имя пользователя веб-службы Robot. Необходимо указать один из параметров: `hetzner_token` или `hetzner_user`. Если указан `hetzner_user`, необходимо также указать `hetzner_password`, а `hetzner_token` указывать нельзя. Этот параметр устарел для данного модуля, и его поддержка будет удалена в community.hrobot 3.0.0.
rate_limit_retry_timeout целое число добавлено в community.hrobot 2.1.0	Время ожидания (в секундах) при получении ошибок превышения ограничения частоты запросов. Установите значение `0`, чтобы отключить повторные попытки. Установите отрицательное значение, например `-1`, чтобы повторять попытки бесконечно. По умолчанию: `-1`
snapshot_comment строка	Комментарий, который нужно задать для снимка.
snapshot_name строка	Имя снимка, для которого нужно изменить комментарий или который нужно удалить. Имя снимка генерируется автоматически; при создании снимка его указывать не следует. Обязательно, если для `state` задано значение `absent` или если указан `snapshot_comment`.
state строка	Состояние снимка. Варианты: `"present"` ← (по умолчанию) `"absent"`
storagebox_id целое число / обязательный	Идентификатор хранилища, для которого нужно создать снимок.

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группы действий: community.hrobot.api, community.hrobot.robot	Используйте `group/community.hrobot.robot` или `group/community.hrobot.api` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля. Группа `group/community.hrobot.robot` для этого модуля устарела; модуль будет исключён из этой группы в community.hrobot 3.0.0.
check_mode	Поддержка: полная	Модуль может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, нужно изменить в `check_mode`).
idempotent	Поддержка: частичная При создании снимка модуль не является идемпотентным.	При повторном запуске с теми же аргументами вне режима проверки модуль сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или к которой он обращается, не изменилась существенным образом.

Примеры

---
- name: Create a snapshot
  community.hrobot.storagebox_snapshot:
    storagebox_id: 12345
    # The snapshot name is automatically generated and should not be specified.

- name: Delete a snapshot
  community.hrobot.storagebox_snapshot:
    storagebox_id: 12345
    snapshot_name: "2025-01-21T12-40-38"
    state: absent

- name: Update snapshot comment
  community.hrobot.storagebox_snapshot:
    storagebox_id: 12345
    snapshot_name: "2025-01-21T12-40-38"
    snapshot_comment: "This is an updated comment"

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

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

Ключ	Описание
snapshot словарь	Созданный или обновлённый снимок. Возвращается: при успехе и `state=present`
name строка	Имя снимка. Возвращается: при успехе Пример: `"2025-01-21T12-40-38"`
size целое число	Размер снимка в МБ. Возвращается: при успехе Пример: `400`
timestamp строка	Временная метка снимка в формате UTC. Возвращается: при успехе Пример: `"2025-01-21T12:40:38+00:00"`

Авторы

Matthias Hurdebise (@matthiashurdebise)

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

© 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/community/hrobot/storagebox_snapshot_module.html