hitachivantara.vspone_block.vsp.hv_hur module – Manages HUR pairs on Hitachi VSP storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install hitachivantara.vspone_block. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hitachivantara.vspone_block.vsp.hv_hur.

New in hitachivantara.vspone_block 3.1.0

Synopsis

• This module allows for the creation, deletion, splitting, swap splitting, re-syncing and swap-resyncing of HUR pairs on Hitachi VSP storage systems.

• For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/hur.yml

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.9

Parameters

Parameter	Comments
connection_info dictionary / required	Information required to establish a connection to the storage system.
address string / required	IP address or hostname of the storage system.
api_token string	Token used to operate on locked resources.
connection_type string	Type of connection to the storage system. Choices: "direct" ← (default)
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
secondary_connection_info dictionary	Information required to establish a connection to the secondary storage system.
address string / required	IP address or hostname of the secondary storage system.
api_token string	Value of the lock token to operate on locked resources.
password string	Password for authentication for the secondary storage system if api_token is not provided.
username string	Username for authentication for the secondary storage system if api_token is not provided.
spec dictionary / required	Specification for the HUR pairs task.
allocate_new_consistency_group boolean	Specify whether to allocate a new consistency group. Choices: false ← (default) true
begin_secondary_volume_id string	Specify beginning ldev id for LDEV range for svol. Required for the Create a HUR pair using a range for secondary volume ID task. If this field is specified, end_secondary_volume_id must also be specified. If this field is not specified, Ansible modules will try to create SVOL ID same as the PVOL ID if available, otherwise it will use the first available LDEV ID.
consistency_group_id integer	Consistency group ID. Optional for the Create HUR pair in new copy group /Create a HUR pair using a range for secondary volume ID /Create HUR-NVMe pair /Create HUR-ISCSI pair /Create HUR pair and debug result /Create HUR-iSCSI pair and debug result /Create HUR-NVMe pair and debug result tasks.
copy_group_name string	Name of the copy group. Required for the Create HUR pair in new copy group /Create HUR pair with existing copy group /Create a HUR pair using a range for secondary volume ID /Create HUR-NVMe pair /Create HUR-ISCSI pair /Create HUR pair with provisioned_secondary_volume_id /Create HUR pair with provisioned_secondary_volume_id and hostgroups /Split HUR pair /Resync HUR pair /Swap-Split HUR pair /Swap-Resync HUR pair /Delete HUR pair /Expand HUR pair /Secondary volume takeover HUR pair /Create HUR pair and debug result /Create HUR-iSCSI pair and debug result /Create HUR-NVMe pair and debug result tasks.
copy_pair_name string	Name of the copy pair. Required for the Create HUR pair in new copy group /Create HUR pair with existing copy group /Create a HUR pair using a range for secondary volume ID /Create HUR-NVMe pair /Create HUR-ISCSI pair /Create HUR pair with provisioned_secondary_volume_id /Create HUR pair with provisioned_secondary_volume_id and hostgroups /Split HUR pair /Resync HUR pair /Swap-Split HUR pair /Swap-Resync HUR pair /Delete HUR pair /Expand HUR pair /Secondary volume takeover HUR pair /Create HUR pair and debug result /Create HUR-iSCSI pair and debug result /Create HUR-NVMe pair and debug result tasks.
do_delta_resync_suspend boolean	Specify whether to enable delta resync suspend. Choices: false true
do_initial_copy boolean	Perform initial copy. This is an optional field during create operation. Choices: false true ← (default)
enable_delta_resync boolean	Specify whether to enable delta resync. Choices: false ← (default) true
end_secondary_volume_id string	Specify end ldev id for LDEV range for svol. Required for the Create a HUR pair using a range for secondary volume ID task. If this field is specified, begin_secondary_volume_id must also be specified. If this field is not specified, Ansible modules will try to create SVOL ID same as PVOL ID iff available, otherwise it will use the first available LDEV ID.
fence_level string	Specifies the primary volume fence level setting and determines if the host is denied access or continues to access the primary volume when the pair is suspended because of an error. This is an optional field. Choices: "ASYNC" ← (default)
is_consistency_group boolean	Specify whether to enable consistency group. Choices: false ← (default) true
is_data_reduction_force_copy boolean	Force copy for data reduction. Optional for the Create HUR pair in new copy group /Create HUR-NVMe pair /Create HUR-ISCSI pair tasks. Choices: false ← (default) true
is_new_group_creation boolean	Specify whether to enable new group creation. Choices: false true
is_svol_readwriteable boolean	Specify whether to enable secondary volume read writeable. Optional for Split HUR pair task. Choices: false true
local_device_group_name string	Name of the local device group name. Optional for the Create HUR pair in new copy group /Create a HUR pair using a range for secondary volume ID /Create HUR-NVMe pair /Create HUR-ISCSI pair /Split HUR pair /Resync HUR pair /Swap-Split HUR pair /Swap-Resync HUR pair /Delete HUR pair /Create HUR pair and debug result /Create HUR-iSCSI pair and debug result /Create HUR-NVMe pair and debug result tasks.
mirror_unit_id integer	Mirror Unit Id. Optional for the Create HUR pair in new copy group /Create a HUR pair using a range for secondary volume ID /Create HUR-NVMe pair /Create HUR-ISCSI pair /Create HUR pair with provisioned_secondary_volume_id /Create HUR pair with provisioned_secondary_volume_id and hostgroups /Create HUR-iSCSI pair and debug result /Create HUR-NVMe pair and debug result tasks. Choices: 0 1 2 3
new_volume_size string	New volume size. Required for the Expand HUR pair task.
path_group_id integer	Optional for the Create HUR pair in new copy group /Create HUR-NVMe pair /Create HUR-ISCSI pair tasks. Specify the path group ID in the range from 0 to 255. If you are unsure don’t use this parameter. If you omit this value or specify 0, the lowest path group ID in the specified path group is used.
primary_volume_id string	Primary volume id. Required for the Create HUR pair in new copy group /Create HUR pair with existing copy group /Create a HUR pair using a range for secondary volume ID /Create HUR-NVMe pair /Create HUR-ISCSI pair /Create HUR pair with provisioned_secondary_volume_id /Create HUR pair with provisioned_secondary_volume_id and hostgroups /Create HUR pair and debug result /Create HUR-iSCSI pair and debug result /Create HUR-NVMe pair and debug result tasks.
primary_volume_journal_id integer	Primary volume journal id. Required for the Create HUR pair in new copy group /Create a HUR pair using a range for secondary volume ID /Create HUR-ISCSI pair /Create HUR pair with provisioned_secondary_volume_id /Create HUR pair with provisioned_secondary_volume_id and hostgroups /Create HUR pair and debug result /Create HUR-iSCSI pair and debug result /Create HUR-NVMe pair and debug result tasks. Optional for the Create HUR-NVMe pair task.
provisioned_secondary_volume_id string	ID of the provisioned secondary volume that you want to use for the HUR pair creation. Required for the Create HUR pair with provisioned_secondary_volume_id /Create HUR pair with provisioned_secondary_volume_id and hostgroups tasks.
remote_device_group_name string	Name of the remote device group name. Optional for the Create HUR pair in new copy group /Create a HUR pair using a range for secondary volume ID /Create HUR-NVMe pair /Create HUR-ISCSI pair /Split HUR pair /Resync HUR pair /Swap-Split HUR pair /Swap-Resync HUR pair /Delete HUR pair /Create HUR pair and debug result /Create HUR-iSCSI pair and debug result /Create HUR-NVMe pair and debug result tasks. Required for the Secondary volume takeover HUR pair task.
secondary_hostgroup dictionary	Host group details of secondary volume. Required for the Create HUR pair in new copy group /Create HUR pair with existing copy group /Create a HUR pair using a range for secondary volume ID /Create HUR pair with provisioned_secondary_volume_id and hostgroups tasks. Optional for the Create HUR pair and debug result task.
lun_id integer	LUN ID can be provided along with host group on the secondary storage system. Optional for the Create HUR pair in new copy group /Create HUR pair with existing copy group tasks. Required for the Create HUR pair with provisioned_secondary_volume_id and hostgroups task.
name string / required	Name of the host group on the secondary storage system. Required for the Create HUR pair in new copy group /Create HUR pair with existing copy group /Create a HUR pair using a range for secondary volume ID /Create HUR pair with provisioned_secondary_volume_id and hostgroups /Create HUR pair and debug result tasks.
port string / required	Port of the host group on the secondary storage system. Required for the Create HUR pair in new copy group /Create HUR pair with existing copy group /Create a HUR pair using a range for secondary volume ID /Create HUR pair with provisioned_secondary_volume_id and hostgroups /Create HUR pair and debug result tasks.
secondary_hostgroups list / elements=dictionary	List of hostgroup objects for the secondary volume. Required for the Create HUR pair in new copy group /Create HUR pair with existing copy group /Create a HUR pair using a range for secondary volume ID /Create HUR pair with provisioned_secondary_volume_id and hostgroups tasks. Optional for the Create HUR pair and debug result task.
lun_id integer	LUN ID of the host group on the secondary storage system. Optional for the Create HUR pair in new copy group /Create HUR pair with existing copy group tasks. Required for the Create HUR pair with provisioned_secondary_volume_id and hostgroups task.
name string / required	Name of the host group on the secondary storage system. Required for the Create HUR pair in new copy group /Create HUR pair with existing copy group /Create a HUR pair using a range for secondary volume ID /Create HUR pair with provisioned_secondary_volume_id and hostgroups /Create HUR pair and debug result tasks.
port string / required	Port of the host group on the secondary storage system. Required for the Create HUR pair in new copy group /Create HUR pair with existing copy group /Create a HUR pair using a range for secondary volume ID /Create HUR pair with provisioned_secondary_volume_id and hostgroups /Create HUR pair and debug result tasks.
secondary_iscsi_targets list / elements=dictionary	The list of iscsi targets on the secondary storage device. Required for the Create HUR-ISCSI pair task. Optional for the Create HUR-iSCSI pair and debug result task.
lun_id integer	LUN ID. Required for the Create HUR-ISCSI pair /Create HUR-iSCSI pair and debug result tasks.
name string / required	ISCSI target name. Required for the Create HUR-ISCSI pair /Create HUR-iSCSI pair and debug result tasks.
port string / required	Port name. Required for the Create HUR-ISCSI pair /Create HUR-iSCSI pair and debug result tasks.
secondary_nvm_subsystem dictionary	NVM subsystem details of the secondary volume. Required for the Create HUR-NVMe pair task. Optional for the Create HUR-NVMe pair and debug result task.
name string / required	Name of the NVM subsystem on the secondary storage system. Required for the Create HUR-NVMe pai /Create HUR-NVMe pair and debug result tasks.
paths list / elements=string	Host NQN paths information on the secondary storage system. Required for the Create HUR-NVMe pair /Create HUR-NVMe pair and debug result tasks.
secondary_pool_id integer	Id of dynamic pool on the secondary storage where the secondary volume will be created. Required for the Create HUR pair in new copy group /Create HUR pair with existing copy group /Create a HUR pair using a range for secondary volume ID /Create HUR-NVMe pair /Create HUR-ISCSI pair /Create HUR pair and debug result /Create HUR-iSCSI pair and debug result /Create HUR-NVMe pair and debug result tasks.
secondary_storage_serial_number integer	Secondary storage serial number.
secondary_volume_journal_id integer	Secondary volume journal id. Required for the Create HUR pair in new copy group /Create a HUR pair using a range for secondary volume ID /Create HUR-ISCSI pair /Create HUR pair with provisioned_secondary_volume_id /Create HUR pair with provisioned_secondary_volume_id and hostgroups /Create HUR pair and debug result /Create HUR-iSCSI pair and debug result /Create HUR-NVMe pair and debug result tasks. Optional for the Create HUR-NVMe pair task.
should_delete_svol boolean	Specify true to delete the SVOL. Optional for the Delete HUR pair task. Choices: false ← (default) true
state string	The level of the HUR pairs task. Choices: "present" ← (default) "absent" "split" "resync" "resize" "expand" "swap_split" "swap_resync" "takeover"
storage_system_info dictionary	Information about the storage system. This field is an optional field.
serial string	The serial number of the storage system.

