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

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

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

Общие сведения

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

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info словарь / обязательный	Сведения, необходимые для установления подключения к системе хранения данных.
address строка / обязательный	IP-адрес или имя узла системы хранения данных.
api_token строка	Токен для работы с заблокированными ресурсами.
connection_type строка	Тип подключения к системе хранения данных. Варианты: `"direct"` ← (по умолчанию)
password строка	Пароль для аутентификации. Это обязательное поле.
username строка	Имя пользователя для аутентификации. Это обязательное поле.
secondary_connection_info словарь	Сведения, необходимые для установления подключения к вторичной системе хранения данных.
address строка / обязательный	IP-адрес или имя узла системы хранения данных Hitachi.
api_token строка	Это поле используется для передачи значения токена блокировки вторичной системы хранения данных, необходимого для работы с заблокированными ресурсами.
password строка	Пароль для аутентификации. Это обязательное поле, если не указан api_token.
username строка	Имя пользователя для аутентификации. Это обязательное поле, если не указан api_token.
spec словарь	Спецификация задачи для пар TrueCopy.
begin_secondary_volume_id строка	Укажите начальный идентификатор LDEV для диапазона LDEV тома SVOL. Это необязательное поле при создании. Если это поле указано, необходимо также указать end_secondary_volume_id. Если это поле не указано, модули Ansible попытаются создать идентификатор SVOL, совпадающий с идентификатором PVOL, если он доступен; в противном случае будет использоваться первый доступный идентификатор LDEV.
consistency_group_id целое число	Идентификатор группы согласованности: от 0 до 255. Это необязательное поле.
copy_group_name строка	Имя группы копирования. Это обязательное поле при создании. Для других операций это поле необязательное, но его указание ускоряет выполнение операции. Обязательно для задач разбиения пары TrueCopy по имени группы копирования и идентификатору первичного тома / синхронизации пары TrueCopy по имени группы копирования и имени пары копирования / синхронизации пары TrueCopy / синхронизации пары TrueCopy по имени группы копирования и идентификатору первичного тома / обмена и разбиения пары TrueCopy по имени группы копирования и имени пары копирования / обмена и разбиения пары TrueCopy / обмена и разбиения пары TrueCopy по имени группы копирования и идентификатору первичного тома / обмена и повторной синхронизации пары TrueCopy по имени группы копирования и имени пары копирования / обмена и повторной синхронизации пары TrueCopy / обмена и повторной синхронизации пары TrueCopy по имени группы копирования и идентификатору первичного тома / удаления пары TrueCopy по имени группы копирования и имени пары копирования / удаления пары TrueCopy / удаления пары TrueCopy по имени группы копирования и идентификатору первичного тома / развертывания пары TrueCopy.
copy_pace строка	Скорость копирования. При создании параметр необязателен. По умолчанию: `"3"`
copy_pair_name строка	Имя пары копирования. Это обязательное поле при создании. Для других операций это поле необязательное, но его указание ускоряет выполнение операции. Обязательно для задач синхронизации пары TrueCopy по имени группы копирования и имени пары копирования / синхронизации пары TrueCopy / обмена и разбиения пары TrueCopy по имени группы копирования и имени пары копирования / обмена и разбиения пары TrueCopy / обмена и повторной синхронизации пары TrueCopy по имени группы копирования и имени пары копирования / обмена и повторной синхронизации пары TrueCopy / удаления пары TrueCopy по имени группы копирования и имени пары копирования / удаления пары TrueCopy / развертывания пары TrueCopy.
do_initial_copy логическое значение	Выполнить начальное копирование. Это необязательное поле при создании. Варианты: `false` `true` ← (по умолчанию)
end_secondary_volume_id строка	Укажите конечный идентификатор LDEV для диапазона LDEV тома SVOL. Это необязательное поле при создании. Если это поле указано, необходимо также указать begin_secondary_volume_id. Если это поле не указано, модули Ansible попытаются создать идентификатор SVOL, совпадающий с идентификатором PVOL, если он доступен; в противном случае будет использоваться первый доступный идентификатор LDEV.
fence_level строка	Задает уровень ограждения первичного тома и определяет, будет ли хост лишен доступа к первичному тому или продолжит обращаться к нему при приостановке пары из-за ошибки. Это необязательное поле. Варианты: `"NEVER"` ← (по умолчанию) `"DATA"` `"STATUS"`
is_consistency_group логическое значение	Это необязательное поле при создании. В зависимости от значения атрибут указывает, следует ли регистрировать новую пару в группе согласованности. Если значение true, новая пара регистрируется в группе согласованности. Если значение false, новая пара не регистрируется в группе согласованности. Варианты: `false` ← (по умолчанию) `true`
is_data_reduction_force_copy логическое значение	Принудительное копирование при сокращении объема данных. Это необязательное поле при создании. Варианты: `false` `true` ← (по умолчанию)
is_new_group_creation логическое значение	Создать новую группу копирования. Это необязательное поле при создании. Варианты: `false` `true`
is_svol_readwriteable логическое значение	Применимо только для операции разбиения пары. Если значение true, после разбиения вторичный том будет доступен для чтения и записи. Необязательно для задач разбиения пары TrueCopy с указанием только обязательных полей / разбиения пары TrueCopy. Варианты: `false` ← (по умолчанию) `true`
local_device_group_name строка	Имя локальной группы устройств. Это необязательное поле.
new_volume_size строка	Требуется только для операции изменения размера или расширения. Значение должно быть больше текущего размера тома.
path_group_id целое число	Это необязательное поле при создании. Укажите идентификатор группы путей в диапазоне от 0 до 255. Если вы не уверены, не используйте этот параметр. Если опустить это значение или указать 0, будет использоваться наименьший идентификатор группы путей в указанной группе путей.
primary_volume_id строка	Идентификатор первичного тома. Это обязательное поле при создании. Обязательно для задач разбиения пары TrueCopy по имени группы копирования и идентификатору первичного тома / синхронизации пары TrueCopy по имени группы копирования и идентификатору первичного тома / обмена и разбиения пары TrueCopy по имени группы копирования и идентификатору первичного тома / обмена и повторной синхронизации пары TrueCopy по имени группы копирования и идентификатору первичного тома / удаления пары TrueCopy по имени группы копирования и идентификатору первичного тома.
provisioned_secondary_volume_id строка	Идентификатор подготовленного вторичного тома, который требуется использовать для создания пары TrueCopy. Обязательно для задач создания пары TrueCopy с provisioned_secondary_volume_id / создания пары TrueCopy с provisioned_secondary_volume_id и группами хостов.
remote_device_group_name строка	Имя удаленной группы устройств. Это необязательное поле.
secondary_hostgroup словарь	Устарело. Используйте secondary_hostgroups. Обязательно для задач создания пары TrueCopy с указанием только обязательных полей / создания пары TrueCopy с provisioned_secondary_volume_id и группами хостов / создания пары TC с использованием диапазона идентификаторов вторичного тома.
lun_id целое число	Идентификатор LUN группы хостов во вторичной системе хранения данных. Обязательно при создании.
name строка / обязательный	Имя группы хостов во вторичной системе хранения данных. Обязательно при создании.
port_id псевдонимы: port строка / обязательный	Идентификатор порта группы хостов во вторичной системе хранения данных. Обязательно при создании. Параметр port устарел, используйте вместо него port_id.
secondary_hostgroups список / элементы=словарь	Список объектов групп хостов для вторичного тома.
lun_id целое число	Идентификатор LUN группы хостов во вторичной системе хранения данных. Не требуется при создании.
name строка / обязательный	Имя группы хостов во вторичной системе хранения данных. Обязательно при создании.
port_id псевдонимы: port строка / обязательный	Идентификатор порта группы хостов во вторичной системе хранения данных. Обязательно при создании. Параметр port устарел, используйте вместо него port_id.
secondary_iscsi_targets список / элементы=словарь	Список целей iSCSI на вторичном устройстве хранения данных. Обязательно для задач создания пары TrueCopy-ISCSI с указанием только обязательных полей / создания пары TrueCopy-ISCSI с указанием всех полей.
lun_id целое число	Идентификатор LUN. Обязательно для задач создания пары TrueCopy-ISCSI с указанием только обязательных полей / создания пары TrueCopy-ISCSI с указанием всех полей.
name строка / обязательный	Имя цели iSCSI. Обязательно для задач создания пары TrueCopy-ISCSI с указанием только обязательных полей / создания пары TrueCopy-ISCSI с указанием всех полей.
port_id псевдонимы: port строка / обязательный	Идентификатор порта. Обязательно для задач создания пары TrueCopy-ISCSI с указанием только обязательных полей / создания пары TrueCopy-ISCSI с указанием всех полей. Параметр port устарел, используйте вместо него port_id.
secondary_nvm_subsystem словарь	Сведения о подсистеме NVM вторичного тома. Обязательно для задач создания пары TrueCopy-NVMe с указанием только обязательных полей / создания пары TrueCopy-NVMe с указанием всех полей.
name строка / обязательный	Имя подсистемы NVM во вторичной системе хранения данных. Обязательно для задач создания пары TrueCopy-NVMe с указанием только обязательных полей / создания пары TrueCopy-NVMe с указанием всех полей.
paths список / элементы=строка	Сведения о путях Host NQN во вторичной системе хранения данных. Обязательно для задач создания пары TrueCopy-NVMe с указанием только обязательных полей / создания пары TrueCopy-NVMe с указанием всех полей.
secondary_pool_id целое число	Идентификатор динамического пула, в котором будет создан вторичный том. Обязательно для задач создания пары TrueCopy с указанием только обязательных полей / создания пары TC с использованием диапазона идентификаторов вторичного тома / создания пары TrueCopy-NVMe с указанием только обязательных полей / создания пары TrueCopy-NVMe с указанием всех полей / создания пары TrueCopy-ISCSI с указанием только обязательных полей / создания пары TrueCopy-ISCSI с указанием всех полей.
should_delete_svol логическое значение	Укажите true, чтобы удалить SVOL. Необязательный параметр для задачи удаления пары TrueCopy. Варианты: `false` ← (по умолчанию) `true`
state строка	Уровень задачи для пар TrueCopy. `present` используется для создания или обновления пары TrueCopy. `absent` используется для удаления пары TrueCopy. `expand` или `resize` используется для увеличения размера томов пары TrueCopy. `resync` используется для повторной синхронизации пары TrueCopy. `split` используется для разбиения пары TrueCopy. `swap-split` используется для обмена и разбиения пары TrueCopy. `swap-resync` используется для обмена и повторной синхронизации пары TrueCopy. Варианты: `"present"` ← (по умолчанию) `"absent"` `"split"` `"resync"` `"resize"` `"expand"` `"swap_split"` `"swap_resync"`

