hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot_facts module – Retrieves snapshot information from 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_facts.

New in hitachivantara.vspone_block 4.4.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module retrieves snapshot information from 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 facts retrieval 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_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	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	Query parameters for retrieving snapshot information.
count integer	Specify the number of snapshots by using a value in the range from 1 through 1000. If this parameter is omitted, 1000 is considered.
master_volume_id string	Master volume ID of the snapshot.
snapshot_date_from string	Information about snapshots created on and after the date and time specified for this parameter will be obtained. Specify the date and time from which snapshots will be obtained, in YYYY-MM-DDThh:mm:ssZ format.
snapshot_date_to string	Information about snapshots created on and before the date and time specified for this parameter will be obtained. Specify the date and time from which snapshots will be obtained, in YYYY-MM-DDThh:mm:ssZ format.
snapshot_group_name string	Snapshot group name. Information about the snapshot that is a perfect match with the specified value is obtained.
snapshot_id integer	Snapshot ID.
start_id string	Specify the first snapshot information to obtain, by specifying the master volume ID of the snapshot and the snapshot ID, linked by a comma. String in formation of ‘master_volume_id,snapshot_id’. If this parameter is omitted, ‘0,0’ is assumed.

Attributes

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

Examples

- name: Get snapshot pair with master_volume_id and snapshot_id
  hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      master_volume_id: 1445
      snapshot_id: 4

- name: Get all snapshot pairs
  hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"

- name: Get port information by protocol
  hitachivantara.vspone_block.vsp.hv_vsp_one_snapshot_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      protocol: "fc"

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	List of snapshot information retrieved from the storage system. Returned: always
id string	Master volume ID of the snapshot and the snapshot ID, linked by a comma. Returned: success Sample: `"1445,4"`
is_volume_capacity_expanding boolean	Indicates if the master volume capacity is expanding. Returned: success Sample: `false`
mapped_volume_id integer	ID of the volume to be created from the snapshots. This attribute is obtained only if the ID of the volume for which the snapshot was created is defined. Returned: success Sample: `1445`
mapped_volume_id_hex string	Mapped volume ID of the snapshot in hexadecimal. Returned: success Sample: `"00:05:A5"`
master_volume_id integer	Master volume ID of the snapshot. Returned: success Sample: `1445`
master_volume_id_hex string	Master volume ID of the snapshot in hexadecimal. Returned: success Sample: `"00:05:A5"`
pool_id integer	ID of the pool in which the differential data of the snapshots is stored. Returned: success Sample: `1`
retention_period integer	Remaining Retention Time (hours) of the snapshot. If the snapshot data retention period is not set or the snapshot data retention period has expired, 0 is obtained. Returned: success Sample: `0`
root_volume_id integer	ID of the root volume of the snapshots. Returned: success Sample: `104`
root_volume_id_hex string	ID of the root volume of the snapshots in hexadecimal. Returned: success Sample: `"00:00:68"`
snapshot_date string	Date and time when the snapshot was created. Returned: success Sample: `"2025-08-28T18:12:39Z"`
snapshot_group_name string	Snapshot group name. Returned: success Sample: `"test_sp_group"`
snapshot_id integer	Snapshot ID. The mirror unit number is obtained. Returned: success Sample: `3`
status string	Status of the snapshot. Returned: success Sample: `"Completed"`
type string	Type of snapshot. Returned: success Sample: `"Snapshot"`
used_capacity_in_mb_per_root_volume integer	The amount of disk space (MiB) occupied by differential information and control information used by the snapshot group created from the same volume. Returned: success Sample: `0`

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