ibm.spectrum_virtualize.ibm_svc_info module – This module gathers various information from the IBM Spectrum Virtualize family storage systems

Note

This module is part of the ibm.spectrum_virtualize collection (version 1.10.0).

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

To use it in a playbook, specify: ibm.spectrum_virtualize.ibm_svc_info.

New in ibm.spectrum_virtualize 1.0.0

Synopsis

  • Gathers the list of specified IBM Spectrum Virtualize family storage system entities. These include the list of nodes, pools, volumes, hosts, host clusters, FC ports, iSCSI ports, target port FC, FC consistgrp, vdiskcopy, I/O groups, FC map, FC connectivity, NVMe fabric, array, and system.

Parameters

Parameter

Comments

clustername

string / required

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

domain

string

Domain for the Spectrum Virtualize storage system.

Valid when hostname is used for the parameter clustername.

gather_subset

list / elements=string

List of string variables to specify the Spectrum Virtualize entities for which information is required.

all - list of all Spectrum Virtualize entities supported by the module.

vol - lists information for VDisks.

pool - lists information for mdiskgrps.

node - lists information for nodes.

iog - lists information for I/O groups.

host - lists information for hosts.

hostvdiskmap - lists all vdisks mapped to host ‘objectname’

vdiskhostmap - lists all hosts vdisk ‘objectname’ is mapped to

hc - lists information for host clusters.

fc - lists information for FC connectivity.

fcport - lists information for FC ports.

targetportfc - lists information for WWPN which is required to set up FC zoning and to display the current failover status of host I/O ports.

fcmap - lists information for FC maps.

rcrelationship - lists information for remote copy relationships.

fcconsistgrp - displays a concise list or a detailed view of flash copy consistency groups.

rcconsistgrp - displays a concise list or a detailed view of remote copy consistency groups.

iscsiport - lists information for iSCSI ports.

vdiskcopy - lists information for volume copy.

array - lists information for array MDisks.

system - displays the storage system information.

Choices:

  • "vol"

  • "pool"

  • "node"

  • "iog"

  • "host"

  • "hostvdiskmap"

  • "vdiskhostmap"

  • "hc"

  • "fcport"

  • "iscsiport"

  • "fc"

  • "fcmap"

  • "fcconsistgrp"

  • "rcrelationship"

  • "rcconsistgrp"

  • "vdiskcopy"

  • "targetportfc"

  • "array"

  • "system"

  • "all" ← (default)

Default: ["all"]

log_path

string

Path of debug log file.

objectname

string

If specified, only the instance with the objectname is returned. If not specified, all the instances are returned.

password

string

REST API password for the Spectrum Virtualize storage system.

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

token

string

added in ibm.spectrum_virtualize 1.5.0

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

To generate a token, use the ibm_svc_auth module.

username

string

REST API username for the Spectrum 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.

Examples

- name: Get volume info
  ibm.spectrum_virtualize.ibm_svc_info:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/ansible.log
    gather_subset: vol
- name: Get volume info
  ibm.spectrum_virtualize.ibm_svc_info:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/ansible.log
    objectname: volumename
    gather_subset: vol
- name: Get pool info
  ibm.spectrum_virtualize.ibm_svc_info:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/ansible.log
    gather_subset: pool

Authors

  • Peng Wang (@wangpww)