Attributes

Attribute	Support	Description
check_mode	Support: none	Determines if the module should run in check mode.

Notes

Note

• The output parameters entitlement_status, subscriber_id, and partner_id were removed in version 3.4.0. These were deprecated due to internal API simplification and are no longer supported.

• Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Create a HUR pair in new copy group
  hitachivantara.vspone_block.vsp.hv_hur:
    state: "present"
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: hur_copy_group_name_1
      copy_pair_name: hur_copy_pair_name_1
      primary_volume_id: 234
      secondary_pool_id: 0
      primary_volume_journal_id: 11
      secondary_volume_journal_id: 12
      local_device_group_name: hur_copy_group_name_1P_
      remote_device_group_name: hur_copy_group_name_1S_
      consistency_group_id: 0
      secondary_hostgroup:
        name: hg_1
        port: CL1-A
        lun_id: 5
      mirror_unit_id: 0

- name: Create a HUR pair in existing copy group
  hitachivantara.vspone_block.vsp.hv_hur:
    state: "present"
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      copy_group_name: "hur_copy_group_name_1"
      copy_pair_name: "hur_copy_pair_name_2"
      primary_volume_id: 334
      secondary_pool_id: 0
      secondary_hostgroups:
        - name: hg_1
          port: CL1-A

- name: Split HUR pair
  hitachivantara.vspone_block.vsp.hv_hur:
    state: "split"
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      local_device_group_name: hur_local_device_group_name_3
      remote_device_group_name: hur_remote_device_group_name_3
      copy_group_name: hur_copy_group_name_3
      copy_pair_name: hur_copy_pair_name_3
      is_svol_readwriteable: true

