hitachivantara.vspone_block.sds_block.hv_sds_block_drives_facts module – Get drives from storage system

Note

This module is part of the hitachivantara.vspone_block collection (version 4.1.0).

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

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.

locator_led_status

string

Filter drives by locator LED status

Choices:

  • "On"

  • "Off"

status

string

Filter drives by status

Choices:

  • "Offline"

  • "Normal"

  • "TemporaryBlockage"

  • "Blockage"

status_summary

string

Filter drives by status summary

Choices:

  • "Normal"

  • "Warning"

  • "Error"

storage_node_id

string

Filter drives by storage node ID (UUID format)

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

data

list / elements=dictionary

List of drive entries.

Returned: success

deviceFileName

string

Device file name as recognized by the OS.

Returned: success

Sample: "sdb"

driveCapacity

integer

Capacity of the drive in GB.

Returned: success

Sample: 195

driveType

string

Type of the drive (e.g., SSD, HDD).

Returned: success

Sample: "SSD"

firmwareRevision

string

Firmware version of the drive.

Returned: success

Sample: "HPD2"

id

string

Unique identifier for the drive.

Returned: success

Sample: "126f360e-c79e-4e75-8f7c-7d91bfd2f0b8"

locatorLedStatus

string

Current status of the locator LED on the drive.

Returned: success

Sample: "Off"

serialNumber

string

Serial number of the drive.

Returned: success

Sample: "S5KWNE0NC01548"

status

string

Current operational status of the drive.

Returned: success

Sample: "Normal"

statusSummary

string

Summary of the drive’s status.

Returned: success

Sample: "Normal"

storageNodeId

string

UUID of the storage node associated with the drive.

Returned: success

Sample: "9d36c162-e379-4c85-bcc2-ccf98fe774a6"

typeCode

string

Manufacturer-specific type code.

Returned: success

Sample: "VO001600JWZJQ"

vendorName

string

Vendor or manufacturer name.

Returned: success

Sample: "HP"

wwid

string

World Wide Identifier of the drive.

Returned: success

Sample: "naa.50000f0b00c060c0"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)