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

Note

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

New in hitachivantara.vspone_block 3.2.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.

ca_cert

string

Path to a CA certificate file or directory on the Ansible control node used to verify the storage system SSL certificate.

Required when connection_info.validate_cert is true and the storage system uses a self-signed or privately issued certificate.

Accepts a PEM file path or a directory of hashed CA certificates.

client_cert

string

Path to client SSL certificate file or CA certificate directory for mutual TLS authentication.

Must be provided together with connection_info.client_key.

client_key

string

Path to the client private key file for mutual TLS authentication.

Must be provided together with connection_info.client_cert.

password

string / required

Password for authentication. This is a required field.

suppress_validate_cert_warning

boolean

Whether to suppress the SSL certificate validation warning.

When set to false (default), a warning is displayed if certificate validation is disabled.

Set to true to suppress the warning.

Choices:

  • false ← (default)

  • true

username

string / required

Username for authentication. This is a required field.

validate_cert

boolean

Whether to validate the storage system SSL certificate.

When set to false (default), certificate validation is disabled. A security warning will be displayed unless connection_info.suppress_validate_cert_warning is true.

Set to true to enable certificate validation. When true, provide connection_info.ca_cert if the storage system uses a self-signed certificate.

Note: Starting with major version 5.0, the default value will change to true. It is strongly recommended to enable certificate validation in production environments.

Choices:

  • false ← (default)

  • true

spec

dictionary

Specification for the hard drive tasks.

drive_location_id

string

The drive location Id of the hard drive to retrieve. Optional for the Change drive settings task.

is_spared_drive

boolean

Specify whether the disk drive is a spared drive. Required for the Change drive settings task.

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.

  • This module is not supported for VSP One BHE and higher storage models.

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

dictionary

Disk drive managed by the module.

Returned: success

drive_location_id

string

The drive location identifier.

Returned: success

Sample: "0-22"

drive_type

string

Model identifier of the drive.

Returned: success

Sample: "SNM5C-R1R9NC"

drive_type_name

string

Human readable drive type name.

Returned: success

Sample: "SSD"

serial_number

string

Serial number of the drive.

Returned: success

Sample: "C2YII03F"

status

string

Status of the drive.

Returned: success

Sample: "NML"

total_capacity

string

Total capacity of the drive expressed as a string with units.

Returned: success

Sample: "1900 GB"

total_capacity_mb

integer

Total capacity of the drive in megabytes.

Returned: success

Sample: 1945600.0

usage_type

string

Current usage type of the drive.

Returned: success

Sample: "FREE"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)