storage_system_info dictionary	Информация о системе хранения. Это необязательное поле.
serial string	Серийный номер системы хранения.

Атрибуты

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

Примечания

Примечание

Выходные параметры entitlement_status, subscriber_id и partner_id удалены в версии 3.4.0. Они также объявлены устаревшими из-за упрощения внутреннего API и больше не поддерживаются.
Тип подключения gateway удален начиная с версии 3.4.0. Если вам требуется этот тип подключения, используйте более раннюю версию.
Модули Ansible используют технологию, называемую группой копирования, для управления всеми типами пар удаленной репликации (GAD, TC, HUR). Поэтому пары репликации, созданные с помощью инструментов, не использующих технологию группы копирования, несовместимы с модулями Ansible. В результате модули Ansible не могут управлять парами репликации, созданными без технологии группы копирования.
Прежде чем управлять парой TrueCopy через Ansible Direct Connect, необходимо зарегистрировать (или попарно связать) исходную и целевую системы хранения на сервере API исходной системы хранения. Этот шаг необходим, поскольку Ansible использует вызовы REST API на серверной стороне. Если пропустить этот шаг — особенно если вы не знакомы с REST API Hitachi, — при управлении парой TrueCopy через Ansible возникнут ошибки. Инструкции см. в разделе «Управление регистрацией удаленных систем хранения».
Прежде чем создавать пару TrueCopy, добавьте P-VOL в группу хостов, целевой объект iSCSI или подсистему NVM в основной системе хранения. Затем определите группу хостов, которую следует использовать во вторичной системе хранения.
Создание пары TrueCopy с указанием только обязательных полей, с указанием всех полей и с использованием диапазона для идентификатора вторичного тома
1. Если P-VOL не имеет имени, S-VOL получит имя в формате smrha-[ldev_id]. Если P-VOL имеет имя, S-VOL следует присвоить то же имя. (Здесь smrha означает Storage Module Red Hat Ansible.)
Расширение пары TrueCopy
1. Сначала увеличивается размер S-VOL, затем размер P-VOL. Если пара находится в состоянии PAIR, перед изменением размера она разделяется. После завершения операции изменения размера пара синхронизируется повторно.
1. Чтобы использовать этот API, включите System Option Mode (SOM) 1198 и отключите SOM 1199 в обеих системах хранения — основной и вторичной.

