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

New in hitachivantara.vspone_block 3.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module gathers facts about hard drives from VSP block storage systems.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/disk_drive_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.
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. Optional for the Get one disk drive task.
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 dictionary	Container for disk drive results. Returned: success
data list / elements=dictionary	List of disk drives with their attributes. Returned: success
drive_location_id string	Drive location identifier. Returned: success Sample: `"0-0"`
drive_type string	Drive model identifier. Returned: success Sample: `"SNB5B-R1R9NC"`
drive_type_name string	Human friendly drive type. Returned: success Sample: `"SSD"`
parity_group_id string	ID of the parity group. Returned: success Sample: `"1-1"`
serial_number string	Drive serial number. Returned: success Sample: `"DKN02C7E"`
status string	Status code of the drive. Returned: success Sample: `"NML"`
total_capacity string	Total capacity expressed as a human readable string. Returned: success Sample: `"1900 GB"`
total_capacity_mb float	Total capacity in megabytes. Returned: success Sample: `1945600.0`
usage_type string	Usage type for the drive (e.g. DATA, CACHE). Returned: success Sample: `"DATA"`

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