hitachivantara.vspone_block.vsp.hv_paritygroup_facts module – retrieves information about parity groups 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_paritygroup_facts.

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module gathers facts about parity groups from VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/paritygroup_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 parity group facts to be gathered.
parity_group_id string	The parity group number of the parity group to retrieve. Required for the Get one parity group task.
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.

Examples

- name: Get a specific parity group
  hitachivantara.vspone_block.vsp.hv_paritygroup_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      parity_group_id: 1-1

- name: Get all parity groups
  hitachivantara.vspone_block.vsp.hv_paritygroup_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"

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
parity_groups list / elements=dictionary	List of parity groups with their attributes. Returned: success
clpr_id integer	CLPR (Cache Logical Partition) ID. Returned: success Sample: `0`
copyback_mode boolean	Indicates if copy back mode is enabled. Returned: success
drive_type string	Type of drive. Returned: success Sample: `"SSD"`
free_capacity string	Free capacity of the parity group. Returned: success Sample: `"0"`
free_capacity_mb boolean	Free capacity in megabytes. Returned: success Sample: `false`
is_accelerated_compression boolean	Indicates if accelerated compression is enabled. Returned: success Sample: `false`
is_encryption_enabled boolean	Indicates if encryption is enabled. Returned: success
is_pool_array_group boolean	Indicates if it is a pool array group. Returned: success
ldev_ids list / elements=integer	List of LDEV IDs. Returned: success Sample: `[32732, 32733, 32734, 32743, 32752, 32753, 32754, 32755, 32756, 32757, 32758, 32759]`
parity_group_id string	The parity group ID. Returned: success Sample: `"1-2"`
raid_level string	RAID level of the parity group. Returned: success Sample: `"RAID5"`
resource_group_id integer	Resource group ID. Returned: success Sample: `-1`
total_capacity string	Total capacity of the parity group. Returned: success Sample: `"15.46TB"`
total_capacity_mb float	Total capacity in megabytes. Returned: success Sample: `16210984.96`

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