hitachivantara.vspone_block.vsp.hv_pav_alias module – Manages PAV (Parallel Access Volume) alias assignments for 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_pav_alias.

New in hitachivantara.vspone_block 4.6.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

This module manages PAV (Parallel Access Volume) alias assignments for VSP block storage systems.
Supports assigning alias devices to base devices and unassign them.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/pav_alias.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.
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
spec dictionary / required	Specification for the PAV alias assignment.
alias_ldev_ids list / elements=integer / required	List of alias LDEV IDs to assign or unassign to/from the base LDEV.
base_ldev_id integer	The base LDEV ID to assign or unassign aliases.
state string	The desired state of the PAV alias assignment. Choices: `"present"` ← (default) `"absent"`

Attributes

Attribute	Support	Description
check_mode	Support: none	Determines if the module should run in check mode.

Examples

- name: Assign PAV aliases to a base LDEV
  hitachivantara.vspone_block.hv_pav_alias:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: present
    spec:
      base_ldev_id: 100
      alias_ldev_ids: [102, 103, 104]

- name: Unassign PAV aliases from a base LDEV
  hitachivantara.vspone_block.hv_pav_alias:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: absent
    spec:
      alias_ldev_ids: [102, 103]

Return Values

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

Key	Description
changed boolean	Whether any changes were made to the PAV alias assignments. Returned: always Sample: `true`
pav_aliases list / elements=dictionary	List of PAV aliases after the operation. Returned: always
assignment_status string	Current assignment status of the PAV alias. Returned: success Sample: `"assigned"`
base_ldev_id integer	Base LDEV ID that this alias is associated with. Returned: success Sample: `100`
ldev_id integer	Logical Device ID of the alias. Returned: success Sample: `102`
pav_attribute string	PAV attribute indicating the role (BASE or ALIAS). Returned: success Sample: `"ALIAS"`

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