hitachivantara.vspone_block.vsp.hv_vclone_parent_volume_facts module – Retrieves virtual clone parent volume 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_vclone_parent_volume_facts.

New in hitachivantara.vspone_block 4.6.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about virtual clone parent volume from VSP block storage systems.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/vclone_parent_volume_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 virtual clone parent volume facts to be gathered.
vclone_volume_id string	The ID of the virtual clone volume.

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 virtual clone parent volume facts
  hitachivantara.vspone_block.vsp.hv_vclone_parent_volume_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      vclone_volume_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
parent_volume_ids list / elements=dictionary	List of parent volume identifiers. Returned: always
ldev_id integer	Logical device (LDEV) identifier of the parent volume. Returned: success Sample: `104`

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