hitachivantara.vspone_block.vsp.hv_snapshot_group module – Manages snapshots in units of snapshot groups 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_snapshot_group.

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module allows for the deletion, splitting, syncing, and restoring of snapshots on VSP block storage systems.
It supports various snapshot operations based on the specified task level.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/snapshot_group.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.
spec dictionary / required	Specification for the snapshot group tasks.
auto_split boolean	Automatically split the snapshot group. Required for the Restore the snapshot pairs using group name and auto split task. Choices: `false` `true`
copy_speed string	The speed of the copy operation. Optional for the Clone the snapshot pairs using group name task. Choices: `"SLOW"` `"MEDIUM"` `"FAST"`
operation_type string	The operation type for the clone. Optional for the Clone the snapshot pairs using group name task.
retention_period integer	Specify the retention period for the snapshot in hours.This can be set when the snapshot status is PSUS. Required for the Set retention period of snapshots using group name task.
snapshot_group_name string / required	The name of the snapshot group. Required for the Split the snapshot pairs using group name /Restore the snapshot pairs using group name /Restore the snapshot pairs using group name and auto split /Resync the snapshot pairs using group name /Delete the snapshot pairs using group name /Set retention period of snapshots using group name /Clone the snapshot pairs using group name tasks.
wait_for_final_state boolean	Whether to wait for the snapshot group to reach its final state after the operation. Optional for all tasks. Choices: `false` ← (default) `true`
state string / required	The level of the snapshot task. Choices are `absent`, `split`, `sync`, `restore`, `clone`, `defragment`. Choices: `"present"` `"split"` `"sync"` `"restore"` `"clone"` `"absent"` `"defragment"`
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

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

Examples

- 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'

Return Values

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

Key	Description
snapshot_data list / elements=dictionary	A list of snapshots gathered from the storage system. Returned: always
snapshot_group_id string	Unique identifier for the snapshot group. Returned: success Sample: `"SampleNameSPG"`
snapshot_group_name string	Name of the snapshot group. Returned: success Sample: `"SampleNameSPG"`
snapshots list / elements=dictionary	List of snapshots within the group. Returned: success
can_cascade boolean	Indicates if the snapshot can cascade. Returned: success Sample: `true`
concordance_rate integer	Concordance rate for the snapshot. Returned: success Sample: `-1`
copy_pace_track_size string	Track size for the copy pace. Returned: success Sample: `""`
copy_rate integer	Copy rate for the snapshot. Returned: success Sample: `-1`
is_clone boolean	Indicates if the snapshot is a clone. Returned: success Sample: `false`
is_consistency_group boolean	Indicates if the snapshot is part of a consistency group. Returned: success Sample: `false`
is_redirect_on_write boolean	Indicates if redirect-on-write is enabled. Returned: success Sample: `true`
is_snapshot_data_read_only boolean	Indicates if the snapshot data is read-only. Returned: success
is_written_in_svol boolean	Indicates if data is written in secondary volume. Returned: success Sample: `false`
mirror_unit_id integer	Deprecated. Use mirror_unit_number instead. Identifier of the mirror unit. Returned: success Sample: `3`
mirror_unit_number integer	Number of the mirror unit. Returned: success Sample: `3`
pool_id integer	Identifier for the pool. Returned: success Sample: `22`
primary_hex_volume_id string	Hexadecimal identifier for the primary volume. Returned: success Sample: `"00:03:4A"`
primary_volume_id integer	Identifier for the primary volume. Returned: success Sample: `842`
progress_rate integer	Progress rate for the snapshot. Returned: success Sample: `-1`
pvol_host_groups list / elements=string	List of host groups for the primary volume. Returned: success Sample: `[]`
pvol_nvm_subsystem_name string	NVM subsystem name for the primary volume. Returned: success Sample: `""`
pvol_processing_status string	Processing status for the primary volume. Returned: success Sample: `"N"`
retention_period_in_hours integer	Retention period for the snapshot in hours. Returned: success Sample: `-1`
secondary_hex_volume_id string	Hexadecimal identifier for the secondary volume. Returned: success Sample: `"00:06:36"`
secondary_volume_id integer	Identifier for the secondary volume. Returned: success Sample: `1590`
snapshot_group_name string	Name of the snapshot group. Returned: success Sample: `"spc-snapshot"`
snapshot_id string	Identifier for the snapshot. Returned: success Sample: `"842,3"`
split_time string	Time when the snapshot was split. Returned: success Sample: `"2025-06-27T23:28:06"`
status string	Status of the snapshot. Returned: success Sample: `"PSUS"`
svol_host_groups list / elements=string	List of host groups for the secondary volume. Returned: success Sample: `[]`
svol_nvm_subsystem_name string	NVM subsystem name for the secondary volume. Returned: success Sample: `""`
svol_processing_status string	Processing status for the secondary volume. Returned: success Sample: `""`
type string	Type of the snapshot. Returned: success Sample: `"CASCADE"`

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