Back up a VMware ESX Server 3.x Virtual Machine's Disk Image from the Service Console with the Linux File System iDataAgent

Overview

Before You Begin

Configure the Environment

Create the PreScan, Prebackup, and PostBackup Script Files

• Script Files for Full Image Backup from the Service Console using vcbMounter
• Script Files for Full Image Backup from the Service Console using vcbSnapshot

Backup of a Virtual Machine from the Service Console - Full Image Backup

Overview

The illustration below shows an example of how the ESX Server and Virtual Machine(s) are configured when using the Linux File System iDataAgent from the Service Console to back up the full disk image for a VMware Virtual Machine running any operating system:

Before You Begin

• You must already be familiar with the information in Back up a VMware ESX Server 3.x Virtual Machine before beginning the procedures below.

• You must already be familiar with VMware ESX Server software.
• These procedures are based on a stand-alone VMware ESX Server version 3.x or later.
• When entering data in the CommCell Console screens (e.g., when configuring a subclient) all paths which contain a space must be in quotes, as shown in the examples.
• The following conventions are used in all of the examples; for each example, substitute the correct names for your environment instead of using these:
  • ESX server = esxserver.mydomain.com
  • VCB Proxy Server = proxy.mydomain.com
  • Virtual Machine = vmsys1.mydomain.com

Configure the Environment

ESX Server

• For backups performed from the Service Console:
  • The ESX Server installation does not need to support a SAN. Contact VMware for proper installation and licensing requirements.
  • ESX Server comes with a built in firewall. One of two methods can be used to insure proper communications between the ESX Server, the CommServe, and the MediaAgent:
    • Method 1:

      Disable the firewall on the ESX Server by executing the following command:

      /etc/init.d/firewall stop

      Executing the above will disable the firewall until the next reboot or until it is explicitly restarted. It is left to administrators to disable the firewall permanently if so desired.

    • Method 2:
      1. Run the VMware Virtual Infrastructure Client for the ESX Server.
      2. Select the ESX Server in the Inventory Window, and then select the Configuration tab.
      3. In the Software Window, select the Security Profile.
      4. Select Properties in the upper right of the Security Profile.
      5. In the Fire Wall Properties window, scroll and select both the CommVault Dynamic and CommVault Static entries.
      6. Select OK.

      The above will now allow the successful installation of the Linux File System iDataAgent on the Service Console. However, to ensure proper backup and restore operation, it will be necessary to configure the firewall when installing the Linux File System iDataAgent on the Service Console, to match the settings for the CommServe and any MediaAgents that will be used to back up and restore data from the Service Console. Failure to configure the firewall properly will cause backups to fail. For more information, see Firewall Requirements.

Virtual Machines

• Full image backup (supported for all Virtual Machine guest operating systems) does not require any additional software installation on the Virtual Machine.

VCB Proxy Server

• This method of backing up the full disk image of the Virtual Machine does not utilize a VCB Proxy Server.

Create the PreScan, Prebackup, and PostBackup Script Files

Create PreScan and PostBackup script files, based on which VMware utility you will be using -- vcbMounter or vcbSnapshot; select one of the following:

• Script Files for Full Image Backup from the Service Console using vcbMounter
• Script Files for Full Image Backup from the Service Console using vcbSnapshot

Script Files for Full Image Backup from the Service Console using vcbMounter

For a Full Image backup of a Virtual Machine from the Service Console, only one script is required; the PreScan script. You may optionally choose to create a PostBackup script as well, if that would be helpful in your environment.

PreScan Script – Full Image Backup from the Service Console using vcbMounter

This example prescan.sh script will be used to invoke the vcbMounter utility to perform the Full Image backup:

#!/bin/bash

sudo /usr/sbin/vcbMounter -h esxserver.mydomain.com -u root -p password -a ipaddr:vmsys1.mydomain.com -r /vmfs/volumes/SanBackup1/vmsys1-imageBackup -t fullvm -M 0 –F 0

The vcbMounter command in the sample script has these components:

-h esxserver.mydomain.com       FQDN of ESX Server

-u root                         Login for ESX Server

-p password                     Password for ESX Server

-a ipaddr:vmsys1.mydomain.com   The Virtual Machine to back up

-r /vmfs/volumes/SanBackup1/vmsys1-imageBackup

                                The destination directory for the Full Image backup
                                (This directory must not already exist.)

-t fullvm                       Type of backup to be performed

-M 0                            Break up Full Image backup into 2GB files

