hitachivantara.vspone_block.vsp.hv_hur_bulk module – Manages bulk HUR pairs on VSP block storage systems.

Note

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

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_bulk.

New in hitachivantara.vspone_block 3.1.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

This module allows for the bulk creation of HUR pairs on VSP block storage systems. - Enables efficient provisioning of multiple HUR pairs in a single operation.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/hur_bulk.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 bulk HUR pairs task.
allocate_new_consistency_group boolean	Specify whether to allocate a new consistency group. Choices: `false` ← (default) `true`
begin_primary_volume_id string	Beginning primary volume ID for batch creation using existing volumes.
begin_secondary_volume_id string	Begin LDEV ID for secondary volume range.
capacity_saving string	Capacity saving mode for new volumes (e.g., ‘compression’, ‘deduplication_compression’).
consistency_group_id integer	Consistency Group ID, 0 to 255. This is an optional field.
copy_group_name string / required	Name of the copy group.
copy_pair_base_name string / required	Prefix for the copy pairs names. Actual copy pair names will be <copy_pair_base_name>_<primary_volume_id>_<secondary_volume_id>
data_reduction_share boolean	Specify whether to create a data reduction shared volume. This value is set to true for Thin Image Advance. 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_primary_volume_id string	Ending primary volume ID for batch creation using existing volumes.
end_secondary_volume_id string	End LDEV ID for secondary volume range.
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. Choices: `false` `true` ← (default)
is_new_group_creation boolean	Specify whether to enable new group creation. Choices: `false` `true`
local_device_group_name string	Name of the local device group name.
mirror_unit_number integer	Mirror Unit Number. Choices: `0` `1` `2` `3`
number_of_pairs integer / required	Number of GAD pairs to create in batch.
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_hostgroups list / elements=dictionary	List of hostgroup objects for the primary volumes.
lun_id integer	LUN ID of the host group on the secondary storage system. This is not required for create operation.
name string / required	Name of the host group on the secondary storage system. This is required for create operation.
port_id string / required	Port of the host group on the secondary storage system. This is required for create operation.
primary_iscsi_targets list / elements=dictionary	The list of iscsi targets on the primary storage device.
lun_id integer	LUN ID.
name string / required	ISCSI target name.
port_id string / required	Port ID.
primary_journal_id integer	Journal ID for the primary volume. This is an optional field.
primary_nvm_subsystem dictionary	NVM subsystem details of the primary volume..
name string / required	Name of the NVM subsystem on the primary storage system.
paths list / elements=string	Host NQN paths information on the primary storage system.
primary_pool_id integer / required	Id of dynamic pool on the primary storage where the primary volume will be created.
primary_volume_base_name string	Prefix for primary volume names when creating new volumes in bulk.
primary_volume_base_name_number_of_digits integer	Number of digits to use for the suffix of primary volume names during bulk creation. Choices: `1` `2` `3` `4` `5`
primary_volume_base_name_start_number integer	The starting number that will be appended to primary_volume_base_name to generate the first volume name during bulk creation.
remote_device_group_name string	Name of the remote device group name.
secondary_hostgroups list / elements=dictionary	List of hostgroup objects for the secondary volumes.
lun_id integer	LUN ID of the host group on the secondary storage system. This is not required for create operation.
name string / required	Name of the host group on the secondary storage system. This is required for create operation.
port_id string / required	Port of the host group on the secondary storage system. This is required for create operation.
secondary_iscsi_targets list / elements=dictionary	The list of iscsi targets on the secondary storage device.
lun_id integer	LUN ID.
name string / required	ISCSI target name for the secondary storage system.
port_id string / required	Port ID.
secondary_journal_id integer	Journal ID for the secondary volume. This is an optional field.
secondary_nvm_subsystem dictionary	NVM subsystem details of the secondary volume.
name string / required	Name of the NVM subsystem on the secondary storage system.
paths list / elements=string	Host NQN paths information on the secondary storage system.
secondary_pool_id integer / required	Id of dynamic pool on the secondary storage where the secondary volume will be created.
should_match_volume_ids boolean	Specify whether the primary volume ID and secondary volume ID should match in hur pairs. Default value is false. Choices: `false` `true`
volume_size string / required	Size of volume to create (e.g., ‘10GB’, ‘1TB’) HUR pairs.
state string	Set state to `present` for creating HUR pairs in bulk. Choices: `"present"` ← (default)

Attributes

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

Examples

