Модуль hitachivantara.vspone_block.vsp.hv_shadow_image_pair — управление парами теневых образов в блочных системах хранения 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_shadow_image_pair.
Добавлено в hitachivantara.vspone_block 3.0.0
Краткое описание
- Этот модуль позволяет создавать, удалять, разделять, синхронизировать, восстанавливать и переносить пары теневых образов в блочных системах хранения VSP.
- Поддерживаются различные операции с парами теневых образов в зависимости от указанного уровня задачи.
- Примеры см. по ссылке https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/shadow_image_pair.yml
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.9
Параметры
Параметр | Комментарии |
|---|---|
connection_info dictionary / обязательный | Информация, необходимая для подключения к системе хранения. |
|
address string / обязательный |
IP-адрес или имя узла системы хранения. |
|
api_token string |
Токен для выполнения операций с заблокированными ресурсами. |
|
connection_type string |
Тип подключения к системе хранения. Варианты:
|
|
password string |
Пароль для аутентификации. Это обязательное поле. |
|
username string |
Имя пользователя для аутентификации. Это обязательное поле. |
spec dictionary / обязательный | Спецификация задачи с парами теневых образов. |
|
allocate_new_consistency_group boolean |
Новая группа согласованности. Необязательный параметр для задач создания пары ShadowImage для существующего вторичного тома / создания пары ShadowImage для несуществующего вторичного тома / создания и автоматического разделения пары ShadowImage. Варианты:
|
|
auto_split boolean |
Автоматическое разделение. Необязательный параметр для задач создания пары ShadowImage для существующего вторичного тома / создания пары ShadowImage для несуществующего вторичного тома. Варианты:
|
|
consistency_group_id integer |
Идентификатор группы согласованности. Необязательный параметр для задачи создания и автоматического разделения пары ShadowImage. |
|
copy_group_name string |
Имя группы копирования. Обязательный параметр для задач создания пары ShadowImage для существующего вторичного тома / создания пары ShadowImage для несуществующего вторичного тома / разделения пары ShadowImage / повторной синхронизации пары ShadowImage / создания и автоматического разделения пары ShadowImage / восстановления пары ShadowImage / переноса пары ShadowImage / отмены переноса пары ShadowImage / удаления пары ShadowImage / принудительного удаления пары ShadowImage / создания пары ShadowImage для существующего вторичного тома с целью переноса / создания пары ShadowImage для несуществующего вторичного тома с целью переноса. |
|
copy_pace псевдонимы: copy_pace_track_size string |
Размер дорожки темпа копирования. Необязательный параметр для задач создания пары ShadowImage для существующего вторичного тома / Поддерживаются значения «SMALL», «MEDIUM», «LARGE» или числа от 1 до 15. / создания пары ShadowImage для несуществующего вторичного тома / повторной синхронизации пары ShadowImage / создания и автоматического разделения пары ShadowImage / восстановления пары ShadowImage. |
|
copy_pair_name string |
Имя пары копирования. Обязательный параметр для задач создания пары ShadowImage для существующего вторичного тома / создания пары ShadowImage для несуществующего вторичного тома / разделения пары ShadowImage / повторной синхронизации пары ShadowImage / создания и автоматического разделения пары ShadowImage / восстановления пары ShadowImage / переноса пары ShadowImage / отмены переноса пары ShadowImage / удаления пары ShadowImage / принудительного удаления пары ShadowImage / создания пары ShadowImage для существующего вторичного тома с целью переноса / создания пары ShadowImage для несуществующего вторичного тома с целью переноса. |
|
create_for_migration boolean |
Укажите, чтобы создать пару теневых образов для переноса. Обязательный параметр для задач создания пары ShadowImage для существующего вторичного тома с целью переноса / создания пары ShadowImage для несуществующего вторичного тома с целью переноса. Варианты:
|
|
enable_quick_mode boolean |
Включить быстрый режим. Необязательный параметр для задач создания пары ShadowImage для существующего вторичного тома / создания пары ShadowImage для несуществующего вторичного тома / разделения пары ShadowImage / повторной синхронизации пары ShadowImage / восстановления пары ShadowImage. Варианты:
|
|
enable_read_write boolean |
Включить режим чтения и записи. Необязательный параметр для задачи разделения пары ShadowImage. Варианты:
|
|
is_data_reduction_force_copy boolean |
Включить принудительное копирование с сокращением объёма данных. Варианты:
|
|
mirror_unit_number псевдонимы: pvol_mu_number integer |
Номер блока зеркалирования первичного тома. Необязательный параметр для создания пары ShadowImage. |
|
pair_id string |
Идентификатор пары. |
|
primary_volume_device_group_name string |
Имя устройства первичного тома. Необязательный параметр для задач создания пары ShadowImage для существующего вторичного тома / создания пары ShadowImage для несуществующего вторичного тома / создания пары ShadowImage для существующего вторичного тома с целью переноса / создания пары ShadowImage для несуществующего вторичного тома с целью переноса. |
|
primary_volume_id string |
Идентификатор первичного тома. Обязательный параметр для задач создания пары ShadowImage для существующего вторичного тома / создания пары ShadowImage для несуществующего вторичного тома / создания и автоматического разделения пары ShadowImage / создания пары ShadowImage для существующего вторичного тома с целью переноса. Необязательный параметр для задач разделения пары ShadowImage / повторной синхронизации пары ShadowImage / восстановления пары ShadowImage / удаления пары ShadowImage / принудительного удаления пары ShadowImage / создания пары ShadowImage для несуществующего вторичного тома с целью переноса. |
|
secondary_pool_id integer |
Идентификатор пула вторичного хранилища. Необязательный параметр для задачи создания пары ShadowImage для несуществующего вторичного тома с целью переноса. |
|
secondary_volume_device_group_name string |
Имя устройства вторичного тома. Необязательный параметр для задач создания пары ShadowImage для существующего вторичного тома / создания пары ShadowImage для несуществующего вторичного тома / создания пары ShadowImage для существующего вторичного тома с целью переноса / создания пары ShadowImage для несуществующего вторичного тома с целью переноса. |
|
secondary_volume_id string |
Идентификатор вторичного тома. Обязательный параметр для задач создания пары ShadowImage для существующего вторичного тома / создания пары ShadowImage для несуществующего вторичного тома / создания и автоматического разделения пары ShadowImage / создания пары ShadowImage для существующего вторичного тома с целью переноса. Необязательный параметр для задач разделения пары ShadowImage / повторной синхронизации пары ShadowImage / восстановления пары ShadowImage / удаления пары ShadowImage / принудительного удаления пары ShadowImage. |
|
should_delete_svol boolean |
Укажите, следует ли удалить SVOL из группы узлов, целевого объекта iSCSI и подсистемы NVM. Обязательный параметр для задачи принудительного удаления пары ShadowImage. Варианты:
|
|
should_force_split boolean |
Укажите, следует ли выполнить принудительное разделение. Необязательный параметр для задачи отмены переноса пары ShadowImage. Варианты:
|
state string | Уровень задачи с парами теневых образов. Возможные варианты: Варианты:
|
storage_system_info dictionary | Информация о системе хранения. Это необязательное поле. |
|
serial string |
Серийный номер системы хранения. |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: нет | Определяет, должен ли модуль выполняться в режиме проверки. |
Примечания
Примечание
- Выходные параметры
entitlement_status,subscriber_idиpartner_idудалены в версии 3.4.0. Они также объявлены устаревшими из-за упрощения внутреннего API и больше не поддерживаются. - Тип подключения
gatewayудалён начиная с версии 3.4.0. Если вам нужен этот тип подключения, используйте более раннюю версию. - При автоматическом создании SVOL в процессе настройки пары система создаёт одну вторичную группу узлов/целевой объект iSCSI.
- Пара ShadowImage поддерживает протоколы Fibre Channel, NVMe over FC, NVMe over TCP и iSCSI.
- В режиме Direct можно создать пару ShadowImage, не указывая идентификатор вторичного тома. Вместо этого укажите в спецификации идентификатор пула вторичных томов. Затем Ansible автоматически создаст S-VOL и назначит его той же подсистеме NVMe, группе узлов и целевому объекту iSCSI, что и P-VOL.
- Для создания пары ShadowImage для существующего вторичного тома
-
- При создании пары ShadowImage, если первичный том (P-VOL) совпадает, используйте другое имя группы копирования. Если P-VOL отличается, можно повторно использовать то же имя группы копирования. Имя пары копирования всегда должно быть уникальным.
- Для переноса пары ShadowImage
-
- После завершения копирования и синхронизации данных между исходным и целевым томами идентификатор LDEV и операции ввода-вывода узла для исходного тома меняются местами с соответствующими значениями целевого тома. С точки зрения узла настройки тома и пути остаются неизменными. Однако фактические данные теперь находятся на томе, подготовленном для переноса.
- Для отмены переноса пары ShadowImage
-
- При отмене переноса пары её состояние меняется на SMPL, что позволяет перезапустить процесс переноса.
- Для создания пары ShadowImage для существующего вторичного тома с целью переноса
-
- При создании пары томов для переноса её состояние устанавливается в SMPL. Данные остаются неизменными до начала процесса переноса.
- Для создания пары ShadowImage для несуществующего вторичного тома с целью переноса
-
- S-VOL будет создан автоматически и сопоставлен с той же подсистемой NVMe, группой узлов и целевым объектом iSCSI, что и P-VOL. При создании пары томов для переноса состояние пары устанавливается в SMPL. Данные не копируются до выполнения переноса.
Примеры
- name: Create shadow image pair for non-existing secondary volume
hitachivantara.vspone_block.vsp.hv_shadow_image_pair:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
state: "present"
spec:
primary_volume_id: 274
secondary_pool_id: 1
allocate_new_consistency_group: true
copy_pace: "MEDIUM"
enable_quick_mode: false
auto_split: true
copy_group_name: "CGTest"
copy_pair_name: "CPTest"
primary_volume_device_group_name: "CPTestP"
secondary_volume_device_group_name: "CPTestS"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, далее перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
data dictionary | Вновь созданный объект пары теневых образов. Возвращается: при успехе |
|
consistency_group_id integer |
Идентификатор группы согласованности. Возвращается: при успехе Пример: |
|
copy_group_name string |
Имя группы копирования. Возвращается: при успехе Пример: |
|
copy_pace_track_size string |
Размер дорожки при копировании. Возвращается: при успехе Пример: |
|
copy_pair_name string |
Имя пары копирования. Возвращается: при успехе Пример: |
|
copy_rate integer |
Скорость копирования. Возвращается: при успехе Пример: |
|
mirror_unit_id integer |
Устарело. Используйте вместо этого mirror_unit_number. Возвращается: при успехе Пример: |
|
mirror_unit_number integer |
Номер зеркального устройства. Возвращается: при успехе Пример: |
|
primary_volume_host_groups list / elements=dictionary |
Группы хостов основного тома. Возвращается: при успехе Пример: |
|
primary_volume_id integer |
Идентификатор основного тома. Возвращается: при успехе Пример: |
|
primary_volume_id_hex string |
Шестнадцатеричный идентификатор основного тома. Возвращается: при успехе Пример: |
|
primary_volume_iscsi_targets list / elements=dictionary |
Цели iSCSI основного тома. Возвращается: при успехе Пример: |
|
primary_volume_nvm_subsystem_name string |
Имя подсистемы NVM основного тома. Возвращается: при успехе Пример: |
|
pvol_host_groups list / elements=dictionary |
Устарело. Используйте вместо этого primary_volume_host_groups. Возвращается: при успехе Пример: |
|
pvol_iscsi_targets list / elements=dictionary |
Устарело. Используйте вместо этого primary_volume_iscsi_targets. Возвращается: при успехе Пример: |
|
pvol_nvm_subsystem_name string |
Устарело. Используйте вместо этого primary_volume_nvm_subsystem_name. Возвращается: при успехе Пример: |
|
secondary_volume_host_groups list / elements=dictionary |
Группы хостов вторичного тома. Возвращается: при успехе Пример: |
|
secondary_volume_id integer |
Идентификатор вторичного тома. Возвращается: при успехе Пример: |
|
secondary_volume_id_hex string |
Шестнадцатеричный идентификатор вторичного тома. Возвращается: при успехе Пример: |
|
secondary_volume_iscsi_targets list / elements=dictionary |
Цели iSCSI вторичного тома. Возвращается: при успехе Пример: |
|
secondary_volume_nvm_subsystem_name string |
Имя подсистемы NVM вторичного тома. Возвращается: при успехе Пример: |
|
status string |
Статус. Возвращается: при успехе Пример: |
|
storage_serial_number string |
Серийный номер системы хранения данных. Возвращается: при успехе Пример: |
|
svol_host_groups list / elements=dictionary |
Устарело. Используйте вместо этого secondary_volume_host_groups. Возвращается: при успехе Пример: |
|
svol_iscsi_targets list / elements=dictionary |
Устарело. Используйте вместо этого secondary_volume_iscsi_targets. Возвращается: при успехе Пример: |
|
svol_nvm_subsystem_name string |
Устарело. Используйте вместо этого secondary_volume_nvm_subsystem_name. Возвращается: при успехе Пример: |
Ссылки на коллекцию
© 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_shadow_image_pair_module.html