hitachivantara.vspone_block.sds_block.hv_sds_block_drives_facts module – Retrieves information about storage drives.

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.sds_block.hv_sds_block_drives_facts.

New in hitachivantara.vspone_block 4.1.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

Get drives from storage system with various filtering options
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_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.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
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 retrieving CHAP user information.
id string	Unique identifier for the drive. Required for the Get drive by ID task.
locator_led_status string	Filter drives by locator LED status Optional for the Get drives by specifying optional parameters task. Choices: `"On"` `"Off"`
status string	Filter drives by status Optional for the Get drives by specifying optional parameters task. Choices: `"Offline"` `"Normal"` `"TemporaryBlockage"` `"Blockage"`
status_summary string	Filter drives by status summary Optional for the Get drives by specifying optional parameters task. Choices: `"Normal"` `"Warning"` `"Error"`
storage_node_id string	Filter drives by storage node ID (UUID format) Optional for the Get drives by specifying optional parameters task.

Attributes

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Examples

- name: Retrieve information about all drives
  hitachivantara.vspone_block.sds_block.hv_sds_block_drives_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve information about drives by specifying optional parameters
  hitachivantara.vspone_block.sds_block.hv_sds_block_drives_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      status_summary: Normal
      status: Normal
      storage_node_id: 086e0c50-4b8d-430e-be47-bd65da4ca229
      locator_led_status: "On"

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
drives list / elements=dictionary	List of drive entries. Returned: success
device_file_name string	Device file name as recognized by the OS. Returned: success Sample: `"sdh"`
drive_capacity integer	Capacity of the drive in GB. Returned: success Sample: `800`
drive_type string	Type of the drive (e.g., SSD, HDD). Returned: success Sample: `"SSD"`
firmware_revision string	Firmware version of the drive. Returned: success Sample: `"HPD3"`
id string	Unique identifier for the drive. Returned: success Sample: `"f41a9fa2-180e-4776-bbc4-9c536870c247"`
locator_led_status string	Current status of the locator LED on the drive. Returned: success Sample: `"Off"`
serial_number string	Serial number of the drive. Returned: success Sample: `"V6V1G2LA"`
status string	Current operational status of the drive. Returned: success Sample: `"TemporaryBlockage"`
status_summary string	Summary of the drive’s status. Returned: success Sample: `"Normal"`
storage_node_id string	UUID of the storage node associated with the drive. Returned: success Sample: `"152d2d10-4e18-44aa-86a4-fbd4f7e4cb08"`
type_code string	Manufacturer-specific type code. Returned: success Sample: `"MO000800JWUFU"`
vendor_name string	Vendor or manufacturer name. Returned: success Sample: `"HP"`
wwid string	World Wide Identifier of the drive. Returned: success Sample: `"naa.5000cca0a602a4f4"`

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/sds_block.hv_sds_block_drives_facts_module.html