Модуль hitachivantara.vspone_block.vsp.hv_snapshot — управление снимками в блочных системах хранения VSP.

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: hitachivantara.vspone_block.vsp.hv_snapshot.

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

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

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

Этот модуль позволяет создавать, удалять, разделять, синхронизировать и восстанавливать снимки в блочных системах хранения VSP.
Он поддерживает различные операции со снимками в зависимости от указанного уровня задачи.
Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/snapshot.yml

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info словарь / обязательный	Информация, необходимая для установления соединения с системой хранения.
address строка / обязательный	IP-адрес или имя хоста системы хранения.
api_token строка	Токен для работы с заблокированными ресурсами.
connection_type строка	Тип соединения с системой хранения. Варианты: `"direct"` ← (по умолчанию)
password строка	Пароль для аутентификации. Это обязательное поле.
username строка	Имя пользователя для аутентификации. Это обязательное поле.
spec словарь / обязательный	Спецификация задачи со снимком.
allocate_new_consistency_group логический	Укажите, следует ли выделить группу согласованности. Обязательный параметр для задачи создания пары снимков с новой группой согласованности. Варианты: `false` `true`
auto_split логический	Укажите, следует ли автоматически разделить пару. Варианты: `false` `true`
can_cascade логический	Укажите, может ли пара быть каскадной. По умолчанию — True, если экономия ёмкости не равна `disabled`; в этом случае Lun может не требоваться добавлять ни в одну группу хостов. Обязательный параметр для задачи создания пары снимков Thin Image Advanced. Варианты: `false` `true`
clones_automation логический	Укажите, следует ли клонировать пару после её создания. Этот параметр можно указать, если для атрибута is_clone задано значение true. Обязательный параметр для задачи создания и клонирования пары снимков с указанием скорости копирования и автоматизацией клонирования. Варианты: `false` `true`
copy_speed строка	Укажите скорость копирования, с которой будет клонирована созданная пара. Этот параметр можно указать, если для атрибутов is_clone и clones_automation задано значение true. Обязательный параметр для задачи создания и клонирования пары снимков с указанием скорости копирования и автоматизацией клонирования. Варианты: `"SLOW"` `"MEDIUM"` `"FAST"`
is_clone логический	Укажите, следует ли создать пару с заданным атрибутом клонирования. Если для этого атрибута указано значение true, не указывайте атрибут auto_split. При создании пары Thin Image Advanced нельзя указывать значение true. Обязательный параметр для задач создания и клонирования пары снимков /создания и клонирования пары снимков с указанием скорости копирования и автоматизацией клонирования. Варианты: `false` `true`
is_data_reduction_force_copy логический	Укажите, следует ли принудительно создать пару для тома, на котором включена функция экономии ёмкости. По умолчанию — True, если экономия ёмкости не равна `disabled`. Обязательный параметр для задач создания пары снимков с использованием существующей группы согласованности /создания пары снимков Thin Image Advanced. Варианты: `false` `true`
mirror_unit_number псевдонимы: mirror_unit_id целое число	Номер зеркального устройства. Обязательный параметр для задач разделения пары снимков /повторной синхронизации пары снимков /восстановления пары снимков /удаления пары снимков /клонирования пары снимков/пары Thin Image /отмены назначения плавающей пары снимков /установки срока хранения существующей пары снимков /установки срока хранения пары снимков после разделения. Необязательный параметр для задач создания плавающей пары снимков /назначения плавающей пары снимков.
operation_type строка	Укажите тип операции удаления неиспользуемых данных. Этот параметр можно задать, если для атрибута should_delete_tree установлено значение true. Обязательный параметр для задачи удаления неиспользуемых данных всех пар Thin Image в дереве снимков.
pool_id целое число	Идентификатор пула, в котором будет выделен снимок. Необязательный параметр для задач создания пары снимков /создания пары снимков с новой группой согласованности /создания и автоматического разделения пары снимков /создания пары снимков с использованием существующей группы согласованности /создания и клонирования пары снимков /создания пары снимков Thin Image Advanced /установки срока хранения пары снимков с автоматическим разделением. Обязательный параметр для задач создания и клонирования пары снимков с указанием скорости копирования и автоматизацией клонирования /создания плавающей пары снимков.
primary_volume_id строка / обязательный	Идентификатор основного тома. Обязательный параметр для задач создания пары снимков /создания пары снимков с новой группой согласованности /разделения пары снимков /повторной синхронизации пары снимков /создания и автоматического разделения пары снимков /восстановления пары снимков /создания пары снимков с использованием существующей группы согласованности /удаления пары снимков /удаления пар Thin Image по дереву снимков /клонирования пары снимков/пары Thin Image /создания и клонирования пары снимков /создания и клонирования пары снимков с указанием скорости копирования и автоматизацией клонирования /создания плавающей пары снимков /назначения плавающей пары снимков /отмены назначения плавающей пары снимков /создания пары снимков Thin Image Advanced /установки срока хранения существующей пары снимков /установки срока хранения пары снимков после разделения /установки срока хранения пары снимков с автоматическим разделением /удаления неиспользуемых данных всех пар Thin Image в дереве снимков.
retention_period целое число	Укажите срок хранения снимка в часах. Этот параметр можно задать, если состояние снимка — PSUS. Атрибут можно использовать, если система хранения — VSP One B20. Указывать его можно только в том случае, если для новой пары атрибут auto_split имеет значение true. Обязательный параметр для задач установки срока хранения существующей пары снимков /установки срока хранения пары снимков после разделения /установки срока хранения пары снимков с автоматическим разделением.
secondary_volume_id строка	Идентификатор вторичного тома. Обязательный параметр для задач создания плавающей пары снимков /назначения плавающей пары снимков /отмены назначения плавающей пары снимков. Необязательный параметр для задачи создания пары снимков Thin Image Advanced.
should_delete_svol логический	Укажите, следует ли удалять вторичный том при удалении пары снимков. Обязательный параметр для задачи удаления пары снимков. Варианты: `false` ← (по умолчанию) `true`
should_delete_tree логический	Укажите, следует ли удалять неиспользуемые данные всех пар Thin Image в дереве снимков. Обязательный параметр для задачи удаления пар Thin Image по дереву снимков. Варианты: `false` `true`
snapshot_group_name строка	Имя группы снимков. Обязательный параметр для задач создания пары снимков /создания пары снимков с новой группой согласованности /создания и автоматического разделения пары снимков /создания пары снимков с использованием существующей группы согласованности /создания и клонирования пары снимков /создания и клонирования пары снимков с указанием скорости копирования и автоматизацией клонирования /создания плавающей пары снимков /создания пары снимков Thin Image Advanced /установки срока хранения пары снимков с автоматическим разделением.
wait_for_final_state логический	Следует ли ожидать конечного состояния после запуска операции со снимком. Варианты: `false` `true`
state строка	Уровень задачи со снимком. Возможные значения: `present`, `absent`, `split`, `sync`, `restore`, `clone`, `defragment`. Варианты: `"present"` ← (по умолчанию) `"absent"` `"split"` `"sync"` `"restore"` `"clone"` `"defragment"`
storage_system_info словарь	Информация о системе хранения. Это необязательное поле.
serial строка	Серийный номер системы хранения.

