hitachivantara.vspone_block.vsp.hv_ldev_facts module – Retrieves information about logical devices (LDEVs) 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_ldev_facts.

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module retrieves information about logical devices (LDEVs) from VSP block storage systems.
It provides details such as LDEV IDs, names, and other relevant information.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/ldev_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.
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 LDEV information.
count integer	Number of LDEVs to retrieve. Required for the Get LDEVs from start ID up to max count task. Optional for the Get Free LDEV IDs task.
end_ldev_id string	Ending LDEV ID for filtering LDEVs. Can be decimal or hexadecimal. Required for the Get LDEVs within range task. Optional for the Get Free LDEV IDs task.
is_detailed boolean	Flag to retrieve all the additional properties that are not returned with regular LDEV facts output. Required for the Get one LDEV with detailed info task. Choices: `false` ← (default) `true`
journal_id integer	ID of the journal to filter LDEVs. Required for the Get LDEV details using journal ID task.
ldev_id string	ID of the specific LDEV to retrieve information for. Can be decimal or hexadecimal. Required for the Get one LDEV /Get one LDEV with detailed info /Get one ldev with detailed info by specifying one or more query parameters tasks.
ldev_ids list / elements=string	List of LDEV IDs to retrieve information for. Can be decimal or hexadecimal. Required for the Get multiple LDEVs task.
name string	Name of the LDEV. Required for the Get LDEVs with the same name task.
parity_group_id string	ID of the parity group to filter LDEVs. Required for the Get LDEV details using parity group ID task.
pool_id integer	ID of the pool to filter LDEVs. Required for the Get LDEV details using pool ID task.
query list / elements=string	Getting all the additional properties of the LDEV facts output is time-consuming. To optimize the performance, you can specify a list of additional properties to be retrieved. This field allows you to specify a list of strings, where each string indicates which additional properties are retrieved. If is_detailed is set to true, this field will be ignored and all additional properties will be retrieved. The supported additional properties are: “cmd_device_settings”, “encryption_settings”, “nvm_subsystem_info”, “qos_settings”, “free_ldev_id” and “snapshots_info”. Required for the Get one ldev with detailed info by specifying one or more query parameters /Get Free LDEV IDs tasks.
resource_group_id integer	ID of the resource group to filter LDEVs. Required for the Get LDEV details using resource group ID task.
start_ldev_id string	Starting LDEV ID for filtering LDEVs. Can be decimal or hexadecimal. Required for the Get LDEVs within range /Get LDEVs from start ID up to max count tasks. Optional for the Get Free LDEV IDs 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: Get all ldevs
  hitachivantara.vspone_block.vsp.hv_ldev_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"

