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

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about snapshots from VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/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.
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	Specification for the snapshot facts to be gathered.
mirror_unit_number aliases: mirror_unit_id integer	The mirror unit identifier. If not provided, it will be omitted. Required for the Get one snapshot pair task.
primary_volume_id string	The primary volume identifier. If not provided, it will be omitted. Required for the Get snapshot pairs with the same P-VOL /Get one snapshot pair tasks.
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.
Currently, only pairs that belong to a copy group are retrieved. Therefore, it is recommended to delete any existing pair that is not part of a copy group and re-create the replication pairs using direct connect with copy group technology.

Examples

- name: Gather snapshot facts with primary volume and mirror unit ID
  hitachivantara.vspone_block.vsp.hv_snapshot_facts:
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"
    spec:
      primary_volume_id: 525
      mirror_unit_number: 10

- name: Gather snapshot facts with only primary volume
  hitachivantara.vspone_block.vsp.hv_snapshot_facts:
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"
    spec:
      primary_volume_id: 'volume1'

- name: Gather snapshot facts without specific volume or mirror unit ID
  hitachivantara.vspone_block.vsp.hv_snapshot_facts:
    connection_info:
      address: storage1.company.com
      username: "dummy_user"
      password: "dummy_password"

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
can_cascade boolean	Indicates if the snapshot can cascade. Returned: success Sample: `true`
concordance_rate integer	Concordance rate of the snapshot. Returned: success Sample: `-1`
copy_pace_track_size string	Deprecated. Track size for copy pace. Returned: success Sample: `""`
copy_rate integer	Deprecated.Copy rate of the snapshot. Returned: success Sample: `-1`
is_clone boolean	Indicates if the snapshot is a clone. Returned: success Sample: `false`
is_cloned boolean	Deprecated. Indicates if the snapshot is cloned. Returned: success Sample: `false`
is_consistency_group boolean	Indicates if the snapshot is part of a consistency group. Returned: success Sample: `true`
is_data_reduction_force_copy boolean	Indicates if data reduction force copy is enabled. Returned: success Sample: `true`
is_redirect_on_write boolean	Indicates if redirect-on-write is enabled. Returned: success Sample: `true`
is_snapshot_data_read_only boolean	Deprecated. Indicates if the snapshot data is read-only. Returned: success
is_virtual_clone_parent_volume boolean	Indicates if this is a virtual clone parent volume. Returned: success Sample: `false`
is_virtual_clone_volume boolean	Indicates if this is a virtual clone volume. Returned: success Sample: `false`
is_written_in_secondary_volume boolean	Indicates if data is written in secondary volume. Returned: success Sample: `false`
is_written_in_svol boolean	Deprecated. Use is_written_in_secondary_volume instead. Returned: success Sample: `false`
mirror_unit_id integer	Deprecated. Use mirror_unit_number instead. Identifier of the mirror unit. Returned: success Sample: `0`
mirror_unit_number integer	Identifier of the mirror unit. Returned: success Sample: `3`
pool_id integer	Identifier of the pool. Returned: success Sample: `1`
primary_volume_host_groups list / elements=string	List of host groups for the primary volume. Returned: success Sample: `[]`
primary_volume_id integer	Identifier of the primary volume. Returned: success Sample: `168`
primary_volume_id_hex string	Hexadecimal identifier of the primary volume. Returned: success Sample: `"00:00:A8"`
primary_volume_nvm_subsystem_name string	NVM subsystem name for the primary volume. Returned: success Sample: `""`
primary_volume_processing_status string	Processing status for the primary volume. Returned: success Sample: `"N"`
progress_rate integer	Progress rate of the snapshot. Returned: success Sample: `-1`
pvol_host_groups list / elements=string	Deprecated. Use primary_volume_host_groups instead. Returned: success Sample: `[]`
pvol_nvm_subsystem_name string	Deprecated. Use primary_volume_nvm_subsystem_name instead. Returned: success Sample: `""`
pvol_processing_status string	Deprecated. Use primary_volume_processing_status instead. Returned: success Sample: `"N"`
retention_period_in_hours integer	Retention period for the snapshot in hours. Returned: success Sample: `-1`
secondary_volume_host_groups list / elements=string	List of host groups for the secondary volume. Returned: success Sample: `[]`
secondary_volume_id integer	Identifier of the secondary volume. Returned: success Sample: `205`
secondary_volume_id_hex string	Hexadecimal identifier of the secondary volume. Returned: success Sample: `"00:00:CD"`
secondary_volume_nvm_subsystem_name string	NVM subsystem name for the secondary volume. Returned: success Sample: `""`
secondary_volume_processing_status string	Processing status for the secondary volume. Returned: success Sample: `"N"`
snapshot_group_name string	Name of the snapshot group. Returned: success Sample: `"snewar-tia-grp-02"`
snapshot_id string	Identifier of the snapshot. Returned: success Sample: `"168,3"`
split_time string	Split time of the snapshot. Returned: success Sample: `""`
status string	Status of the snapshot. Returned: success Sample: `"PFUL"`
svol_host_groups list / elements=string	Deprecated. Use secondary_volume_host_groups instead. Returned: success Sample: `[]`
svol_nvm_subsystem_name string	Deprecated. Use secondary_volume_nvm_subsystem_name instead. Returned: success Sample: `""`
svol_processing_status string	Deprecated. Use secondary_volume_processing_status instead. Returned: success Sample: `""`
type string	Type of the snapshot. Returned: success Sample: `"CASCADE"`

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