- name: Resync HUR pair
  hitachivantara.vspone_block.vsp.hv_hur:
    state: "resync"
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      local_device_group_name: hur_local_device_group_name_3
      remote_device_group_name: hur_remote_device_group_name_3
      copy_group_name: hur_copy_group_name_3
      copy_pair_name: hur_copy_pair_name_3

- name: Delete HUR pair
  hitachivantara.vspone_block.vsp.hv_hur:
    state: "absent"
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      local_device_group_name: hur_local_device_group_name_3
      remote_device_group_name: hur_remote_device_group_name_3
      copy_group_name: hur_copy_group_name_3
      copy_pair_name: hur_copy_pair_name_3

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
data dictionary	Newly created HUR pair object. Returned: success
consistency_group_id integer	Consistency group ID. Returned: success Sample: 9
copy_group_name string	Name of the copy group. Returned: success Sample: "HUR_TEST_GROUP_ZM_1"
copy_pair_name string	Name of the copy pair. Returned: success Sample: "HUR_TEST_PAIR_ZM_3"
fence_level string	Fence level setting. Returned: success Sample: "ASYNC"
mirror_unit_number integer	Mirror unit number. Returned: success Sample: 2
pvol_difference_data_management string	Difference data management for primary volume. Returned: success Sample: "S"
pvol_journal_id integer	Journal ID for primary volume. Returned: success Sample: 12
pvol_ldev_id integer	LDEV ID for primary volume. Returned: success Sample: 1848
pvol_processing_status string	Processing status for primary volume. Returned: success Sample: "N"
pvol_status string	Status of primary volume. Returned: success Sample: "PAIR"
pvol_storage_device_id string	Storage device ID for primary volume. Returned: success Sample: "900000040014"
pvol_storage_serial_number string	Storage serial number for primary volume. Returned: success Sample: "40014"
remote_mirror_copy_pair_id string	Remote mirror copy pair ID. Returned: success Sample: "900000040015,HUR_TEST_GROUP_ZM_1,HUR_TEST_GROUP_ZM_1P_,HUR_TEST_GROUP_ZM_1S_,HUR_TEST_PAIR_ZM_3"
replication_type string	Replication type. Returned: success Sample: "UR"
svol_difference_data_management string	Difference data management for secondary volume. Returned: success Sample: "S"
svol_journal_id integer	Journal ID for secondary volume. Returned: success Sample: 32
svol_ldev_id integer	LDEV ID for secondary volume. Returned: success Sample: 1978
svol_processing_status string	Processing status for secondary volume. Returned: success Sample: "N"
svol_status string	Status of secondary volume. Returned: success Sample: "PAIR"
svol_storage_device_id string	Storage device ID for secondary volume. Returned: success Sample: "900000040015"
svol_storage_serial_number string	Storage serial number for secondary volume. Returned: success Sample: "40015"

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)