Linux operating systemsWindows operating systems

Query VAPP

Use the query vapp command to determine which VMware vApps are backed up.

To use this command, you must have a license to use Tivoli® Storage Manager for Virtual Environments V7.1, or later version. Before you can use this command, the Tivoli Storage Manager nodes must be configured for the vCloud environment. In the Data Protection for VMware vCloud GUI, go to the Configuration window and click Run Configuration Wizard.

Supported Clients

Windows operating systemsThis command is valid for Windows clients that are configured to perform vCloud Director vApp backups.

Linux operating systemsThis command is valid for Linux clients that are configured to perform vCloud Director vApp backups.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-Query VAPP-- --vapp_specification-- ------------------------->

>-- -ASNODENAME=--provider_vdc_node--+-----------+-------------><
                                     '- -options-'   

Parameters

vapp_specification
Required parameter. Specifies the vApps that you want to query. Specify an asterisk (*) to query all vApps that belong to all organization virtual data centers that the data mover node has access to.
The vApp specification must include an organization name and an organization virtual data center name. The following parameters identify the vApp to query:
ORG=organization_name
Specifies the name of the organization that the organization virtual data center belongs to.
ORGVDC=org_vdc_name
Specifies the name of the organization virtual data center that contains the vApps to query.
VAPP=vapp_name
Optional parameter that specifies the name of a single vApp to query. If you do not specify a vApp name, the command displays all vApps for the specified organization and organization virtual data center.
You must specify these keyword parameters in the following order: ORG=, ORGVDC=, VAPP=. The following syntax rules also apply:
  • If any value contains a space character, enclose the entire specification in quotation marks.
  • To specify more than one organization virtual data center name, separate the organization virtual data center names with commas and do not insert a space character after the commas.
    "org=organization_name,orgvdc=org_vdc_name1,org_vdc_name2"
  • To specify more than one vApp name, separate the vApp names with commas and do not insert a space character after the commas.
    "org=organization_name_name,orgvdc=org_vdc_name,
     vapp=vapp_name1,vapp_name2,vapp_name3"
  • To specify organization virtual data centers from multiple organizations, separate the org= and orgvdc= pairs with semicolons. Do not insert a space character after the semicolons.
    "org=organization_name1,orgvdc=org_vdc_name1;
     organization=organization_name2,orgvdc=org_vdc_name2"
  • A wildcard can be used in a vApp name to match one or more characters. For example, to query all vAPPs that have names that begin with TEST, use the following syntax:
    "org=org1,orgvdc=vdc1,vapp=TEST*"
  • To query all vApp snapshots that are restorable by the data mover that protects the organization virtual data center, specify an asterisk (*) as the vApp specification.
    dsmc query vapp * -asnodename=providerVDC
-ASNODENAME=provider_vdc_node
Required parameter. Specifies the node name of the Tivoli Storage Manager node that is associated with a provider virtual data center. This parameter can be set on the command line or in the client options file (dsm.opt).

Related options

Table 1. Restore VAPP command: Related options
Option Where to use
asnodename

Linux operating systemsClient user-options file (dsm.opt) or client systems option file (dsm.sys), on the command line, or on the General tab in the Preferences editor.

Windows operating systemsClient user-options file (dsm.opt), on the command line, or on the General tab in the Preferences editor.

detail Command line only. Shows more detail about each vApp.
inactive Command line only. Show information about inactive and active vApp snapshots.

Example commands for querying VMware vApps

The following example command queries all backed up active versions of all vApps from all combinations of organizations and organization virtual data centers to which the data mover node has access:
dsmc query vapp *
IBM Tivoli Storage Manager
Command Line Backup-Archive Client Interface
  Client Version 7, Release 1, Level 0.0 
  Client date/time: 11/14/2013 14:02:26
(c) Copyright by IBM Corporation and other(s) 1990, 2013. All Rights Reserved.

Node Name: DM_pvdc1_DM1
Session established with server TEST_VM: Windows
  Server Version 6, Release 3, Level 0.0
  Server date/time: 11/14/2013 15:02:26  Last access: 11/14/2013 14:52:00

 #      Backup Date       Mgmt Class  Size         Type   A/I vApp
---  -------------------  ----------  -----------  ------ --- ---------------
  1  09/07/2013 13:47:35  MG1            21.95 GB  IFINCR  A  vApp: VAPP_1 
                                                              Org : Marketing
                                                              OvDC: Marketing_Gold
  2  09/07/2013 15:14:35  MG2            13.50 GB  IFFULL  A  vApp: WIN27
                                                              Org : Development
                                                     	        OvDC: Development_fast
  3  09/07/2013 16:12:36  MG1             1.95 GB  IFFULL  A  vApp: SUSE10
                                                              Org : Sales
                                                              OvDC: Sales_vDC2
  4  09/12/2013 08:40:48  MG17            9.00 GB  IFINCR  A  vApp: RHEL2
                                                              Org : Support
                                                              OvDC: Suport_vDC2
