Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot — управление снимками в системах VSP One SDS Block и Cloud.

Примечание

Этот модуль входит в коллекцию hitachivantara.vspone_block (версия 4.8.1).

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

Чтобы установить её, используйте: ansible-galaxy collection install hitachivantara.vspone_block. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot.

Добавлено в hitachivantara.vspone_block 4.1.0

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

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

Этот модуль позволяет создавать, подготавливать и завершать снимки в системах хранения Hitachi SDS Block.
Примеры см. по URL-адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/snapshot.yml

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info словарь / обязательный	Информация, необходимая для подключения к системе хранения.
address строка / обязательный	IP-адрес или имя узла системы хранения.
connection_type строка	Тип подключения к системе хранения. Варианты: `"direct"` ← (по умолчанию)
password строка / обязательный	Пароль для аутентификации. Это обязательное поле.
username строка / обязательный	Имя пользователя для аутентификации. Это обязательное поле.
spec словарь / обязательный	Спецификация операции со снимком.
master_volume_id строка	UUID основного тома. Это поле используется при создании и является обязательным, если поле master_volume_name не указано.
master_volume_name строка	Имя основного тома. Это поле используется при создании и является обязательным, если поле master_volume_id не указано. Обязательно для задач «Создать снимок указанного тома» и «Создать снимок указанного тома в VPS».
name строка	Имя снимка. Это поле используется при создании. Обязательно для задач «Создать снимок указанного тома» и «Создать снимок указанного тома в VPS».
operation_type строка	Тип операции со снимком. Это поле используется при создании и является обязательным. Обязательно для задач «Создать снимок указанного тома», «Изменить состояние снимка с Prepare на Finalize» и «Создать снимок указанного тома в VPS». Варианты: `"prepare_and_finalize"` `"prepare"` `"finalize"`
qos словарь	Параметры QoS для снимка. Это поле используется при создании и является необязательным.
upper_alert_allowable_time целое число	Допустимое время для верхнего порогового предупреждения. Обязательно для задач «Создать снимок указанного тома» и «Создать снимок указанного тома в VPS».
upper_limit_for_iops целое число	Верхний предел IOPS. Обязательно для задач «Создать снимок указанного тома» и «Создать снимок указанного тома в VPS».
upper_limit_for_transfer_rate целое число	Верхний предел скорости передачи данных. Обязательно для задач «Создать снимок указанного тома» и «Создать снимок указанного тома в VPS».
snapshot_volume_id строка	UUID тома-снимка. Это поле используется при удалении и восстановлении и является обязательным, если поле snapshot_volume_name не указано.
snapshot_volume_name строка	Имя тома-снимка. Это поле используется при удалении и восстановлении и является обязательным, если поле snapshot_volume_id не указано. Обязательно для задач «Удалить снимок указанного тома», «Восстановить снимок указанного тома» и «Изменить состояние снимка с Prepare на Finalize».
vps_id строка	UUID VPS.
vps_name строка	Имя VPS. Обязательно для задачи «Создать снимок указанного тома в VPS».
state строка	Требуемое состояние снимка. Варианты: `"present"` ← (по умолчанию) `"absent"` `"restore"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: отсутствует	Определяет, должен ли модуль выполняться в режиме проверки.

Примеры

- name: Create a snapshot (present)
  hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "present"
    spec:
      name: "snapshot1"
      master_volume_name: "volume1"
      operation_type: "prepare_and_finalize"

- name: Delete a snapshot (absent)
  hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "absent"
    spec:
      snapshot_volume_name: "snapshot1"

- name: Restore a snapshot (restore)
  hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "restore"
    spec:
      snapshot_volume_name: "snapshot1"

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

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

Ключ	Описание
snapshot_info словарь	Информация о томе-снимке, полученная из системы хранения. Возвращается: всегда
is_written_in_svol логическое значение	Показывает, были ли записаны данные во вторичный том. Возвращается: при успешном выполнении
qos_param словарь	Параметры качества обслуживания (QoS) для снимка. Возвращается: при успешном выполнении
upper_alert_allowable_time целое число	Пороговое время для верхнего предупреждения в секундах. Возвращается: при успешном выполнении Пример: `30`
upper_alert_time целое число	Текущее значение времени верхнего предупреждения. Возвращается: при успешном выполнении Пример: `-1`
upper_limit_for_iops целое число	Верхний предел IOPS. Возвращается: при успешном выполнении Пример: `120`
upper_limit_for_transfer_rate целое число	Верхний предел скорости передачи данных (МБ/с). Возвращается: при успешном выполнении Пример: `20`
snapshot_concordance_rate целое число	Степень согласованности снимка в процентах. Возвращается: при успешном выполнении Пример: `-1`
snapshot_progress_rate целое число	Ход выполнения операции со снимком в процентах. Возвращается: при успешном выполнении Пример: `-1`
snapshot_status строка	Текущее состояние снимка. Возвращается: при успешном выполнении Пример: `"Empty"`
snapshot_timestamp строка	Временная метка создания снимка. Возвращается: при успешном выполнении Пример: `""`
snapshot_type строка	Тип снимка. Возвращается: при успешном выполнении Пример: `"Snapshot"`
snapshot_volume_id строка	Уникальный идентификатор тома-снимка. Возвращается: при успешном выполнении Пример: `"1ec0d4ea-2c47-47b2-b76b-22fa7714de43"`
snapshot_volume_name строка	Имя тома-снимка. Возвращается: при успешном выполнении Пример: `"testsnapshot12"`
snapshot_volume_nickname строка	Псевдоним тома-снимка. Возвращается: при успешном выполнении Пример: `"SDSBolume12"`
status строка	Общее состояние снимка. Возвращается: при успешном выполнении Пример: `"Normal"`
status_summary строка	Сводка о состоянии снимка. Возвращается: при успешном выполнении Пример: `"Normal"`
vps_id строка	Идентификатор VPS, связанного со снимком. Возвращается: при успешном выполнении Пример: `"(system)"`
vps_name строка	Имя VPS, связанного со снимком. Возвращается: при успешном выполнении Пример: `"(system)"`

Авторы

Hitachi Vantara LTD (@hitachi-vantara)

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

© 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/hitachivantara/vspone_block/sds_block.hv_sds_block_snapshot_module.html