Модуль hitachivantara.vspone_block.vsp.hv_snapshot_group — управление снимками в группах снимков в блочных системах хранения данных 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_group.

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

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

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

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

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info словарь / обязательный	Информация, необходимая для установления соединения с системой хранения данных.
address строка / обязательный	IP-адрес или имя узла системы хранения данных.
api_token строка	Токен для работы с заблокированными ресурсами.
connection_type строка	Тип подключения к системе хранения данных. Варианты: `"direct"` ← (по умолчанию)
password строка	Пароль для аутентификации. Это обязательное поле.
username строка	Имя пользователя для аутентификации. Это обязательное поле.
spec словарь / обязательный	Спецификация задач для группы снимков.
auto_split логическое значение	Автоматически разделить группу снимков. Обязательный параметр для задачи восстановления пар снимков по имени группы с автоматическим разделением. Варианты: `false` `true`
copy_speed строка	Скорость операции копирования. Необязательный параметр для задачи клонирования пар снимков по имени группы. Варианты: `"SLOW"` `"MEDIUM"` `"FAST"`
operation_type строка	Тип операции клонирования. Необязательный параметр для задачи клонирования пар снимков по имени группы.
retention_period целое число	Укажите срок хранения снимка в часах. Это значение можно задать, если снимок находится в состоянии PSUS. Обязательный параметр для задачи задания срока хранения снимков по имени группы.
snapshot_group_name строка / обязательный	Имя группы снимков. Обязательный параметр для задач разделения пар снимков по имени группы, восстановления пар снимков по имени группы, восстановления пар снимков по имени группы с автоматическим разделением, повторной синхронизации пар снимков по имени группы, удаления пар снимков по имени группы, задания срока хранения снимков по имени группы и клонирования пар снимков по имени группы.
wait_for_final_state логическое значение	Ожидать ли, пока группа снимков перейдёт в конечное состояние после выполнения операции. Необязательный параметр для всех задач. Варианты: `false` ← (по умолчанию) `true`
state строка / обязательный	Уровень задачи для снимков. Допустимые значения: `absent`, `split`, `sync`, `restore`, `clone`, `defragment`. Варианты: `"present"` `"split"` `"sync"` `"restore"` `"clone"` `"absent"` `"defragment"`
storage_system_info словарь	Информация о системе хранения данных. Это необязательное поле.
serial строка	Серийный номер системы хранения данных.

Атрибуты

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

Примечания

Примечание

Тип подключения gateway удалён начиная с версии 3.4.0. Если вам требуется этот тип подключения, используйте более раннюю версию.

Примеры

- name: Split snapshots using snapshot group name
  hitachivantara.vspone_block.vsp.hv_snapshot_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: split
    spec:
      snapshot_group_name: 'NewNameSPG'

- name: Split and set the retention period of the snapshot using group id
  hitachivantara.vspone_block.vsp.hv_snapshot_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: split
    spec:
      snapshot_group_name: 'NewNameSPG'
      retention_period: 60

- name: Restore snapshots using snapshot group name
  hitachivantara.vspone_block.vsp.hv_snapshot_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: restore
    spec:
      snapshot_group_name: 'NewNameSPG'

- name: Resync snapshots using snapshot group name
  hitachivantara.vspone_block.vsp.hv_snapshot_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: sync
    spec:
      snapshot_group_name: 'NewNameSPG'

- name: Delete snapshots using snapshot group name
  hitachivantara.vspone_block.vsp.hv_snapshot_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: absent
    spec:
      snapshot_group_name: 'NewNameSPG'

- name: Clone snapshots using snapshot group name
  hitachivantara.vspone_block.vsp.hv_snapshot_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: clone
    spec:
      snapshot_group_name: 'NewNameSPG'
      copy_speed: 'SLOW'

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

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

Ключ	Описание
snapshot_data list / elements=dictionary	Список снимков, полученных из системы хранения данных. Возвращается: всегда
snapshot_group_id string	Уникальный идентификатор группы снимков. Возвращается: при успешном выполнении Пример: `"SampleNameSPG"`
snapshot_group_name string	Имя группы снимков. Возвращается: при успешном выполнении Пример: `"SampleNameSPG"`
snapshots list / elements=dictionary	Список снимков в группе. Возвращается: при успешном выполнении
can_cascade boolean	Указывает, можно ли каскадировать снимок. Возвращается: при успешном выполнении Пример: `true`
concordance_rate integer	Коэффициент согласованности снимка. Возвращается: при успешном выполнении Пример: `-1`
copy_pace_track_size string	Размер дорожки для скорости копирования. Возвращается: при успешном выполнении Пример: `""`
copy_rate integer	Скорость копирования снимка. Возвращается: при успешном выполнении Пример: `-1`
is_clone boolean	Указывает, является ли снимок клоном. Возвращается: при успешном выполнении Пример: `false`
is_consistency_group boolean	Указывает, входит ли снимок в группу согласованности. Возвращается: при успешном выполнении Пример: `false`
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	Идентификатор пула. Возвращается: при успешном выполнении Пример: `22`
primary_hex_volume_id string	Шестнадцатеричный идентификатор основного тома. Возвращается: при успешном выполнении Пример: `"00:03:4A"`
primary_volume_id integer	Идентификатор основного тома. Возвращается: при успешном выполнении Пример: `842`
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:06:36"`
secondary_volume_id integer	Идентификатор вторичного тома. Возвращается: при успешном выполнении Пример: `1590`
snapshot_group_name string	Имя группы снимков. Возвращается: при успешном выполнении Пример: `"spc-snapshot"`
snapshot_id string	Идентификатор снимка. Возвращается: при успешном выполнении Пример: `"842,3"`
split_time string	Время разделения снимка. Возвращается: при успешном выполнении Пример: `"2025-06-27T23:28:06"`
status string	Состояние снимка. Возвращается: при успешном выполнении Пример: `"PSUS"`
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_group_module.html