Модуль community.hrobot.storagebox_snapshot_info — получение снимков для хранилища

Примечание

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

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

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

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

Новое в community.hrobot 2.4.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`
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: Query the snapshots
  community.hrobot.storagebox_snapshot_info:
    hetzner_user: foo
    hetzner_password: bar
    id: 123
  register: result

- name: Output data
  ansible.builtin.debug:
    msg: "Timestamp of the first snapshot : {{ result.snapshots[0].timestamp }}"

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

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

Ключ	Описание
snapshots список / элементы=словарь	Сведения о хранилище. Все параметры даты и времени указаны в формате UTC. Возвращается: при успехе
automatic логическое значение	Указывает, был ли снимок создан автоматически. Обратите внимание: если указан `hetzner_token`, это значение вычисляется на основе `snapshots[].is_automatic`. Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успехе Пример: `false`
comment строка	Комментарий к снимку. Обратите внимание: если указан `hetzner_token`, это значение копируется из `snapshots[].description`. Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успехе Пример: `"This is a snapshot"`
created целое число добавлен в community.hrobot 2.5.0	Время создания снимка в формате ISO-8601, UTC. Возвращается: при успехе, если указан `hetzner_token` Пример: `"2016-01-30T23:55:00+00:00"`
description целое число добавлен в community.hrobot 2.5.0	Описание снимка (в API Robot ранее называлось комментарием). Возвращается: при успехе, если указан `hetzner_token` Пример: `"my-description"`
filesystem_size целое число	Размер хранилища в МБ на момент создания снимка. Обратите внимание: если указан `hetzner_token`, это значение вычисляется на основе `snapshots[].stats.size_filesystem`. Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успехе Пример: `12345`
id целое число добавлен в community.hrobot 2.5.0	Идентификатор снимка. Возвращается: при успехе, если указан `hetzner_token` Пример: `1`
is_automatic логическое значение добавлен в community.hrobot 2.5.0	Указывает, был ли снимок создан автоматически. Возвращается: при успехе, если указан `hetzner_token` Пример: `true`
labels словарь добавлен в community.hrobot 2.5.0	Метки снимка, заданные пользователем. Возвращается: при успехе, если указан `hetzner_token`
name строка	Имя снимка. Возвращается: при успехе Пример: `"2025-01-21T12-40-38"`
size целое число	Размер снимка в МБ. Обратите внимание: если указан `hetzner_token`, это значение копируется из `snapshots[].stats.size`. Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успехе Пример: `400`
stats словарь добавлен в community.hrobot 2.5.0	Статистика снимка. Возвращается: при успехе, если указан `hetzner_token`
size целое число	Общий размер снимка в байтах. Возвращается: при успехе Пример: `2097152`
size_filesystem целое число	Фактический размер снимка в файловой системе в байтах (после дедупликации). Возвращается: при успехе Пример: `1048576`
storage_box целое число добавлен в community.hrobot 2.5.0	Идентификатор связанного хранилища. Возвращается: при успехе, если указан `hetzner_token` Пример: `42`
timestamp строка	Время создания снимка в формате UTC. Обратите внимание: если указан `hetzner_token`, это значение копируется из `snapshots[].created`. Это возвращаемое значение устарело и будет удалено в community.hrobot 3.0.0. Если вы используете ansible-core версии 2.19 или новее, при использовании этого возвращаемого значения с `hetzner_token` появится сообщение об устаревании. Возвращается: при успехе Пример: `"2025-01-21T13: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_info_module.html