–F 0                            Optimize the Full Image backup file

There is more than one method to specify the Virtual Machine to be backed up. For more information, refer to the VMware Virtual Machine Backup Guide. The above method used the FQDN of the Virtual Machine and requires the Virtual Machine to be active to work. The Virtual Machine's VMFS disk image in this example is located in a datastore on a non-SAN local SCSI disk.

The following information is intended to show how this information is derived, so that you can create a script for your environment. More detailed information on the vcbMounter utility can be obtained from VMware.

• Execute the following command to discover the datastores that exist on esxserver.mydomain.com; this will produce output similar to the example shown:

# vdf
Filesystem     1K-blocks      Used   Available  Use%  Mounted on
/dev/sda2        5036316   1430076     3350408   30%  /
/dev/sda1         101089     33737       62133   36%  /boot
none              134156         0      134156    0%  /dev/shm
/dev/sda8        1462604     55972     1332336    5%  /var/log
/vmfs/devices  454740210         0   454740210    0%  /vmfs/devices
/vmfs/volumes/238c5ef3-9be4ed7b
                92033536  53295336    38738200   57%  /vmfs/volumes/nfsDataStore1
/vmfs/volumes/3204d433-533283f0
                58603260  16842748    41760512   28%  /vmfs/volumes/nfsDataStore2
/vmfs/volumes/444e6f5d-ac750886-4f6d-0011435b35d5
                63438848  53569536     9869312   84%  /vmfs/volumes/Vmfs3Vol1
/vmfs/volumes/44bd0297-a0d76b9c-5d85-0011435b35d5
                35389440  14519296    20870144   41%  /vmfs/volumes/SanTarget0
/vmfs/volumes/44c529af-b8365ad6-7307-0011435b35d5
                35389440    641024    34748416    1%  /vmfs/volumes/SanBackup1
#

• For a given datastore, in this case /vmfs/volumes/Vmfs3Vol1 from the previous output, execute the following command to discover the Virtual Machines in the datastore; this will produce output similar to the example shown:

# pwd
/vmfs/volumes/Vmfs3Vol1
# ls -l
total 384
drwxr-xr-x  1 root  root  2240  Jul 18 11:07  vmsys1
drwxr-xr-x  1 root  root  2240  Jul  6 11:08  vmsys2
drwxr-xr-x  1 root  root  1260  Jun 23 09:22  vmsys3
drwxr-xr-x  1 root  root  2520  Jul 18 11:07  vmsys4
drwxr-xr-x  1 root  root  2240  Jul 21 15:37  vmsys4
drwxr-xr-x  1 root  root  2240  Jul 21 13:19  vmsys5
#

• For a given Virtual Machine, in this case vmsys1 from the previous output, you can execute the following command to discover the files in the /vmfs/volumes/Vmfs3Vol1/vmsys1 directory; this will produce output similar to the example shown:

# ls -l vmsys1
total 6931200
-rw-------  1 root  root   805306368  Jul 20 08:41  vmsys1-79672131.vswp
-rw-------  1 root  root  6291456000  Jul 25 10:31  vmsys1-flat.vmdk
-rw-------  1 root  root        8664  Jul 20 08:41  vmsys1.nvram
-rw-------  1 root  root         343  Jul 21 15:37  vmsys1.vmdk
-rw-------  1 root  root         471  Jul 21 15:37  vmsys1.vmsd
-rwx------  1 root  root        1400  Jul 21 15:37  vmsys1.vmx
-rw-------  1 root  root         255  Jul 20 08:29  vmsys1.vmxf
-rw-------  1 root  root       43774  Jul 20 08:12  vmware-4.log
-rw-------  1 root  root       26219  Jul 20 08:12  vmware-5.log
-rw-------  1 root  root       19355  Jul 20 08:12  vmware-6.log
-rw-------  1 root  root       27734  Jul 20 08:12  vmware-7.log
-rw-------  1 root  root       42141  Jul 20 08:12  vmware-8.log
-rw-r--r--  1 root  root       19033  Jul 20 08:35  vmware-9.log
-rw-r--r--  1 root  root       62039  Jul 24 13:34  vmware.log
#

PostBackup Script – Full Image Backup from the Service Console using vcbMounter

A Full Image backup of a Virtual Machine from the Service Console does not require any additional actions to be taken once vcbMounter completes a backup of the Virtual Machine. However, you may choose to use a Post Backup script to delete the Full Image backup files from the ESX Server after the backup has completed, or for some other purpose which meets the needs of your environment.

