W3cubDocs

/Ansible

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

New in hitachivantara.vspone_block 3.0.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 LDEV information.

count

integer

Number of LDEVs to retrieve.

end_ldev_id

integer

Ending LDEV ID for filtering LDEVs.

is_detailed

boolean

Flag to retrieve all the additional properties that are not returned with regular LDEV facts output.

Choices:

  • false ← (default)
  • true

ldev_id

integer

ID of the specific LDEV to retrieve information for.

name

string

Name of the LDEV.

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”, and “snapshots_info”.

start_ldev_id

integer

Starting LDEV ID for filtering LDEVs.

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

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.60060e8028274200508027420000000a"

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

deduplication_compression_mode

string

Mode of deduplication and compression.

Returned: success

Sample: "disabled"

emulation_type

string

Emulation type of the volume.

Returned: success

Sample: "OPEN-V-CVS-CM"

hostgroups

list / elements=string

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

Sample: false

is_data_reduction_share_enabled

boolean

Indicates if data reduction share is enabled.

Returned: success

Sample: false

is_device_group_definition_enabled

boolean

Indicates if device group definition is enabled.

Returned: success

Sample: false

is_encryption_enabled

boolean

Indicates if encryption is enabled.

Returned: success

Sample: false

is_security_enabled

boolean

Indicates if security is enabled.

Returned: success

Sample: false

is_user_authentication_enabled

boolean

Indicates if user authentication is enabled.

Returned: success

Sample: false

is_write_protected

boolean

Indicates if the volume is write-protected.

Returned: success

Sample: false

is_write_protected_by_key

boolean

Indicates if the volume is write-protected by key.

Returned: success

Sample: false

iscsi_targets

list / elements=string

List of associated iSCSI targets.

Returned: success

Sample: []

ldev_id

integer

Logical Device ID.

Returned: success

Sample: 10

logical_unit_id_hex_format

string

Logical Unit ID in hexadecimal format.

Returned: success

Sample: "00:00:0A"

name

string

Name of the volume.

Returned: success

Sample: "snewar-cmd"

num_of_ports

integer

Number of ports associated with the volume.

Returned: success

Sample: 1

nvm_subsystems

list / elements=string

List of associated NVM subsystems.

Returned: success

Sample: []

parity_group_id

string

Parity group ID of the volume.

Returned: success

Sample: ""

path_count

integer

Number of paths to the volume.

Returned: success

Sample: 1

pool_id

integer

Pool ID where the volume resides.

Returned: success

Sample: 0

provision_type

string

Provisioning type of the volume.

Returned: success

Sample: "CMD,CVS,HDP"

qos_settings

dictionary

Quality of Service settings for the volume.

Returned: success

Sample: {}

resource_group_id

integer

Resource group ID of the volume.

Returned: success

Sample: 0

snapshots

list / elements=string

List of snapshots associated with the volume.

Returned: success

Sample: []

status

string

Current status of the volume.

Returned: success

Sample: "NML"

storage_serial_number

string

Serial number of the storage system.

Returned: success

Sample: "810050"

tiering_policy

dictionary

Tiering policy applied to the volume.

Returned: success

Sample: {}

total_capacity

string

Total capacity of the volume.

Returned: success

Sample: "50.00MB"

total_capacity_in_mb

string

Total capacity of the volume in megabytes.

Returned: success

Sample: "50.0 MB"

used_capacity

string

Used capacity of the volume.

Returned: success

Sample: "0.00B"

used_capacity_in_mb

string

Used capacity of the volume in megabytes.

Returned: success

Sample: "0.0 MB"

virtual_ldev_id

integer

Virtual Logical Device ID.

Returned: success

Sample: -1

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_ldev_facts_module.html