Атрибуты

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

Примечания

Примечание

Входные параметры consistency_group_id и enable_quick_mode удалены в версии 3.4.0. Они объявлены устаревшими из-за упрощения внутреннего API и больше не поддерживаются.
Тип соединения gateway удалён начиная с версии 3.4.0. Если вам необходим этот тип соединения, используйте более раннюю версию.
При автоматическом создании SVOL во время настройки пары система выделяет одну вторичную группу хостов/цель iSCSI.
Для задачи создания пары снимков
1. Если имя P-VOL не задано, S-VOL будет присвоено имя в формате smrha-[ldev_id]. Если у P-VOL есть имя, для S-VOL следует использовать то же имя. (Здесь smrha означает Storage Module Red Hat Ansible.)
1. Технология Thin Image Advanced поддерживается только моделями VSP One B24, B26 и B28.
Для задачи создания пары снимков с новой группой согласованности
1. Если имя P-VOL не задано, S-VOL будет присвоено имя в формате smrha-[ldev_id]. Если у P-VOL есть имя, для S-VOL следует использовать то же имя. (Здесь smrha означает Storage Module Red Hat Ansible.)
1. Технология Thin Image Advanced поддерживается только моделями VSP One B24, B26 и B28.
Для задачи разделения пары снимков
1. Разделение пары снимков завершится ошибкой, если пара входит в группу согласованности.
Для задачи восстановления пары снимков
1. Чтобы восстановить пару Thin Image или Thin Image Advanced, она должна иметь статус PSUS. После восстановления пара Thin Image Advanced сохраняет статус PSUS, а пара Thin Image переходит в статус PAIR.
Для задачи удаления пары снимков
1. Если пара содержит SVOL, он отключается от соответствующих групп хостов, целей iSCSI и подсистем NVM, а затем удаляется.
Для задачи удаления пар Thin Image по дереву снимков
1. Технология Thin Image Advanced недоступна для этой задачи.
Для задачи назначения плавающей пары снимков
1. Парам Thin Image Advanced необходимо назначить статус PSUS.
Для задачи отмены назначения плавающей пары снимков
1. SVOL отключается от сопоставленных групп хостов, целей iSCSI и подсистем NVM, а затем удаляется.
Для задачи установки срока хранения существующей пары снимков
Если P-VOL и S-VOL образуют новую пару Thin Image (HTI), а требуемое состояние — разделённое, выполните следующие действия:
1. Создайте новую пару TI (из двух томов, не входящих в пары).
1. Разделите пару, чтобы сохранить данные снимка (снимок будет сохранён, а копирование при записи прекратится).
Для задачи установки срока хранения пары снимков после разделения. Если P-VOL и S-VOL образуют новую пару Thin Image (HTI), а требуемое состояние — разделённое, выполните следующие действия:
1. Создайте новую пару TI (из двух томов, не входящих в пары).
1. Разделите пару, чтобы сохранить данные снимка (снимок будет сохранён, а копирование при записи прекратится).
Для задачи установки срока хранения пары снимков с автоматическим разделением. Если P-VOL и S-VOL образуют новую пару Thin Image (HTI), а требуемое состояние — разделённое, выполните следующие действия:
1. Создайте новую пару TI (из двух томов, не входящих в пары).
1. Разделите пару, чтобы сохранить данные снимка (снимок будет сохранён, а копирование при записи прекратится).
Для задачи удаления неиспользуемых данных всех пар Thin Image в дереве снимков
1. Пары Thin Image Advanced не поддерживают эту задачу.

