ibm.storage_virtualize.ibm_sv_manage_drive module – This module manages drives on IBM Storage Virtualize family storage systems

Note

This module is part of the ibm.storage_virtualize collection (version 2.7.4).

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 ibm.storage_virtualize.

To use it in a playbook, specify: ibm.storage_virtualize.ibm_sv_manage_drive.

New in ibm.storage_virtualize 2.4.0

Synopsis

  • Ansible interface to manage drive-related operations.

Parameters

Parameter

Comments

clustername

string / required

The hostname or management IP of the Storage Virtualize storage system.

domain

string

Domain for the Storage Virtualize storage system.

Valid when hostname is used for the parameter clustername.

drive_id

integer / required

Specifies the drive id.

drive_state

string

Specifies the desired usability state of the drive.

Choices:

  • "unused"

  • "candidate"

  • "spare"

  • "failed"

log_path

string

Path of debug log file.

password

string

REST API password for the Storage Virtualize storage system.

The parameters username and password are required if not using token to authenticate a user.

task

string

Specifies a task to be performed on drive.

Choices:

  • "format"

  • "certify"

  • "recover"

  • "erase"

  • "triggerdump"

token

string

The authentication token to verify a user on the Storage Virtualize storage system.

To generate a token, use the ibm_svc_auth module.

username

string

REST API username for the Storage Virtualize storage system.

The parameters username and password are required if not using token to authenticate a user.

validate_certs

boolean

Validates certification.

Choices:

  • false ← (default)

  • true

Notes

Note

  • This module supports check_mode.

  • If error code CMMVC6624E is returned after running a recover task, most likely drive has already been recovered.

Examples

- name: Change drive state to candidate
  ibm.storage_virtualize.ibm_sv_manage_drive:
   clustername: "{{ cluster }}"
   username: "{{ username }}"
   password: "{{ password }}"
   drive_id: 5
   drive_state: candidate
   log_path: /tmp/playbook.debug

- name: Format a drive
  ibm.storage_virtualize.ibm_sv_manage_drive:
   clustername: "{{ cluster }}"
   username: "{{ username }}"
   password: "{{ password }}"
   drive_id: 5
   task: format
   log_path: /tmp/playbook.debug

- name: Trigger a drive dump
  ibm.storage_virtualize.ibm_sv_manage_drive:
   clustername: "{{ cluster }}"
   username: "{{ username }}"
   password: "{{ password }}"
   drive_id: 5
   task: triggerdump
   log_path: /tmp/playbook.debug

Authors

  • Sumit Kumar Gupta (@sumitguptaibm)