hitachivantara.vspone_block.sds_block.hv_sds_block_drive module – Manages drive on Hitachi SDS Block storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.2.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_drive.

New in hitachivantara.vspone_block 4.2.0

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.
should_drive_locator_led_on boolean	Whether to turn on the drive locator LED.. 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
storage_pools dictionary	A list of storage pools. Returned: always
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)

Collection links

• Issue Tracker
• Repository (Sources)