hitachivantara.vspone_block.sds_block.hv_sds_block_drive module – Turns ON and OFF the drive locator LED, removes a drive from VSP One SDS Block system cluster.

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_drive.

New in hitachivantara.vspone_block 4.2.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

This module allows to control on and off of the locator LED of a drive, and remove a drive on Hitachi SDS Block storage systems.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_drive.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 / required	Specification for the drive.
id string / required	The ID of the drive. Required for the Turn on the locator LED of a drive (Bare Metal only) /Turn off the locator LED of a drive (Bare Metal only) /Remove a drive tasks.
should_drive_locator_led_on boolean	Whether to turn on the drive locator LED. Required for the Turn on the locator LED of a drive (Bare Metal only) task. Choices: `false` ← (default) `true`
state string	The desired state of the storage pool. Choices: `"present"` ← (default) `"absent"`

Attributes

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

Examples

- name: Turn on the locator LED of a drive
  hitachivantara.vspone_block.sds_block.hv_sds_block_drive:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "present"
    spec:
      id: "ff27bc05-a181-4de2-b496-675fdc1ce869"
      should_drive_locator_led_on: true

- name: Turn off the locator LED of a drive
  hitachivantara.vspone_block.sds_block.hv_sds_block_drive:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "present"
    spec:
      id: "ff27bc05-a181-4de2-b496-675fdc1ce869"

- name: Remove a drive
  hitachivantara.vspone_block.sds_block.hv_sds_block_drive:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "absent"
    spec:
      id: "ff27bc05-a181-4de2-b496-675fdc1ce869"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
drive dictionary	Details of the drive. Returned: always
device_file_name string	Device file name as recognized by the OS. Returned: success Sample: `"sda"`
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: `"f17d6b10-d0e4-4604-a0af-f9b3f0d32664"`
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: `"V6V1MHJA"`
status string	Current operational status of the drive. Returned: success Sample: `"Normal"`
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: `"db77407c-237d-4ae2-9efe-13332c2a71e8"`
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.5000cca0a602f64c"`

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