Примеры

- name: Create a TrueCopy pair
  hitachivantara.vspone_block.vsp.hv_truecopy:
    state: "present"
    connection_info:
      address: 172.1.1.126
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: 172.1.1.127
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "copy_group_name_1"
      copy_pair_name: "copy_pair_name_1"
      primary_volume_id: 11
      is_consistency_group: true
      fence_level: 'NEVER'
      secondary_pool_id: 1
      secondary_hostgroup:
        name: ansible_test_group
        port_id: CL1-A
        lun_id: 1

- name: Split a TrueCopy pair
  hitachivantara.vspone_block.vsp.hv_truecopy:
    state: "split"
    connection_info:
      address: 172.1.1.126
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: 172.1.1.127
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "copy_group_name_1"
      copy_pair_name: "copy_pair_name_1"

- name: Resync a TrueCopy pair
  hitachivantara.vspone_block.vsp.hv_truecopy:
    state: "resync"
    connection_info:
      address: 172.1.1.126
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: 172.1.1.127
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "copy_group_name_1"
      copy_pair_name: "copy_pair_name_1"

- name: Swap-split a TrueCopy pair
  hitachivantara.vspone_block.vsp.hv_truecopy:
    state: "swap_split"
    connection_info:
      address: 172.1.1.127
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: 172.1.1.126
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "copy_group_name_1"
      copy_pair_name: "copy_pair_name_1"

