ibm.storage_virtualize.ibm_svctask_command (2.3.1) — module

Install collection

Install with ansible-galaxy collection install ibm.storage_virtualize:==2.3.1

Add to requirements.yml

  collections:
    - name: ibm.storage_virtualize
      version: 2.3.1

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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}}"
    password:
    usesshkey: yes
    log_path: /tmp/ansible.log

Inputs

    
command:
    description:
    - A list containing svctask CLI commands to be executed on storage.
    - Each command must start with 'svctask' keyword.
    elements: str
    type: list

log_path:
    description:
    - Path of debug log file.
    type: str

password:
    description:
    - Password for the Storage Virtualize system.
    required: true
    type: str

username:
    description:
    - Username for the Storage Virtualize system.
    required: true
    type: str

usesshkey:
    choices:
    - 'yes'
    - 'no'
    default: 'no'
    description:
    - 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.
    type: str

clustername:
    description:
    - The hostname or management IP of the Storage Virtualize system.
    required: true
    type: str

key_filename:
    description:
    - SSH client private key filename. By default, ~/.ssh/id_rsa is used.
    type: str