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_external_paritygroup_facts.
New in hitachivantara.vspone_block 3.5.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. |
|
connection_type string |
Type of connection to the storage system. Choices:
|
|
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 retrieving External Parity Group information. |
|
external_parity_group string |
The external parity group ID. |
storage_system_info dictionary | Information about the storage system. This field is an optional field. |
|
serial string |
The serial number of the storage system. |
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: Retrieve information about all External Parity Groups
hitachivantara.vspone_block.vsp.hv_external_path_group_facts:
connection_info:
address: storage1.company.com
username: "admin"
password: "changeme"
- name: Retrieve information about a specific External Parity Groups
hitachivantara.vspone_block.vsp.hv_external_path_group_facts:
connection_info:
address: storage1.company.com
username: "admin"
password: "changeme"
spec:
external_parity_group: "1-1"
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 |
|---|---|
available_volume_capacity integer | Available capacity (GB). Returned: success Sample: |
external_parity_group_id string | External parity group ID. Returned: success Sample: |
spaces list / elements=dictionary | For the free space and the LDEV defined in the specified external parity group. Returned: success |
|
lba_size string |
ize of the partition in the external parity group (in a multiple of 512 bytes). Returned: success Sample: |
|
ldev_id integer |
LDEV number. Returned: success Sample: |
storage_serial_number string | Storage serial number. Returned: success Sample: |
used_capacity_rate integer | Usage rate of the external parity 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_external_paritygroup_facts_module.html