- name: Swap-resync a TrueCopy pair
  hitachivantara.vspone_block.vsp.hv_truecopy:
    state: "swap_resync"
    connection_info:
      address: 172.1.1.127
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: 172.1.1.126
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "copy_group_name_1"
      copy_pair_name: "copy_pair_name_1"

- name: Delete a TrueCopy pair
  hitachivantara.vspone_block.vsp.hv_truecopy:
    state: "swap_resync"
    connection_info:
      address: 172.1.1.126
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: 172.1.1.127
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "copy_group_name_1"
      copy_pair_name: "copy_pair_name_1"

- name: Increase the size of the volumes of a TrueCopy pair
  hitachivantara.vspone_block.vsp.hv_truecopy:
    state: "expand"
    connection_info:
      address: 172.1.1.126
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: 172.1.1.127
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "copy_group_name_1"
      copy_pair_name: "copy_pair_name_1"
      new_volume_size: 4GB

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

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

Ключ	Описание
truecopy_info list / elements=dictionary	Список объектов пар TrueCopy, возвращаемых модулем. Возвращается: success
consistency_group_id integer	Идентификатор группы согласованности. Возвращается: success Пример: `-1`
copy_group_name string	Имя группы копирования. Возвращается: success Пример: `"ESD_TC_CG"`
copy_pair_name string	Имя пары копирования. Возвращается: success Пример: `"ESD_TC_CP"`
copy_progress_rate integer	Устарело. Скорость выполнения копирования. Возвращается: success Пример: `-1`
fence_level string	Уровень изоляции. Возвращается: success Пример: `"NEVER"`
local_device_group_name string	Имя локальной группы устройств, для которой извлекаются сведения о паре TrueCopy. Возвращается: success Пример: `"tc_bulk_cg_1P_"`
primary_volume_id integer	Идентификатор основного тома. Возвращается: success Пример: `11`
primary_volume_id_hex string	Идентификатор основного тома в шестнадцатеричном формате. Возвращается: success Пример: `"00:00:0B"`
primary_volume_size string	Размер основного тома. Возвращается: success Пример: `"4.00GB"`
primary_volume_status string	Состояние основного тома. Возвращается: success Пример: `"PAIR"`
primary_volume_storage_serial_number string	Серийный номер системы хранения для основного тома. Возвращается: success Пример: `"810050"`
pvol_status string	Устарело. Используйте вместо этого primary_volume_status. Возвращается: success Пример: `"PAIR"`
pvol_storage_device_id string	Устарело. Идентификатор устройства хранения PVOL. Возвращается: success Пример: `"A00000970041"`
remote_device_group_name string	Имя удаленной группы устройств, для которой извлекаются сведения о паре TrueCopy. Возвращается: success Пример: `"tc_bulk_cg_1S_"`
remote_mirror_copy_pair_id string	Идентификатор пары копирования удаленного зеркала. Возвращается: success Пример: `"A00000970045,ESD_TC_CG,ESD_TC_CGP_,ESD_TC_CGS_,ESD_TC_CP"`
secondary_volume_id integer	Идентификатор вторичного тома. Возвращается: success Пример: `11`
secondary_volume_id_hex string	Идентификатор вторичного тома в шестнадцатеричном формате. Возвращается: success Пример: `"00:00:0B"`
secondary_volume_size string	Размер вторичного тома. Возвращается: success Пример: `"4.00GB"`
secondary_volume_status string	Состояние вторичного тома. Возвращается: success Пример: `"PAIR"`
secondary_volume_storage_serial_number string	Серийный номер системы хранения для вторичного тома. Возвращается: success Пример: `"810045"`
storage_serial_number string	Устарело. Используйте вместо этого primary_volume_storage_serial_number. Возвращается: success Пример: `"810050"`
svol_status string	Устарело. Используйте вместо этого secondary_volume_status. Возвращается: success Пример: `"PAIR"`
svol_storage_device_id string	Устарело. Идентификатор устройства хранения SVOL. Возвращается: success Пример: `"A34000810045"`

Авторы

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_truecopy_module.html