ibm.storage_virtualize.ibm_svcinfo_command module – This module implements SSH Client which helps to run svcinfo CLI command 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_svcinfo_command.

New in ibm.storage_virtualize 1.2.0

Synopsis

  • Runs single svcinfo CLI command on IBM Storage Virtualize family systems. Filter options like filtervalue or pipe ‘|’ with grep, awk, and others are not supported in the command in this module. 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

string

Single svcinfo CLI command to be executed on Storage Virtualize system.

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 keyfile in key_filename field. If not provided, default path of SSH key is used.

Choices:

  • "yes"

  • "no" ← (default)

Examples

- name: Run svcinfo CLI command using SSH client with password
  ibm.storage_virtualize.ibm_svcinfo_command:
    command: "svcinfo lsuser {{ user }}"
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: /tmp/ansible.log
- name: Run svcinfo CLI command using passwordless SSH Client
  ibm.storage_virtualize.ibm_svcinfo_command:
    command: "svcinfo lsuser"
    usesshkey: "yes"
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    log_path: /tmp/ansible.log
- name: Run sainfo CLI command
  ibm.storage_virtualize.ibm_svcinfo_command:
    command: "sainfo lsservicenodes"
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: /tmp/ansible.log

Authors

  • Shilpi Jain (@Shilpi-Jain1)