W3cubDocs

/Ansible

ibm.storage_virtualize.ibm_svctask_command module – This module implements SSH Client which helps to run svctask CLI command(s) on IBM Storage Virtualize family 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_svctask_command.

New in ibm.storage_virtualize 1.2.0

Synopsis

  • Runs svctask and satask CLI command(s) on IBM Storage Virtualize Family systems. In case any command fails while running this module, then the module stops processing further commands in the list. Paramiko must be installed to use this module.

Parameters

Parameter

Comments

clustername

string / required

The hostname or management IP of the Storage Virtualize system.

command

list / elements=string

A list containing svctask CLI commands to be executed on storage.

domain

string

Domain for the Storage Virtualize storage system.

Valid when hostname is used for the parameter clustername.

key_filename

string

SSH client private key filename. By default, ~/.ssh/id_rsa is used.

log_path

string

Path of debug log file.

password

string

Password for the Storage Virtualize system.

username

string / required

Username for the Storage Virtualize system.

usesshkey

string

For key-pair based SSH connection, set this field as “yes”. Provide full path of key in key_filename field. If not provided, default path of SSH key is used.

Choices:

  • "yes"
  • "no" ← (default)

Examples

- name: Run svctask CLI commands using SSH client with password
  ibm.storage_virtualize.ibm_svctask_command:
    command: [
      "svctask mkvdisk -name {{ volname }} -mdiskgrp '{{ pool }}' -easytier '{{ easy_tier }}' -size {{ size }} -unit {{ unit }}",
      "svctask rmvdisk {{ volname }}"
    ]
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: /tmp/ansible.log
- name: Run svctask CLI command using passwordless SSH Client
  ibm.storage_virtualize.ibm_svctask_command:
    command: [
      "svctask mkvdisk -name vol0 -mdiskgrp pool0 -easytier off -size 1 -unit gb",
      "svctask rmvdisk vol0"
    ]
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    usesshkey: 'yes'
    log_path: /tmp/ansible.log
- name: Run satask CLI command
  ibm.storage_virtualize.ibm_svctask_command:
    command: "satask snap"
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: /tmp/ansible.log
- name: Generate and export system-signed root CA certificate
  ibm.storage_virtualize.ibm_svctask_command:
    command: [
      "svctask chsystemcert -mksystemsigned",
      "svctask chsystemcert -exportrootcacert"
    ]
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: /tmp/ansible.log

Authors

  • Shilpi Jain (@Shilpi-Jain1)
  • Sumit Kumar Gupta (@sumitguptaibm)
  • Rahul Pawar (@rahulpawaribm)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ibm/storage_virtualize/ibm_svctask_command_module.html