W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_snapshot_group_facts module – Retrieves snapshot information in units of snapshot groups from 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_facts.

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about snapshots in units of snapshot groups from Hitachi VSP storage systems.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/snapshot_group_facts.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	Specification for the snapshot group facts to be gathered.
snapshot_group_name string / required	The name of the snapshot group.
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: full	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: Gather snapshot facts with primary volume and mirror unit ID
  hitachivantara.vspone_block.vsp.hv_snapshot_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      snapshot_group_name: 'NewNameSPG'

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key	Description
snapshots list / elements=dictionary	A list of snapshots gathered from the storage system. Returned: success
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	ID of the consistency group. Returned: success Sample: `-1`
copy_pace_track_size string	Track size for copy pace. Returned: success Sample: `""`
copy_rate integer	Copy rate of the snapshot. Returned: success Sample: `-1`
is_consistency_group boolean	Indicates if it is a consistency group. Returned: success Sample: `true`
mirror_unit_id integer	ID of the mirror unit. Returned: success Sample: `3`
pool_id integer	ID of the pool. Returned: success Sample: `12`
primary_hex_volume_id string	Hexadecimal ID of the primary volume. Returned: success Sample: `"00:04:06"`
primary_or_secondary string	Indicates if it is a primary or secondary volume. Returned: success Sample: `"P-VOL"`
primary_volume_id integer	ID of 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 ID of the secondary volume. Returned: success Sample: `"00:04:07"`
secondary_volume_id integer	ID of the secondary volume. Returned: success Sample: `1031`
snapshot_id string	ID of 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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_snapshot_group_facts_module.html