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_shadow_image_group_facts.
New in hitachivantara.vspone_block 3.2.0
The below requirements are needed on the host that executes this module.
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. |
|
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 Local Copy Group facts to be gathered. |
|
name string |
The local copy group name. If not provided, list of all copy groups will be returned. |
|
primary_volume_device_group_name string |
Specify the device group name for the P-VOL. Value should not exceed 31 characters. The name is case sensitive. |
|
secondary_volume_device_group_name string |
Specify the device group name for the S-VOL. Value should not exceed 31 characters. The name is case sensitive. |
|
should_include_copy_pairs boolean |
Whether we want to get all local copy pairs from a specific copy group. Should be specified along with the ‘name’ parameter in spec. Choices:
|
Attribute | Support | Description |
|---|---|---|
check_mode | Support: full | Determines if the module should run in check mode. |
Note
gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.- name: Get all shadow image groups
hitachivantara.vspone_block.vsp.hv_shadow_image_group_facts:
connection_info:
address: storage1.company.com
username: "admin"
password: "password"
- name: Get one shadow image group by name
hitachivantara.vspone_block.vsp.hv_shadow_image_group_facts:
connection_info:
address: storage1.company.com
username: "admin"
password: "password"
spec:
name: "copygroup1"
- name: Get one shadow image group by name with copy pairs information
hitachivantara.vspone_block.vsp.hv_shadow_image_group_facts:
connection_info:
address: storage1.company.com
username: "admin"
password: "password"
spec:
name: "copygroup1"
should_include_remote_replication_pairs: true
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 |
|---|---|
shadow_image_groups list / elements=dictionary | A list of local copy groups gathered from the storage system. Returned: success |
|
copy_group_name string |
The name of the local copy group. Returned: success Sample: |
|
local_clone_copygroup_id string |
The ID of the local clone copy group. Returned: success Sample: |
|
pvol_device_group_name string |
The name of the primary volume device group. Returned: success Sample: |
|
svol_device_group_name string |
The name of the secondary volume device group. Returned: success Sample: |
© 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_shadow_image_group_facts_module.html