Inquire_detail

Use this vmcli command to view configuration information about the backup environment that is associated with Data Protection for VMware.

Syntax

The vmcli -f inquire_detail command uses this syntax:
vmcli -f inquire_detail -d datacenternodename | organizationvDCnodename [-a] [-n vmclinodename] [-o datamovernodename] [-p tsmserverport] [-e vmdetail | vappdetail ] [-q dmverify | vmfs | vmsingle | vappfs | vappsingle (-I inputfile)] [-s tsmserverhostname] [-t backupType] [-vmrestoretype (instantrestore | instantaccess | alltype | mount)]
Linux operating systemsYou must issue the vmcli -f inquire_detail command as tdpvmware user, and not as root.

Parameters

-d datacenternodename | organizationvDCnodename
When the VE_TSM_MODE parameter specifies VSPHERE, specify the datacenter node name.
When the VE_TSM_MODE parameter specifies vCloud, specify the organization vDC node name.
[-a]
Specify to show only the active backups on the Tivoli® Storage Manager server.
[-n vmclinodename]
Specify the VMCLI node name. This name is the node that connects the Data Protection for VMware command-line interface to the Tivoli Storage Manager server and the data mover node. If this parameter is not specified, the value in the profile is used.
[-o datamovernodename]
Specify the data mover node name.
[-p tsmserverport]
Specify the port of the Tivoli Storage Manager server.
  • If this parameter is not specified in the Data Protection for VMware command-line interface and not specified in the profile, the default port (1500) is used.
  • If this parameter is not specified in the Data Protection for VMware command-line interface but is specified in the profile, the value in the profile is used.
[-e vmdetail | vmappdetail
Specify vmdetail to show more detailed information about the backed up VMs. For example, the parameter shows information about disks that are attached to the VM. This parameter is valid only when the VE_TSM_MODE parameter specifies VSPHERE.
Specify vmappdetail to show more detailed information about the backed up vApps. For example, this parameter shows the following information:
  • VMs that are attached to the vApp.
  • VM name as it appears in both vCloud and vSphere mode.
  • Success or fail status for the VM backup.
This parameter is valid only when the VE_TSM_MODE parameter specifies vCloud.
[-q dmverify | vmfs | vmsingle | vappfs | vappsingle (-I inputfile)]
dmverify
Specify to query the status of the data mover node identified by the -o parameter. You must specify the -d and -o parameters when you specify dmverify.
vmfs
Specify to query all VMware Virtual Machine File Systems (VMFS). This parameter shows high-level information about all VMs. This parameter is valid only in vSphere mode.
vmsingle
Specify to query individual VMs that are being restored during an instant access or instant restore operation. This parameter is valid only in vSphere mode.
vappfs
Specify to show high-level information about all vApps. This parameter is valid only in vCloud mode.
vappsingle
Specify to show information about individual vApps that are identified in the inputfile. This parameter is valid only in vCloud mode.
-I inputfile
The inputfile value defines the full path and name of the input file. This keyword is valid with the vmsingle and vappsingle parameters only.
In vSphere mode, specify the name of the VM to query. You can specify this keyword for each VM that you want to query: vmname:vmname. For example:
vmname:vm1
vmname:vm2
In vCloud mode, specify the name of the VM to query. You can specify this keyword for each VM you want to query: vappname:vappname. For example:
vappname:vapp1
vappname:vapp2
When the q option is not specified, the default value is vmfs (in vSphere mode) and vappfs (in vCloud mode). When the inputfile entry contains spaces, enclose the entry with quotation marks. For example:
-I "/my dir/my file"
[-s tsmserverhostname]
Specify the host name or IP address of the Tivoli Storage Manager server. If this parameter is not specified, the value in the profile is used.
[-t backupType]
Specify one of the following backup types to query:
ALL
Specifies that the inquire_detail command is applied to all registered backup types.
FCM
Specifies that the inquire_detail command is applied to only Tivoli Storage FlashCopy® Manager for VMware backups.

Tivoli Storage FlashCopy Manager for VMware is a separately licensed product that contains its own user documentation. Familiarity with this product and its documentation is necessary to adequately implement a comprehensive plan for protecting your VMs.

TSM
Specifies that the inquire_detail command is applied to only Data Protection for VMware backups. This value must be specified when in vCloud mode.
Windows operating systems[-vmrestoretype (instantrestore | instantaccess | alltype | mount)]
Windows operating systemsSpecify this option to query active instant access or restore operations. This option also queries stale or orphan artifacts after a failure. The vmrestoretype parameter uses the following keywords:
instantrestore
The query lists VMs that are active in an instant restore operation.
instantaccess
The query lists VMs that are active in an instant access process.
alltype
The query lists VMs that are active in all instant operations.
mount
The query lists all active mount operations. For each mount operation, the output lists the mounted snapshots (restore points) that were created during a restore operation for a particular VM.
Restriction: When an instant restore or instant access operation that is issued from the Tivoli Storage Manager backup-archive client (dsmc) is followed by an instant restore or instant access operation that is issued from the Data Protection for VMware command-line interface (vmcli) or Data Protection for VMware vSphere GUI, the Tivoli Storage Manager recovery agent service must be restarted. This situation applies only when the Data Protection for VMware command-line interface accesses the Tivoli Storage Manager server with a node name different from the one used by the backup-archive client. This restriction applies to any order of operations between the two products.

Restart the service by going to Start > Administrative Tools > Computer Management > Services and Applications > Services. Look for service name Tivoli Storage Manager recovery agent in the Services window. The path to the Services window might vary depending on your operating system.

The service does not have to be restarted when the VMware datacenter name is specified with the asnodename option in the dsm.opt file.

Example

In this example, the vmcli -f inquire_detail command is issued to query the VM named antures for details:
vmcli -f inquire_detail -s BORODIN.MAINZ.DE.IBM.COM -p 1505 -n JF_VMCLI_HANNE
-v CHRISTO.MAINZ.DE.IBM.COM -o JF_MAINZ_DEVELOPMENT_DC_DM -d JF_MAINZ_DEVELOPMENT_DC
-q vmsingle -I .\inputfile.txt --vmrestoretype (instantrestore | instantaccess)
The inputfile contains this statement:
vmname:antures