Restore VAPP

Supported Clients

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

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

Parameters

vapp_specification

Required parameter. Specifies the vApp that you want to restore.

The vApp specification must include an organization name and an organization virtual data center name and a single vApp name. The following parameters identify the vApp to restore:

ORG=organization_name

organization_name specifies the name of the organization that the organization virtual data center (ORGVDC) belongs to.

ORGVDC=org_vdc_name

Specifies the name of the organization virtual data center, within the organization, that contains the vApps to restore.

VAPP=vapp_name

Specifies a single vApp to restore. Wildcards and some special characters cannot be included in vApp name on this command. Specifically, you cannot include any of the following characters: in a vApp name: " ' : ; * ? , < > / \ |.

You must specify these keyword parameters in the following order: ORG=, ORGVDC=, VAPP=. If any value contains a space character, enclose the entire specification in quotation marks.

-ASNODENAME=provider_vdc_node

Required parameter. Specifies the node name of the Tivoli Storage Manager data mover node that is configured to protect vApps in a provider virtual data center. This parameter can be set on the command line or in the client options file (dsm.opt).

-VAPPName=new_vapp_name

Optional parameter. Specifies a new name for the restored vApp. You must specify a new vApp name if the vApp you are restoring exists in the inventory. The restore operation fails if the vApp exists and a new vApp name is not provided.

-VCDHost=vCloud_server

-VCDUser=vCloud_administrator

-VCDPw=password

Optional parameters for this command. These three parameters specify the following information:

• The host name or IP address of the vCloud Director server (VCDHost).
• The account name for a user on that server (VCDUser).
• The password that is associated with the user account (VCDPw).

These options are typically not specified on the command line. Instead, the server address is specified on the VCDHost option in the client options file. The administrator name and password are then associated with that host by a set password command, where you specify that host, the administrator name, and the administrator password. You also specify TYPE=VCD on the set password command to indicate that these credentials are for logging on to a vCloud server.

You can specify these parameters on the command line. However, passing these parameters on the command line does supply your login credentials in plain text. Adding these parameters on the command line should be done only as a temporary measure when you are troubleshooting logins.

-VMCHost=hostname

-VMCUser=username

-VMCPw=password

Optional parameters for this command. These three parameters specify the following information:

• The host name or IP address of the vCenter or ESXi server that hosts the vApps that you want to protect (VMCHost).
• The account name for a user on that server (VMCUser).
• The password that is associated with the user account (VMCPw).

These options are typically not specified on the command line. Instead, the server address is specified on the VMCHost option in the client options file. The administrator name and password are then associated with that host by a set password command, where you specify that host, the administrator name, and the administrator password. You also specify TYPE=VM on the set password command to indicate that these credentials are for logging on to a vCenter or ESXi server.

You can specify these parameters on the command line. However, passing these parameters on the command line does supply your login credentials in plain text. Adding these parameters on the command line should be done only as a temporary measure when you are troubleshooting logins.

Related options

Example commands for restoring vApps

dsmc restore vApp org=Orion,orgvdc=Development,vapp=master_vApp2
IBM Tivoli Storage Manager
Command Line Backup-Archive Client Interface
  Client Version 7, Release 1, Level 0.0
  Client date/time: 11/15/2013 00:34:06
(c) Copyright by IBM Corporation and other(s) 1990, 2013. All Rights Reserved.

Node Name: DM_pvdc1_DM1
Session established with server BORODINSERV: AIX
  Server Version 6, Release 3, Level 0.0
  Server date/time: 11/15/2013 09:27:49  Last access: 11/14/2013 14:26:10

Accessing as node: OVDC_ORG1_ORGVDC2
Restore function invoked.
Organization: Orion 
Organization vDC: Orion_Silver

Restore VAPP command started.  Total number of vApps to process: 1
Total number of virtual machines to process: 2

Starting Full VAPP restore of VMware vApp 'master_vApp2'

Restoring vApp configuration. 

Restore of Virtual Machine 'VM1' started

Starting Full VM restore of VMware Virtual Machine 'VM1' 
 target node name='OVDC_Orion_DEVELOPMENT', data mover node name='DM_pvdc1_DM1'

...  Creating vApp 'master_vApp2' by importing VM 'VM1'   
Putting vApp into maintenance mode.   Restore of Virtual Machine 'VM2' started  
Starting Full VM restore of VMware Virtual Machine 'VM2' 
target node name='OVDC_Orion_DEVELOPMENT', data mover node name='DM_pvdc1_DM1'

...  Importing VM 'VM2'   Removing maintenance mode from vApp.  
Restore processing finished.  
Successful Full VAPP restore of VMware vApp 'master_vApp2' 
target node name='OVDC_Orion_DEVELOPMENT', data mover node name='DM_pvdc1_DM1'  
Total number of objects restored:             1 
Total number of objects failed:               0 
Total number of bytes transferred:         4.50 GB 
Data transfer time:                      316.78 sec 
Network data transfer rate:            7,748.33 KB/sec 
Aggregate data transfer rate:          5,972.31 KB/sec 
Elapsed processing time:               00:06:50  
Restore VAPP command complete 
Total number of vApps backed up successfully: 1 
Total number of virtual machines backed up successfully: 2 
Total number of vApps failed: 0 
Total number of vApps processed: 1