hitachivantara.vspone_block.vsp.hv_external_volume_facts module – Retrieves information about External Volume from Hitachi VSP storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 3.4.0).

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

New in hitachivantara.vspone_block 3.3.0

Synopsis

• This module retrieves information about External Volume from Hitachi VSP storage systems.

• For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/external_volume_facts.yml

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.8

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.
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 retrieving External Volume information.
external_ldev_id integer	The external LDEV ID.
external_storage_serial string	The external storage serial number.
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.

Examples

- name: Retrieve information about all External Volume
  hitachivantara.vspone_block.vsp.hv_external_volume_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "changeme"
    spec:
      external_storage_serial: '410109'
      external_ldev_id: 1354

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
ldevs list / elements=dictionary	The list of external volume IDs. Returned: success
external_ldev_id integer	External LDEV ID. Returned: success Sample: 1353
external_lun integer	External lun ID. Returned: success Sample: 9
external_path_group_id integer	External path group ID. Returned: success Sample: 0
external_product_id string	External path group ID. Returned: success Sample: "VSP Gx00"
external_serial_number string	External serial number. Returned: success Sample: "410109"
external_volume_capacity integer	External volume capacity. Returned: success Sample: 41943040
external_volume_capacity_in_mb float	External volume capacity in MB. Returned: success Sample: 20480.0
external_volume_info string	External volume information. Returned: success Sample: "OPEN-V HITACHI 5040277D0549"
external_wwn string	External WWN. Returned: success Sample: "50060e8012277d61"
ldev_ids list / elements=integer	External volume capacity. Returned: success Sample: [151]
port_id string	External WWN. Returned: success Sample: "CL3-B"

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)