hitachivantara.vspone_block.vsp.hv_snapshot_group module – Manages snapshots in units of snapshot groups on Hitachi VSP storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 3.5.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

• This module allows for the deletion, splitting, syncing, and restoring of snapshots on Hitachi VSP 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	This field is used to pass the value of the lock token 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 if api_token is not provided.
username string	Username for authentication. This is a required field if api_token is not provided..
spec dictionary / required	Specification for the snapshot group tasks.
auto_split boolean	Automatically split the snapshot group. Choices: false true
copy_speed string	The speed of the copy operation. Choices: "SLOW" "MEDIUM" "FAST"
retention_period integer	Specify the retention period for the snapshot in hours.This can be set when the snapshot status is PSUS.
snapshot_group_name string / required	The name of the snapshot group.
state string / required	The level of the snapshot task. Choices are absent, split, sync, restore, clone, defragment. Choices: "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
snapshots 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
consistency_group_id integer	Identifier for the consistency group. 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_consistency_group boolean	Indicates if the snapshot is part of a consistency group. Returned: success Sample: true
mirror_unit_id integer	Identifier for the mirror unit. Returned: success Sample: 3
pool_id integer	Identifier for the pool. Returned: success Sample: 12
primary_hex_volume_id string	Hexadecimal identifier for the primary volume. Returned: success Sample: "00:04:06"
primary_or_secondary string	Indicates if the volume is primary or secondary. Returned: success Sample: "P-VOL"
primary_volume_id integer	Identifier for the primary volume. Returned: success Sample: 1030
retention_period integer	Retention period for the snapshot. Returned: success Sample: 60
secondary_hex_volume_id string	Hexadecimal identifier for the secondary volume. Returned: success Sample: "00:04:07"
secondary_volume_id integer	Identifier for the secondary volume. Returned: success Sample: 1031
snapshot_id string	Identifier for the snapshot. Returned: success Sample: "1030,3"
status string	Status of the snapshot. Returned: success Sample: "PAIR"
storage_serial_number integer	Serial number of the storage system. Returned: success Sample: 810050
svol_access_mode string	Access mode of the secondary volume. Returned: success Sample: ""
type string	Type of the snapshot. Returned: success Sample: ""

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)