ibm.storage_virtualize.ibm_svc_info 模块 – 此模块从 IBM Storage Virtualize 系列系统中收集各种信息
注意
此模块是 ibm.storage_virtualize 集合（版本 2.5.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install ibm.storage_virtualize。
要在剧本中使用它，请指定：ibm.storage_virtualize.ibm_svc_info。
ibm.storage_virtualize 1.0.0 中的新增功能
概要
收集指定的 IBM Storage Virtualize 系列系统实体的列表。这些包括节点、池、卷、主机、主机集群、FC 端口、iSCSI 端口、目标端口 FC、FC consistgrp、vdiskcopy、I/O 组、FC 映射、FC 连接、NVMe fabric、阵列和系统列表。
参数
参数 |
注释 |
|---|---|
Storage Virtualize 系统的 hostname 或管理 IP。 |
|
指定获取有关 gather_subset 选择之外的任何 Storage Virtualize 实体的信息。 必须指定确切的命令才能使用 command_list（例如 lssystemcert、lstimezones、lsportset 等）。 输出将以此方式存储（例如 lssystemcert -> Systemcert，lstimezones -> Timezones 等）。 |
|
Storage Virtualize 系统的域。 当 hostname 用于参数 clustername 时有效。 |
|
指定 (key=value) 组合，有助于返回满足条件的对象的子集。 |
|
用于指定需要哪些 Storage Virtualize 实体信息的字符串变量列表。 all - 模块支持的所有 Storage Virtualize 实体的列表。 vol - 列出 VDisk 的信息。 pool - 列出 mdiskgrps 的信息。 node - 列出节点的信息。 iog - 列出 I/O 组的信息。 host - 列出主机的信息。 hostvdiskmap - 列出映射到主机“objectname”的所有 VDisk vdiskhostmap - 列出 VDisk “objectname”映射到的所有主机 hc - 列出主机集群的信息。 fc - 列出 FC 连接的信息。 fcport - 列出 FC 端口的信息。 targetportfc - 列出设置 FC 分区和显示主机 I/O 端口当前故障转移状态所需的 WWPN 信息。 fcmap - 列出 FC 映射的信息。 rcrelationship - 列出远程复制关系的信息。 fcconsistgrp - 显示闪存复制一致性组的简要列表或详细视图。 rcconsistgrp - 显示远程复制一致性组的简要列表或详细视图。 iscsiport - 列出 iSCSI 端口的信息。 vdiskcopy - 列出卷复制的信息。 array - 列出阵列 MDisk 的信息。 system - 显示存储系统信息。 cloudaccount - 列出所有已配置的云帐户。 cloudaccountusage - 列出有关已配置的云存储帐户的使用信息。 cloudimportcandidate - 列出有关在云帐户中存储了数据的系统的信息。 ldapserver - 列出所有已配置的轻量级目录访问协议 (LDAP) 服务器的最新详细信息。 drive - 列出配置信息和驱动器重要产品数据 (VPD)。 user - 列出系统上创建的所有用户。 usergroup - 列出系统上创建的用户组。 ownershipgroup - 显示系统中可用的所有权组。 partnership - 列出与本地系统关联的所有集群系统（系统）。 replicationpolicy - 列出系统上的所有复制策略。 cloudbackup - 列出启用了云快照的卷和云帐户中具有云快照的卷。 cloudbackupgeneration - 列出指定卷上的任何可用卷快照。objectname 是必填参数。 snapshotpolicy - 列出系统上的所有快照策略。 snapshotpolicyschedule - 列出系统上的所有快照计划。 volumegroup - 列出系统上的所有卷组。 volumepopulation - 列出有关克隆或精简克隆类型卷的填充信息。 volumegrouppopulation - 列出有关克隆或精简克隆类型卷组的信息。 volumegroupsnapshotpolicy - 列出系统中与卷组关联的快照策略属性。 volumesnapshot - 列出所有卷快照。 dnsserver - 列出系统中任何域名系统 (DNS) 服务器的信息。 systemcertificate - 列出当前系统安全套接字层 (SSL) 证书的相关信息。 truststore - 列出当前的证书存储。 sra - 用于检查安全远程协助状态和上次登录时间的命令。 syslogserver - 列出集群系统中配置的 syslog 服务器。 emailserver - 列出系统中配置的电子邮件服务器。 emailuser - 列出所有电子邮件收件人、单个电子邮件收件人或指定类型（本地或支持）的电子邮件收件人的电子邮件事件通知设置。 provisioningpolicy - 列出系统中可用的精简配置策略。 volumegroupsnapshot - 列出系统中可用的快照对象。 callhome - 显示发送到云中服务器的 Call Home 信息的当前状态。 ip - 列出当前配置的 IP 地址。 portset - 列出系统中当前配置的端口集。 safeguardedpolicy - 列出系统中可用的 Safeguarded 策略。 mdisk - 显示系统可见的受管磁盘 (MDisk) 的简洁列表或详细视图。 safeguardedpolicyschedule - 显示与 Safeguarded 策略关联的 Safeguarded 备份计划。 eventlog - 显示系统事件日志的简洁视图。 enclosurestats - 列出所有机柜统计信息的最新值（平均值）。 enclosurestatshistory - 列出所有机柜统计信息的历史值，包括功耗、华氏温度和摄氏温度。 driveclass - 列出系统中的所有驱动器类。 security - 显示当前系统的安全套接字层 (SSL) 或传输层安全 (TLS) 安全性和密码规则设置。 partition - 显示与存储相关的所有存储分区信息。 volumegroupreplication - 显示卷组的所有复制信息。 plugin - 显示已注册插件的信息。 quorum - 显示系统用于存储仲裁数据的所有仲裁设备。 enclosure - 显示机柜的摘要。 snmpserver - 显示系统中配置的 SNMP 服务器的简洁列表或详细视图。 testldapserver - 测试轻型目录访问协议 (LDAP) 服务器。 availablepatch - 显示与 SVC 版本兼容的补丁。 patch - 显示特定节点上的所有补丁列表。 systempatches - 显示安装在系统中所有节点上的补丁。 选择
|
|
调试日志文件的路径。 |
|
如果指定，则仅返回具有 objectname 的实例。如果未指定，则返回所有实例。 如果指定了objectname:”all”，则显示在gather_subset和command_list中指定的所有对象的所有实例的详细输出。 对于需要将objectname作为强制参数的实体，objectname:”all” 将抛出错误。 |
|
用于 Storage Virtualize 系统的 REST API 密码。 如果未使用 token 验证用户身份，则需要 username 和 password 参数。 |
|
用于验证 Storage Virtualize 系统上用户的身份验证令牌。 要生成令牌，请使用 ibm_svc_auth 模块。 |
|
用于 Storage Virtualize 系统的 REST API 用户名。 如果未使用 token 验证用户身份，则需要 username 和 password 参数。 |
|
验证证书。 选择
|
注释
注意
此模块支持
check_mode。如果未指定 gather_subset 和 command_list，则 ibm_svc_info 将列出有关default 对象的信息。
不涵盖 lsroute 和 lsarraylba 命令。
示例
- 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
返回值
常见的返回值在此处记录 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
当 gather_subset=array 或 gather_subset=all 时，将填充数据 列出阵列 MDisk 的信息 返回： 成功 示例： |
|
当 gather_subset=availablepatch 或 gather_subset=all 时，将填充数据 显示与用户系统上的 SVC 版本兼容的补丁。 返回： 成功 示例： |
|
当 gather_subset=callhome 或 gather_subset=all 时，将填充数据 显示发送到云中服务器的 Call Home 信息的当前状态 返回： 成功 示例： |
|
当 gather_subset=cloudaccount 或 gather_subset=all 时，将填充数据 列出所有配置的云帐户 返回： 成功 示例： |
|
当 gather_subset=cloudaccountusage 或 gather_subset=all 时，将填充数据 列出有关已配置的云存储帐户的使用信息 返回： 成功 示例： |
|
当 gather_subset=cloudbackup 或 gather_subset=all 时，将填充数据 列出已启用云快照的卷和云帐户中具有云快照的卷 返回： 成功 示例： |
|
当 gather_subset=cloudbackupgeneration 时，将填充数据 列出指定卷上可用的任何卷快照 返回： 成功 示例： |
|
当 gather_subset=cloudimportcandidate 或 gather_subset=all 时，将填充数据 列出有关在云帐户中存储数据的系统的信息 返回： 成功 示例： |
|
当 gather_subset=dnsserver 或 gather_subset=all 时，将填充数据 列出系统中任何域名系统 (DNS) 服务器的信息 返回： 成功 示例： |
|
当 gather_subset=drive 或 gather_subset=all 时，将填充数据 列出配置信息和驱动器的重要产品数据 (VPD) 返回： 成功 示例： |
|
当 gather_subset=driveclass 或 gather_subset=all 时，将填充数据 列出系统中的所有驱动器类 返回： 成功 示例： |
|
当 gather_subset=emailserver 或 gather_subset=all 时，将填充数据 列出系统中配置的电子邮件服务器 返回： 成功 示例： |
|
当 gather_subset=emailuser 或 gather_subset=all 时，将填充数据 列出所有电子邮件收件人、单个电子邮件收件人或指定类型（本地或支持）的电子邮件收件人的电子邮件事件通知设置 返回： 成功 示例： |
|
当 gather_subset=enclosure 或 gather_subset=all 时，将填充数据 显示机柜的摘要。 返回： 成功 示例： |
|
当 gather_subset=enclosurestats 或 gather_subset=all 时，将填充数据 列出所有机柜统计信息的最新值（平均值）。 返回： 成功 示例： |
|
当 gather_subset=enclosurestatshistory 或 gather_subset=all 时，将填充数据 列出所有机柜统计信息的历史值，包括功耗、华氏温度和摄氏温度。 返回： 成功 示例： |
|
当 gather_subset=eventlog 或 gather_subset=all 时，将填充数据 列出有关系统事件日志的信息 返回： 成功 示例： |
|
当 gather_subset=fc 或 gather_subset=all 时，将填充数据 列出 FC 连接的信息 返回： 成功 示例： |
|
当 gather_subset=fcconsistgrp 或 gather_subset=all 时，将填充数据 显示闪存复制一致性组的简洁列表或详细视图 返回： 成功 示例： |
|
当 gather_subset=fcmap 或 gather_subset=all 时，将填充数据 列出 FC 映射的信息 返回： 成功 示例： |
|
当 gather_subset=fcport 或 gather_subset=all 时，将填充数据 列出 FC 端口的信息 返回： 成功 示例： |
|
当 gather_subset=host 或 gather_subset=all 时，将填充数据 列出主机的信息 返回： 成功 示例： |
|
当 gather_subset=hc 或 gather_subset=all 时，将填充数据 列出主机集群的信息 返回： 成功 示例： |
|
当 gather_subset=hostvdiskmap 或 gather_subset=all 时，将填充数据 列出映射到主机“objectname”的所有 VDisk 返回： 成功 示例： |
|
当 gather_subset=iog 或 gather_subset=all 时，将填充数据 列出 I/O 组的信息 返回： 成功 示例： |
|
当 gather_subset=ip 或 gather_subset=all 时，将填充数据 列出当前配置的 IP 地址 返回： 成功 示例： |
|
当 gather_subset=iscsiport 或 gather_subset=all 时，将填充数据 列出 iSCSI 端口的信息 返回： 成功 示例： |
|
当 gather_subset=ldapserver 或 gather_subset=all 时，将填充数据 列出所有配置的轻型目录访问协议 (LDAP) 服务器的最新详细信息 返回： 成功 示例： |
|
当 gather_subset=mdisk 或 gather_subset=all 时，将填充数据 显示系统可见的受管磁盘 (MDisk) 的简洁列表或详细视图 返回： 成功 示例： |
|
当 gather_subset=node 或 gather_subset=all 时，将填充数据 列出节点的信息 返回： 成功 示例： |
|
当 gather_subset=ownershipgroup 或 gather_subset=all 时，将填充数据 显示系统中可用的所有权组 返回： 成功 示例： |
|
当 gather_subset=partition 或 gather_subset=all 时，将填充数据 显示所有存储分区 返回： 成功 示例： |
|
当 gather_subset=partnership 或 gather_subset=all 时，将填充数据 列出与本地系统关联的所有集群系统（系统） 返回： 成功 示例： |
|
当 gather_subset=patch 或 gather_subset=all 时，将填充数据 显示系统中特定节点上的所有补丁列表。 返回： 成功 示例： |
|
当 gather_subset=plugin 或 gather_subset=all 时，将填充数据 显示所有已注册的插件 返回： 成功 示例： |
|
当 gather_subset=pool 或 gather_subset=all 时，将填充数据 列出 mdiskgrps 的信息 返回： 成功 示例： |
|
当 gather_subset=portset 或 gather_subset=all 时，将填充数据 列出系统上当前配置的端口集 返回： 成功 示例： |
|
当 gather_subset=provisioningpolicy 或 gather_subset=all 时，将填充数据 列出系统上可用的配置策略 返回： 成功 示例： |
|
当 gather_subset=quorum 或 gather_subset=all 时，将填充数据 列出系统用于存储仲裁数据的仲裁设备。 返回： 成功 示例： |
|
当 gather_subset=rcconsistgrp 或 gather_subset=all 时，将填充数据 显示远程复制一致性组的简洁列表或详细视图 返回： 成功 示例： |
|
当 gather_subset=rcrelationship 或 gather_subset=all 时，将填充数据 列出远程复制关系的信息 返回： 成功 示例： |
|
当 gather_subset=replicationpolicy 或 gather_subset=all 时，将填充数据 列出系统上的所有复制策略 返回： 成功 示例： |
|
当 gather_subset=safeguardedpolicy 或 gather_subset=all 时，将填充数据 列出系统上可用的安全保护策略 返回： 成功 示例： |
|
当 gather_subset=safeguardedpolicyschedule 或 gather_subset=all 时，将填充数据 显示与安全保护策略关联的安全保护备份计划 返回： 成功 示例： |
|
当 gather_subset=security 或 gather_subset=all 时，将填充数据 显示系统当前的安全设置 返回： 成功 示例： |
|
当 gather_subset=snapshotpolicy 或 gather_subset=all 时，将填充数据 列出系统上的所有快照策略 返回： 成功 示例： |
|
当 gather_subset=snapshotpolicyschedule 或 gather_subset=all 时，将填充数据 列出系统上的所有快照计划 返回： 成功 示例： |
|
当 gather_subset=snmpserver 或 gather_subset=all 时，将填充数据 显示系统上配置的 SNMP 服务器的简洁列表或详细视图 返回： 成功 示例： |
|
当 gather_subset=sra 或 gather_subset=all 时，将填充数据 用于检查安全远程协助状态和上次登录时间的命令 返回： 成功 示例： |
|
当 gather_subset=syslogserver 或 gather_subset=all 时，将填充数据 列出集群系统上配置的 syslog 服务器 返回： 成功 示例： |
|
当 gather_subset=system 或 gather_subset=all 时，将填充数据 显示存储系统信息 返回： 成功 示例： |
|
当 gather_subset=systemcertificate 或 gather_subset=all 时，将填充数据 列出有关当前系统安全套接字层 (SSL) 证书的信息 返回： 成功 示例： |
|
当 gather_subset=systempatches 或 gather_subset=all 时，将填充数据 显示系统上所有节点安装的补丁 返回： 成功 示例： |
|
当 gather_subset=targetportfc 或 gather_subset=all 时，将填充数据 列出设置 FC 分区和显示主机 I/O 端口当前故障转移状态所需的 WWPN 信息 返回： 成功 示例： |
|
当 gather_subset=testldapserver 时，将填充数据 测试轻量级目录访问协议 (LDAP) 服务器。 返回： 成功 示例： |
|
当 gather_subset=truststore 或 gather_subset=all 时，将填充数据 列出当前的证书存储 返回： 成功 示例： |
|
当 gather_subset=user 或 gather_subset=all 时，将填充数据 列出在系统上创建的所有用户 返回： 成功 示例： |
|
当 gather_subset=usergroup 或 gather_subset=all 时，将填充数据 列出系统上创建的用户组 返回： 成功 示例： |
|
当 gather_subset=vdiskcopy 或 gather_subset=all 时，将填充数据 列出卷复制的信息 返回： 成功 示例： |
|
当 gather_subset=vdiskhostmap 或 gather_subset=all 时，将填充数据 列出 VDisk 'objectname' 映射到的所有主机 返回： 成功 示例： |
|
当 gather_subset=vol 或 gather_subset=all 时，将填充数据 列出 VDisk 的信息 返回： 成功 示例： |
|
当 gather_subset=volumegroup 或 gather_subset=all 时，将填充数据 列出系统上的所有卷组 返回： 成功 示例： |
|
当 gather_subset=volumegrouppopulation 或 gather_subset=all 时，将填充数据 列出类型为克隆或瘦克隆的卷组的信息，包括源和正在进行的恢复 返回： 成功 示例： |
|
当 gather_subset=volumegroupreplication 或 gather_subset=all 时，将填充数据 显示卷组的所有复制 返回： 成功 示例： |
|
当 gather_subset=volumegroupsnapshot 或 gather_subset=all 时，将填充数据 列出基于卷组的系统上可用的快照对象 返回： 成功 示例： |
|
当 gather_subset=volumegroupsnapshotpolicy 或 gather_subset=all 时，将填充数据 列出系统上的查看快照对象 返回： 成功 示例： |
|
当 gather_subset=volumepopulation 或 gather_subset=all 时，将填充数据 列出类型为克隆或瘦克隆的卷的信息 返回： 成功 示例： |
|
当 gather_subset=volumesnapshot 或 gather_subset=all 时，将填充数据 列出所有卷快照 返回： 成功 示例： |