Примеры

- name: Create a snapshot
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: present
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 123
      pool_id: 1
      snapshot_group_name: "snap_group"

- name: Create a thin image advance cascade
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: present
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 123
      pool_id: 1
      snapshot_group_name: "snap_group"
      can_cascade: true
      is_data_reduction_force_copy: true

- name: Create a thin image clone pair
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: present
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 123
      pool_id: 1
      snapshot_group_name: "snap_group"
      is_clone: true

- name: Clone a thin image clone pair
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: clone
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 123
      mirror_unit: 3

- name: Delete a snapshot
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: absent
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 123
      mirror_unit: 10

- name: Split a snapshot
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: split
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 123
      mirror_unit: 10

- name: Resync a snapshot
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: resync
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 123
      mirror_unit: 10

- name: Restore a snapshot
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: restore
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 123
      mirror_unit: 3

- name: Set the retention period for a snapshot
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: split
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 123
      mirror_unit: 3
      retention_period: 500

- name: Set the retention period for a snapshot with auto split.
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: split
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 123
      mirror_unit: 3
      retention_period: 500
      pool_id: 1
      snapshot_group_name: "snap_group"

- name: Create and clone snapshot pair with copy speed and clones automation
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: "present"
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 100
      pool_id: 5
      snapshot_group_name: "snapshot-group-name-1"
      is_clone: true
      copy_speed: "FAST"
      clones_automation: true

- name: Create floating snapshot pair
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: "present"
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 100
      secondary_volume_id: -1
      pool_id: 5
      snapshot_group_name: "snapshot-group-name-1"
      mirror_unit_number: 4

- name: Assign floating snapshot pair
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: "present"
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 100
      secondary_volume_id: 200
      mirror_unit_number: 1

