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_svc_info.
New in ibm.storage_virtualize 1.0.0
Parameter | Comments |
|---|---|
clustername string / required | The hostname or management IP of the Storage Virtualize system. |
command_list list / elements=string | Specify to get information regarding any Storage Virtualize entities other than choices of gather_subset. Exact command has to be specified to use command_list (i.e. lssystemcert, lstimezones, lsportset etc.). Output will be stored in this way (i.e. lssystemcert -> Systemcert, lstimezones -> Timezones etc.). |
domain string | Domain for the Storage Virtualize system. Valid when hostname is used for the parameter clustername. |
filtervalue string | Specifies (key=value) combination that helps in returning a subset of objects satisfying the condition. |
gather_subset list / elements=string | 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. fabricport - list the FDMI information that is discovered by the system. 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. 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. availablepatch - display the patches that are compatible with the SVC version. patch - displays a list of all the patches on a specific node. systempatches - displays patches installed on all the nodes in the system. flashgrid - displays the summarized view of flashsystem grid. flashgridmembers - displays the summarized view of flashsystem grid members. flashgridsystem - displays the information about all systems in the flashsystem grid. flashgridpartition - displays the information about all partitions in the flashsystem grid. Choices:
|
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. If objectname:”all” specified, display detailed output of all instances of all objects that are specified in gather_subset and command_list. For entities that require objectname as a mandatory parameter, objectname:”all” will throw error. |
password string | REST API password for the Storage Virtualize system. The parameters username and password are required if not using token to authenticate a user. |
token string added in ibm.storage_virtualize 1.5.0 | The authentication token to verify a user on the Storage Virtualize system. To generate a token, use the ibm_svc_auth module. |
username string | REST API username for the Storage Virtualize system. The parameters username and password are required if not using token to authenticate a user. |
validate_certs boolean | Validates certification. Choices:
|
Note
check_mode.- 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
- name: Get detailed info of all volumes.
ibm.storage_virtualize.ibm_svc_info:
clustername: "{{ clustername }}"
domain: "{{ domain }}"
username: "{{ username }}"
password: "{{ password }}"
log_path: /tmp/ansible.log
gather_subset: vol
objectname: all
- name: Get detailed info for objects returned by lsvdiskcopy using command_list.
ibm.storage_virtualize.ibm_svc_info:
clustername: "{{ clustername }}"
domain: "{{ domain }}"
username: "{{ username }}"
password: "{{ password }}"
log_path: /tmp/ansible.log
command_list: lsvdiskcopy
objectname: all
- name: Get detailed info of multiple objects using gather_subset and command_list.
ibm.storage_virtualize.ibm_svc_info:
clustername: "{{ clustername }}"
domain: "{{ domain }}"
username: "{{ username }}"
password: "{{ password }}"
log_path: /tmp/ansible.log
gather_subset: [vol, host]
command_list: [lsvdiskcopy, lssite]
objectname: all
- name: Get list of candidate drives info using filtervale and gather_subset.
ibm.storage_virtualize.ibm_svc_info:
clustername: "{{ clustername }}"
domain: "{{ domain }}"
username: "{{ username }}"
password: "{{ password }}"
log_path: /tmp/ansible.log
gather_subset: drive
filtervalue: "use=candidate"
- name: Get list of replication type portsets info using filtervalue and command_list.
ibm.storage_virtualize.ibm_svc_info:
clustername: "{{ clustername }}"
domain: "{{ domain }}"
username: "{{ username }}"
password: "{{ password }}"
log_path: /tmp/ansible.log
command_list: lsportset
filtervalue: "type=replication"
Common return values are documented here, the following are the fields unique to this module:
Key | Description |
|---|---|
Array list / elements=dictionary | Data will be populated when gather_subset=array or gather_subset=all Lists information for array MDisks Returned: success Sample: |
Availablepatch list / elements=dictionary | Data will be populated when gather_subset=availablepatch or gather_subset=all Display the patches that are compatible with the SVC version on the users system. Returned: success Sample: |
CallHome list / elements=dictionary | Data will be populated when gather_subset=callhome or gather_subset=all Displays the status of the Call Home information that is sent to a server in the Cloud Returned: success Sample: |
CloudAccount list / elements=dictionary | Data will be populated when gather_subset=cloudaccount or gather_subset=all Lists all the configured cloud accounts Returned: success Sample: |
CloudAccountUsage list / elements=dictionary | Data will be populated when gather_subset=cloudaccountusage or gather_subset=all Lists the usage information about the configured cloud storage accounts Returned: success Sample: |
CloudBackup list / elements=dictionary | Data will be populated when gather_subset=cloudbackup or gather_subset=all Lists the volumes that have cloud snapshot that enabled and volumes that have cloud snapshots in the cloud account Returned: success Sample: |
CloudBackupGeneration list / elements=dictionary | Data will be populated when gather_subset=cloudbackupgeneration List any volume snapshots available on the specified volume Returned: success Sample: |
CloudImportCandidate list / elements=dictionary | Data will be populated when gather_subset=cloudimportcandidate or gather_subset=all Lists information about systems that have data that is stored in the cloud accounts Returned: success Sample: |
DnsServer list / elements=dictionary | Data will be populated when gather_subset=dnsserver or gather_subset=all Lists the information for any Domain Name System (DNS) servers in the system Returned: success Sample: |
Drive list / elements=dictionary | Data will be populated when gather_subset=drive or gather_subset=all Lists the configuration information and drive vital product data (VPD) Returned: success Sample: |
DriveClass list / elements=dictionary | Data will be populated when gather_subset=driveclass or gather_subset=all List all drive classes in the system Returned: success Sample: |
EmailServer list / elements=dictionary | Data will be populated when gather_subset=emailserver or gather_subset=all Lists the Email servers that are configured on the system Returned: success Sample: |
EmailUser list / elements=dictionary | Data will be populated when gather_subset=emailuser or 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 Returned: success Sample: |
Enclosure list / elements=dictionary | Data will be populated when gather_subset=enclosure or gather_subset=all Displays a summary of the enclosures. Returned: success Sample: |
EnclosureStats list / elements=dictionary | Data will be populated when gather_subset=enclosurestats or gather_subset=all Lists the most recent values (averaged) of all enclosure statistics. Returned: success Sample: |
EnclosureStatsHistory list / elements=dictionary | Data will be populated when gather_subset=enclosurestatshistory or gather_subset=all Lists the history values of all enclosure statistics including power consumed, temperature in fahrenheit and temperature in celsius. Returned: success Sample: |
EventLog list / elements=dictionary | Data will be populated when gather_subset=eventlog or gather_subset=all Lists information about the system event log Returned: success Sample: |
FabricPort list / elements=dictionary | Data will be populated when gather_subset=fabricport or gather_subset=all List the FDMI information that is discovered by the system. Returned: success Sample: |
FCConnectivity list / elements=dictionary | Data will be populated when gather_subset=fc or gather_subset=all Lists information for FC connectivity Returned: success Sample: |
FCConsistgrp list / elements=dictionary | Data will be populated when gather_subset=fcconsistgrp or gather_subset=all Displays a concise list or a detailed view of flash copy consistency groups Returned: success Sample: |
FCMap list / elements=dictionary | Data will be populated when gather_subset=fcmap or gather_subset=all Lists information for FC maps Returned: success Sample: |
FCPort list / elements=dictionary | Data will be populated when gather_subset=fcport or gather_subset=all Lists information for FC ports Returned: success Sample: |
FlashsystemGrid list / elements=dictionary | Data will be populated when gather_subset=flashgrid or gather_subset=all Displays summarized view of flashsystem grid. Returned: success |
FlashsystemGridMembers list / elements=dictionary | Data will be populated when gather_subset=flashgridmembers or gather_subset=all Displays summarized view of flashsystem grid members. Returned: success |
FlashsystemGridPartition list / elements=dictionary | Data will be populated when gather_subset=flashgridpartition or gather_subset=all Displays the information about all partitions in the flashsystem grid. Returned: success |
FlashsystemGridSystem list / elements=dictionary | Data will be populated when gather_subset=flashgridsystem or gather_subset=all Displays the information about all systems in the flashsystem grid. Returned: success |
Host list / elements=dictionary | Data will be populated when gather_subset=host or gather_subset=all Lists information for hosts Returned: success Sample: |
HostCluster list / elements=dictionary | Data will be populated when gather_subset=hc or gather_subset=all Lists information for host clusters Returned: success Sample: |
HostVdiskMap list / elements=dictionary | Data will be populated when gather_subset=hostvdiskmap or gather_subset=all Lists all VDisks mapped to host ‘objectname’ Returned: success Sample: |
IOGroup list / elements=dictionary | Data will be populated when gather_subset=iog or gather_subset=all Lists information for I/O groups Returned: success Sample: |
IP list / elements=dictionary | Data will be populated when gather_subset=ip or gather_subset=all Lists the currently configured IP addresses Returned: success Sample: |
iSCSIPort list / elements=dictionary | Data will be populated when gather_subset=iscsiport or gather_subset=all Lists information for iSCSI ports Returned: success Sample: |
LdapServer list / elements=dictionary | Data will be populated when gather_subset=ldapserver or gather_subset=all Lists the most recent details for all configured Lightweight Directory Access Protocol (LDAP) servers Returned: success Sample: |
Mdisk list / elements=dictionary | Data will be populated when gather_subset=mdisk or gather_subset=all Displays a concise list or a detailed view of managed disks (MDisks) visible to the system Returned: success Sample: |
Node list / elements=dictionary | Data will be populated when gather_subset=node or gather_subset=all Lists information for nodes Returned: success Sample: |
Ownershipgroup list / elements=dictionary | Data will be populated when gather_subset=ownershipgroup or gather_subset=all Displays the ownership groups that are available in the system Returned: success Sample: |
Partition list / elements=dictionary | Data will be populated when gather_subset=partition or gather_subset=all Displays all storage partitions Returned: success Sample: |
Partnership list / elements=dictionary | Data will be populated when gather_subset=partnership or gather_subset=all Lists all the clustered systems (systems) that are associated with the local system Returned: success Sample: |
Patch list / elements=dictionary | Data will be populated when gather_subset=patch or gather_subset=all Displays a list of all the patches on a specific node in the system. Returned: success Sample: |
Plugin list / elements=dictionary | Data will be populated when gather_subset=plugin or gather_subset=all Displays all registered plugins Returned: success Sample: |
Pool list / elements=dictionary | Data will be populated when gather_subset=pool or gather_subset=all Lists information for mdiskgrps Returned: success Sample: |
Portset list / elements=dictionary | Data will be populated when gather_subset=portset or gather_subset=all Lists the currently configured portset on the system Returned: success Sample: |
ProvisioningPolicy list / elements=dictionary | Data will be populated when gather_subset=provisioningpolicy or gather_subset=all Lists the provisioning policies available on the system Returned: success Sample: |
Quorum list / elements=dictionary | Data will be populated when gather_subset=quorum or gather_subset=all list the quorum devices that the system uses to store quorum data. Returned: success Sample: |
RCConsistgrp list / elements=dictionary | Data will be populated when gather_subset=rcconsistgrp or gather_subset=all Displays a concise list or a detailed view of remote copy consistency groups Returned: success Sample: |
RemoteCopy list / elements=dictionary | Data will be populated when gather_subset=rcrelationship or gather_subset=all Lists information for remote copy relationships Returned: success Sample: |
ReplicationPolicy list / elements=dictionary | Data will be populated when gather_subset=replicationpolicy or gather_subset=all Lists all the replication policies on the system Returned: success Sample: |
SafeguardedPolicy list / elements=dictionary | Data will be populated when gather_subset=safeguardedpolicy or gather_subset=all Lists the Safeguarded policies available on the system Returned: success Sample: |
SafeguardedSchedule list / elements=dictionary | Data will be populated when gather_subset=safeguardedpolicyschedule or gather_subset=all Displays the Safeguarded backup schedule that is associated with Safeguarded policies Returned: success Sample: |
Security list / elements=dictionary | Data will be populated when gather_subset=security or gather_subset=all Displays current security settings of the system Returned: success Sample: |
SnapshotPolicy list / elements=dictionary | Data will be populated when gather_subset=snapshotpolicy or gather_subset=all Lists all the snapshot policies on the system Returned: success Sample: |
SnapshotSchedule list / elements=dictionary | Data will be populated when gather_subset=snapshotpolicyschedule or gather_subset=all Lists all snapshot schedules on the system Returned: success Sample: |
Snmpserver list / elements=dictionary | Data will be populated when gather_subset=snmpserver or gather_subset=all Display a concise list or a detailed view of SNMP servers that are configured on the system Returned: success Sample: |
Sra list / elements=dictionary | Data will be populated when gather_subset=sra or gather_subset=all Command to check both secure remote assistance status and the time of the last login Returned: success Sample: |
SysLogServer list / elements=dictionary | Data will be populated when gather_subset=syslogserver or gather_subset=all Lists the syslog servers that are configured on the clustered system Returned: success Sample: |
System list / elements=dictionary | Data will be populated when gather_subset=system or gather_subset=all Displays the storage system information Returned: success Sample: |
SystemCert list / elements=dictionary | Data will be populated when gather_subset=systemcertificate or gather_subset=all Lists the information about the current system Secure Sockets Layer (SSL) certificate Returned: success Sample: |
Systempatches list / elements=dictionary | Data will be populated when gather_subset=systempatches or gather_subset=all Displays patches installed on all the nodes in the system Returned: success |
TargetPortFC list / elements=dictionary | Data will be populated when gather_subset=targetportfc or 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 Returned: success Sample: |
Testldapserver list / elements=dictionary | Data will be populated when gather_subset=testldapserver Tests a Lightweight Directory Access Protocol (LDAP) server. Returned: success Sample: |
TrustStore list / elements=dictionary | Data will be populated when gather_subset=truststore or gather_subset=all Lists the current certificate stores Returned: success Sample: |
User list / elements=dictionary | Data will be populated when gather_subset=user or gather_subset=all Lists all the users that are created on the system Returned: success Sample: |
UserGrp list / elements=dictionary | Data will be populated when gather_subset=usergroup or gather_subset=all Lists the user groups that is created on the system Returned: success Sample: |
VdiskCopy list / elements=dictionary | Data will be populated when gather_subset=vdiskcopy or gather_subset=all Lists information for volume copy Returned: success Sample: |
VdiskHostMap list / elements=dictionary | Data will be populated when gather_subset=vdiskhostmap or gather_subset=all Lists all hosts the VDisk ‘objectname’ is mapped to Returned: success Sample: |
Volume list / elements=dictionary | Data will be populated when gather_subset=vol or gather_subset=all Lists information for VDisks Returned: success Sample: |
VolumeGroup list / elements=dictionary | Data will be populated when gather_subset=volumegroup or gather_subset=all Lists all volume groups on the system Returned: success Sample: |
VolumeGroupPopulation list / elements=dictionary | Data will be populated when gather_subset=volumegrouppopulation or gather_subset=all Lists information about volume groups of type clone or thinclone including source and in-progress restore Returned: success Sample: |
Volumegroupreplication list / elements=dictionary | Data will be populated when gather_subset=volumegroupreplication or gather_subset=all Displays all replication for the volumegroup Returned: success Sample: |
VolumeGroupSnapshot list / elements=dictionary | Data will be populated when gather_subset=volumegroupsnapshot or gather_subset=all Lists the snapshot objects available on the system based on volume group Returned: success Sample: |
VolumeGroupSnapshotPolicy list / elements=dictionary | Data will be populated when gather_subset=volumegroupsnapshotpolicy or gather_subset=all Lists view snapshot objects on the system Returned: success Sample: |
VolumePopulation list / elements=dictionary | Data will be populated when gather_subset=volumepopulation or gather_subset=all Lists information about volumes of type clone or thinclone Returned: success Sample: |
VolumeSnapshot list / elements=dictionary | Data will be populated when gather_subset=volumesnapshot or gather_subset=all Lists all volume snapshots Returned: success Sample: |
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ibm/storage_virtualize/ibm_svc_info_module.html