- name: Retrieve information about a specific LDEV
  hitachivantara.vspone_block.vsp.hv_ldev_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    spec:
      ldev_id: 123

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
free_ldev_ids list / elements=integer	List of free LDEV IDs when querying for available LDEVs. Returned: success Sample: `[100, 101, 102, 103, 104]`
volumes list / elements=dictionary	List of storage volumes with their attributes. Returned: success
canonical_name string	Unique identifier for the volume. Returned: success Sample: `"naa.60060e8028273d005080273d00000102"`
clpr_id integer	CLPR (Control Logical Partition) ID. Returned: success Sample: `0`
compression_acceleration_status string	Status of compression accelerator. Returned: success Sample: `"ENABLED"`
cylinder integer	Cylinder number for mainframe volumes. Returned: success Sample: `65945`
data_reduction_process_mode string	Data reduction process mode. Returned: success Sample: `"inline"`
dedup_compression_progress integer	Progress percentage of deduplication and compression. Returned: success Sample: `-1`
dedup_compression_status string	Status of deduplication and compression. Returned: success Sample: `"ENABLED"`
deduplication_compression_mode string	Mode of deduplication and compression. Returned: success Sample: `"compression_deduplication"`
emulation_type string	Emulation type of the volume. Returned: success Sample: `"3390-V-CVS"`
hostgroups list / elements=dictionary	List of host groups associated with the volume. Returned: success Sample: `[]`
is_alua boolean	Indicates if ALUA is enabled. Returned: success Sample: `false`
is_command_device boolean	Indicates if the volume is a command device. Returned: success
is_compression_acceleration_enabled boolean	Whether compression accelerator is enabled. Returned: success Sample: `true`
is_data_reduction_share_enabled boolean	Indicates if data reduction share is enabled. Returned: success Sample: `true`
is_device_group_definition_enabled boolean	Indicates if device group definition is enabled. Returned: success
is_encryption_enabled boolean	Indicates if encryption is enabled. Returned: success Sample: `false`
is_full_allocation_enabled boolean	Indicates if full allocation is enabled. Returned: success Sample: `false`
is_relocation_enabled boolean	Indicates if tier relocation is enabled. Returned: success
is_security_enabled boolean	Indicates if security is enabled. Returned: success
is_user_authentication_enabled boolean	Indicates if user authentication is enabled. Returned: success
is_write_protected boolean	Indicates if write protection is enabled. Returned: success
is_write_protected_by_key boolean	Indicates if write protection by key is enabled. Returned: success
iscsi_targets list / elements=dictionary	List of iSCSI targets associated with the volume. Returned: success Sample: `[]`
ldev_id integer	Logical Device ID. Returned: success Sample: `10010`
ldev_id_hex string	Logical Device ID in hexadecimal. Returned: success Sample: `"00:27:1A"`
mp_blade_id integer	MP blade ID. Returned: success Sample: `3`
name string	Name of the volume. Returned: success Sample: `"smrha-258"`
num_of_ports integer	Number of ports associated with the volume. Returned: success Sample: `2`
nvm_subsystems list / elements=dictionary	List of NVMe subsystems associated with the volume. Returned: success Sample: `[]`
parent_volume_id integer	Parent volume ID for snapshot volumes. Returned: success Sample: `-1`
parent_volume_id_hex string	Parent volume ID in hexadecimal format. Returned: success Sample: `"-0:00:01"`
parity_group_id string	Parity group ID. Returned: success Sample: `"1-8"`
path_count integer	Path count to the volume. Returned: success Sample: `2`
pool_id integer	Pool ID where the volume resides. Returned: success Sample: `13`
ports list / elements=dictionary	List of ports associated with the volume. Returned: success Sample: `[{"host_group_name": "1C-G00", "host_group_number": 156, "lun": 26, "port_id": "CL1-C"}]`
host_group_name string	Host group name. Returned: success Sample: `"1C-G00"`
host_group_number integer	Host group number. Returned: success Sample: `156`
lun integer	Logical Unit Number. Returned: success Sample: `26`
port_id string	Port identifier. Returned: success Sample: `"CL1-C"`
provision_type string	Provisioning type of the volume. Returned: success Sample: `"CVS"`
qos_settings dictionary	QoS settings for the volume. Returned: success
resource_group_id integer	Resource group ID of the volume. Returned: success Sample: `0`
snapshots list / elements=dictionary	List of snapshots associated with the volume. Returned: success Sample: `[]`
ssid string	Subsystem ID for mainframe volumes. Returned: success Sample: `"000C"`
status string	Current status of the volume. Returned: success Sample: `"NML"`
storage_serial_number string	Serial number of the storage system. Returned: success Sample: `"70033"`
tiering_policy dictionary	Tiering policy details. Returned: success Sample: `{}`
total_capacity string	Total capacity of the volume. Returned: success Sample: `"54.71GB"`
total_capacity_in_mb float	Total capacity of the volume in megabytes. Returned: success Sample: `56023.04`
used_capacity string	Used capacity of the volume. Returned: success Sample: `"0.00B"`
used_capacity_in_mb float	Used capacity of the volume in megabytes. Returned: success Sample: `0.0`
virtual_ldev_id integer	Virtual Logical Device ID. Returned: success Sample: `-1`
virtual_ldev_id_hex string	Virtual Logical Device ID in hexadecimal. Returned: success Sample: `""`

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