TSM for Virtual Environments ("TSM for VE") is a new HFS service for backing up Virtual Machines that are running in a VMware vSphere infrastructure.
Features of TSM for VE include:
The Service Level Description is available here.
2.1. A suitable "proxy" machine
This can be installed on the vSphere infrastructure that you are planning to back up. The machine needs to be running Windows 7 or 2008R2 and will need at least 2 GB of RAM. You will also need to have version 4 of the .NET Framework installed to run the installer. A suitable version is included in the TSM for VE distribution package.
2.2. Firewall configuration
When setting up TSM for VE on a proxy machine, several ports are used for communication between the proxy machine and the vCenter server or vice-versa. These ports need to be open in any host-based or dedicated firewall between the two machines and are listed in Table 1. Firewall configuration for TSM for VE.
|Source host||Destination port||Destination host||Use||Required?|
|Proxy machine||443||vCenter server||Communication between the proxy machine and the vCenter server.||Yes|
|Proxy machine||902||vCenter server||Used for NBD (Network Block Disk) transport.||If proxy machine is not a VM.|
|vCenter server||1527||Proxy Machine||Used for the vCenter plugin. Required if installing vCenter plugin.||If installing vCenter plugin.|
|VMs||3260||Proxy Machine||Default iSCSI port.||If using iSCSI file-level restore.|
|Proxy machine||3400||dsmdd1.hfs.ox.ac.uk||TSM backup traffic||Yes|
|vCenter server||9080||Proxy Machine||Used for the vCenter plugin.||If installing vCenter plugin.|
2.3. vCenter server and backup user
TSM for VE communicates with a vCenter server to perform VM backups. The user required for this needs some elevated privileges but does not need to be a full administrator. It is recommended that you set up a new vCenter user specifically for TSM backup and restore. To add a new role suitable for backup and restore operations, perform the following steps:
Log into the vCenter server with the vSphere client.
[Roles] and click
Add New Role dialogue box is displayed:
Choose a name for the new role, e.g. "HFS Backup".
Add the following permissions to the role:
Create a new user in your vSphere infrastructure. How you do this depends on your local authentication setup.
[VMs and Templates].
Right-click on the vCenter server in the list on the left and choose
Add Permission.... The Assign Permission dialogue box is displayed:
Add.... The Select Users and Groups dialogue is displayed:
Choose the newly created user from the list and click
Choose the HFS backup role created earlier from the Assigned Role drop
down in the
Assign Permissions dialogue box.
Propagate to Child Objects is checked and click
You can check that the permission has been assigned correctly by choosing the
vCenter server from the navigation pane and then choosing the
You should see the new permission listed.
Extract the supplied zip file to a suitable location. You will need about 1.5 GB of disk space for the extracted files and substantially more for the installed files.
Navigate to the directory containing the extracted files and run
TSM for VE installer.exe.
Fill in the requested information in the form that is displayed:
If you wish to install the vCenter server plugin, you should check the box for that option and
provide details of an administrative account on the vCenter server. This account is only used
to register the TSM for Virtual Environments vCenter plugin. Hovering over each item on the
form will give more information on that item.
Help takes you to this page.
Once you have filled in the information, click
Install. The installer does several
The installer will take some time to complete. Once it is, you will see a message reminding you of the required firewall holes.
If a reboot is required, the installer will ask you if you want to reboot now or later.
We have tried to choose reasonable defaults in the configuration file (
However, there are some configuration options that you may want to adjust to suit your setup.
In particular, these are:
This sets the list of VMs that you want to back up. If the proxy machine is a VM on the vCenter server,
you should not back it up via itself so add its name to the
-VM part of
To exclude virtual machines
the backups, give them as the value for
-VM, separated by commas:
Note that if the VM name contains spaces, it should not be surrounded by quotes.
There should also be no spaces between VM names and the commas. This applies to all
To specify explicitly the VMs to backup, use the
VM option. For example
VMs can also be specified by vCenter folder, host, host cluster and datastore. To backup specific folders, use:
To backup specific ESX/ESXi hosts, use:
To backup specific host clusters, use:
To backup specific datastores, use:
Maximum number of VM backups to perform in parallel per instance of the TSM client.
Maximum number of VM backups to perform in parallel per ESX or ESXi host.
Maximum number of VM backups to perform in parallel per datastore.
The limit options can be used to ensure that parallel VM backups do not put too much load on any one part of your infrastructure. If you have one ESX/ESXi host and one datastore then all the limits on parallel backups should be equal.
5. Backup virtual machines
5.1. Using the TSM client GUI
Launch the TSM client GUI on the proxy machine.
[Backup VM]. The
Backup Virtual Machine
window is displayed.
Virtual Machines item. This displays the ESX/ESXi hosts in the navigation
pane. Expand or click on the ESX/ESXi hosts:
Select virtual machines to backup. Choose
Incremental Forever - Incremental
from the drop down box at the top of the window and click
The task list window displays the progress:
For detailed information, click
5.2. Using the TSM command line
To back up all virtual machines specified in the
start the TSM command line client and run:
tsm> backup vm -mode=IFincr
To back up a specific VM, run:
tsm> backup vm 'vmname' -mode=IFincr
6. Restore virtual machines
6.1. Using the TSM client GUI
Launch the TSM GUI client on the proxy machine.
[Restore VM]. The
Restore Virtual Machine window is displayed:
Choose a VM in the navigation pane. All the available backups of the VM are
displayed. Choose a backup and click
Restore Destination window is displayed. If you wish to restore
to the original location, you need to make sure that there is not a VM with the same
name in that location. If you are restoring to a new location, specify as much of the
information as necessary. If you specify only a new name the VM will be restored to
the original location with the new name
Restore to start the restore.
6.2. Using the TSM command line
tsm> restore vm 'vm name'
tsm> restore vm 'vm name' -vmname='new vm name'
tsm> restore vm 'vm name' -vmname='new vm name' -datacenter='data center name' -host='ESXi host name' -datastore='datastore name'
7. Restore individual files
Restoring individual files is achieved by using the
Data Protection for VMware Recovery Agent.
Launch the Recovery Agent from
[All Programs] >
[Tivoli Storage Manager]
[Data Protection for VMware] >
[Data Protection for VMware Recovery Agent]:
7.1. Using iSCSI
The most flexible way to restore individual files is by using the
Recovery Agent to export
a backup as an iSCSI target that the iSCSI initiator on a virtual machine can then mount.
[New Tivoli Storage Manager server...] from the
Tivoli Storage Manager
Choose the relevant backup by selecting a
Select mount destination dialogue is displayed:
Figure /hfs/help/images/tsm4ve-recoveryAgentMountDialogISCSImount.png [Recovery Agent select mount destination dialogue (iSCSI).]
Mount as an iSCSI target and set a unique (on the proxy machine)
iSCSI target name and set the appropriate iSCSI initiator name that corresponds to the
virtual machine that will connect to this iSCSI target. Note that port 3260 must be open between the
The iSCSI target will now be listed in the
Mounted Volumes list in the Recovery
Agent. Configure the iSCSI initiator on the appropriate VM to mount the target read-only and copy
the required files to the VM using standard operating system tools. How to do this is beyond the scope of these
instructions as it varies for each operating system.
When the iSCSI target is not needed any longer, unmount it and disconnect the iSCSI initiator from
the target. Select the target in the Recovery Agent and click
Exit the Recovery Agent by clicking
7.2. Using a Windows mount
You can mount an NTFS backup as a drive letter or in an empty NTFS folder.
Follow the steps for setting up iSCSI until you reach the
Select mount destination
Create virtual volume from selected partition.
Select a partition to mount. You should also select
Show only mountable partitions
Mount virtual volume as read only.
Choose either a drive letter or NTFS folder for the partition.
Figure /hfs/help/images/tsm4ve-recoveryAgentMountDialogLocalMount.png [Recovery Agent select mount destination dialogue (local mount).]
Although the above procedure was run on the TSM for VE proxy machine it is possible to install the recovery agent on a VM to perform local mounts. Contact the HFS team if you wish to do this.