- name: Create a HUR pairs in bulk mode
  hitachivantara.vspone_block.vsp.hv_hur_bulk:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      number_of_pairs: 2
      copy_group_name: "rd_hur_cg_123"
      copy_pair_base_name: "rd_hur_cp_123_"
      primary_pool_id: 0
      secondary_pool_id: 0
      volume_size: "1GB"
      primary_hostgroups:
        - name: "snewar-common-hg-01"
          port_id: "CL2-A"
        - name: "snewar-common-hg-01"
          port_id: "CL2-B"
      secondary_hostgroups:
        - name: "snewar-common-hg-01"
          port_id: "CL2-A"
        - name: "snewar-common-hg-01"
          port_id: "CL2-B"

- name: Create a HUR pairs in bulk mode with matching primary and secondary volume IDs
  hitachivantara.vspone_block.vsp.hv_hur_bulk:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    secondary_connection_info:
      address: storage2.company.com
      username: "admin"
      password: "secret"
    spec:
      should_match_volume_ids: true
      number_of_pairs: 2
      copy_group_name: "rd_hur_cg_123"
      copy_pair_base_name: "rd_hur_cp_123_"
      primary_pool_id: 0
      secondary_pool_id: 0
      volume_size: "1GB"
      primary_hostgroups:
        - name: "snewar-common-hg-01"
          port_id: "CL2-A"
        - name: "snewar-common-hg-01"
          port_id: "CL2-B"
      secondary_hostgroups:
        - name: "snewar-common-hg-01"
          port_id: "CL2-A"
        - name: "snewar-common-hg-01"
          port_id: "CL2-B"

Return Values

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

Key	Description
hur_info dictionary	Newly created HUR pair object. Returned: success
consistency_group_id integer	Consistency group ID. Returned: success Sample: `51`
copy_group_name string	Name of the copy group. Returned: success Sample: `"snewar_hur_copy_group_12"`
copy_pair_name string	Name of the copy pair. Returned: success Sample: `"snewar_hur_copy_pair_12"`
copy_rate integer	Deprecated. Copy rate. Returned: success Sample: `-1`
fence_level string	Fence level setting. Returned: success Sample: `"ASYNC"`
local_device_group_name string	Name of the local device group to retrieve TrueCopy pair information for. Returned: success Sample: `"hur_bulk_cg_1P_"`
mirror_unit_id integer	Deprecated. Use mirror_unit_number instead. Returned: success Sample: `1`
mirror_unit_number integer	Mirror unit number. Returned: success Sample: `1`
primary_journal_id integer	Primary journal Id. Returned: success Sample: `25`
primary_journal_pool integer	Deprecated. Use primary_journal_id instead. Returned: success Sample: `25`
primary_volume_id integer	Primary volume ID. Returned: success Sample: `6442`
primary_volume_id_hex string	Hexadecimal representation of the primary volume ID. Returned: success Sample: `"00:19:2A"`
primary_volume_status string	Primary volume status. Returned: success Sample: `"PAIR"`
primary_volume_storage_id string	Deprecated. Use primary_volume_storage_serial_number instead. Returned: success Sample: `"810050"`
primary_volume_storage_serial_number string	Storage serial number of the primary volume. Returned: success Sample: `"810050"`
pvol_status string	Deprecated. Use primary_volume_status instead. Returned: success Sample: `"PAIR"`
pvol_storage_device_id string	Deprecated. PVOL storage device ID. Returned: success Sample: `"A34000810050"`
remote_device_group_name string	Name of the remote device group to retrieve TrueCopy pair information for. Returned: success Sample: `"hur_bulk_cg_1S_"`
remote_mirror_copy_pair_id string	Deprecated. Remote mirror copy pair ID. Returned: success Sample: `"A34000810050,spcA34000810045A34000810050,spcA34000810045A34000810050,spcA34000810050A34000810045,spc-7331-6442"`
secondary_journal_id integer	Secondary journal ID. Returned: success Sample: `25`
secondary_journal_pool integer	Deprecated. Use secondary_journal_id instead. Returned: success Sample: `25`
secondary_volume_id integer	Secondary volume ID. Returned: success Sample: `7331`
secondary_volume_id_hex string	Hexadecimal representation of the secondary volume ID. Returned: success Sample: `"00:1C:A3"`
secondary_volume_storage_id string	Deprecated. Use secondary_volume_storage_serial_number instead. Returned: success Sample: `"810045"`
secondary_volume_storage_serial_number string	Storage serial number of the secondary volume. Returned: success Sample: `"810045"`
svol_status string	SVOL status. Returned: success Sample: `"PAIR"`
svol_storage_device_id string	Deprecated. SVOL storage device ID. Returned: success Sample: `"A34000810045"`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

Collection links

© 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_hur_bulk_module.html