hitachivantara.vspone_block.vsp.hv_disk_drive module – Changes disk drive settings from Hitachi VSP storage systems.

Note

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

New in hitachivantara.vspone_block 3.2.0

Synopsis

• This module changes disk drive settings from Hitachi VSP storage systems.

• For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/disk_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.
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 tasks.
drive_location_id string	The drive location Id of the hard drive to retrieve.
is_spared_drive boolean	Specify whether the disk drive is a spared drive. Choices: false true
state string	The level of the Disk Drives task. Choices: "present" ← (default)

Attributes

Attribute	Support	Description
check_mode	Support: none	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: Change disk drive settings
  hitachivantara.vspone_block.vsp.hv_disk_drive:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "present"
    spec:
      drive_location_id: "0-16"
      is_spared_drive: true

Return Values

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

Key	Description
disk_drive list / elements=dictionary	Disk drive managed by the module. Returned: success
copyback_mode boolean	Indicates if copy back mode is enabled. Returned: success Sample: true
drive_type string	Type of the drive. Returned: success Sample: "SSD"
free_capacity string	Free capacity of the drive. Returned: success Sample: "5.16TB"
is_accelerated_compression boolean	Indicates if accelerated compression is enabled. Returned: success Sample: false
is_encryption_enabled boolean	Indicates if encryption is enabled. Returned: success Sample: true
is_pool_array_group boolean	Indicates if the drive is part of a pool array group. Returned: success Sample: false
ldev_ids list / elements=integer	List of LDEV IDs associated with the drive. Returned: success Sample: []
parity_group_id string	ID of the parity group. Returned: success Sample: "1-10"
raid_level string	RAID level of the drive. Returned: success Sample: "RAID5"
resource_group_id integer	ID of the resource group. Returned: success Sample: -1
status string	Status of the drive. Returned: success Sample: ""
total_capacity string	Total capacity of the drive. Returned: success Sample: "5.16TB"

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)