hitachivantara.vspone_block.vsp.hv_snapshot_family_facts module – Retrieves snapshot family information of the provided LDEV ID from 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_family_facts.

New in hitachivantara.vspone_block 4.6.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about snapshot family of the provided LDEV IDfrom VSP block storage systems.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/snapshot_family_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.
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 family facts to be gathered.
ldev_id string / required	The ID of the logical device (LDEV).

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 family facts
  hitachivantara.vspone_block.vsp.hv_snapshot_family_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      ldev_id: '12345'

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 and virtual clone volume details. Returned: always
is_virtual_clone_parent_volume boolean	Indicates whether the volume is a parent of a virtual clone. Returned: success Sample: `true`
is_virtual_clone_volume boolean	Indicates whether the volume is a virtual clone. Returned: success Sample: `true`
ldev_id integer	Logical device (LDEV) identifier of the snapshot or clone volume. Returned: success Sample: `104`
mu_number integer	Mirror Unit (MU) number associated with the snapshot. Returned: success Sample: `3`
parent_ldev_id integer	LDEV identifier of the parent volume. Returned: success Sample: `104`
pool_id integer	Pool identifier where the snapshot or clone resides. Returned: success Sample: `22`
primary_or_secondary string	Indicates whether the volume is a primary or secondary volume. Returned: success Sample: `"P-VOL"`
pvol_ldev_id integer	LDEV identifier of the primary volume. Returned: success Sample: `104`
snapshot_group_id string	Identifier of the snapshot group. Returned: success Sample: `"test_sp_group"`
snapshot_group_name string	Name of the snapshot group. Returned: success Sample: `"test_sp_group"`
snapshot_id string	Unique identifier of the snapshot, typically in the format LDEV,MU. Returned: success Sample: `"104,3"`
split_time string	Timestamp when the snapshot was split from the parent volume. Returned: success Sample: `"2025-08-28T18:12:39"`
status string	Current status of the snapshot or clone. Returned: success Sample: `"PFUS"`

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