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 4.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_external_volume_facts.

New in hitachivantara.vspone_block 3.3.0

Synopsis

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.

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

string

The external LDEV ID. Required for the Get all external volume for specific ldev_id task.

external_storage_serial

string

The external storage serial number. Required for the Get all external volume for specific ldev_id task.

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.

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: 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

external_volume

list / elements=dictionary

The list of external volumes.

Returned: success

external_ldev_id

integer

External LDEV ID.

Returned: success

Sample: 1323

external_ldev_id_hex

string

External LDEV ID in hexadecimal format.

Returned: success

Sample: "00:05:2B"

external_lun

integer

External LUN number.

Returned: success

Sample: 0

external_path_group_id

integer

External path group ID.

Returned: success

Sample: 0

external_product_id

string

Product ID of the external storage system.

Returned: success

Sample: "VSP Gx00"

external_serial_number

string

Serial number of the external storage system.

Returned: success

Sample: "410109"

external_volume_capacity

integer

External volume capacity in blocks.

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

Returned: success

Sample: "OPEN-V HITACHI 5040277D052B"

external_wwn

string

WWN of the external storage system.

Returned: success

Sample: "50060e8012277d71"

ldev_ids

list / elements=integer

List of LDEV IDs associated with the external volume.

Returned: success

Sample: [1351, 1465, 1670, 1510, 1511, 1512, 1513]

port_id

string

Port ID of the external storage system.

Returned: success

Sample: "CL6-B"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)