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

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

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_path_groups

list / elements=dictionary

The list of external path groups.

Returned: success

external_parity_groups

list / elements=dictionary

The list of external parity groups.

Returned: success

cache_mode

string

Cache mode.

Returned: success

Sample: "E"

external_luns

list / elements=dictionary

List of LUNs of the external storage system.

Returned: success

external_lun

integer

LUN within the ports of the external storage system.

Returned: success

Sample: 2

external_wwn

string

WWN of the external storage system.

Returned: success

Sample: "50060e8012277d71"

path_status

string

Status of the external path.

Returned: success

Sample: "NML"

port_id

string

Port number.

Returned: success

Sample: "CL6-B"

priority

integer

Priority within the external path group.

Returned: success

Sample: 1

external_parity_group_id

string

External parity group ID.

Returned: success

Sample: "1-3"

external_parity_group_status

string

Status of the external parity group.

Returned: success

Sample: "NML"

is_data_direct_mapping

boolean

Whether the data direct mapping attribute is enabled.

Returned: success

Sample: false

is_inflow_control_enabled

boolean

Inflow cache control.

Returned: success

Sample: false

load_balance_mode

string

The load balancing method for I/O operations for the external storage system.

Returned: success

Sample: "N"

mp_blade_id

integer

Inflow cache control.

Returned: success

Sample: 0

path_mode

string

Path mode of the external storage system.

Returned: success

Sample: "M"

external_path_group_id

integer

External path group number.

Returned: success

Sample: 1

external_serial_number

string

Serial number of the external storage system.

Returned: success

Sample: "410109"

storage_serial_number

string

Serial number of the storage system.

Returned: success

Sample: "410109"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)