hitachivantara.vspone_block.vsp.hv_external_volume module – Manages External Volumes in the 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_external_volume.

New in hitachivantara.vspone_block 3.3.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module creates and deletes the External Volumes in the VSP block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/external_volume.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.
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 the External Volume management.
external_ldev_id string	The external LDEV ID. Required for the Create/Delete tasks.
external_parity_group string	The external parity group ID. Required for the Disconnect from a volume tasks.
external_storage_serial string	The external storage serial number. Required for the Create/Delete tasks.
ldev_id string	LDEV ID, it will be auto-selected if omitted. Required for the Create/Delete tasks. Can be decimal or hexadecimal.
state string	The level of the Disk Drives task. Choices: `"present"` ← (default) `"absent"` `"disconnect"`
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: none	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: Create a External Volume
  hitachivantara.vspone_block.vsp.hv_external_volume_facts:
    connection_info:
      address: storage1.company.com
      username: 'username'
      password: 'password'
    spec:
      external_storage_serial: '410109'
      external_ldev_id: 1354
      ldev_id: 151

- name: Delete External Volume
  hitachivantara.vspone_block.vsp.hv_external_volume:
    connection_info:
      address: storage1.company.com
      username: 'username'
      password: 'password'
    state: "absent"
    spec:
      ldev_id: 151

- name: Disconnect from a volume on the external storage system
  hitachivantara.vspone_block.vsp.hv_external_volume:
    connection_info:
      address: storage1.company.com
      username: 'username'
      password: 'password'
    state: "disconnect"
    spec:
      external_parity_group: "1-2"

Return Values

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

Key	Description
external_parity_group dictionary	Information about the external parity group. Returned: when state is disconnect
external_volume dictionary	Detailed information about the external volume on the storage system. Returned: when state is present
canonical_name string	Canonical name of the external volume. Returned: success Sample: `""`
emulation_type string	Emulation type of the external volume. Returned: success Sample: `"OPEN-V"`
externalPorts list / elements=dictionary	List of external ports associated with the volume. Returned: success
host_group_number integer	Host group number for the external port. Returned: success Sample: `0`
lun integer	Logical unit number. Returned: success Sample: `17`
port_id string	Port identifier. Returned: success Sample: `"CL6-A"`
wwn string	World Wide Name of the port. Returned: success Sample: `"50060e8012277d61"`
externalVolumeId string	External volume identifier. Returned: success Sample: `"484954414348492035303430323737443035353400000000000000000000000000000000"`
ldev_id integer	Logical device ID. Returned: success Sample: `1579`
logical_unit_id_hex_format string	Logical unit ID in hexadecimal format. Returned: success Sample: `"00:06:2B"`
name string	Name of the external volume. Returned: success Sample: `"quorum-1364"`
provision_type string	Provisioning type of the volume. Returned: success Sample: `"ELUN,QRD"`
resource_group_id integer	Resource group ID. Returned: success Sample: `0`
status string	Status of the external volume. Returned: success Sample: `"BLK"`
total_capacity string	Total capacity in human readable format. Returned: success Sample: `"20.00GB"`
total_capacity_in_mb float	Total capacity in megabytes. Returned: success Sample: `20480.0`
virtual_ldev_id integer	Virtual logical device ID. Returned: success Sample: `-1`

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