Backup 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 vApps that you want to back up. You can specify a single vApp, a list of vApps, or back up all vApps that are in an organization virtual data center. If you do not specify any vApps on this command, the vApps are selected from the DOMAIN.VCD client option.

The vApp specification must include an organization name and an organization virtual data center name. The following parameters identify the vApps to back up:

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 protect.

VAPP=vapp_name

Specifies one or more vApps to protect. If you omit vApp names, all vApps in the specified organization and organization virtual data center are processed.

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=. 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 that is under the same organization, 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"

  When you specify multiple organization virtual data centers on the same statement, you cannot specify vApp names.

• To specify multiple vApp names within the same organization virtual data center, separate the vApp names with commas. 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"

-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 this command or in the client options file (dsm.opt). However, if you have backup schedules that are associated with the data move node, you must specify this option on the command or in the schedule definition, and not in the client options file.

-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.

-PREView

Optional. This parameter can be specified only on the command line for the Backup VAPP command. It creates a list of vApps, including their VMs, that are included in the backup operation when you run the Backup VAPP command without this parameter. Add this parameter to determine whether the vApp specification or the DOMAIN.VCD statement includes the vApps that you want protected.

Related options

Example commands for backing up vApps

dsmc backup vApp ”org=Orion,orgvdc=Orion_Silver,
 vapps=master_vApp2” -asnodename=PVDC_NODE_For_Orion_Silver
IBM Tivoli Storage Manager
Command Line Backup-Archive Client Interface
  Client Version 7, Release 1, Level 0.0
  Client date/time: 11/14/2013 13:22:52
(c) Copyright by IBM Corporation and other(s) 1990, 2013. All Rights Reserved.

Node Name: DM_pvdc1_DM1
Session established with server VM-08R2-TSM62-6_SERVER2: Windows
  Server Version 6, Release 3, Level 0.0
  Server date/time: 11/14/2013 14:22:52  Last access: 11/14/2013 14:22:39

	Accessing as node: OVDC_ORG1_ORGVDC2
Full BACKUP VAPP of vApp 'master_vApp2'.
Organization: Haifa 
Organization vDC: Haifa_Silver

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

Starting Full VAPP backup of VMware vApp 'master_vApp2'

Putting vApp into maintenance mode. 
Backing up vApp configuration data. 

Backing up VM1...
<normal output suppressed for this example>

Backing up VM2 ...
<normal output suppressed for this example>

...  Removing maintenance mode from vApp.  
Successful Full VAPP backup of VMware vApp 'master_vApp2'       
  mode:	 'Periodic Full - Full'
  target node name:	'OVDC_ORG1_ORGVDC2'
  data mover node name: 'DM_pvdc1_DM1'
  VMs: VM1, VM2  

Statistics for vApp 'master_vApp2'.  

Total number of objects inspected:            1 
Total number of objects backed up:            1 
Total number of objects updated:              0 
Total number of objects rebound:              0 
Total number of objects deleted:              0 
Total number of objects expired:              0 
Total number of objects failed:               0 
Total number of subfile objects:              0 
Total number of bytes inspected:           4.50 GB 
Total number of bytes transferred:         4.50 GB 
Data transfer time:                      681.06 sec 
Network data transfer rate:            6,928.30 KB/sec 
Aggregate data transfer rate:          6,298.05 KB/sec 
Objects compressed by:                        0% 
Total data reduction ratio:                0.00% 
Subfile objects reduced by:                   0% 
Elapsed processing time:               00:12:29  

Backup 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

The following example shows the -PREView option output. The output shows that the vApp that is named golden_vApp3 has three virtual machines, which are named VM1, VM2, and VM3.

dsmc backup vApp ”org=Orion,orgvdc=Orion_Silver,
  vapps=golden_vApp3” -preview

IBM Tivoli Storage Manager
Command Line Backup-Archive Client Interface
  Client Version 7, Release 1, Level 0.0
  Client date/time: 11/14/2013 13:52:00
(c) Copyright by IBM Corporation and other(s) 1990, 2013. All Rights Reserved.

Node Name: DM_pvdc1_DM1
Session established with server VM-08R2-TSM62-6_SERVER2: Windows
  Server Version 6, Release 3, Level 0.0
  Server date/time: 11/14/2013 14:52:00  Last access: 11/14/2013 14:23:06

	Accessing as node: OVDC_ORG1_ORGVDC2
Full BACKUP VAP of vApp 'golden_vApp3'.
Organization: Orion 
Organization vDC: Orion_Silver

  1. vAppName:  golden_vApp3
       DomainKeyword:  vapp= golden_vApp3
       VMNAME[1]:   VM1
       VMNAME[2]:   VM2
       VMNAME[3]:   VM3

Total number of vApps processed: 1
Accessing as node: OVDC_Orion_Orion_Silver

dsmc backup vapp -domain.vdc=“org=Org1,orgvdc=Org1_vdc”

dsmc backup vapp -domain.vcd=“org=Haifa,orgvdc=vdc1;
 org=Mainz,orgvdc=vdc2;org=SanJose,orgvdc=vdc4”