hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot_group module – Manages snapshot group operations in VSP E series, VSP One Block 20 series, and VSP One Block 80 series 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_vsp_one_snapshot_group.

New in hitachivantara.vspone_block 4.4.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

This module manages snapshot group operations in VSP E series, VSP One Block 20 series, and VSP One Block 80 series storage systems.
Utilizes the Hitachi Virtual Storage Platform One Simple API for snapshot group operations across VSP One B20 series, VSP One B80 series, and VSP E series models.
For usage examples, visit https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/vsp_one_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.
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
spec dictionary / required	Configuration parameters for the snapshot group operation.
snapshot_group_name string / required	Snapshot group name. Information about the snapshot group that is a perfect match with the specified value is obtained.
state string	The desired state of the snapshot group. Choices: `"present"` ← (default) `"absent"`

Attributes

Attribute	Support	Description
check_mode	Support: full	Specifies whether the module operates in check mode.

Examples

- name: Get snapshot groups with specific snapshot group name
  hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot_group:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      snapshot_group_name: "test_sp_group"

- name: Delete snapshot group by snapshot_group_name
  hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot_group:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    state: absent
    spec:
      snapshot_group_name: "test_sp_group"

Return Values

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

Key	Description
snapshots list / elements=dictionary	List of snapshots retrieved from the storage system. Returned: always
name string	Name of the snapshot group. Returned: success Sample: `"Thin-AnsibleAuto222303"`
snapshots list / elements=dictionary	List of snapshots within the snapshot group. Returned: success
master_volume_id integer	Master volume ID of the snapshot. Returned: success Sample: `8009`
snapshot_id integer	Snapshot ID. The mirror unit number is obtained. Returned: success Sample: `41`

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