- name: Unassign floating snapshot pair
  hitachivantara.vspone_block.vsp.hv_snapshot:
    state: "present"
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    spec:
      primary_volume_id: 100
      secondary_volume_id: -1
      mirror_unit_number: 1

- name: Deleting garbage data of all Thin Image pairs in a snapshot tree
  hitachivantara.vspone_block.vsp.hv_snapshot:
    connection_info:
      address: storage1.company.com
      username: "username"
      password: "password"
    state: "defragment"
    spec:
      primary_volume_id: 100
      operation_type: "start"

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

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

Ключ	Описание
snapshot_data list / elements=dictionary	Список снимков, полученных из системы хранения. Возвращается: всегда
can_cascade boolean	Указывает, можно ли каскадировать снимок. Возвращается: при успехе Пример: `true`
concordance_rate integer	Согласованность операции создания снимка. Возвращается: при успехе Пример: `100`
copy_pace_track_size string	Размер дорожки темпа копирования. Возвращается: при успехе Пример: `""`
copy_rate integer	Скорость копирования снимка. Возвращается: при успехе Пример: `-1`
is_clone boolean	Указывает, является ли снимок клоном. Возвращается: при успехе Пример: `false`
is_cloned boolean	Указывает, был ли снимок клонирован. Возвращается: при успехе Пример: `false`
is_consistency_group boolean	Указывает, является ли снимок частью группы согласованности. Возвращается: при успехе Пример: `true`
is_data_reduction_force_copy boolean	Указывает, включено ли принудительное копирование при сокращении объема данных. Возвращается: при успехе Пример: `true`
is_redirect_on_write boolean	Указывает, включен ли режим перенаправления при записи. Возвращается: при успехе Пример: `true`
is_snapshot_data_read_only boolean	Указывает, доступны ли данные снимка только для чтения. Возвращается: при успехе
is_written_in_svol boolean	Указывает, записываются ли данные во вторичный том. Возвращается: при успехе Пример: `false`
mirror_unit_id integer	Устарело. Используйте mirror_unit_number. Идентификатор зеркального блока. Возвращается: при успехе Пример: `3`
mirror_unit_number integer	Номер зеркального блока. Возвращается: при успехе Пример: `3`
pool_id integer	Идентификатор пула, в котором размещен снимок. Возвращается: при успехе Пример: `1`
primary_hex_volume_id string	Шестнадцатеричный идентификатор основного тома. Возвращается: при успехе Пример: `"00:00:A8"`
primary_volume_id integer	Идентификатор основного тома. Возвращается: при успехе Пример: `168`
progress_rate integer	Степень выполнения операции создания снимка. Возвращается: при успехе Пример: `-1`
pvol_host_groups list / elements=string	Список групп хостов для основного тома. Возвращается: при успехе Пример: `[]`
pvol_nvm_subsystem_name string	Имя подсистемы NVM для основного тома. Возвращается: при успехе Пример: `""`
pvol_processing_status string	Состояние обработки основного тома. Возвращается: при успехе Пример: `"N"`
retention_period_in_hours integer	Срок хранения снимка. Возвращается: при успехе Пример: `-1`
secondary_hex_volume_id string	Шестнадцатеричный идентификатор вторичного тома. Возвращается: при успехе Пример: `"00:00:CD"`
secondary_volume_id integer	Идентификатор вторичного тома. Возвращается: при успехе Пример: `205`
snapshot_group_name string	Имя группы снимков. Возвращается: при успехе Пример: `"snewar-tia-grp-02"`
snapshot_id string	Идентификатор снимка. Возвращается: при успехе Пример: `"168,3"`
split_time string	Время разделения снимка. Возвращается: при успехе Пример: `""`
status string	Состояние снимка. Возвращается: при успехе Пример: `"PFUL"`
svol_host_groups list / elements=string	Список групп хостов для вторичного тома. Возвращается: при успехе Пример: `[]`
svol_nvm_subsystem_name string	Имя подсистемы NVM для вторичного тома. Возвращается: при успехе Пример: `""`
svol_processing_status string	Состояние обработки вторичного тома. Возвращается: при успехе Пример: `""`
type string	Тип снимка. Возвращается: при успехе Пример: `"CASCADE"`

Авторы

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/vsp.hv_snapshot_module.html