W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_paritygroup module – Create, delete parity group from Hitachi VSP storage systems.

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_paritygroup.

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module creates, delete parity group from Hitachi VSP storage systems.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/paritygroup.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	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: `"direct"` ← (default)
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 parity group tasks.
clpr_id integer	Specify a CLPR number in the range from 0 to 31.
drive_location_ids list / elements=string	Specify the locations of the drives to be used to create to the parity group.
is_accelerated_compression_enabled boolean	Specify whether to enable accelerated compression for the parity group. Choices: `false` `true`
is_copy_back_mode_enabled boolean	Specify whether to enable the encryption function for the parity group. Choices: `false` `true`
is_encryption_enabled boolean	Specify whether to enable the encryption function for the parity group. Choices: `false` `true`
parity_group_id string	The parity group number of the parity group to retrieve.
raid_type string	RAID type.
state string	The level of the HUR pairs task. Choices are `present`, `absent`, `update`. Choices: `"present"` ← (default) `"absent"` `"update"`

Attributes

Attribute	Support	Description
check_mode	Support: none	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: Create parity group
  hitachivantara.vspone_block.vsp.hv_paritygroup:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "present"
    spec:
      parity_group_id: 1-10
      drive_location_ids: ["0-16", "0-17", "0-18", "0-19"]
      raid_type: 3D+1P
      is_encryption_enabled: true
      is_copy_back_mode_enabled: false
      is_accelerated_compression_enabled: true
      clpr_id: 1

- name: Delete parity group
  hitachivantara.vspone_block.vsp.hv_paritygroup:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "absent"
    spec:
      parity_group_id: 1-10

- name: Update parity group
  hitachivantara.vspone_block.vsp.hv_paritygroup:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "update"
    spec:
      parity_group_id: 1-10
      is_accelerated_compression_enabled: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
parity_group list / elements=dictionary	Parity group managed by the module. Returned: success
clpr_id integer	CLPR number. Returned: success Sample: `0`
copyback_mode boolean	Indicates if copyback mode is enabled. Returned: success Sample: `false`
drive_type string	Type of drive. Returned: success Sample: `"SSD"`
free_capacity string	Free capacity of the parity group. Returned: success Sample: `"5.16TB"`
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 Sample: `true`
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: `[]`
parity_group_id string	Parity group ID. Returned: success Sample: `"1-10"`
raid_level string	RAID level. Returned: success Sample: `"RAID5"`
resource_group_id integer	Resource group ID. Returned: success
resource_id integer	Resource ID. Returned: success
status string	Status of the parity group. Returned: success
total_capacity string	Total capacity of the parity group. Returned: success Sample: `"5.16TB"`

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/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_paritygroup_module.html