/ home / ibm / ibm.storage_virtualize / 2.3.1 / module / ibm_svcinfo_command

ibm.storage_virtualize.ibm_svcinfo_command (2.3.1) — module

This module implements SSH Client which helps to run svcinfo CLI command on IBM Storage Virtualize family systems

| "added in version" 1.2.0 of ibm.storage_virtualize"

Authors: Shilpi Jain (@Shilpi-Jain1)

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

Usage examples

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

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

Inputs

    
command:
    description:
    - Single svcinfo CLI command to be executed on Storage Virtualize system. Each command
      must start with svcinfo keyword.
    type: str

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 C('yes'). Provide full path
      of keyfile 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, C(~/.ssh/id_rsa) is used.
    type: str