The following postbackup.sh script will be used in our example to remove the image files once the Linux File System iDataAgent has completed the backup:

#!/bin/bash

rm –rf /vmfs/volumes/SanBackup1/vmsys1-imageBackup

Script Files for Full Image Backup from the Service Console using vcbSnapshot

For a Full Image backup of a Virtual Machine from the Service Console using vcbSnapshot, two scripts are required; the PreBackup script and PostBackup script.

PreBackup Script – Full Image Backup from the Service Console using vcbSnapshot

This example prebackup.sh script will be used to invoke the vcbSnapshot utility to perform the Full Image backup:

sudo /usr/sbin/vcbSnapshot -h esxserver.mydomain.com -u root -p password -c moref:64 vmsys1snap

The vcbSnapshot command in the sample script has these components:

-h esxserver.mydomain.com       FQDN of ESX Server

-u root                         Login for ESX Server

-p password                     Password for ESX Server

-c moref:64 vmsys1snap          Creates snapshot for Virtual Machine vmsys1 with moref:64
                                and names the snapshot vmsys1snap.

The following command example can be used to determine the moref value:

vcbVmName –h esxserver.mydomain.com –u root -p password –s name:vmsys1

# vcbVmName -h esxserver.mydomain.com -u root -p password -s name:vmsys1 [2006-07-27 11:29:31.503 'App' 3076452480 info] Current working directory: /root/scripts [2006-07-27 11:29:31.547 'BaseLibs' 8653744 warning] [Vmdb_Unset] Unsetting unknown path: /vmomi/

Found VM: moref:64 name:vmsys1 uuid:564df2c7-51a8-bac7-4b7e-3a4a0eddcfaa ipaddr:192.168.1.5 #

PostBackup Script – Full Image Backup from the Service Console using vcbSnapshot

This example postbackup.sh script will be used to remove the snapshot file:

The first command returns the SSID of the snapshot given its moref and snapshot name. The SSID is needed when issuing the second command to remove the snapshot.

#!/bin/bash

# get the SSID of the snapshot
SSID=$(sudo /usr/sbin/vcbSnapshot-h esxserver.mydomain.com -u root -p password -f moref:64 vmsys1snap | grep SsId )

# remove the snapshot
sudo /usr/sbin/vcbSnapshot -h esxserver.mydomain.com -u root -p password -d moref:64 $SSID

The actual remove command issued would look similar to the following:

sudo /usr/sbin/vcbSnapshot -h esxserver.mydomain.com -u root -p password -d moref:64 ssid:/vmfs/volumes/444e6f5d-ac750886-4f6d-0011435b35d5/vmsys1/vmsys1.vmx-snapshot-1

Backup of a Virtual Machine from the Service Console - Full Image Backup

To perform a Full Image backup, from the Service Console, of a Virtual Machine with any guest operating system, perform these steps:

1. Install the Linux File System iDataAgent on the VMware ESX Service Console, esxserver.mydomain.com. For instructions, see Deployment - Unix File System iDataAgent. It is not necessary to install software on the Virtual Machine.
2. Configure the firewall on the ESX Server using one of the two methods described in Configure the Environment.
3. Create the PreScan or PreBackup and optional PostBackup scripts if you have not already done so. See Create the PreScan, Prebackup, and PostBackup Script Files.
4. Create a subclient for the Linux File System iDataAgent on the VMware ESX Service Console. See Create a New Subclient for instructions and use the following information:

   General Tab:

   • Enter a subclient name

   Content Tab:

   • Content: /vmfs/volumes/SanBackup1/vmsys1-imageBackup

   Pre/Post Process Tab:

   • PreScan (vcbMounter): /root/scripts/PreScan.sh
   • PreBackup (vcbSnapshot): /root/scripts/PreBackup.sh
   • PostBackup (not required): /root/scripts/PostBackup.sh
   • Select Run Post Backup process for all attempts.

   Storage Device Tab:

   • Select the appropriate Storage Policy.

Backups using vcbMounter

The following occurs when a backup is performed using the Linux File System subclient you created:

1. The prescan.sh script will execute on the ESX Server, esxserver.mydomain.com, invoking the VMware vcbMounter utility, which quiesces the Virtual Machine and creates a snapshot of its VMFS disk image in the datastore. The actual snapshot file is highlighted below:

   # ls -ltr
   total 6948672
   -rw------- 1 root root      42141 Jul 20 08:12 vmware-8.log
   -rw------- 1 root root      27734 Jul 20 08:12 vmware-7.log
   -rw------- 1 root root      19355 Jul 20 08:12 vmware-6.log
   -rw------- 1 root root      26219 Jul 20 08:12 vmware-5.log
   -rw------- 1 root root      43774 Jul 20 08:12 vmware-4.log
   -rw------- 1 root root        255 Jul 20 08:29 vmsys1.vmxf
   -rw-r--r-- 1 root root      19033 Jul 20 08:35 vmware-9.log
   -rw------- 1 root root  805306368 Jul 20 08:41 vmsys1-79672131.vswp
   -rw------- 1 root root       8664 Jul 20 08:41 vmsys1.nvram
   -rw------- 1 root root        343 Jul 21 15:37 vmsys1.vmdk
   -rw------- 1 root root 6291456000 Jul 25 14:16 vmsys1-flat.vmdk
   -rwx------ 1 root root       1407 Jul 25 14:16 vmsys1.vmx
   -rw------- 1 root root      18380 Jul 25 14:16 vmsys1-Snapshot5.vmsn
   -rw------- 1 root root        530 Jul 25 14:16 vmsys1.vmsd
   -rw------- 1 root root        231 Jul 25 14:16 vmsys1-000001.vmdk
   -rw-r--r-- 1 root root      65750 Jul 25 14:16 vmware.log
   -rw------- 1 root root   16777216 Jul 25 14:16 vmsys1-000001-delta.vmdk
   # pwd
   # /vmfs/volumes/Vmfs3Vol1/vmsys1

2. The backup directory /vmfs/volumes/SanBackup1/vmsys1-imageBackup is shown below. The Virtual Machines VMFS disk image has been split into four files and they are currently being populated by vcbMounter:

   # ls -l vmsys1-imageBackup
   total 850560
   -rw------- 1 root root      8664 Jul 25 14:16 vmsys1.nvram
   -rw------- 1 root root      1407 Jul 25 14:16 vmsys1.vmx
   -rw-r--r-- 1 root root       909 Jul 25 14:16 catalog
   -rw------- 1 root root 866713600 Jul 25 14:24 scsi0-0-0-vmsys1-s001.vmdk
   -rw------- 1 root root    327680 Jul 25 14:16 scsi0-0-0-vmsys1-s002.vmdk
   -rw------- 1 root root    262144 Jul 25 14:16 scsi0-0-0-vmsys1-s003.vmdk
   -rw------- 1 root root       474 Jul 25 14:16 scsi0-0-0-vmsys1.vmdk
   -rw------- 1 root root     43774 Jul 25 14:16 vmware-4.log
   -rw------- 1 root root     26219 Jul 25 14:16 vmware-5.log
   -rw------- 1 root root     19355 Jul 25 14:16 vmware-6.log
   -rw------- 1 root root     27734 Jul 25 14:16 vmware-7.log
   -rw------- 1 root root     42141 Jul 25 14:16 vmware-8.log
   -rw------- 1 root root     19033 Jul 25 14:16 vmware-9.log
   -rw------- 1 root root     65750 Jul 25 14:16 vmware.log
   # /vmfs/volumes/SanBackup1’

3. Once vcbMounter has completed creating the Full Image backup files, the contents of the snapshot file are merged back into the Virtual Machine, and the snapshot file is deleted.
4. The Linux File System iDataAgent backup runs on the ESX Server, esxserver.mydomain.com to back up the image files.
5. After the backup completes, the /vmfs/volumes/SanBackup1/vmsys1-imageBackup directory and its contents will remain unless removed manually or via a PostBackup script. A PostBackup script is not required, but if one has been specified, it is executed. In the case of our example, the script runs and removes the four image files, as well as the directory /vmfs/volumes/SanBackup1/vmyss1-imageBackup.

Backups using vcbSnapshot

The following occurs when a backup is performed using the Linux File System subclient you created:

1. The prebackup.sh script will execute on the ESX Server, esxserver.mydomain.com, invoking the VMware vcbSnapshot utility, which quiesces the Virtual Machine and creates a snapshot of its datastore.
2. The Linux File System iDataAgent backup runs on the ESX Server, esxserver.mydomain.com to back up the contents of the Virtual Machine's VMFS disk image as a flat file.
3. After the backup completes, the postbackup.sh script will run, merging the changes back into the Virtual Machine's VMFS disk image and deleting the snapshot.