Try SpotterThis module gathers various information from the IBM Storage Virtualize family systems
| "added in version" 1.0.0 of ibm.storage_virtualize"
Authors: Peng Wang (@wangpww), Sumit Kumar Gupta (@sumitguptaibm), Sandip Gulab Rajbanshi (@Sandip-Rajbanshi)
Install with ansible-galaxy collection install ibm.storage_virtualize:==2.3.1
collections:
- name: ibm.storage_virtualize
version: 2.3.1Gathers the list of specified IBM Storage Virtualize family 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.
- name: Get volume info
ibm.storage_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.storage_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.storage_virtualize.ibm_svc_info:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/ansible.log
gather_subset: pool
- name: Get population information about volumes and volumegroups of type clone or thinclone
ibm.storage_virtualize.ibm_svc_info:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/ansible.log
gather_subset: ['volumepopulation','volumegrouppopulation']
- name: Get all info related to volume 'Volume1'
ibm.storage_virtualize.ibm_svc_info:
clustername: "{{clustername}}"
domain: "{{domain}}"
username: "{{username}}"
password: "{{password}}"
log_path: /tmp/ansible.log
gather_subset: vol
objectname: Volume1
token:
description:
- The authentication token to verify a user on the Storage Virtualize system.
- To generate a token, use the ibm_svc_auth module.
type: str
version_added: 1.5.0
version_added_collection: ibm.storage_virtualize
domain:
description:
- Domain for the Storage Virtualize system.
- Valid when hostname is used for the parameter I(clustername).
type: str
log_path:
description:
- Path of debug log file.
type: str
password:
description:
- REST API password for the Storage Virtualize system.
- The parameters I(username) and I(password) are required if not using I(token) to
authenticate a user.
type: str
username:
description:
- REST API username for the Storage Virtualize system.
- The parameters I(username) and I(password) are required if not using I(token) to
authenticate a user.
type: str
objectname:
description:
- If specified, only the instance with the I(objectname) is returned. If not specified,
all the instances are returned.
type: str
clustername:
description:
- The hostname or management IP of the Storage Virtualize system.
required: true
type: str
gather_subset:
choices:
- vol
- pool
- node
- iog
- host
- hostvdiskmap
- vdiskhostmap
- hc
- fcport
- iscsiport
- fc
- fcmap
- fcconsistgrp
- rcrelationship
- rcconsistgrp
- vdiskcopy
- targetportfc
- array
- system
- cloudaccount
- cloudaccountusage
- ldapserver
- drive
- user
- usergroup
- ownershipgroup
- partnership
- replicationpolicy
- cloudbackup
- enclosurestats
- cloudbackupgeneration
- snapshotpolicy
- snapshotpolicyschedule
- volumegroup
- volumepopulation
- volumegrouppopulation
- volumegroupsnapshotpolicy
- volumesnapshot
- dnsserver
- systemcertificate
- sra
- syslogserver
- enclosurestatshistory
- emailserver
- emailuser
- provisioningpolicy
- volumegroupsnapshot
- truststore
- callhome
- ip
- portset
- safeguardedpolicy
- mdisk
- safeguardedpolicyschedule
- cloudimportcandidate
- eventlog
- driveclass
- security
- partition
- volumegroupreplication
- plugin
- quorum
- enclosure
- snmpserver
- testldapserver
- all
default: all
description:
- List of string variables to specify the Storage Virtualize entities for which information
is required.
- all - list of all Storage 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.
- cloudaccount - lists all the configured cloud accounts.
- cloudaccountusage - lists the usage information about the configured cloud storage
accounts.
- cloudimportcandidate - lists information about systems that have data that is stored
in the cloud accounts.
- ldapserver - lists the most recent details for all configured Lightweight Directory
Access Protocol (LDAP) servers.
- drive - lists the configuration information and drive vital product data (VPD).
- user - lists all the users that are created on the system.
- usergroup - lists the user groups that is created on the system.
- ownershipgroup - displays the ownership groups that are available in the system.
- partnership - lists all the clustered systems (systems) that are associated with
the local system.
- replicationpolicy - lists all the replication policies on the system.
- cloudbackup - lists the volumes that have cloud snapshot enabled and volumes that
have cloud snapshots in the cloud account.
- cloudbackupgeneration - lists any volume snapshots available on the specified volume.
I(objectname) is a mandatory parameter.
- snapshotpolicy - lists all the snapshot policies on the system.
- snapshotpolicyschedule - lists all snapshot schedules on the system.
- volumegroup - lists all volume groups on the system.
- volumepopulation - list the population information about volumes of type clone or
thinclone.
- volumegrouppopulation - list the information about volume groups of type clone or
thinclone.
- volumegroupsnapshotpolicy - lists the snapshot policy attributes associated with
a volume group on the system.
- volumesnapshot - lists all volume snapshots.
- dnsserver - lists the information for any Domain Name System (DNS) servers in the
system.
- systemcertificate - lists the information about the current system Secure Sockets
Layer (SSL) certificate.
- truststore - lists the current certificate stores.
- sra - command to check both secure remote assistance status and the time of the
last login.
- syslogserver - lists the syslog servers that are configured on the clustered system.
- emailserver - lists the email servers that are configured on the system.
- emailuser - lists the Email event notification settings for all Email recipients,
an individual Email recipient, or a specified type (local or support) of an Email
recipient.
- provisioningpolicy - lists the provisioning policies available on the system.
- volumegroupsnapshot - lists the snapshot objects available on the system.
- callhome - displays the status of the Call Home information that is sent to a server
in the Cloud.
- ip - lists the currently configured IP addresses.
- portset - lists the currently configured portset on the system.
- safeguardedpolicy - lists the Safeguarded policies available on the system.
- mdisk - displays a concise list or a detailed view of managed disks (MDisks) visible
to the system.
- safeguardedpolicyschedule - displays the Safeguarded backup schedule that is associated
with Safeguarded policies.
- eventlog - displays the concise view of system event log
- enclosurestats - lists the most recent values (averaged) of all enclosure statistics.
- enclosurestatshistory - lists the history values of all enclosure statistics including
power consumed, temperature in fahrenheit and temperature in celsius.
- driveclass - lists all drive classes in the system
- security - display the current system Secure Sockets Layer (SSL) or Transport Layer
Security (TLS) security and password rules settings
- partition - display all the storage partitions information related to storage.
- volumegroupreplication - displays all the replication information for the volume
group.
- plugin - display the information of registered plugins.
- quorum - display all the quorum devices that the system uses to store quorum data.
- enclosure - displays a summary of the enclosures.
- snmpserver - display a concise list or a detailed view of SNMP servers that are
configured on the system
- testldapserver - tests a Lightweight Directory Access Protocol (LDAP) server.
elements: str
type: list
validate_certs:
default: false
description:
- Validates certification.
type: bool
Array:
description:
- Data will be populated when I(gather_subset=array) or I(gather_subset=all)
- Lists information for array MDisks
elements: dict
returned: success
sample:
- '...': null
type: list
CallHome:
description:
- Data will be populated when I(gather_subset=callhome) or I(gather_subset=all)
- Displays the status of the Call Home information that is sent to a server in the
Cloud
elements: dict
returned: success
sample:
- '...': null
type: list
CloudAccount:
description:
- Data will be populated when I(gather_subset=cloudaccount) or I(gather_subset=all)
- Lists all the configured cloud accounts
elements: dict
returned: success
sample:
- '...': null
type: list
CloudAccountUsage:
description:
- Data will be populated when I(gather_subset=cloudaccountusage) or I(gather_subset=all)
- Lists the usage information about the configured cloud storage accounts
elements: dict
returned: success
sample:
- '...': null
type: list
CloudBackup:
description:
- Data will be populated when I(gather_subset=cloudbackup) or I(gather_subset=all)
- Lists the volumes that have cloud snapshot that enabled and volumes that have
cloud snapshots in the cloud account
elements: dict
returned: success
sample:
- '...': null
type: list
CloudBackupGeneration:
description:
- Data will be populated when I(gather_subset=cloudbackupgeneration)
- List any volume snapshots available on the specified volume
elements: dict
returned: success
sample:
- '...': null
type: list
CloudImportCandidate:
description:
- Data will be populated when I(gather_subset=cloudimportcandidate) or I(gather_subset=all)
- Lists information about systems that have data that is stored in the cloud accounts
elements: dict
returned: success
sample:
- '...': null
type: list
DnsServer:
description:
- Data will be populated when I(gather_subset=dnsserver) or I(gather_subset=all)
- Lists the information for any Domain Name System (DNS) servers in the system
elements: dict
returned: success
sample:
- '...': null
type: list
Drive:
description:
- Data will be populated when I(gather_subset=drive) or I(gather_subset=all)
- Lists the configuration information and drive vital product data (VPD)
elements: dict
returned: success
sample:
- '...': null
type: list
DriveClass:
description:
- Data will be populated when I(gather_subset=driveclass) or I(gather_subset=all)
- List all drive classes in the system
elements: dict
returned: success
sample:
- '...': null
type: list
EmailServer:
description:
- Data will be populated when I(gather_subset=emailserver) or I(gather_subset=all)
- Lists the Email servers that are configured on the system
elements: dict
returned: success
sample:
- '...': null
type: list
EmailUser:
description:
- Data will be populated when I(gather_subset=emailuser) or I(gather_subset=all)
- Lists the Email event notification settings for all Email recipients, an individual
Email recipient, or a specified type (local or support) of Email recipient
elements: dict
returned: success
sample:
- '...': null
type: list
Enclosure:
description:
- Data will be populated when I(gather_subset=enclosure) or I(gather_subset=all)
- Displays a summary of the enclosures.
elements: dict
returned: success
sample:
- '...': null
type: list
EnclosureStats:
description:
- Data will be populated when I(gather_subset=enclosurestats) or I(gather_subset=all)
- Lists the most recent values (averaged) of all enclosure statistics.
elements: dict
returned: success
sample:
- '...': null
type: list
EnclosureStatsHistory:
description:
- Data will be populated when I(gather_subset=enclosurestatshistory) or I(gather_subset=all)
- Lists the history values of all enclosure statistics including power consumed,
temperature in fahrenheit and temperature in celsius.
elements: dict
returned: success
sample:
- '...': null
type: list
EventLog:
description:
- Data will be populated when I(gather_subset=eventlog) or I(gather_subset=all)
- Lists information about the system event log
elements: dict
returned: success
sample:
- '...': null
type: list
FCConnectivitie:
description:
- Data will be populated when I(gather_subset=fc) or I(gather_subset=all)
- Lists information for FC connectivity
elements: dict
returned: success
sample:
- '...': null
type: list
FCConsistgrp:
description:
- Data will be populated when I(gather_subset=fcconsistgrp) or I(gather_subset=all)
- Displays a concise list or a detailed view of flash copy consistency groups
elements: dict
returned: success
sample:
- '...': null
type: list
FCMap:
description:
- Data will be populated when I(gather_subset=fcmap) or I(gather_subset=all)
- Lists information for FC maps
elements: dict
returned: success
sample:
- '...': null
type: list
FCPort:
description:
- Data will be populated when I(gather_subset=fcport) or I(gather_subset=all)
- Lists information for FC ports
elements: dict
returned: success
sample:
- '...': null
type: list
Host:
description:
- Data will be populated when I(gather_subset=host) or I(gather_subset=all)
- Lists information for hosts
elements: dict
returned: success
sample:
- '...': null
type: list
HostCluster:
description:
- Data will be populated when I(gather_subset=hc) or I(gather_subset=all)
- Lists information for host clusters
elements: dict
returned: success
sample:
- '...': null
type: list
HostVdiskMap:
description:
- Data will be populated when I(gather_subset=hostvdiskmap) or I(gather_subset=all)
- Lists all VDisks mapped to host 'objectname'
elements: dict
returned: success
sample:
- '...': null
type: list
IOGroup:
description:
- Data will be populated when I(gather_subset=iog) or I(gather_subset=all)
- Lists information for I/O groups
elements: dict
returned: success
sample:
- '...': null
type: list
IP:
description:
- Data will be populated when I(gather_subset=ip) or I(gather_subset=all)
- Lists the currently configured IP addresses
elements: dict
returned: success
sample:
- '...': null
type: list
LdapServer:
description:
- Data will be populated when I(gather_subset=ldapserver) or I(gather_subset=all)
- Lists the most recent details for all configured Lightweight Directory Access
Protocol (LDAP) servers
elements: dict
returned: success
sample:
- '...': null
type: list
Mdisk:
description:
- Data will be populated when I(gather_subset=mdisk) or I(gather_subset=all)
- Displays a concise list or a detailed view of managed disks (MDisks) visible to
the system
elements: dict
returned: success
sample:
- '...': null
type: list
Node:
description:
- Data will be populated when I(gather_subset=node) or I(gather_subset=all)
- Lists information for nodes
elements: dict
returned: success
sample:
- '...': null
type: list
Ownershipgroup:
description:
- Data will be populated when I(gather_subset=ownershipgroup) or I(gather_subset=all)
- Displays the ownership groups that are available in the system
elements: dict
returned: success
sample:
- '...': null
type: list
Partition:
description:
- Data will be populated when I(gather_subset=partition) or I(gather_subset=all)
- Displays all storage partitions
elements: dict
returned: success
sample:
- '...': null
type: list
Partnership:
description:
- Data will be populated when I(gather_subset=partnership) or I(gather_subset=all)
- Lists all the clustered systems (systems) that are associated with the local system
elements: dict
returned: success
sample:
- '...': null
type: list
Plugin:
description:
- Data will be populated when I(gather_subset=plugin) or I(gather_subset=all)
- Displays all registered plugins
elements: dict
returned: success
sample:
- '...': null
type: list
Pool:
description:
- Data will be populated when I(gather_subset=pool) or I(gather_subset=all)
- Lists information for mdiskgrps
elements: dict
returned: success
sample:
- '...': null
type: list
Portset:
description:
- Data will be populated when I(gather_subset=portset) or I(gather_subset=all)
- Lists the currently configured portset on the system
elements: dict
returned: success
sample:
- '...': null
type: list
ProvisioningPolicy:
description:
- Data will be populated when I(gather_subset=provisioningpolicy) or I(gather_subset=all)
- Lists the provisioning policies available on the system
elements: dict
returned: success
sample:
- '...': null
type: list
Quorum:
description:
- Data will be populated when I(gather_subset=quorum) or I(gather_subset=all)
- list the quorum devices that the system uses to store quorum data.
elements: dict
returned: success
sample:
- '...': null
type: list
RCConsistgrp:
description:
- Data will be populated when I(gather_subset=rcconsistgrp) or I(gather_subset=all)
- Displays a concise list or a detailed view of remote copy consistency groups
elements: dict
returned: success
sample:
- '...': null
type: list
RemoteCopy:
description:
- Data will be populated when I(gather_subset=rcrelationship) or I(gather_subset=all)
- Lists information for remote copy relationships
elements: dict
returned: success
sample:
- '...': null
type: list
ReplicationPolicy:
description:
- Data will be populated when I(gather_subset=replicationpolicy) or I(gather_subset=all)
- Lists all the replication policies on the system
elements: dict
returned: success
sample:
- '...': null
type: list
SafeguardedPolicy:
description:
- Data will be populated when I(gather_subset=safeguardedpolicy) or I(gather_subset=all)
- Lists the Safeguarded policies available on the system
elements: dict
returned: success
sample:
- '...': null
type: list
SafeguardedSchedule:
description:
- Data will be populated when I(gather_subset=safeguardedpolicyschedule) or I(gather_subset=all)
- Displays the Safeguarded backup schedule that is associated with Safeguarded policies
elements: dict
returned: success
sample:
- '...': null
type: list
Security:
description:
- Data will be populated when I(gather_subset=security) or I(gather_subset=all)
- Displays current security settings of the system
elements: dict
returned: success
sample:
- '...': null
type: list
SnapshotPolicy:
description:
- Data will be populated when I(gather_subset=snapshotpolicy) or I(gather_subset=all)
- Lists all the snapshot policies on the system
elements: dict
returned: success
sample:
- '...': null
type: list
SnapshotSchedule:
description:
- Data will be populated when I(gather_subset=snapshotpolicyschedule) or I(gather_subset=all)
- Lists all snapshot schedules on the system
elements: dict
returned: success
sample:
- '...': null
type: list
Snmpserver:
description:
- Data will be populated when I(gather_subset=snmpserver) or I(gather_subset=all)
- Display a concise list or a detailed view of SNMP servers that are configured
on the system
elements: dict
returned: success
sample:
- '...': null
type: list
Sra:
description:
- Data will be populated when I(gather_subset=sra) or I(gather_subset=all)
- Command to check both secure remote assistance status and the time of the last
login
elements: dict
returned: success
sample:
- '...': null
type: list
SysLogServer:
description:
- Data will be populated when I(gather_subset=syslogserver) or I(gather_subset=all)
- Lists the syslog servers that are configured on the clustered system
elements: dict
returned: success
sample:
- '...': null
type: list
System:
description:
- Data will be populated when I(gather_subset=system) or I(gather_subset=all)
- Displays the storage system information
elements: dict
returned: success
sample:
- '...': null
type: list
SystemCert:
description:
- Data will be populated when I(gather_subset=systemcertificate) or I(gather_subset=all)
- Lists the information about the current system Secure Sockets Layer (SSL) certificate
elements: dict
returned: success
sample:
- '...': null
type: list
TargetPortFC:
description:
- Data will be populated when I(gather_subset=targetportfc) or I(gather_subset=all)
- Lists information for WWPN which is required to set up FC zoning and to display
the current failover status of host I/O ports
elements: dict
returned: success
sample:
- '...': null
type: list
Testldapserver:
description:
- Data will be populated when I(gather_subset=testldapserver)
- Tests a Lightweight Directory Access Protocol (LDAP) server.
elements: dict
returned: success
sample:
- '...': null
type: list
TrustStore:
description:
- Data will be populated when I(gather_subset=truststore) or I(gather_subset=all)
- Lists the current certificate stores
elements: dict
returned: success
sample:
- '...': null
type: list
User:
description:
- Data will be populated when I(gather_subset=user) or I(gather_subset=all)
- Lists all the users that are created on the system
elements: dict
returned: success
sample:
- '...': null
type: list
UserGrp:
description:
- Data will be populated when I(gather_subset=usergroup) or I(gather_subset=all)
- Lists the user groups that is created on the system
elements: dict
returned: success
sample:
- '...': null
type: list
VdiskCopy:
description:
- Data will be populated when I(gather_subset=vdiskcopy) or I(gather_subset=all)
- Lists information for volume copy
elements: dict
returned: success
sample:
- '...': null
type: list
VdiskHostMap:
description:
- Data will be populated when I(gather_subset=vdiskhostmap) or I(gather_subset=all)
- Lists all hosts the VDisk 'objectname' is mapped to
elements: dict
returned: success
sample:
- '...': null
type: list
Volume:
description:
- Data will be populated when I(gather_subset=vol) or I(gather_subset=all)
- Lists information for VDisks
elements: dict
returned: success
sample:
- '...': null
type: list
VolumeGroup:
description:
- Data will be populated when I(gather_subset=volumegroup) or I(gather_subset=all)
- Lists all volume groups on the system
elements: dict
returned: success
sample:
- '...': null
type: list
VolumeGroupPopulation:
description:
- Data will be populated when I(gather_subset=volumegrouppopulation) or I(gather_subset=all)
- Lists information about volume groups of type clone or thinclone including source
and in-progress restore
elements: dict
returned: success
sample:
- '...': null
type: list
VolumeGroupSnapshot:
description:
- Data will be populated when I(gather_subset=volumegroupsnapshot) or I(gather_subset=all)
- Lists the snapshot objects available on the system based on volume group
elements: dict
returned: success
sample:
- '...': null
type: list
VolumeGroupSnapshotPolicy:
description:
- Data will be populated when I(gather_subset=volumegroupsnapshotpolicy) or I(gather_subset=all)
- Lists view snapshot objects on the system
elements: dict
returned: success
sample:
- '...': null
type: list
VolumePopulation:
description:
- Data will be populated when I(gather_subset=volumepopulation) or I(gather_subset=all)
- Lists information about volumes of type clone or thinclone
elements: dict
returned: success
sample:
- '...': null
type: list
VolumeSnapshot:
description:
- Data will be populated when I(gather_subset=volumesnapshot) or I(gather_subset=all)
- Lists all volume snapshots
elements: dict
returned: success
sample:
- '...': null
type: list
Volumegroupreplication:
description:
- Data will be populated when I(gather_subset=volumegroupreplication) or I(gather_subset=all)
- Displays all replication for the volumegroup
elements: dict
returned: success
sample:
- '...': null
type: list
iSCSIPort:
description:
- Data will be populated when I(gather_subset=iscsiport) or I(gather_subset=all)
- Lists information for iSCSI ports
elements: dict
returned: success
sample:
- '...': null
type: list