hitachivantara.vspone_block.vsp.hv_external_paritygroup module – Manages assignment of MP blade and CLPR to an External Parity Group 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_external_paritygroup.

New in hitachivantara.vspone_block 4.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module retrieves information about External Volume from VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/external_parity_group_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	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 External Parity Group.
clpr_id integer	CLPR number to be used by the external volume group. This is an optional field for the create operation. Specify a decimal (base 10) number in the range from 0 to 31. If this attribute is omitted for the create, 0 is set.
command_device_ldev_id integer	LDEV number of the remote command device. This is an optional field for the create operation. The specified LDEV number is assigned to the remote command device.
emulation_type string	Emulation type. This is an optional field for create operation. Choices: `"OPEN-3"` `"OPEN-8"` `"OPEN-9"` `"OPEN-E"` `"OPEN-K"` `"OPEN-L"` `"OPEN-V"` ← (default) `"3380-3"` `"3380-3A"` `"3380-3B"` `"3380-3C"` `"3390-1"` `"3390-2"` `"3390-3"` `"3390-A"` `"3390-3A"` `"3390-3B"` `"3390-3C"` `"3390-3R"` `"3390-9"` `"3390-9A"` `"3390-9B"` `"3390-9C"` `"3390-L"` `"3390-LA"` `"3390-LB"` `"3390-LC"` `"3390-M"` `"3390-MA"` `"3390-MB"` `"3390-MC"` `"3390-V"` `"6586-G"` `"6586-J"` `"6586-K"` `"6586-KA"` `"6586-KB"` `"6586-KC"` `"6588-1"` `"6588-3"` `"6588-9"` `"6588-A"` `"6588-3A"` `"6588-3B"` `"6588-3C"` `"6588-9A"` `"6588-9B"` `"6588-9C"` `"6588-L"` `"6588-LA"` `"6588-LB"` `"6588-LC"`
external_parity_group_id string / required	The external parity group ID. This is a required field for all the operations.
external_path_group_id integer	External path group ID. This is a required field for the create operation.
external_wwn string	WWN of the external storage system. This is a required field for create operation.
force boolean	Specify whether to forcibly unmap the external volume without destaging it. This is an optional field for the delete operation. If this attribute is omitted, false is set. Specify true to unmap the volume on the external storage system without destaging it. Choices: `false` `true`
is_external_attribute_migration boolean	Whether to set the nondisruptive migration attribute for the external volume group. This is an optional field for the create operation. If this attribute is omitted, false is set. Choices: `false` `true`
lun_id integer	LUN of the port on the external storage system. This is a required field for the create operation.
mp_blade_id integer	The blade number of the MP blade to be assigned to the external volume group.
port_id string	Number of the port on the local storage system. This is a required field for the create operation.
state string	The level of the External Path Group task. Choices: `"present"` ← (default) `"assign_external_parity_group"` `"change_mp_blade"` `"disconnect"` `"absent"`

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: Change the MP blade assigned to an external parity group
  hitachivantara.vspone_block.vsp.hv_external_path_group:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "changeme"
    state: "change_mp_blade"
    spec:
      external_parity_group_id: "1-5"
      mp_blade_id: 0

- name: Assign external parity group to a CLPR
  hitachivantara.vspone_block.vsp.hv_external_path_group_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "changeme"
    state: "assign_external_parity_group"
    spec:
      external_parity_group_id: "1-5"
      clpr_id: 1

- name: Create external parity group
  hitachivantara.vspone_block.vsp.hv_external_paritygroup:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "changeme"
    state: "present"
    spec:
      external_parity_group_id: "1-17"
      external_path_group_id: 4
      port_id: "CL6-B"
      external_wwn: "50060e8012277d71"
      lun_id: 20

- name: Disconnect from a volume on the external storage system
  hitachivantara.vspone_block.vsp.hv_external_paritygroup:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "changeme"
    state: "disconnect"
    spec:
      external_parity_group_id: "1-17"

- name: Delete external parity group
  hitachivantara.vspone_block.vsp.hv_external_paritygroup:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "changeme"
    state: "disconnect"
    spec:
      external_parity_group_id: "1-17"
      force: true

Return Values

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

Key	Description
external_parity_groups list / elements=dictionary	List of discovered external parity groups. Returned: always
available_volume_capacity integer	Available capacity (GB). Returned: success Sample: `20`
available_volume_capacity_in_kb integer	Available capacity (KB). Returned: success Sample: `20971520`
clpr_id integer	CLPR number assigned to the external parity group. Returned: success Sample: `0`
emulation_type string	Emulation type. Returned: success Sample: `"OPEN-V"`
external_parity_group_id string	External parity group ID. Returned: success Sample: `"1-17"`
external_product_id string	External product identifier. Returned: success Sample: `"OPEN-V"`
num_of_ldevs integer	Number of LDEVs in the external parity group. Returned: success Sample: `0`
spaces list / elements=dictionary	Free space and LDEV information for the external parity group. Returned: success
lba_size string	Size of the partition in the external parity group (hex string, multiple of 512 bytes). Returned: success Sample: `"0x000002800000"`
ldev_id any	LDEV number or false if not defined. Returned: success Sample: `1351`
storage_serial_number string	Storage serial number. Returned: success Sample: `"810045"`
used_capacity_rate integer	Usage rate of the external parity group. Returned: success Sample: `0`

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