W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_disk_drive_facts module – Retrieves information about hard drives 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_disk_drive_facts.

New in hitachivantara.vspone_block 3.2.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 of the hostname of the storage system.

password

string / required

Password for authentication. This is a required field.

username

string / required

Username for authentication. This is a required field.

spec

dictionary

Specification for the hard drive facts to be gathered.

drive_location_id

string

The drive location Id of the hard drive to retrieve.

storage_system_info

dictionary

Information about the storage system.

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 a specific hard drive
  hitachivantara.vspone_block.hv_disk_drive_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      drive_location_id: 0-16

- name: Get all hard drives
  hitachivantara.vspone_block.hv_disk_drive_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"

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

disk_drives

list / elements=dictionary

List of disk drives with their attributes.

Returned: success

copyback_mode

boolean

Indicates if copy-back mode is enabled.

Returned: success

Sample: true

drive_type

string

Type of the drive.

Returned: success

Sample: "SSD"

free_capacity

string

Free capacity of the drive.

Returned: success

Sample: "5.16TB"

is_accelerated_compression

boolean

Indicates if accelerated compression is enabled.

Returned: success

Sample: false

is_encryption_enabled

boolean

Indicates if encryption is enabled.

Returned: success

Sample: true

is_pool_array_group

boolean

Indicates if the drive is part of a pool array group.

Returned: success

Sample: false

ldev_ids

list / elements=integer

List of LDEV IDs associated with the drive.

Returned: success

Sample: []

parity_group_id

string

ID of the parity group.

Returned: success

Sample: "1-10"

raid_level

string

RAID level of the drive.

Returned: success

Sample: "RAID5"

resource_group_id

integer

ID of the resource group.

Returned: success

Sample: -1

status

string

Status of the drive.

Returned: success

Sample: ""

total_capacity

string

Total capacity of the drive.

Returned: success

Sample: "5.16TB"

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