hitachivantara.vspone_block.vsp.hv_pav_alias_facts module – retrieves information about PAV aliases 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_pav_alias_facts.

New in hitachivantara.vspone_block 4.6.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module gathers facts about PAV aliases from VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/pav_alias_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.
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 PAV alias facts to be gathered.
alias_ldev_id integer	The PAV LDEV ID to retrieve information for. Required for getting information about a specific PAV LDEV.
base_ldev_id integer	The base LDEV ID to retrieve PAV aliases for. Required for getting PAV aliases for a specific base LDEV.
cu_number integer	The CU (Control Unit) number to retrieve PAV aliases for. Required for getting PAV aliases for a specific control unit.

Attributes

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

Examples

- name: Get PAV aliases for a specific control unit
  hitachivantara.vspone_block.hv_pav_alias_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      cu_number: "0"

- name: Get all PAV aliases
  hitachivantara.vspone_block.hv_pav_alias_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
pav_aliases list / elements=dictionary	List of PAV aliases with their attributes. Returned: success
c_base_volume_id integer	Base volume ID for command device. Returned: success Sample: `100`
cu_number integer	Control Unit number. Returned: success Sample: `0`
ldev_id integer	Logical Device ID. Returned: success Sample: `102`
pav_attribute string	PAV attribute type. Returned: success Sample: `"ALIAS"`
s_base_volume_id integer	Base volume ID for secondary device. Returned: success Sample: `100`

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