The following example shows detailed output of all backed up active versions of vApps from the organization that is named MilkyWay and the organization virtual data center that is named Orion_vDC2.
dsmc query vapp org=MilkyWay,orgvdc=Orion_vDC2 -detail
IBM Tivoli Storage Manager
Command Line Backup-Archive Client Interface
  Client Version 7, Release 1, Level 0.0 
  Client date/time: 11/14/2013 14:02:26
(c) Copyright by IBM Corporation and other(s) 1990, 2013. All Rights Reserved.

Node Name: DM_pvdc1_DM1
Session established with server TEST_VM: Windows
  Server Version 6, Release 3, Level 0.0
  Server date/time: 11/14/2013 15:02:26  Last access: 11/14/2013 14:52:00

 #      Backup Date       Mgmt Class  Size         Type   A/I vApp
---  -------------------  ----------  -----------  ------ --- ---------------
  1  09/07/2013 13:47:35  MG1            21.95 GB  IFINCR  A  vApp: VAPP_1 
                                                              Org : MilkyWay
                                                              OvDC: Orion_vDC2
        Incremental backup size: 50 KB  
        Owner                  : Catalin
        VM[1] VCD Name         : vm1
        VM[1] vSphere Name     : vm1 (3419c577-fd0e-4389-ac9a-6b483e2fb0f6)
        VM[1] size             : 5.66 GB
        VM[1] Status           : backup successful
        VM[2] VCD Name         : vm2
        VM[2] vSphere Name     : vm2 (35a1415c-0da7-4b22-b4a9-35d0df26518f)
        VM[2] size             : 16.27 GB
        VM[2] Status           : backup failed

  2  09/07/2013 15:14:35  MG2            13.50 GB  IFFULL  A  vApp: WIN27
                                                     	        Org : MilkyWay
                                                              OvDC: Orion_vDC2
        Incremental backup size: 100 KB
        Owner                  : Stefan
        VM[1] VCD Name         : vm1
        VM[1] vSphere Name     : vm1 (3419c577-fd0e-4389-ac9a-6b483e2fb0f6)
        VM[1] size             : 4.32 GB
        VM[1] Status           : backup successful
        VM[2] VCD Name         : vm2
        VM[2] vSphere Name     : vm2 (35a1415c-0da7-4b22-b4a9-35d0df26518f)
        VM[2] size             : 9.17 GB
        VM[2] Status           : backup failed
The following example shows all backed up active and inactive versions of vApps from all organizations and organization virtual data centers.
dsmc query vapp * -ina
IBM Tivoli Storage Manager
Command Line Backup-Archive Client Interface
  Client Version 7, Release 1, Level 0.0 
  Client date/time: 11/14/2013 14:02:26
(c) Copyright by IBM Corporation and other(s) 1990, 2013. All Rights Reserved.

Node Name: DM_pvdc1_DM1
Session established with server TEST_VM: Windows
  Server Version 6, Release 3, Level 0.0
  Server date/time: 11/14/2013 15:02:26  Last access: 11/14/2013 14:52:00

  #      Backup Date       Mgmt Class  Size         Type   A/I vApp
---  -------------------  ----------  -----------  ------ --- ---------------
  1  09/07/2013 13:47:35  MG1         21.95 GB  IFINCR  A  vApp: VAPP_1
                                                           Org : HQ
                                                           OvDC: HQ_Gold
  2  09/07/2013 10:47:35  MG1         21.95 GB  IFINCR  I  vApp: VAPP_1
                                                           Org : HQ
                                                           OvDC: HQ_Gold
  3  09/07/2013 15:14:35  MG2         13.50 GB  IFFULL  A  vApp: WIN27
                                                           Org : Manufacturing
                                                     	    OvDC: Manufacturing_fast
  4  09/07/2013 09:14:35  MG2         13.50 GB  IFFULL  I  vApp: WIN27
                                                           Org : Manufacturing
                                                     	     OvDC: Manufacturing_fast
  5  09/07/2013 16:12:36  MG1          1.95 GB  IFFULL  A  vApp: SUSE10
                                                           Org : Sales
                                                           OvDC: Sales_vDC2
More examples:
Display all vApps in all organization virtual data centers of the organization that is named Bucharest and the organization virtual data centers that are named Production and Development:
dsmc q vapp org=Bucharest,orgvdc=Production,Development
Display all vApps whose names begin with "Production" from the organization that is named Haifa and the organization virtual data center that is named Development:
dsmc q vapp org=Haifa,orgvdc=Development,vapp=Production*