b_ve_inst_guide (1)
b_ve_inst_guide (1)
Version 7.1.8
IBM
IBM Tivoli Storage Manager for Virtual Environments
Version 7.1.8
IBM
Note:
Before you use this information and the product it supports, read the information in “Notices” on page 139.
This edition applies to version 7, release 1, modification 8 of IBM Tivoli Storage Manager for Virtual Environments
(product number 5725-A44) and to all subsequent releases and modifications until otherwise indicated in new
editions.
© Copyright IBM Corporation 2011, 2017.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
About this publication . . . . . . . . v Uninstalling Data Protection for VMware on
Who should read this publication . . . . . . . v Windows . . . . . . . . . . . . . . 50
Publications . . . . . . . . . . . . . . v Uninstalling the data mover on Windows . . . 52
Uninstalling Data Protection for VMware with
What's new in Version 7.1.8. . . . . . vii the Windows Installer . . . . . . . . . . 53
Uninstalling Data Protection for VMware for a
Windows 32-bit system in silent mode . . . . 53
Chapter 1. Installing and upgrading Uninstalling Data Protection for VMware for
Tivoli Storage Manager for Virtual Windows 64-bit system in silent mode . . . . 54
Environments . . . . . . . . . . . . 1 Uninstalling Data Protection for VMware a Linux
Installable components . . . . . . . . . . . 1 system . . . . . . . . . . . . . . . 55
Data Protection for VMware vSphere GUI . . . 3
Data Protection for VMware vCloud GUI . . . . 6 Chapter 2. Configuring Data Protection
Tivoli Storage Manager recovery agent . . . . 8 for VMware . . . . . . . . . . . . . 57
IBM Data Protection extension . . . . . . . 9 Configuring a new installation with the wizard . . 57
Data Protection for VMware command-line Using the notebook to edit an existing installation 58
interface . . . . . . . . . . . . . . . 9 Enabling the environment for file restore operations 59
Tivoli Storage Manager file restore interface . . 10 Setting up file restore operations on Linux . . . 60
Data mover feature . . . . . . . . . . . 10 Modifying options for file restore operations . . . 61
Planning to install Data Protection for VMware . . 11 File restore options . . . . . . . . . . . 62
Installation roadmap . . . . . . . . . . 11 Configuring log activity for file restore operations 63
Installation scenarios . . . . . . . . . . 12 File restore log activity options . . . . . . . 63
System requirements . . . . . . . . . . 13 Configuring a data mover node for tagging support 64
Required installation permissions . . . . . . 16 Configuring your environment for full virtual
Required communication ports . . . . . . . 17 machine instant restore operations . . . . . . . 66
VMware vCenter Server user privilege 1. Configuring the iSCSI software on the ESXi
requirements . . . . . . . . . . . . . 19 host . . . . . . . . . . . . . . . . 66
Data Protection for VMware GUI registration 2. Installing and configuring applications on the
keys . . . . . . . . . . . . . . . . 22 data mover . . . . . . . . . . . . . 67
Installing the Data Protection for VMware 3. Setting the Recovery Agent connection . . . 67
components . . . . . . . . . . . . . . 23 4. Configuring a dedicated iSCSI network for the
Obtaining the Data Protection for VMware ESXi host and data mover . . . . . . . . 68
installation package. . . . . . . . . . . 23 | Configuring security settings for Data Protection for
Installing the Data Protection for VMware | VMware . . . . . . . . . . . . . . . 69
components by using the installation wizard . . 24 | Configuring security settings to connect data
Installing the Data Protection for VMware | mover and VMCLI nodes to the Tivoli Storage
components in silent mode . . . . . . . . 29 | Manager server . . . . . . . . . . . . 69
Taking the first steps after you install Data | Configuring Data Protection for VMware vSphere
Protection for VMware . . . . . . . . . 40 | GUI communication using the Transport Layer
Upgrading Data Protection for VMware . . . . . 42 | Security . . . . . . . . . . . . . . 74
Upgrading Data Protection for VMware . . . . 42 VMware vCenter Server user privilege requirements 80
Upgrading Data Protection for VMware from Data Protection for VMware vSphere GUI user roles 84
Tivoli Storage FlashCopy Manager for VMware . 44 Data Protection for VMware GUI registration keys 87
Upgrading Data Protection for VMware from Configuring the Tivoli Storage Manager recovery
Tivoli Storage FlashCopy Manager for VMware agent GUI . . . . . . . . . . . . . . . 87
and Data Protection for VMware . . . . . . 45 Locale settings . . . . . . . . . . . . . 93
Upgrading Data Protection for VMware on a Log file activity . . . . . . . . . . . . . 93
Windows 32-bit system in silent mode . . . . 47 Starting and running services for Data Protection for
Upgrading Data Protection for VMware on a VMware . . . . . . . . . . . . . . . 96
Windows 64-bit system in silent mode . . . . 47
Upgrading Data Protection for VMware on a
Linux system in silent mode . . . . . . . . 48
Appendix A. Advanced configuration
Upgrading the data mover nodes on the vStorage tasks . . . . . . . . . . . . . . . 97
Backup Server . . . . . . . . . . . . 49 Setting up the Tivoli Storage Manager nodes in a
Uninstalling Data Protection for VMware . . . . 50 vSphere environment . . . . . . . . . . . 98
Appendix B. Migrating to an
incremental forever backup strategy . 129
iv IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
About this publication
IBM® Tivoli® Storage Manager for Virtual Environments provides off-host
block-level incremental backup and file recovery and instant restore from a full-VM
backup for Windows and Linux guest machines. Block level incremental backups
are available when you use IBM Tivoli Storage Manager for Virtual Environments
with the Tivoli Storage Manager backup-archive client. In addition, protection of
vApps and Organization VDCs in a vCloud Director environment is also available.
Publications
The Tivoli Storage Manager product family includes IBM Tivoli Storage
FlashCopy® Manager, IBM Tivoli Storage Manager for Space Management, IBM
Tivoli Storage Manager for Databases, and several other storage management
products from IBM.
For a list of new features and updates in this release and previous Version 7
releases, see Data Protection for VMware updates.
Installable components
Data Protection for VMware includes several components that you can install to
protect your virtual environment.
Depending on the operating system environment, the following Data Protection for
VMware features are available for installation:
Restriction: Each installation package presents you with a user licensing file
(EULA). If you do not accept the file, the installation process stops.
Table 1. Available Data Protection for VMware features by operating system
Component Linux Windows
Tivoli Storage Manager recovery agent ' '
2 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Table 1. Available Data Protection for VMware features by operating system (continued)
Component Linux Windows
Data mover ' '
1. Although the file restore interface component must be installed and enabled on
a Windows system, you can use this interface to restore files on both Windows
and Linux guest virtual machines.
Data Protection for VMware offloads the backup workload from VMs to a vStorage
backup server. To accomplish this task, the backup-archive client V7.1.8 must be
installed on the vStorage Backup Server.
Overview
The Data Protection for VMware vSphere GUI is the primary interface from which
to complete the following tasks:
v Initiate or schedule backups of your VMs to a Tivoli Storage Manager server.
v Initiate a full recovery of your VMs from a Tivoli Storage Manager server.
v Issue reports about the progress of your tasks, the most recent events that
completed, backup status, and space usage. This information can help you
troubleshoot errors that occurred in backup processing.
Tip: Information about how to complete tasks with the vSphere GUI is provided
in the online help that is installed with the GUI. Click Learn More in any of the
GUI windows to open the online help for task assistance.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 3
IBM Data Protection
extension
(in VMware vSphere
Web Client)
Data Protection
for VMware Tivoli Storage Manager
vSphere GUI file restore interface
vSphere plug-in
client
Web browser
vStorage API
(VADP) Data Protection for
Proxy VMware vSphere
vCenter GUI
Server
Data Protection for
VMware CLI
Tivoli
Storage
Data mover Manager
(Tivoli Storage API
Manager
backup-archive
Guest client)
machines Tivoli Storage
Manager
Recovery Agent
Tivoli
Host machines Storage
(ESX, ESXi) Manager
server
VMFS VMDK
NAS/local vStorage
SAN backup server
Storage hierarchy
Figure 1. Data Protection for VMware system components in a VMware vSphere user environment
Requirements
The Data Protection for VMware vSphere GUI can be installed on any system that
meets the operating system prerequisites. The vSphere GUI resource requirements
are minimal as it does not process I/O data transfers.
Tip: Installing the vSphere GUI on the vStorage Backup Server is the most
common configuration.
The vSphere GUI must have network connectivity to the following systems:
v vStorage Backup Server
v Tivoli Storage Manager server
v vCenter Server
4 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
In addition, ports for the Derby database (default 1527) and GUI web server
(default 9081) must be available.
Configuration
You can register multiple vSphere GUIs to a single vCenter Server. This scenario
reduces the number of datacenters (and their VM guest backups) that are managed
by a single VMware vSphere GUI. Each plug-in can then manage a subset of the
total number of datacenters that are defined on the vCenter Server. For each
plug-in that is registered to the vCenter Server, one Data Protection for VMware
package must be installed on a separate host.
When you register multiple vSphere GUIs to a single vCenter Server, the following
guidelines apply:
v Each datacenter can be managed by only one installed vSphere GUI.
v A unique VMCLI node name is required for each installed vSphere GUI.
v Using unique data mover node names for each installed vSphere GUI simplifies
managing the nodes.
where:
– hostname is the name of the system where the Data Protection for VMware
vSphere GUI is installed
– port is the port number where the vSphere GUI is accessible through. The
default port number is 9081.
v A vSphere Web Client extension that connects to a GUI web server to access
virtual machines in IBM storage (referred to as the data protection extension).
The content is a subset of what is provided in the plug-in and web browser GUI.
You can specify one or more access methods during installation.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 5
Data Protection for VMware vCloud GUI
The Data Protection for VMware vCloud GUI (vCloud GUI) component is a
graphical user interface that protects vApps and organization vDCs in a vCloud
Director environment.
Overview
The Data Protection for VMware vCloud GUI is the primary interface from which
to complete the following tasks:
v Initiate or schedule incremental forever backups of specific vApps, or vApps
that are contained in an organization vDC to the Tivoli Storage Manager server
storage.
v Restore single or multiple vApps.
v Generate reports to display progress information about tasks and space-usage
information about backups.
v Display information about the progress of tasks, the most recent events that
completed, the backup status of vApps, and space usage. This information can
help you troubleshoot errors that occurred in backup processing.
Tip: Information about how to complete tasks with the vCloud GUI is provided in
the online help that is installed with the GUI. Click Learn More in any of the GUI
windows to open the online help for task assistance.
6 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Data Protection for
VMware vCloud GUI
Data Protection for
VMware CLI
DB2
database
vCloud vApps Service VMs
Data mover
(Tivoli Storage Data Protection
Manager for VMware
backup-archive Recovery Agent
vCloud vCloud client)
Connector
vSphere VMs
vShield vCenter
Storage hierarchy
Physical resources
Data mover
(Tivoli Storage
Data Protection
Manager for VMware
backup-archive Recovery Agent
client)
Network DataStores ESXi servers
Figure 2. Data Protection for VMware system components in a VMware vCloud Director user environment
The vCloud GUI is accessed through a web browser by using the following URL:
https://hostname:port/TsmVMwareUI
where:
v hostname is the name of the system where the Data Protection for VMware
vCloud GUI is installed
v port is the port number where the vCloud GUI is accessible through. The default
port number is 9081.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 7
Tivoli Storage Manager recovery agent
Use the recovery agent service to mount any snapshot volume from the Tivoli
Storage Manager server.
Overview
You can view snapshots locally, with read-only access, on the client system, or use
an iSCSI protocol to access a snapshot from a remote system.
In addition, the recovery agent provides both the instant restore function and
protection for in-guest applications. Instant restore enables the volume that is in
use to remain available while the restore operation proceeds in the background.
Application protection enables applications that are installed in a guest virtual
machine, such as Microsoft Exchange Server and Microsoft SQL Server, to be
available for backup and restore protection.
Important: When you install the recovery agent for the instant restore function,
you must also select the device driver for installation. It is not selected by default.
Choosing this option requires a system reboot.
The recovery agent can complete the following tasks from a remote system:
v Gather information about the data that can be restored, for example:
– Backed-up VMs.
– Snapshots available for a backed-up virtual machine.
– Partitions available in a specific snapshot.
v Mount a snapshot as a virtual device.
v Provide a list of virtual devices.
v Remove a virtual device.
Requirements
Windows On Windows systems, you can install the recovery agent GUI,
command-line interface, and device driver.
Linux On Linux systems, you can install the recovery agent GUI and device
driver. The command-line interface is not available.
Windows You can access the recovery agent from the Start menu: Start > Tivoli
Storage Manager > Tivoli Storage Manager for Virtual Environments > Tivoli
Storage Manager recovery agent
Windows Alternatively, you can access the GUI and command-line interface from a
command prompt:
install_dir\TSM\recoveryagent\mount\RecoveryAgent.exe -notservice
install_dir\TSM\recoveryagent\shell\RecoveryAgentShell.exe
8 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Linux To start the recovery agent, issue the following commands from a
command line as root user:
cd /opt/tivoli/tsm/tdpvmware/mount
./TDPVMwareMountRestore.sh
Overview
The IBM Data Protection extension provides a subset of the functions that are
available in the browser and plug-in views for the Data Protection for VMware
vSphere GUI and some additional functions.
Requirement
To install the IBM Data Protection extension, you must select the following options
when you run the Tivoli Storage Manager for Virtual Environments installation
wizard.
v On the Environment Protection page of the installation wizard, click vSphere
protection.
v On the GUI information for vSphere protection page, select Enable access to the
GUI by a web browser and Register as an Extension in vSphere Web Client.
You can access the extension from the vSphere Web Client.
Overview
You can use the Data Protection for VMware CLI to complete the following tasks:
v Initiate or schedule backups of your VMs to a Tivoli Storage Manager server.
v Initiate a full recovery of your VMs, VM files, or VM Disks (VMDKs) from a
Tivoli Storage Manager server.
v View configuration information about the backup database and environment.
Although the Data Protection for VMware vSphere GUI is the primary task
interface, the Data Protection for VMware CLI provides a useful secondary
interface.
For example, the Data Protection for VMware CLI can be used to implement a
scheduling mechanism that is different from the one that is implemented by the
Data Protection for VMware vSphere GUI. Also, the Data Protection for VMware
CLI is useful when you evaluate automation results with scripts.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 9
Accessing the Data Protection for VMware command-line
interface
You can access the Data Protection for VMware CLI from a command line.
Overview
The file restore interface is a web-based interface where you can restore individual
files from a VM backup. The advantage of this interface is that file, software, and
platform owners can restore their own files without prior knowledge of Tivoli
Storage Manager backup and restore operations.
The file restore interface feature is installed when you select the option to protect
your data in a vSphere environment. In the Data Protection for VMware
configuration wizard, you must enable the file restore feature for the interface to be
available.
To access the file restore interface, open a web browser and enter the URL
provided by your administrator. For example:
https://hostname:9081/FileRestoreUI
where hostname is the host name of the system where the Data Protection for
VMware vSphere GUI is installed.
Overview
In the typical VMware environment, the data mover node is used to save virtual
machine backups to a data center node.
For more information about the data mover, including information about
environments with multiple data movers, see How Tivoli Storage Manager nodes
are used in a virtual environment.
You can configure the data mover from the Data Protection for VMware vSphere
GUI or Data Protection for VMware vCloud GUI.
10 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Planning to install Data Protection for VMware
Data Protection for VMware eliminates the impact of running backups on a VM by
offloading backup workloads from a VMware ESX or ESXi-based host to a
vStorage Backup server.
Data Protection for VMware works with the backup-archive client (installed on the
vStorage Backup server) to complete full and incremental backups of VMs. The
client node that is installed on the vStorage Backup server is called the data mover
node. This node "moves" the data to the Tivoli Storage Manager server for storage,
and for VM image-level restore at a later time. Instant restore is available at the
disk volume level and full VM level. In addition, protection of vApps and
organization vDCs in a vCloud Director environment is also available.
Tip: The backup-archive client is a separately licensed component that contains its
own user interfaces and documentation. Familiarity with this product and its
documentation is necessary in order to adequately integrate a comprehensive plan
for protecting your VMs with Data Protection for VMware. Data Protection for
VMware for Windows 64-bit includes the data mover feature (backup-archive
client).
Installation roadmap
The following table identifies the steps to complete a successful installation
process.
Table 2. Installation tasks for new or existing Data Protection for VMware customers
Step Task Get started here
Check system requirements. Make sure the system on which Data
1 Protection for VMware is to be installed
meets the system requirements.
Check user permission requirements. Avoid potential installation errors or
2 delays by using the required user
permission levels.
Check availability of required Prevent installation failure or delays by
communication ports. opening the required communication
3
ports before you attempt to install Data
Protection for VMware.
Install Data Protection for VMware: Each installation package presents you
v Installing Data Protection for with a user licensing file (EULA). If you
VMware by using the installation do not accept the file, the installation
wizard ends.
v “Installing the Data Protection for
4 VMware components in silent mode”
on page 29
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 11
Table 2. Installation tasks for new or existing Data Protection for VMware
customers (continued)
Step Task Get started here
“Configuring a new installation with Use the configuration wizard for an
the wizard” on page 57 initial configuration. Depending on the
features that are installed, more
If you are planning to upgrade Data configuration tasks might be required as
5 Protection for VMware, depending on described in this section.
the components that are installed, more
configuration tasks might be required.
See Configure Data Protection for
VMware for more details.
Tip: To assist with planning the quantity of proxy hosts that are required for your
specific Data Protection for VMware backup environment, the following
publication is available on the Tivoli Storage Manager Wiki:
Step by Step Guide To vStorage Backup Server (Proxy) Sizing
This publication is available in the Tivoli Storage Manager for Virtual
Environments product section.
Installation scenarios
Before you install Data Protection for VMware, choose the scenario that best meets
the needs of your business.
You can install Data Protection for VMware and the data mover by using the GUI
or in silent mode:
v “Installing the Data Protection for VMware components by using the installation
wizard” on page 24
v “Installing the Data Protection for VMware components in silent mode” on page
29
For a list of features and components that are available by platform, see
“Installable components” on page 1.
Table 3. Installation scenarios
Scenario
Number Description Tasks that you must complete
1 Use this scenario for a Windows You can use the Suite Installer in
new installation where GUI or silent mode to install both software.
you want to install Data Restriction: On Windows 32-bit systems, the
Protection for VMware only the recovery agent GUI and command
and the data mover line are available to install.
(backup-archive client) on
the same system. Linux You can use the Data Protection
for VMware and data mover stand-alone
installers to install both software in GUI or
silent mode.
12 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Table 3. Installation scenarios (continued)
Scenario
Number Description Tasks that you must complete
System requirements
To implement Data Protection for VMware components, your system must meet
appropriate system requirements.
Software requirements
Table 4. Software requirements for Data Protection for VMware.
Component Minimal requirement Preferred
Operating system Important: Details of the software and operating
system requirements can change over time. For
current software requirements, see technote 1505139.
Communication
protocol
Device drivers
Other software
Hardware requirements
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 13
v Data set sizes
v LAN and SAN connectivity
Note: The Tivoli Storage Manager recovery agent component does not support
operations in a LAN-free environment.
The following table describes the hardware requirements that are needed to install
Data Protection for VMware.
Table 5. Hardware requirements for Data Protection for VMware.
Component Minimal requirement Preferred
System IntelPentium D 3 GHz Dual Not applicable
Core processor or compatible
Memory 2 GB RAM, 2 GB virtual Not applicable
address space
Available hard disk 200 MB for 'Documents and 2 GB
Settings' folder
NIC Card 1 NIC - 100 Mbps 1 NIC - 1 Gbps
A Windows proxy host is required for Tivoli Storage Manager recovery agent on
Linux. This Windows proxy host must have the Tivoli Storage Manager recovery
agent installed.
Restriction: The following restrictions apply to VMware VMDKs that are involved
in a backup operation:
v For incremental forever backup mode, each individual VMDK involved in a
backup operation cannot exceed 8 TB. If a VMDK exceeds 8 TB, the backup
operation fails. To increase the size of the VMDK to be larger than the default 2
TB, specify the maximum size with the vmmaxvirtualdisks option. For more
information, see Vmmaxvirtualdisks.
v For periodic full backup mode, each individual VMDK involved in a backup
operation cannot exceed 2 TB. If a VMDK exceeds 2 TB, the backup operation
fails.
To prevent a failure during either backup mode, you can skip processing the
VMDK by specifying vmskipmaxvirtualdisks yes in the backup-archive client
options file. For more information, see Vmskipmaxvirtualdisks.
To enable the file restore feature, Data Protection for VMware must be installed on
a Windows system.
The following prerequisites apply to the VMware virtual machine that contains the
files to be restored:
v Linux Windows VMware Tools must be installed on the virtual machine.
v Linux Windows The virtual machine must be running during the file restore
operation.
14 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
v Windows The virtual machine must belong to the same Windows domain as the
data mover system.
v Windows When a virtual machine is deleted from a Windows domain and then
restored later, the virtual machine must rejoin the domain to ensure the domain
trust relationship. Do not attempt a file restore from the virtual machine until
the domain trust relationship is restored.
v Windows If the user does not own the file to be restored, the Microsoft
Windows Restore Files and Directories privilege must be assigned to the user
for that virtual machine.
v Linux Local user authentication is required for the virtual machine.
Authentication is not available through Windows domain, Lightweight Directory
Access Protocol (LDAP), Kerberos, or other network authentication methods.
v Linux On a Red Hat Enterprise Linux 6 operating system, the
ChallengeResponseAuthentication option in the sshd daemon configuration file
(/etc/ssh/sshd_config) must specify YES or be commented out. For example,
either of the following statements are valid:
ChallengeResponseAuthentication yes
#ChallengeResponseAuthentication no
The data mover system represents a specific backup-archive client that "moves
data" from one system to another.
Windows The data mover system must belong to the same Windows domain as
the virtual machine that contains the files to be restored.
The mount proxy system represents the Linux or Windows proxy system that
accesses the mounted virtual machine disks through an iSCSI connection. This
system enables the file systems on the mounted virtual machine disks to be
accessible as restore points to the Tivoli Storage Manager file restore interface.
Linux Windows The Windows mount proxy system and Linux mount proxy
system must be on the same subnet.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 15
v Windows Windows domain administrator credentials are required to access the
network share. An administrator enters these credentials in the Data Protection
for VMware vSphere GUI configuration wizard or notebook to enable the
environment for file restore operations.
v Windows A file owner accesses the remote virtual machine (that contains the
files to be restored) with Windows domain user credentials. These credentials are
entered in the Tivoli Storage Manager file restore interface during login. Domain
user credentials verify that the file owner has permission to log in to the remote
virtual machine and restore files into the remote virtual machine. These
credentials do not require any special permissions.
v Windows If a file owner uses a Windows domain user account that limits access
to specific computers (instead of access to all computers within the domain),
ensure that the mount proxy system is included in the list of computers that are
accessible to this domain user account. Otherwise, the file owner is unable to log
in to the Tivoli Storage Manager file restore interface.
File restore from tape media is supported. However, recovery of individual files
generates random read request patterns. As a result, processing might be slow
when a sequential-access device (such as tape media) is used. File restore from disk
storage is the preferred method.
Consider moving target virtual machine backup data from tape media to disk
storage before you attempt a file restore operation. You can do move data with the
Tivoli Storage Manager server MOVE NODEDATA command. You can also run
traditional full VM backups regularly.
16 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Required communication ports
View a list of communication ports that are required to be open in the firewall
when you install Data Protection for VMware.
The ports that are identified in the table reflect a typical installation. A typical
installation consists of the following components on the same Windows system:
v Data Protection for VMware GUI server
v vStorage backup server (data mover)
v Windows mount proxy
v Tivoli Storage Manager file restore interface
Restriction: The Windows mount proxy and Linux mount proxy must be on the
same subnet.
Table 7. Required communication ports. This table identifies the ports that are accessed by
Data Protection for VMware.
TCP Port Initiator: Out-Bound (From Host) Target: In-Bound (To Host)
443 vStorage Backup Server vCenter Server (secure HTTP)
443 Data Protection for VMware vSphere vCenter Server
GUI Server
443 Windows mount proxy vCenter Server
This setting is
required only
when the data
mover is a
Linux system.
902 vCenter Server ESXi hosts
443
902 vStorage Backup Server (proxy) ESXi hosts (all protected hosts)
443
1500 vStorage Backup Server (proxy) Tivoli Storage Manager server
(tcpport)
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 17
Table 7. Required communication ports (continued). This table identifies the ports that are
accessed by Data Protection for VMware.
TCP Port Initiator: Out-Bound (From Host) Target: In-Bound (To Host)
1500 Data Protection for VMware vSphere Tivoli Storage Manager server
(tcpadminport) GUI Server
v 1500 (tcpadminport) is non-SSL
communication
v For SSL communication,
tcpadminport is the only port that
supports SSL communication with
the Tivoli Storage Manager server.
The correct port number to use for
the SSL protocol is typically the
value that is specified by the
ssltcpadminport option in the Tivoli
Storage Manager server dsmserv.opt
file. However, if adminonclient no is
specified in the dsmserv.opt file,
then the correct port number to use
for the SSL protocol is the value that
is specified by the ssltcpadminport
option. The ssltcpadminport option
does not have a default value.
Therefore, the value must be
specified by the user.
1527
Internal Derby
database
1501 Tivoli Storage Manager server vStorage Backup Server
v Backup-archive client
1581
scheduler
(httpport)
v Web client
v Client Acceptor Daemon
1581 Data Protection for VMware vSphere vStorage Backup Server
(httpport) GUI server
1582, 1583
(webports)
9080 vSphere Client Data Protection for VMware
vSphere GUI Server (HTTP port
for access to vCenter as plug-in)
9081 vSphere Client Data Protection for VMware
vSphere GUI Server (secure
GUI web server HTTPS port for access to
(HTTPS vCenter through web browser)
protocol)
22 Recovery agent Data Protection for VMware
Windows "mount" host
SSH default
v SSH for Linux recovery agent
port for the
recovery agent
3260 Linux Data Protection for VMware file Data Protection for VMware
restore Windows "mount" host
v iSCSI
18 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Table 7. Required communication ports (continued). This table identifies the ports that are
accessed by Data Protection for VMware.
TCP Port Initiator: Out-Bound (From Host) Target: In-Bound (To Host)
3260 Windows target with Dynamic disk for Data Protection for VMware
file restore Windows "mount" host
iSCSI default
v iSCSI
port for the
recovery agent
135 Windows mount proxy VMware virtual machine that
contains the files to be restored
with the Tivoli Storage Manager
file restore interface
Tip: Alternatively, rather than creating a specific role for the installation, you can
enter the administrator user name when prompted for the vCenter user name.
The vCenter Server user ID that signs on to the browser or plug-in views for the
Data Protection for VMware vSphere GUI must have sufficient VMware privileges
to view content for a datacenter that is managed by the GUI.
The VMware vCenter Server defines a set of privileges collectively as a role. A role
is applied to an object for a specified user or group to create a privilege. From the
VMware vSphere web client, you must create a role with a set of privileges. To
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 19
create a vCenter Server role for backup and restore operations, use the VMware
vSphere Client Add a Role function. You must assign this role to a user ID for a
specified vCenter Server or datacenter. If you want to propagate the privileges to
all datacenters within the vCenter, specify the vCenter Server and select the
propagate to children check box. Otherwise, you can limit the permissions if you
assign the role to the required datacenters only with the propagate to children
check box selected. Enforcement for the browser and plug-in view GUIs is at the
datacenter level.
The following example shows how to control access to datacenters for two
VMware user groups. First, create a role that contains all of the privileges defined
in technote 7047438. The set of privileges in this example are identified by the role
named “TDPVMwareManage”. Group 1 requires access to manage virtual
machines for the Primary1_DC and Primary2_DC datacenters. Group 2 requires
access to manage virtual machines for the Secondary1_DC and Secondary2_DC
datacenters.
The users in each VMware user group can use the Data Protection for VMware
GUI to manage virtual machines in their respective datacenters only.
Tip: When you create a role, consider adding extra privileges to the role that you
might need later to complete other tasks on objects.
The Tivoli Storage Manager backup-archive client that is installed on the vStorage
Backup server (the data mover node) requires the VMCUser and VMCPw options. The
VMCUser option specifies the user ID of the vCenter or ESX server that you want to
back up, restore, or query. The required privileges that are assigned to this user ID
(VMCUser) ensure that the client can run operations on the virtual machine and the
VMware environment. This user ID must have the VMware privileges that are
described in technote 7047438.
To create a vCenter Server role for backup and restore operations, use the VMware
vSphere Client Add a Role function. You must select the propagate to children
option when you add privileges for this user ID (VMCUser). In addition, consider
adding other privileges to this role for tasks other than backup and restore. For the
VMCUser option, enforcement is at the top-level object.
The IBM Data Protection extension requires a set of privileges that are separate
from the privileges that are required to sign in to the GUI.
During the installation the following custom privileges are created for the IBM
Data Protection extension:
v Datacenter > IBM Data Protection
v Global > IBM Data Protection
20 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Custom privileges that are required for the IBM Data Protection extension are
registered as a separate extension. The privileges extension key is
com.ibm.tsm.tdpvmware.IBMDataProtection.privileges.
These privileges allow the VMware administrator to enable and disable access to
IBM Data Protection extension content. Only users with these custom privileges on
the required VMware object can access the IBM Data Protection extension content.
One IBM Data Protection extension is registered for each vCenter Server and is
shared by all GUI hosts that are configured to support the vCenter Server.
From the VMware vSphere web client, you must create a role for users who can
complete data protection functions for virtual machines by using the IBM Data
Protection extension. For this role, in addition to the standard virtual machine
administrator role privileges required by the web client, you must specify the
Datacenter > IBM Data Protection privilege. For each datacenter, assign this role
for each user or user group where you want to grant permission for the user to
manage virtual machines.
The Global > IBM Data Protection privilege is required for the user at the vCenter
level. This privilege allows the user to manage, edit, or clear the connection
between the vCenter Server and the Data Protection for VMware vSphere GUI web
server. Assign this privilege to administrators that are familiar with the Data
Protection for VMware vSphere GUI that protects their respective vCenter Server.
Manage your IBM Data Protection extension connections on the extension
Connections page.
The following example shows how to control access to datacenters for two user
groups. Group 1 requires access to manage virtual machines for the NewYork _DC
and Boston_DC datacenters. Group 2 requires access to manage virtual machines for
the LosAngeles_DC and SanFranciso_DC datacenters.
From the VMware vSphere client, create for example the “IBMDataProtectManage”
role, assign the standard virtual machine administrator role privileges and also the
Datacenter > IBM Data Protection privilege.
For Group 1, assign the “IBMDataProtectManage” role to the NewYork _DC and
Boston_DC datacenters. For Group 2, assign the “IBMDataProtectManage” role to
the LosAngeles_DC and SanFranciso_DC datacenters.
The users in each group can use the IBM Data Protection extension in the vSphere
web client to manage virtual machines in their respective datacenters only.
When the web browser or vSphere Client plug-in view user does not have
sufficient permissions for any datacenter, access to the view is blocked. Instead, the
error message GVM2013E is issued to advise that the user is not authorized to
access any managed datacenters due to insufficient permissions. Other new
messages are also available that inform users of issues that result from insufficient
permissions. To resolve any permissions-related issues, make sure that the user role
is set up as described in the previous sections. The user role must have all
privileges that are identified in the Required privileges vCenter Server user ID and
data mover table, and these privileges must be applied at the datacenter level with
the propagate to children check box.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 21
When the IBM Data Protection extension user does not have sufficient permissions
for a datacenter, the data protection functions for that datacenter and its content
are made unavailable in the extension.
When the Tivoli Storage Manager user ID (specified by the VMCUser option)
contains insufficient permissions for a backup and restore operation, the following
message is shown:
ANS9365E VMware vStorage API error.
"Permission to perform this operation was denied."
When the Tivoli Storage Manager user ID contains insufficient permissions to view
a machine, the following messages are shown:
Backup VM command started. Total number of virtual machines to process: 1
ANS4155E Virtual Machine ’tango’ could not be found on VMware server.
ANS4148E Full VM backup of Virtual Machine ’foxtrot’ failed with RC 4390
To retrieve log information through the VMware Virtual Center Server for
permission problems, complete these steps:
1. In vCenter Server Settings, select Logging Options and set "vCenter Logging to
Trivia (Trivia).
2. Re-create the permission error.
3. Reset vCenter Logging to its previous value prevent recording excessive log
information.
4. In System Logs, look for the most current vCenter Server log (vpxd-wxyz.log)
and search for the string NoPermission. For example:
[2011-04-27 15:15:35.955 03756 verbose ’App’] [VpxVmomi] Invoke error:
vim.VirtualMachine.createSnapshot session: 92324BE3-CD53-4B5A-B7F5-96C5FAB3F0EE
Throw: vim.fault.NoPermission
This log message indicates that the user ID did not contain sufficient
permissions to create a snapshot (createSnapshot).
The phrase “Data Protection for VMware GUI” applies to the following GUIs:
v Data Protection for VMware vSphere GUI accessed in a web browser
v Data Protection for VMware vSphere GUI accessed as a plug-in from either of
the vSphere GUIs
v IBM Data Protection extension in the vSphere Web Client GUI
The Data Protection for VMware vSphere GUI plug-in registration key is
com.ibm.tsm.tdpvmware@hostname. This key is registered when you select the
Register GUI as vCenter plug-in check box during the installation. A separate key
is registered for each web GUI host. When multiple web GUI hosts exist, then
multiple instances of the Data Protection for VMware vSphere GUI plug-in are
registered.
22 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
the Register the vSphere Web Client extension check box during the installation.
A single instance of the IBM Data Protection extension is registered per vCenter
server.
A registration key is not created for the Data Protection for VMware vSphere GUI
that is accessed in a web browser.
To view the registration keys, log in to the VMware Managed Object Browser
(MOB). After you log in to the MOB, go to Content→Extension Manager to view
the registration keys.
Using the Data Protection for VMware installer, you can install the following
components:
v Tivoli Storage Manager recovery agent
v Recovery agent command-line interface
v Documentation (readme file and notices file)
v Data Protection for VMware enablement file
v Data Protection for VMware vSphere GUI or Data Protection for VMware
vCloud GUI
v Data mover feature (backup-archive client), which includes the following items:
– Backup-archive client GUI
– Backup-archive web client
– Client API (64-bit) runtime files
– Administrative client command line
– VMware vStorage API runtime files
Restriction: You can install only the data mover feature and Data Protection for
VMware vSphere or vCloud GUI on 64-bit systems, not 32-bit systems.
Tip: You can create multiple data movers on the same system as the Data
Protection for VMware software, or you can create data movers on remote systems.
This configuration increases the resources available for use by Data Protection for
VMware. The systems with the data mover installed are called vStorage backup
servers.
Linux
Before you begin
If you plan to download the files, set the system user limit for maximum file size
to unlimited to ensure that the files can be downloaded correctly:
1. To query the maximum file size value, issue the following command:
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 23
ulimit -Hf
2. If the system user limit for maximum file size is not set to unlimited, change it
to unlimited by following the instructions in the documentation for your
operating system.
Procedure
1. Download the appropriate package file from one of the following websites, or
you can access the files from the product DVD:
v For a first-time installation or a new release go to Passport Advantage at:
http://www.ibm.com/software/lotus/passportadvantage/. Passport
Advantage is the only site that you can download a licensed package file
from.
v For the latest information, updates, and maintenance fixes, go to the Tivoli
Storage Manager support site: http://www.ibm.com/support/entry/portal/
Overview/Software/Tivoli/Tivoli_Storage_Manager.
2. If you downloaded the package from an IBM download site, complete the
following steps:
a. Download the package file to the directory of your choice. The path must
contain no more than 128 characters. Be sure to extract the installation files
to an empty directory. Do not extract to a directory that contains previously
extracted files, or any other files.
b. Linux Ensure that executable permission is set for the package. If
necessary, change the file permissions by issuing the following command:
chmod a+x package_name.bin
c. Linux Extract the package by issuing the following command:
./package_name.bin
Windows You can use the Suite Installer to install both the Data Protection for
VMware and the data mover (backup-archive client). Optionally, you can use the
Data Protection for VMware stand-alone installer or the data mover stand-alone
installer.
Linux You can install Data Protection for VMware by using the Data Protection
for VMware stand-alone installer. Similarly, you can use the data mover
stand-alone installer to install the data mover.
24 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Installing the Data Protection for VMware components on
Windows systems
Install Data Protection for VMware components and features by using the
installation wizard.
Before you install the Data Protection for VMware components, ensure that you
meet the following requirements:
v A user ID with administrator privilege access.
v Network connectivity to a VMware vCenter Server 5.x (or later) with
administrator privilege access.
v Network connectivity to a Tivoli Storage Manager server with administrator
access (System or Unrestricted Policy Domain privilege). This server must be
available and running.
v Ensure that you reviewed the following requirements:
– “System requirements” on page 13
– “Required installation permissions” on page 16
– “Required communication ports” on page 17
Before you install Data Protection for VMware, you must be aware of the following
options:
Installation Type
Typical Installation
With typical installations, all of the Data Protection for VMware
components and features are installed.
Advanced Installation
With advanced installations, you can select the components and
features that you want to install.
You can use the Suite Installer to install both Data Protection for VMware and the
data mover feature. The spinstall.exe file for the Suite Installer is located at the
root of the installation package that is on DVD or in the installation folder.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 25
Alternatively, you can use the separate stand-alone installers to install Data
Protection for VMware and the data mover feature separately. The spinstall.exe
file for Data Protection for VMware is in the tsm4ve directory in the installation
package. The spinstall.exe file for the data mover feature is in the client
directory in the installation package.
For a list of components and features that you can install, see “Installable
components” on page 1.
Procedure
To install Data Protection for VMware or the data mover feature, complete the
following steps from the location of the spinstall.exe file for the component that
you chose to install:
1. Double-click the spinstall.exe file.
2. Follow the wizard instructions to install the selected components. When you
install the recovery agent for instant restore, you must also select the device
driver for installation. It is not selected by default. Choosing this option
requires a system reboot.
What to do next
To access the Data Protection for VMware vSphere GUI or the Data Protection for
VMware vCloud GUI, see the following sections:
v “Accessing the Data Protection for VMware vSphere GUI” on page 41
v “Accessing the Data Protection for VMware vCloud GUI” on page 42
The configuration wizard is automatically displayed the first time that you start
the GUI.
Before you install Data Protection for VMware, ensure that you meet the following
requirements:
v Ensure that the user ID has the required permission level and that the required
communication ports are open before you proceed.
v The installation process creates user tdpvmware. You must issue all vmcli
commands as user tdpvmware, and with root user ID.
v X Window Server is required when you install in console mode.
v Ensure that you reviewed the following requirements:
– “System requirements” on page 13
– “Required installation permissions” on page 16
– “Required communication ports” on page 17
Procedure
26 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
2. From a command line, enter the following command:
./install-Linux.bin
Results
If you receive any warnings or errors, check the log files for more information. See
“Log file activity” on page 93.
If you are unable to install Data Protection for VMware because of a failure, see
the "Manually removing Data Protection for VMware" procedure in “Uninstalling
Data Protection for VMware a Linux system” on page 55.
You can install the data mover feature (backup-archive client) on the same system
as Data Protection for VMware or install it on a separate system. To install the data
mover feature, see “Installing the data mover feature on Linux systems.”
Procedure
where version represent the GSKIT version in the file name on the
installation media. For example, in the gskcrypt64-
8.0.50.35.linux.x86_64.rpm and gskssl64-8.0.50.35.linux.x86_64.rpm
files, the version is 8.0.50.35.
b. Install the 64-bit Tivoli Storage Manager API:
rpm -ivh TIVsm-API64.x86_64.rpm
c. Optional: Install the Common Inventory Technology package that is used by
the API to supports processor value unit (PVU) calculations. This package
depends on the API so it must be installed after the API package is
installed.
rpm -ivh TIVsm-APIcit.x86_64.rpm
3. Install the backup-archive client, command-line client, administrative client,
web client, and the documentation:
rpm -ivh TIVsm-BA.x86_64.rpm
4. Optional: Install the Common Inventory Technology package the client uses to
send PVU metrics to the server. This package depends on the client package so
it must be installed after the client package is installed.
rpm -ivh TIVsm-msg.language_ID.x86_64.rpm
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 27
Results
If you receive any warnings or errors, check the log files for more information. See
“Log file activity” on page 93.
If you are unable to install Data Protection for VMware because of a failure, see
the "Manually removing Data Protection for VMware" procedure in “Uninstalling
Data Protection for VMware a Linux system” on page 55.
Procedure
1. If the Data Protection for VMware vSphere GUI is installed, complete these
tasks:
a. Stop the Data Protection for VMware command-line interface by issuing this
command:
/etc/init.d/vmcli stop
b. Stop the Data Protection for VMware GUI Web Server by issuing this
command:
/etc/init.d/webserver stop
c. Remove the .rpm package by issuing this command:
rpm -e TIVsm-TDPVMwarePlugin
2. Remove the Deployment Engine product entries:
a. Issue the following command to list all Deployment Engine entries:
/usr/ibm/common/acsi/bin/de_lsrootiu.sh
b. Issue the following command to remove all Deployment Engine entries:
/usr/ibm/common/acsi/bin/deleteRootIU.sh <UUID> <discriminant>
c. Remove the /var/ibm/common directory.
d. Remove the /usr/ibm/common directory.
e. Clean up the /tmp directory by removing the acu_de.log file, if it exists.
f. Remove the /tmp directory that contains the ID of the user that installed the
Deployment Engine.
g. Remove all Deployment Engine entries from the /etc/inittab system file.
The entries are delimited by #Begin AC Solution Install block and #End
AC Solution Install block. Remove all text between those delimiters, and
remove the delimiting text itself.
h. Remove all Deployment Engine references from the /etc/services system
file.
3. Remove all Data Protection for VMware files from the failed installation:
a. Remove files in the <USER_INSTALL_DIR>, which is the path where the failed
installation was attempted. For example: /opt/tivoli/tsm/TDPVMware/
b. Remove any desktop shortcuts.
4. Back up the global registry file (/var/.com.zerog.registry.xml). After backing
up this file, remove all tags that reference Data Protection for VMware.
28 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
5. Remove log files under root that contain the TDPVMware string. For example:
IA-TDPVMware-00.log or IA-TDPVMware_Uninstall-00.log.
6. Remove the user that ran the Data Protection for VMware command-line
interface.
a. Issue the following command:
userdel -r tdpvmware
b. Issue the following command:
groupdel tdpvmware
Tip: In some versions of Linux, the userdel command also removes the
group when no other associated user exists. As a result, ignore any
command-related fail message.
Results
Windows You can use the Suite Installer to install both the Data Protection for
VMware and the data mover (backup-archive client). Optionally, you can use the
Data Protection for VMware stand-alone installer or the data mover stand-alone
installer.
Linux You can install Data Protection for VMware by using the Data Protection
for VMware stand-alone installer. Similarly, you can use the data mover
stand-alone installer to install the data mover.
Use the Suite Installer to install all of the components and features from one
package.
Restriction: On Windows 32-bit systems, you can install only the recovery agent
GUI and command-line interface.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 29
Installing Data Protection for VMware on Windows 32-bit systems by using the
Suite Installer in silent mode:
Install the recovery agent GUI and command-line interface silently on a Windows
32-bit operating system.
Restriction: All features are installed to their default location. To locate the default
installation directories for the components, see the subtopics in “Installable
components” on page 1.
Procedure
To install Data Protection for VMware, complete the following steps from the
directory where you extracted the package or from the product DVD:
1. Open a command prompt and enter the following command:
spinstall.exe /silent SETUP_SUPPORT_DIR="directory to setup.iss file"
For example, if the setup.iss file is in the C:\install\test directory, enter the
following command:
spinstall.exe /silent SETUP_SUPPORT_DIR="C:\install\test"
Note: The following message displays the first time that you mount a volume:
The Virtual Volume Driver is not yet registered. Recovery Agent can register
the driver now. During registration, a Microsoft Windows Logo warning
may be displayed.
Accept this warning to allow the registration to complete.
Do you want to register the Virtual Volume Driver now?
You must register the Virtual Volume Driver to proceed with the recovery agent
operations.
Related tasks:
“Uninstalling Data Protection for VMware for a Windows 32-bit system in silent
mode” on page 53
Installing Data Protection for VMware on Windows 64-bit systems by using the
Suite Installer in silent mode:
Install all Data Protection for VMware components and the data mover feature
(backup-archive client) by using the Suite Installer in silent mode.
Before you install Data Protection for VMware and the data mover feature, ensure
that your system meets the requirements in the following sections:
v “System requirements” on page 13
v “Required installation permissions” on page 16
v “Required communication ports” on page 17
30 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Use the following Data Protection for VMware parameters with the silent
installation features:
Table 8. Data Protection for VMware silent installation parameters
Parameter Description Default value
ISFeatureInstall Specify one or both of the following options: TSM4VE,Client
TSM4VE
Install all Data Protection for
VMware features except the
recovery agent device driver.
Client Install all data mover features.
ComponentsToInstallVe Specify the Data Protection for VMware None
features to install. Use the features that are
described in Table 9 on page 32
ComponentsToInstallBa Specify the data move features to install. None
Use the features that are described in
Table 10 on page 33
GUI_MODE vcenter
To protect data in a vSphere environment,
specify GUI_MODE=vcenter.
This parameter installs the Data Protection
for VMware vSphere GUI. This GUI
integrates the product with the VMware
vSphere client to back up, restore, and
manage VMs in a VMware vCenter
environment. Includes the Data Protection
for VMware command-line interface. You
can install only one Data Protection for
VMware vSphere GUI on a machine. As a
result, multiple Data Protection for VMware
vSphere GUIs are not allowed on the same
machine. vcenter is the default value when
GUI_MODE is specified.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 31
Table 8. Data Protection for VMware silent installation parameters (continued)
Parameter Description Default value
VCLOUD_HOSTNAME The vCloud server address or name. This None
feature is required when GUI_MODE=vcloud is
specified.
VCLOUD_USERNAME The vCloud user ID. This feature is required None
when GUI_MODE=vcloud is specified.
VCLOUD_PASSWORD The vCloud password. This feature is None
required when GUI_MODE=vcloud is specified.
DIRECT_START 1
(vSphere only) To access the Data Protection Important: After
for VMware vSphere GUI in a web browser, installation
specify DIRECT_START=1. completes, the
The Data Protection for VMware vSphere DIRECT_START value
GUI is accessed through a URL bookmark to cannot be changed
the GUI web server. If you do not want to except by
access the Data Protection for VMware reinstalling the
vSphere GUI in a web browser, specify product.
DIRECT_START=0.
REGISTER_PLUGIN (vSphere only) To access the Data Protection 0
for VMware vSphere GUI as an extension in
the Solutions and Applications panel of your
vCenter Server System, specify
REGISTER_PLUGIN=1.
This plug-in access method is the same
method as provided in prior versions of
Tivoli Storage Manager for Virtual
Environments.If you do not want to access
the Data Protection for VMware vSphere
GUI as an extension, specify
REGISTER_PLUGIN=0.
REGISTER_EXTENSION 0
(vSphere only) To access the Data Protection
for VMware vSphere GUI as an extension in
the vSphere Web Client, specify
REGISTER_EXTENSION=1.
DB_PORT The TCP/IP port number for the Derby 1527
database.
WC_DEFAULTHOST The HTTP protocol for the GUI web server. 9080
WEBSERVER_SECUREPORT The HTTPS protocol for the GUI web server. 9081
32 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Table 9. Data Protection for VMware silent installation features (continued)
Feature Description Installed by default?
LAP Data Protection for VMware license Yes
TSMLicence Data Protection for VMware enablement Yes
file
Use the following data mover parameters with the silent installation features:
Table 10. Data mover silent installation parameters
Parameter Description Default value
BackupArchiveGUI Tivoli Storage Manager backup-archive None
client GUI
BackupArchiveWeb Tivoli Storage Manager backup-archive web None
client
Api64Runtime Tivoli Storage Manager API runtimes None
AdministrativeCmd Tivoli Storage Manager Administrative None
command line
Restriction: All features are installed to their default location. To locate the default
installation directories for the components, see the subtopics in “Installable
components” on page 1.
Procedure
To install Data Protection for VMware, complete the following steps from the
directory where you extracted the package or from the product DVD:
1. Open a command prompt and go to the location of the spinstall.exe file for
the component that you want to install.
2. Specify which features to install.
The following example installs the Tivoli Storage Manager recovery agent,
device driver, and recovery agent command-line interface:
spinstall.exe ISFeatureInstall=TSM4VE ComponentsToInstallVe=mount,mountdriver,shell
REBOOT=ReallySuppress SUITE_MODE=1 /silent
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 33
The following example installs a subset of Data Protection for VMware and
data mover features:
spinstall.exe ISFeatureInstall=Client,TSM4VE /silent
ComponentsToInstallBa=BackupArchiveGUI,BackupArchiveWeb,Api64Runtime
ComponentsToInstallVe=LAP,TSMLicence,documents,gui SUITE_MODE=1 REBOOT=ReallySuppress
GUI_MODE=vcenter VCENTER_HOSTNAME=host_name
VCENTER_USERNAME=user_name VCENTER_PASSWORD=password
REGISTER_PLUGIN=1 DIRECT_START=1
The following example installs all Data Protection for VMware and data mover
features:
spinstall.exe /silent SUITE_MODE=1 REBOOT=ReallySuppress
GUI_MODE=vcenter VCENTER_HOSTNAME=host_name VCENTER_USERNAME=user_name
VCENTER_PASSWORD=password REGISTER_PLUGIN=1 DIRECT_START=1
3. Optional: When the device driver is installed, you must restart the system.
Note: The following message displays the first time that you mount a volume:
The Virtual Volume Driver is not yet registered. Recovery Agent can register
the driver now. During registration, a Microsoft Windows Logo warning
may be displayed.
Accept this warning to allow the registration to complete.
Do you want to register the Virtual Volume Driver now?
You must register the Virtual Volume Driver to proceed with the recovery agent
operations.
Related tasks:
“Uninstalling Data Protection for VMware for Windows 64-bit system in silent
mode” on page 54
Use the stand-alone installer to install the Data Protection for VMware and data
mover features separates.
Windows If you do not want to install Data Protection for VMware and the data
mover feature on the same system, you can use the stand-alone installers. You can
install multiple data movers on different systems and you can use the stand-alone
installer for the data mover to do so.
Restriction: On Windows 32-bit systems, you can install only the recovery agent
GUI and command-line interface.
34 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Installing Data Protection for VMware on Windows 32-bit systems in silent
mode:
You can silently install the recovery agent GUI and the recovery agent
command-line interface on a Windows 32-bit operating system.
Data Protection for VMware provides the following silent installation features for
Windows 32-bit operating systems:
Table 11. Data Protection for VMware silent installation features
Installed by
Feature Description default?
Mount Tivoli Storage Manager recovery agent Yes
Procedure
To install Data Protection for VMware, complete the following steps from the
directory where you extracted the files or from the product DVD:
1. Change directories to the tsm4ve\X86 directory.
2. Open the setup.iss file in a text editor:
v For a default installation, complete the following tasks:
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 35
a. In the SERVER_IP= string, specify the host name or IP address of the
Windows system where the recovery agent is to be installed.
b. Save and close the setup.iss file.
c. From a command prompt window, enter the following command:
spinstall.exe /s /f1"path\setup.iss"
You can customize which Data Protection for VMware features to silently install on
a Linux operating system.
Before you install Data Protection for VMware, ensure that you meet the following
requirements:
v Ensure that the user ID has the required permission level and that the required
communication ports are open before you proceed.
36 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
v The installation process creates user tdpvmware. You must issue all vmcli
commands as user tdpvmware, and with root user ID.
v X Window Server is required when you install in console mode.
v Ensure that you reviewed the following requirements:
– “System requirements” on page 13
– “Required installation permissions” on page 16
– “Required communication ports” on page 17
Data Protection for VMware provides the following silent installation features for
Linux operating systems:
Table 12. Data Protection for VMware silent installation features
Installed by
Feature Description default?
Docs Readme file Yes
RecoveryAgent Tivoli Storage Manager recovery agent Yes
Use the following Data Protection for VMware parameters with the silent
installation features:
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 37
Table 13. Data Protection for VMware silent installation parameters for the
installer.properties file
Parameter Description Default value
PRODUCT_PROTECT VSPHERE
_TYPE To protect data in a vSphere environment,
specify PRODUCT_PROTECT_TYPE=VSPHERE.
This parameter installs the Data Protection
for VMware vSphere GUI. This GUI
integrates the product with the VMware
vSphere client to back up, restore, and
manage VMs in a VMware vCenter
environment. Includes the Data Protection
for VMware command-line interface. You
can install only one Data Protection for
VMware vSphere GUI on a machine. As a
result, multiple Data Protection for VMware
vSphere GUIs are not allowed on the same
machine.
38 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Table 13. Data Protection for VMware silent installation parameters for the
installer.properties file (continued)
Parameter Description Default value
DIRECT_START YES
(vSphere only) To access the Data Important: After
Protection for VMware vSphere GUI in a installation completes,
web browser, specify DIRECT_START=YES. the DIRECT_START
The Data Protection for VMware vSphere value cannot be
GUI is accessed through a URL bookmark changed except by
to the GUI web server. If you do not want reinstalling the
to access the Data Protection for VMware product.
vSphere GUI in a web browser, specify
DIRECT_START=NO.
USERNAME User name. A profile for this user name is tdpvmware
created in /home/<username>/tdpvmware/
config.
REGISTER_PLUGIN (vSphere only) To access the Data NO
Protection for VMware vSphere GUI as an
extension in the Solutions and Applications
panel of your vCenter Server System,
specify REGISTER_PLUGIN=YES.
This plug-in access method is the same
method as provided in prior versions of
Tivoli Storage Manager for Virtual
Environments.If you do not want to access
the Data Protection for VMware vSphere
GUI as an extension, specify
REGISTER_PLUGIN=No.
REGISTER_EXTENSION (vSphere only) To access the Data 0
Protection for VMware vSphere GUI as an
extension in the vSphere Web Client,
specify REGISTER_EXTENSION=1.
VMCLI_DB_PORT The TCP/IP port number for the Derby 1527
Database.
WC_defaulthost The HTTP protocol for the GUI web server. 9080
WebServer_Https The HTTPS protocol for the GUI web 9081
server.
Keystore_Password The keystore password for the GUI web None
server. The password must be a minimum
of six valid characters (a-z A-Z 0-9).
SSL_Certificate The installation process generates a 10
self-signed SSL certificate. Enter the number
of years to keep this SSL certificate active.
Procedure
To install Data Protection for VMware, complete the following steps from the
directory where you extracted the installation package or from the product DVD:
1. Open the path/CD/Linux/DataProtectionForVMware/installer.properties file
and uncomment the following entry in the to accept the license (where path is
the installation folder or DVD mount):
#LICENSE_ACCEPTED=TRUE
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 39
LICENSE_ACCEPTED=TRUE
2. Choose one of the following methods to install the Data Protection for VMware
components:
v For a default installation, open the CD/Linux/DataProtectionForVMware folder
and enter the following command:
./install-Linux.bin -i silent -DLICENSE_ACCEPTED=true
v For a custom installation, complete the following steps:
a. Edit the installer.properties file with the appropriate values:
1) Specify INSTALL_MODE=Custom. Ensure the number sign (#) is removed
from this statement.
2) Specify the features to install with the CHOSEN_INSTALL_FEATURE_LIST
option. For example, all features are installed with the following
value:
CHOSEN_INSTALL_FEATURE_LIST=Docs,RecoveryAgent,TDPVMwareEnableFile,TDPVMwareGUI
3) Specify the installer.properties parameters as described in Table 13
on page 38.
b. From the CD/Linux/DataProtectionForVMware folder, issue the following
command:
./install-Linux.bin -i silent -f installer.properties
Taking the first steps after you install Data Protection for
VMware
After you install Data Protection for VMware, prepare for the configuration. Using
the configuration wizard is the preferred method of configuring Data Protection for
VMware.
Configuration worksheet
Use this worksheet to record information that you need when you configure and
administer Data Protection for VMware. The worksheet is intended to help you
remember the values that you specified after the configuration.
Table 14. Data Protection for VMware configuration worksheet
Item Your value Notes
Tivoli Storage Manager server
information
Tivoli Storage Manager server address
Tivoli Storage Manager server port
Tivoli Storage Manager server admin
ID/password
Tivoli Storage Manager server admin port
Node definition options
Prefix to add to nodes
Policy domain to use when you register
new nodes
vCenter node name/password
VMCLI node name/password
40 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Table 14. Data Protection for VMware configuration worksheet (continued)
Item Your value Notes
Datacenter node names/passwords
The data center node name consists of
Remember: You can create multiple the specified prefix, followed by an
datacenter nodes. underscore character, followed by the
datacenter name.
For example:
nodePrefix_datacenterName
Data mover node names/passwords on
the vStorage backup server The data mover node consists of the
datacenter node name, followed by an
Remember: You can create multiple data underscore character, followed by DM.
mover nodes.
For example: datacenterNodename_DM
Data mover node names/passwords on
remote servers
Before you can access the Data Protection for VMware vSphere GUI, during the
installation, you must have selected the option to protect your data in a vSphere
environment.
Procedure
v If you selected the Enable access to the GUI by a web browser option during
the installation, you can access the Data Protection for VMware vSphere GUI
from the browser:
1. Open a web browser and enter the following URL:
https://hostname:port/TsmVMwareUI
where:
– hostname is the name of the system where the Data Protection for VMware
vSphere GUI is installed
– port is the port number where the vSphere GUI is accessible through. The
default port number is 9081.
2. Log in by using your vCenter user ID and password.
v If you did not select the Enable access to the GUI by a web browser option
during the installation, you can start the Data Protection for VMware vSphere
GUI by completing the following steps:
1. Open the VMware vSphere Client and log on with the vCenter user ID and
password.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 41
2. In the Solutions and Applications panel of the vSphere Client, click the Data
Protection for VMware vSphere GUI icon.
Before you can access the Data Protection for VMware vSphere GUI, during the
installation, you must have selected the option to protect your data in a vSphere
environment.
Procedure
1. Open a web browser and enter the following URL:
https://hostname:port/TsmVMwareUI
v hostname is the name of the system where the Data Protection for VMware
vCloud GUI is installed
v port is the port number where the vCloud GUI is accessible through. The
default port number is 9081.
2. Log in by using your vCloud Directory user ID and password.
If you are installing Data Protection for VMware Version 7.1.8 on a system that
contains IBM Tivoli Storage FlashCopy Manager for VMware Version 3.x, you must
also upgrade Tivoli Storage FlashCopy Manager for VMware to Version 4.1.6. Data
Protection for VMware Version 7.1.8 is not compatible with Tivoli Storage
FlashCopy Manager for VMware Version 3.x.
See the Tivoli Storage FlashCopy Manager for VMware Installation and User's
Guide when working with that product.
You must have administrator privileges to upgrade Data Protection for VMware.
Updates to the existing Data Protection for VMware vSphere GUI are processed in
the following manner:
v Parameter files are backed up before the Data Protection for VMware vSphere
GUI upgrade process begins.
42 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
v The same Derby Database Port and WebSphere® Application Server Default Base
Port numbers are used.
v Linux The values in the profile (vmcliprofile) are used for the Data
Protection for VMware command-line interface.
Restriction:
v Windows When Tivoli Storage Manager for Virtual Environments was installed
to a non-default location, the upgrade process installs Tivoli Storage Manager for
Virtual Environments V7.1.8 features to the default installation directory. You
cannot upgrade to a non-default location. See the subtopics in “Installable
components” on page 1 for the default installation directories for each feature.
v Linux Windows The upgrade process does not install new components.
For example, if your previous version has only the Tivoli Storage Manager
recovery agent GUI installed, the upgrade procedure does not install the Tivoli
Storage Manager recovery agent command-line interface. In such a scenario, you
must run the installation program again and then select the missing component
to install.
v Linux The Tivoli Storage Manager recovery agent on Linux version must be
the same version as the Tivoli Storage Manager recovery agent on the Windows
proxy. Therefore, if you upgrade Tivoli Storage Manager recovery agent on
Linux, you must also upgrade the Tivoli Storage Manager recovery agent
version on the Windows proxy.
Procedure
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 43
Upgrading Data Protection for VMware from Tivoli Storage
FlashCopy Manager for VMware
This procedure documents how to upgrade to Data Protection for VMware V7.1.8
when Tivoli Storage FlashCopy Manager for VMware is also installed.
Important: This upgrade procedure applies to a Linux system that does not have
Data Protection for VMware installed.
Updates to the existing Data Protection for VMware vSphere GUI are processed in
the following manner:
v Parameter files are backed up before the Data Protection for VMware vSphere
GUI upgrade process begins.
v The same Derby Database Port and WebSphere Application Server Default Base
Port numbers are used.
v The values in the profile (vmcliprofile) are used for the Data Protection for
VMware command-line interface.
You must have administrator privileges to upgrade Data Protection for VMware.
Procedure
44 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
The installation process completed successfully. If you are upgrading, you must
upgrade all components from the Data Protection for VMware, FlashCopy Manager for
VMware, and Tivoli Storage Manager Backup-Archive Client (data mover) packages
because of component dependencies.
v When Data Protection for VMware V7.1.8 does not install successfully, follow
the instructions provided in the installation dialog. You can also check the
log file to determine what must be done to resolve the issue. See “Log file
activity” on page 93 for the location of various log files.
Important: This upgrade procedure applies to a Linux system that has both Data
Protection for VMware V6.x and Tivoli Storage FlashCopy Manager for VMware
V3.x installed.
You must have administrator privileges to upgrade Data Protection for VMware.
Updates to the existing Data Protection for VMware vSphere GUI are processed in
the following manner:
v Parameter files are backed up before the Data Protection for VMware vSphere
GUI upgrade process begins.
v The same Derby Database Port and WebSphere Application Server Default Base
Port numbers are used.
v The values in the profile (vmcliprofile) are used for the Data Protection for
VMware command-line interface.
Restriction:
v The upgrade process does not install new components.
For example, if your previous version has only the recovery agent GUI installed,
the upgrade procedure does not install the recovery agent command-line
interface. In such a scenario, you must run the installation program again and
then select the missing component to install.
v The recovery agent on Linux version must be the same version as the recovery
agent on the Windows proxy. Therefore, if you upgrade recovery agent on
Linux, you must also upgrade the recovery agent version on the Windows
proxy.
Procedure
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 45
b. Install the backup-archive client V7.1.8. Follow the instructions in “Installing
Data Protection for VMware on Linux systems” on page 26.
2. Either download the code package or insert the Data Protection for VMware
product DVD into the DVD drive.
3. Start the installation program by running install-Linux.bin for your platform.
The default installation path is /opt/tivoli/tsm/tdpvmware.
4. Choose the language to be used for the installation process and click OK.
5. The Welcome page opens. Click Next.
6. The Software License Agreement page opens. Read the terms of the license
agreement. Select I accept the terms in the license agreement and click Next. If
you do not accept the terms of the license agreement, the installation ends.
7. The Choose Installation Folder page opens prompting you to specify where to
install the software. You can accept the default location shown in the
Destination Folder field, type the location name, or click Browse to go to the
location. Click Next.
8. Select Complete or Custom:
v Select Complete to install all of the components.
v Select Custom to specify only those components you want to install. At the
prompt, enter the number that corresponds to the component. If multiple
components, separate each number with a comma.
After completing your selection, click Next to continue.
9. The Pre-Installation Summary panel opens. This panel contains a list of the
settings you provided. Review the settings and click Install to begin installing
the files.
v When the Data Protection for VMware V7.1.8 installation is successful, the
following message is displayed:
The installation process completed successfully. If you are upgrading, you must
upgrade all components from the Data Protection for VMware, FlashCopy Manager for
VMware, and Tivoli Storage Manager Backup-Archive Client (data mover) packages
because of component dependencies.
– If you are using Tivoli Storage FlashCopy Manager for VMware V3.x, you
must upgrade to V4.1.6 as described in Upgrading Tivoli Storage
FlashCopy Manager for VMware.
– If you are using Tivoli Storage Manager backup-archive client V6.x or
earlier, you must upgrade to V7.1.8 as described in Upgrading the Tivoli
Storage Manager backup-archive client.
– Data Protection for VMware offloads the backup workload from VMs to a
vStorage Backup Server. To accomplish this task, the backup-archive client
must be installed on the vStorage Backup Server. During configuration,
the backup-archive client is registered as a data mover node. This node
runs the operation and "moves" the data from the vStorage Backup Server
to the Tivoli Storage Manager server. You must upgrade all data mover
nodes to the backup-archive clientV7.1.8 level as described in “Upgrading
the data mover nodes on the vStorage Backup Server” on page 49.
v When Data Protection for VMware V7.1.8 does not install successfully, follow
the instructions provided in the installation dialog. You can also check the
log file to determine what must be done to resolve the issue. See “Log file
activity” on page 93 for the location of various log files.
46 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Upgrading Data Protection for VMware on a Windows 32-bit
system in silent mode
You can silently upgrade Data Protection for VMware on a supported 32-bit
operating system
Procedure
When Data Protection for VMware V6.x was installed to a non-default location, the
silent upgrade process installs Data Protection for VMware V7.1.8 features to the
default installation directory. You cannot silently upgrade to a non-default location.
See the subtopics in “Installable components” on page 1 section for the default
installation directories for each feature.
Procedure
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 47
3. Unmount any mounted virtual volumes. You can use the Tivoli Storage
Manager recovery agent GUI or command-line interface (mount del command)
to unmount volumes.
4. Either download the code package or insert the Data Protection for VMware
product DVD into the DVD drive.
5. In the folder for Data Protection for VMware, either go to the X64 folder.
6. From a command prompt window, enter the following command:
spinstall.exe /s /v"/qn REBOOT=ReallySuppress"
Use the following Data Protection for VMware parameters with the silent
installation feature:
Table 15. Data Protection for VMware silent installation upgrade parameters
Parameter Description Default value
DVCENTER_HOSTNAME The vCenter Server fully qualified domain None
name or IP address.
DVCENTER_USERNAME The vCenter user ID. This user ID must be None
a VMware administrator that has
permission to register and unregister
extensions.
DVCENTER_PASSWORD The vCenter password. None
DDIRECT_START To access the Data Protection for VMware YES
vSphere GUI in a web browser, specify Important: After
DDIRECT_START=YES. upgrade completes,
The Data Protection for VMware vSphere the DDIRECT_START
GUI is accessed through a URL bookmark value cannot be
to the GUI web server. If you do not want changed except by
to access the Data Protection for VMware reinstalling the
vSphere GUI in a web browser, specify product.
DDIRECT_START=NO.
DREGISTER_PLUGIN To access the Data Protection for VMware NO
vSphere GUI as an extension in the
Solutions and Applications panel of your
vCenter Server System, specify
DREGISTER_PLUGIN=YES.
This plug-in access method is the same
method as provided in prior versions of
Tivoli Storage Manager for Virtual
Environments.If you do not want to access
the Data Protection for VMware vSphere
GUI as an extension, specify
DREGISTER_PLUGIN=No.
DREGISTER_EXTENSION To access the Data Protection for VMware 0
vSphere GUI as an extension in the vSphere
Web Client, specify DREGISTER_EXTENSION=1.
48 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Procedure
Data Protection for VMware works with Tivoli Storage Manager backup-archive
client (installed on the vStorage Backup server) to complete full, incremental, and
incremental forever snapshots of VMs. The client node on the vStorage Backup
server is called the data mover node. This node "moves" the data to the Tivoli
Storage Manager server for storage, and VM image-level restore at a later time.
Important: Data Protection for VMware stores sensitive information locally on the
data mover, and the data mover might also have direct access to VM storage.
Access to the data mover must be protected. Allow only trusted users access to the
data mover system.
Procedure
1. Upgrade each vStorage Backup Server in your Data Protection for VMware
environment with Tivoli Storage Manager backup-archive client V7.1.8.
2. When upgrading the Tivoli Storage Manager backup-archive client, upgrade the
VMware vStorage API runtime files:
a. During the upgrade process, select setup type Custom.
b. Select VMware vStorage API runtime files.
3. Upgrade each vStorage Backup Server in your Data Protection for VMware
environment with Data Protection for VMware V7.1.8:
a. Detailed instructions are provided in “Upgrading Data Protection for
VMware” on page 42.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 49
b. When upgrading the vStorage Backup Server, the only Data Protection for
VMware component required for the data mover node is the Data
Protection for VMware Enablement File. This file enables the data mover
node to perform the backup VM incremental function.
Configuration and property files are located in the C:\Program Files (x86)\Common
Files\Tivoli\TDPVMware\VMwarePlugin\config directory after the uninstall
completes.
Procedure
1. Stop any Data Protection for VMware components that are running.
2. Unmount any mounted virtual volumes. You can use the Tivoli Storage
Manager recovery agent GUI or command-line interface (mount del command)
to unmount volumes.
3. Click Start > Control Panel > Programs and Features > Uninstall a program.
v If you installed Data Protection for VMware with the Suite Installer, select
Data Protection for VMware suite and click Uninstall.
v If you installed Data Protection for VMware with the stand-alone installer,
select IBM Tivoli Storage Manager for Virtual Environments and click
Uninstall.
This action uninstalls the Windows Data Protection for VMware program. It
also removes services that are associated with the Recovery Agent, web server,
and Data Protection for VMware command-line interface. However, this action
does not remove log files, backup-archive client (data mover and mount proxy)
services, or other items that were created when you configured or used Data
Protection for VMware. Leaving these artifacts on disk is not a problem if you
50 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
want to reinstall Data Protection for VMware in the future. However, if you
want to more thoroughly remove Data Protection for VMware and related files
and settings, go to Step 4.
4. Remove the following Data Protection for VMware files and directories from
the file system. Open an Administrator command prompt and complete the
following steps:
a. Go to the C:\Program Files\Tivoli\TSM\ directory. For example:
cd /d “C:\Program Files\Tivoli\TSM\”
Note: The following command deletes all configuration and property files
that were saved after uninstallation.
Issue the following command:
rd /s TDPVMware
c. Go to the C:\ProgramData directory. For example:
cd /d “C:\ProgramData”
What to do next
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 51
Uninstalling the data mover on Windows
Uninstall backup-archive client components (data mover) and remove files and
directories from a Windows system.
Uninstall Data Protection for VMware before you proceed with this task.
Procedure
1. Stop any backup-archive client components that are running.
2. Delete any existing virtual machine backups by issuing the backup-archive
client delete backup command. For example, to delete the active backup of a
virtual machine that is named vm1, issue the following command:
delete backup -objtype=vm vm1
Important: Ensure that you remove the TSM Remote Client Agent in Step 3b
before you remove the TSM Client Acceptor in Step 3c. Otherwise, the TSM
Client Acceptor (Step 3c) cannot be removed.
c. dsmcutil remove /name:“TSM Client Acceptor”
4. Click Start > Control Panel > Programs and Features > Uninstall a program.
Uninstall the following Tivoli Storage Manager backup-archive client items if
they are listed:
IBM® Tivoli Storage Manager client
IBM Tivoli Storage Manager Client - Chinese(PRC)
IBM Tivoli Storage Manager Client - Chinese(Taiwan)
IBM Tivoli Storage Manager Client - French
IBM Tivoli Storage Manager Client - German
IBM Tivoli Storage Manager Client - Italian
IBM Tivoli Storage Manager Client - Japanese
IBM Tivoli Storage Manager Client - Korean
IBM Tivoli Storage Manager Client - Portuguese(Brazil)
IBM Tivoli Storage Manager Client - Spanish
This action uninstalls the Windows client program. It does not remove any
services, log files, or other items that were created when you configured or
used the client. Leaving these artifacts on disk is not a problem if you want to
reinstall the client in the future. However, if you want to more thoroughly
remove the client and related files and settings, see the following IBM
developerWorks article: How to completely remove the Backup-Archive client
from Microsoft Windows.
Related tasks:
“Uninstalling Data Protection for VMware on Windows” on page 50
52 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Uninstalling Data Protection for VMware with the Windows
Installer
Uninstall Data Protection for VMware from a Microsoft Windows Server Core with
the Microsoft Windows Installer Tool.
Configuration and property files are located in the C:\Program Files (x86)\Common
Files\Tivoli\TDPVMware\VMwarePlugin\config directory after the uninstall
completes.
Procedure
1. Stop any Data Protection for VMware components that are running.
2. Unmount any mounted virtual volumes. You can use the Tivoli Storage
Manager recovery agent GUI or command-line interface (mount del command)
to unmount volumes.
3. Initiate the Windows Installer (MSI) with either of the following methods:
v To initiate the MSI with the Suite installer in GUI mode, complete the
following steps:
a. Locate the Data Protection for VMware UninstallString in the
Wow6432Node registry path. For example:
[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\
Uninstall\{4D11E402-4480-4A4D-B6E5-B98A7E5FA97F}]
b. Run the following command:
C:\"C:\Program Files (x86)\InstallShield Installation Information\
{4D11E402-4480-4A4D-B6E5-B98A7E5FA97F}\spinstall.exe" -remove -runfromtemp
v To initiate the MSI directly, complete the following steps:
Uninstall Tivoli Storage Manager for Virtual Environments:
a. Obtain the product code from the HKLM\SOFTWARE\Microsoft\Windows\
CurrentVersion\Uninstall registry key.
1) Issue CTRL + F to search for the Tivoli Storage Manager for Virtual
Environments text string.
2) The product code is viewable when the text string is located.
b. Issue msiexec.exe /uninstall {PRODUCTCODE}. For example:
C:\Program Files (x86)>Msiexec.exe /uninstall {9ED81E7A-E410-4A39-990D-3256DDDCFCD5}
Procedure
1. Stop any Data Protection for VMware components that are running.
2. Unmount any mounted virtual volumes. You can use the Tivoli Storage
Manager recovery agent GUI or command-line interface (mount del command)
to unmount volumes.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 53
3. From a command prompt window, use the cd command to change to one of
the following folders:
v To uninstall Data Protection for VMware with an uninstall.iss file, go to
the X64 folder.
v To uninstall Data Protection for VMware with Suite installer, go to one of the
following folders:
– If you downloaded the product image from Passport Advantage, go to
<extract folder>TSM4VE_WIN.
– If you inserted the product DVD into the DVD drive, go to <DVD>\.
4. Enter one of the following commands:
v To uninstall Data Protection for VMware with an uninstall.iss file, enter
the following command:
spinstall.exe /s /f1"
<full absolute path_to_the_uninstall.iss_file and uninstall.iss>"
Note: The command must be entered on one line. This example shows two
lines to accommodate page formatting.
v To uninstall Data Protection for VMware with Suite installer, enter the
following command:
spinstall.exe /silent /remove
5. Restart the system after uninstallation completes.
Configuration and property files are located in the C:\Program Files (x86)\Common
Files\Tivoli\TDPVMware\VMwarePlugin\config directory after the uninstall
completes.
Procedure
54 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
– Enter this command to uninstall Data Protection for VMware and
unregister the Data Protection for VMware vSphere GUI:
spinstall.exe /s /v"/qn REBOOT=ReallySuppress REMOVE=ALL
VCENTER_HOSTNAME=<vCenter hostname or IP>
VCENTER_USERNAME=<vCenter user name>
VCENTER_PASSWORD=<vCenter password>"
– To uninstall Data Protection for VMware and skip Data Protection for
VMware vSphere GUI unregistration, enter this command:
spinstall.exe /s /v"/qn REBOOT=ReallySuppress REMOVE=ALL
IGNORE_VCENTER_UNREGISTER=1"
– Enter this command to uninstall Data Protection for VMware and
unregister the Data Protection for VMware vCloud GUI:
spinstall.exe /s /v"/qn REBOOT=ReallySuppress REMOVE=ALL
VCLOUD_HOSTNAME=<vCloud Server IP address or name>"
– To uninstall Data Protection for VMware and skip Data Protection for
VMware vCloud GUI unregistration, enter this command:
spinstall.exe /s /v"/qn REBOOT=ReallySuppress REMOVE=ALL
IGNORE_VCLOUD_UNREGISTER=1"
v To uninstall all features with Suite installer, enter the following command:
spinstall.exe /silent /remove
5. Restart the system after uninstallation completes.
When you uninstall Data Protection for VMware on a Linux system, by default, the
type of uninstallation is the same process as the type of original installation. To use
a different uninstallation process, specify the correct parameter. For example, if you
used a silent installation process, you can use the installation wizard to uninstall
by specifying the –i swing parameter. Run the uninstallation process as the root
user. The root user profile must be sourced. If you use the su command to switch
to root, use the su - command to source the root profile.
When the uninstall process begins removing program files, canceling the uninstall
process does not return the system to a clean state. This situation might cause the
reinstallation attempt to fail. As a result, clean the system by completing the tasks
that are described in “Manually removing Data Protection for VMware from a
Linux system” on page 56.
Procedure
1. Change to the directory for the uninstallation program. The following path is
the default location to the uninstallation program: /opt/tivoli/tsm/tdpvmware/
_uninst/TDPVMware/
2. Depending on the type of installation, use one of the following methods to
uninstall Data Protection for VMware:
Note: The commands in this procedure must be entered on one line. These
examples show two lines to accommodate page formatting.
Chapter 1. Installing and upgrading Tivoli Storage Manager for Virtual Environments 55
v To use the installation wizard to uninstall Data Protection for VMware, enter
this command:
./Uninstall_Tivoli_Data_Protection_for_VMware –i swing
v To use the console to uninstall Data Protection for VMware, enter this
command:
./Uninstall_Tivoli_Data_Protection_for_VMware -i console
v To silently uninstall Data Protection for VMware, enter this command:
./Uninstall_Tivoli_Data_Protection_for_VMware -i silent
-f uninstall.properties
When Data Protection for VMware cannot be uninstalled by using the standard
uninstallation procedure, you must manually remove Data Protection for VMware
from the system as described in these steps. Complete this process as the root user.
Procedure
1. If you installed the Data Protection for VMware vSphere GUI or Data
Protection for VMware vCloud GUI, remove its package from the Package
Manager database with this command:
rpm -e TIVsm-TDPVMwarePlugin
2. Remove the Tivoli Storage Manager API with this command:
rpm -e TIVsm-API64
3. Remove the product entries from the Deployment Engine:
a. Issue this command to view a list of all entries:
/usr/ibm/common/acsi/bin/de_lsrootiu.sh
b. Issue this command to remove the installed unit entries that are related to
Data Protection for VMware:
/usr/ibm/common/acsi/bin/deleteRootIU.sh <UUID> <discriminant>
56 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Chapter 2. Configuring Data Protection for VMware
This section provides instructions for configuring Data Protection for VMware and
starting related services.
The system where Data Protection for VMware is installed must have network
connectivity to the following servers:
v vStorage Backup Server
v Tivoli Storage Manager server
v vCenter Server
To configure the Data Protection for VMware environment, complete these steps:
Procedure
1. Open a web browser and enter the GUI web server address. For example:
https://guihost.mycompany.com:9081/TsmVMwareUI/
v In a vSphere environment, log in with the vCenter user name and password.
v In a vCloud environment, log in with the vCloud user name and password.
This user name must be the name of a vCloud system administrator.
2. In the Getting Started window, go to the Configuration window and click Run
Configuration Wizard.
3. Follow the instructions in each page of the wizard until the Summary window
displays. Review the settings and click Finish to complete the configuration
and exit the wizard.
Tip: Information about each configuration page is provided in the online help
that is installed with the GUI. Click Learn More in any of the GUI windows to
open the online help for task assistance. See the Running the configuration wizard
topic.
4. Verify that the data mover nodes are configured properly:
a. Click the Configuration tab to view the Configuration Status page.
b. In the Configuration Status page, select a data mover node to view its status
information in the Status Details pane. When a node displays a warning or
error, click that node and use the information in the Status Details pane to
resolve the issue. Then, select the node and click Validate Selected Node to
verify whether the issue is resolved. Click Refresh to retest all nodes.
Results
Fast path: After you successfully complete this wizard task, no additional
configuration tasks are required to back up your VM data.
The Edit Configuration notebook provides the following tasks for an existing
configuration:
v Set or change the Tivoli Storage Manager Administrator ID.
v Reset the password and unlock the VMCLI node.
v (vSphere environment) Add or remove VMware data centers to your Data
Protection for VMware vSphere GUI domain.
v Add or remove mount proxy nodes. Modify a password for an existing mount
proxy node.
v Add or remove data mover nodes. Modify a password for an existing data
mover node.
v Enable file restore.
v Enable tagging support for a data mover node.
Procedure
1. Open a web browser and enter the GUI web server address. For example:
https://guihost.mycompany.com:9081/TsmVMwareUI/
v In a vSphere environment, log in with the vCenter user name and password.
v In a vCloud environment, log in with the vCloud user name and password.
This user name must be the name of a vCloud system administrator.
2. In the Getting Started window, go to the Configuration window and click Edit
Configuration.
3. Go to the page relevant for your edit task and follow the instructions. You must
click OK to save your changes before you proceed to another Configuration
Settings page. Otherwise, your changes do not take effect.
Results
58 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Enabling the environment for file restore operations
Windows
When the file restore feature is enabled by an administrator, file owners can restore
files without assistance.
Complete these steps on the system where the Data Protection for VMware
vSphere GUI is installed.
Procedure
1. Start the Data Protection for VMware vSphere GUI by opening a web browser
and entering the GUI web server address. For example:
https://<GUI web server address>:9081/TsmVMwareUI/
Results
The environment is enabled for file restore operations. File owners can restore their
files by using the URL to access the Tivoli Storage Manager file restore interface.
To enable the file restore feature when Data Protection for VMware is installed on
a Linux system, an additional Data Protection for VMware environment must be
set up on a Windows system.
Procedure
1. Set up a separate Windows server that is used for the file restore feature.
2. Install Data Protection for VMware on the Windows system. Accept the default
values during the installation.
3. When you configure Data Protection for VMware on the Windows system, use
the following node names:
a. Create a vCenter node named VCENTER_FR.
b. Create a VMCLI node named VMCLI_FR.
c. Reuse the datacenter node name from the Linux environment.
For example: DATACENTER.
60 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
d. Do not create a data mover node. A data mover node is not required for the
file restore feature in this scenario.
e. Create the following new pair of mount proxy nodes named
REMOTE_FR_MP_WIN and REMOTE_FR_MP_LNX.
4. On the File Restore page in the configuration wizard, select the Enable File
Restore option.
5. To access the file restore interface, open a web browser and enter the URL
provided by your administrator. For example:
https:\\hostname:9081\FileRestoreUI
where hostname is the host name of the Windows system where Data Protection
for VMware is installed.
Results
The following example shows the proxy node relationships on the Tivoli Storage
Manager server:
tsm: SERVER>q proxy
The additional nodes that are created to enable the file restore feature have the _FR
suffix.
To allow administrators to configure and control restore processing for file restore
operations, modify the options in the frConfig.props file.
Procedure
1. Go to the directory where the frConfig.props file is located. For example, open
a command prompt and issue the following command:
cd C:\IBM\tivoli\tsm\tdpvmware\webserver\usr\servers\veProfile\tsmVmGUI
2. Open the frConfig.props file with a text editor in administrator mode and
modify the options as needed. Use the information in “File restore options” on
page 62 to determine which options to modify.
3. Save your changes and close the frConfig.props file.
Results
Modified options are applied to the Tivoli Storage Manager file restore interface.
Tip: To prevent a virtual machine from being mounted multiple times for
simultaneous restore operations, set this option with a low value.
mount_session_timeout_minutes=num_mins
Specify the amount of time, in minutes, that a restore and the mounted
recovery point can be idle before the session is canceled. A cancellation
unmounts the recovery point. The maximum value is 8 hours (480 minutes).
The default value is 30 minutes.
Tip: To prevent the session from being canceled unexpectedly, increase the
number of minutes.
restore_info_duration_hours=num_hrs
Specify the amount of time, in hours, that information about recent restore
activity is retained in the Tivoli Storage Manager file restore interface. Use the
restore activity window to view error information and recently completed
tasks. This information provides a way to locate recently restored files. The
maximum value is 14 days (336 hours). The default value is one week (168
hours).
contact_info=administrator information
Provide administrator contact information that file owners can use to obtain
support. Contact information displays in the Tivoli Storage Manager file restore
interface in the following locations:
v Login window
62 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
v The About pane in the help menu
v The support information link in interface messages
You can overwrite the following options with the Data Protection for VMware
vSphere GUI configuration wizard or notebook:
v enable_contact_info
v enable_filerestore
v contact_info
The FRLog.config file is generated the first time that the Tivoli Storage Manager
file restore interface is accessed.
Complete these steps on the system where the Data Protection for VMware
vSphere GUI is installed.
Procedure
1. Go to the directory where the FRLog.config file is located. Open a command
prompt and issue the following command:
cd Install_Directory\IBM\tivoli\tsm\tdpvmware\webserver\usr\servers\veProfile\frGUI\
2. Open the FRLog.config file with a text editor in administrator mode and
modify the options as needed. Use the information in “File restore log activity
options” to determine which options to modify.
3. Save your changes and close the FRLog.config file.
4. Restart the GUI web server:
a. Click Start > Control Panel > Administrative Tools > Services.
b. Right-click Data Protection for VMware Web Server Service and click
Restart.
Results
Settings are applied to the content and format of logging information for file
restore operations.
The following options log information for file restore tasks in the fr_gui.log file:
MAX_LOG_FILES=number
Specify the maximum number of fr_gui.log files to retain. The default value
is 8.
The following options log information for file restore services in the fr_api.log
file. These services are internal API services that are related to file restore activity:
API_MAX_LOG_FILES=number
Specify the maximum number of fr_api.log files to retain. The default value
is 8.
API_MAX_LOG_FILE_SIZE=number
Specify the maximum size of the fr_api.log file in KBs. The default value is
8192 KB.
API_LOG_FILE_NAME=API_log_file_name
Specify the name of the API log file. The default value is fr_api.log.
API_LOG_FILE_LOCATION=API_log_file_name
Specify the location of the API log file. The location must be specified with a
forward slash (/). The default location is Install_Directory/IBM/tivoli/tsm/
tdpvmware/webserver/usr/servers/veProfile/logs.
FR.API.LOG=ON | OFF
Specify whether to enable logging for file restore services.
v To enable logging for file restore services, specify ON. The default value is
ON.
v To disable logging for file restore services, specify OFF.
To troubleshoot problems that you might encounter during file restore operations,
see Trace options for file restore. Trace options are also specified in the
FRLog.config file.
For Linux data mover nodes, the default password file (/etc/adsm/TSM.PWD)
must be used.
64 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
About this task
You can use data protection tags to change backup policy, such as excluding or
including virtual machines in VMware inventory objects in scheduled backups, or
changing the retention policy of backups. These data protection tags are presented
as settings that can be changed in the IBM Data Protection extension. The virtual
machines must be in the protection set that is defined by the domain.vmfull data
mover option in the schedule definition. A protection set is a group of virtual
machines that is added to a schedule domain.
Procedure
Use one of the following methods:
v To configure a new data mover for tagging support on Windows by using the
Data Protection for VMware vSphere GUI, complete the following steps:
1. On the Windows system where the Data Protection for VMware vSphere GUI
is installed, start the GUI by opening a web browser and entering the GUI
web server address. For example:
https://<GUI web server address>:9081/TsmVMwareUI/
Results
After the data mover node is enabled for tagging support, the data mover queries
the VMware inventory for tagging information when it runs a backup. The data
mover then backs up the virtual machines according to the data protection tags
that are set. If the data mover node is not configured for tagging support, any data
protection tags are ignored during a backup operation.
Related information:
Vmtagdatamover
Important: These configuration settings are provided to assist with setting up the
VMware environment for efficient full virtual machine instant restore and instant
access operations. However, since these settings apply to VMware configuration
tasks and VMware user interfaces, you must refer to your appropriate VMware
documentation for detailed, step-by-step instructions.
This procedure requires an iSCSI adapter on each ESXi host that is used for instant
restore operations. Use the appropriate VMware documentation to set up the
adapter. At the time of publication, the following procedures are available at
VMware ESXi and vCenter Server 5 Documentation.
v To set up a software iSCSI adapter, follow the instructions in the VMware
“Configure Software iSCSI Adapters” procedure.
v To set up a hardware iSCSI adapter, follow the instructions in the VMware
“Setting Up Independent Hardware iSCSI Adapters” procedure.
What to do next
After the iSCSI software is set up on the ESXi host, install and configure
applications on the data mover system.
66 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
2. Installing and configuring applications on the data mover
Before you begin
If the Recovery Agent V7.1.8 and Tivoli Storage Manager backup-archive client
V7.1.8 are installed and configured on the data mover system, begin at Step 3.
Procedure
This task sets up the data mover system with the applications and settings for
instant restore operations.
1. Install the Recovery Agent V7.1.8 and the Tivoli Storage Manager
backup-archive client V7.1.8 on the data mover system.
In Step 4 of the Installing Data Protection for VMware procedure, select the
Install a complete data mover for in-guest application protection installation
type.
2. Configure the backup-archive client.
Follow the instructions in Configuring the backup-archive client.
3. Set the iSCSI server IP address:
a. Go to the C:\Program Files\Tivoli\TSM\baclient\dsm.opt file and specify
the following parameter:
VMISCSIServeraddress=<IP address of the network card on the data mover
system that exposes the iSCSI targets.>
If your data mover system has more than one network card, make sure that
you specify the correct network card for the iSCSI network.
What to do next
After the data mover system is set up, establish a connection between the Recovery
Agent CLI and the Recovery Agent GUI.
Procedure
This task establishes a connection between the Recovery Agent CLI and the
Recovery Agent GUI.
1. Start the Recovery Agent CLI on the data mover system.
From the Windows Start menu, click Programs > Tivoli Storage Manager >
Tivoli Storage Manager for Virtual Environments > Tivoli Storage Manager
Recovery Agent.
2. In the command prompt window, enter the following command:
RecoveryAgentShell.exe -c set_connection mount_computer <IP address
of the network card on the data mover system that exposes the iSCSI targets.>
This command establishes a connection between the Recovery Agent CLI and
the Recovery Agent GUI.
Procedure
This task sets up a dedicated iSCSI network for the ESXi host and for the data
mover that runs in a virtual machine.
1. Log in to the ESXi host to be used for instant restore operations.
2. Set up the virtual switch for the iSCSI network.
These steps use vSwitch1 for the virtual switch.
a. Select VMkernel Network Adapter for the Connection Type.
The iSCSI network requires this connection type.
b. Select Create a vSphere standard switch for the VMkernel Network Access.
c. Select Network Label for the VMkernel Connection Settings.
Specify a label that indicates that vSwitch1 and this network are for your
iSCSI traffic.
For example: VMkernel iSCSI.
d. Specify an IP address and subnet mask for vSwitch1 in VMkernel IP
Connection Settings.
Do not change the Subnet Mask or VMkernel Default Gateway values.
e. Specify the kernel port for the iSCSI network to operate.
3. Set up the virtual switch for the virtual machine network.
These steps use vSwitch0 for the virtual switch.
a. Select Virtual Machine for the Connection Type.
b. Select Create a vSphere standard switch for the VMkernel Network Access.
c. Go to the Port Group Properties tab and select Network Label.
Specify the same label that you specified for vSwitch1 virtual machine
network.
For example: VMkernel iSCSI.
4. Bind the newly created iSCSI adapter with the VMkernel Network Adapter.
Follow the instructions in the VMware “Bind iSCSI Adapters with VMkernel
Adapters” procedure. At the time of publication, this procedure was available
at VMware ESXi and vCenter Server 5 Documentation.
68 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Tip: If a timeout occurs when iSCSI devices are scanned, reduce the number of
iSCSI devices that are connected to the ESXi host. Then, scan the iSCSI devices
again.
5. Verify that the iSCSI adapter binding properties are correct.
a. Go to the Hardware > Storage Adapters in the VMware vSphere Client.
b. Right-click the iSCSI adapter and select iSCSI Initiator Properties. Make
sure that the following binding properties exist:
Table 16. iSCSI network settings
Virtual Machine Network iSCSI Network
Standard Switch: vSwitch0 Standard Switch: vSwitch1
Virtual Machine Port Group: VM Network VMkernel Port: VMkernel iSCSI
Tip: VMkernel iSCSI is bound to VMkernel
Adapter: vmk1, which is on Physical
Network Adapter: vmnic1.
Physical Adapter: vmnic0 VMkernel Network Adapter: vmk1
Physical Network Adapter: vmnic1
Virtual Network Adapter IP address:
192.168.42.x (subnet for the iSCSI network)
Results
A dedicated iSCSI network is ready for full VM instant restore and instant access
operations.
| This scenario automatically obtains certificates from the server when the node
| connects the first time, assuming that the Tivoli Storage Manager server
| SESSIONSECURITY parameter is set to TRANSITIONAL, which is the default value at
| first connection. You can follow this scenario whether you first upgrade the Tivoli
| Storage Manager server to V7.1.8 and later V7 levels, or V8.1.2 and later V8 levels,
| and then upgrade Data Protection for VMware to these levels, or vice versa..
| The following dsmc options specify security settings for the data mover node. For
| more information about these options, see Client options reference.
| v SSLREQUIRED. The default value Default enables existing session-security
| connections to servers earlier than V7.1.8 or V8.1.2, and automatically configures
| the Data Protection for VMware data mover to securely connect to a V7.1.8 or
| V8.1.2 or later server by using TLS for authentication.
| v SSLACCEPTCERTFROMSERV. The default value Yes enables the data mover to
| automatically accept a self-signed public certificate from the server, and to
| automatically configure the data mover to use that certificate when the data
| mover connects to a V7.1.8 or V8.1.2 or later server.
| v SSL. The default value No indicates that encryption is not used when data is
| transferred between the data mover and a server earlier than V7.1.8 or V8.1.2.
| When the data mover connects to a V7.1.8 or V8.1.2 or later server, the default
| value No indicates that object data is not encrypted. All other information is
| encrypted, when the data mover communicates with the server. The value Yes
| indicates that TLS is used to encrypt all information, including object data, when
| the data mover communicates with the server.
| v SSLFIPSMODE. The default value No indicates that a Federal Information
| Processing Standards (FIPS) certified TLS library is not required.
| In addition, the following options apply only when the data mover uses TLS
| connection to a server earlier than V7.1.8 or V8.1.2. They are ignored when the
| data mover connects to a later server.
| v SSLDISABLELEGACYTLS. A value of No indicates that the data mover does not
| require TLS 1.2 for SSL sessions. It allows connection at TLS 1.1 and lower SSL
| protocols. When the data mover communicates with a Tivoli Storage Manager
| server that is V7.1.7 or V8.1.1 or earlier, No is the default.
| v LANFREESSL. The default value No indicates that the data mover does not use TLS
| when communicating with the Storage Agent when LAN-free data transfer is
| configured.
| v REPLSSLPORT. Specifies the TCP/IP port address that is enabled for TLS when the
| data mover communicates with the replication target server.
| The following parameters specify the security settings for the VMCLI node. For
| more information about these options, see Profile parameters.
| v VE_TSM_SSL. The default value NO indicates that encryption is not used when data
| is transferred between the data mover and a server earlier than V7.1.8 or V8.1.2.
| Set this value to YES if you want to use TLS is to encrypt all information when
| connecting to a server earlier than V7.1.8.
| v VE_TSM_SSLACCEPTCERTFROMSERV. The default value YES enables the interface to
| automatically accept a self-signed public certificate from the server, and to
| automatically configure the interface to use that certificate when the data mover
| connects to a V7.1.8 or V8.1.2 or later server.
70 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
| v VE_TSM_SSLREQUIRED. The default value DEFAULT enables existing session-security
| connections to servers earlier than V7.1.8 or V8.1.2, and automatically configures
| the interface to securely connect to a V7.1.8 or V8.1.2 or later server by using
| TLS for authentication.
| The options for security settings are the same as those described in “Configuring
| by using the default security settings (fast path)” on page 69, with the exception
| that you must set the SSLACCEPTCERTFROMSERV option to No to ensure that the data
| mover node does not automatically accept a self-signed public certificate from the
| server when the node first connects to a V7.1.8 or V8.1.2 or later server.
| If the data mover and VMCLI nodes are on the same machine, only one certificate
| is required. If the nodes are on separate machines, a certificate is required one each
| machine.
| v First, the server is upgraded to V7.1.8 or V8.1.2. Then, Data Protection for
| VMware is upgraded. The existing data mover nodes are not using SSL
| communications:
| – Set the SSLACCEPTCERTFROMSERV option with the value No.
| – Obtain the necessary certificate from the Tivoli Storage Manager server or
| from a CA and use the dsmcert utility to import the certificate. See
72 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
| Configuring Tivoli Storage Manager client/server communication with Secure
| Sockets Layer for configuration instructions.
| v First, the server is upgraded to V7.1.8 or V8.1.2. Then, Data Protection for
| VMware is upgraded. The existing data mover nodes are using SSL
| communications:
| – No changes are required to the security options for the data mover nodes. If
| the nodes already have a server certificate for SSL communication, the
| SSLACCEPTCERTFROMSERV option does not apply.
| – SSL communication with existing server public certificate continues to be
| used.
| – SSL communication is automatically enhanced to use the TLS level that is
| required by the server.
| v First, Data Protection for VMware is upgraded to V7.1.8 or V8.1.2. Then, the
| server is upgraded later. The existing data mover nodes are not using SSL
| communications:
| – Set the SSLACCEPTCERTFROMSERV option with the value No.
| – Existing authentication protocol continues to be used to servers at levels
| earlier than V7.1.8 or V8.1.2.
| – Before the data mover nodes connect to a V7.1.8 or V8.1.2 or later server:
| - Obtain the necessary certificate from the Tivoli Storage Manager server or
| from a CA and use the dsmcert utility to import the certificate. See
| Configuring Tivoli Storage Manager client/server communication with
| Secure Sockets Layer for configuration instructions.
| v First, Data Protection for VMware is upgraded to V7.1.8 or V8.1.2. Then, the
| server is upgraded later. The existing data mover nodes are using SSL
| communications
| – No changes are required to the security options for the data mover nodes. If
| the nodes already have a server certificate for SSL communication, the
| SSLACCEPTCERTFROMSERV option does not apply.
| – SSL communication with existing server public certificate continues to be
| used with servers at levels earlier than V7.1.8 or V8.1.2.
| – SSL communication is automatically enhanced to use the TLS level that is
| required by the server after the server is updated to V7.1.8 or V8.1.2 or later.
| First, Data Protection for VMware is upgraded to V7.1.8 or V8.1.2. Then, the
| data mover nodes connect to multiple servers. The servers are upgraded at
| different times:
| – Set the SSLACCEPTCERTFROMSERV option with the value No.
| – Existing authentication protocol continues to be used to servers at levels
| earlier than V7.1.8 or V8.1.2.
| – Before the data mover nodes connect to a V7.1.8 or V8.1.2 later server, or
| when SSL communication is required at any server level:
| - Obtain the necessary certificate from the Tivoli Storage Manager server or
| from a CA and use the dsmcert utility to import the certificate. See
| Configuring Tivoli Storage Manager client/server communication with
| Secure Sockets Layer for configuration instructions.
| – The data mover nodes use existing authentication and session security
| protocol to servers at versions earlier than V7.1.8 or V8.1.2, and automatically
| upgrade to use TLS authentication when initially connecting to a server at
| V7.1.8 or V8.1.2 or later. Session security is managed per server.
| v New Data Protection for VMware installation, server is at V7.1.8 or V8.1.2 or
| later:
| For communication with web browsers and the VMware VCenter Server, the TLS
| protocol is always enabled. During the installation of Data Protection for VMware,
| a self-signed TLS digital certificate is generated and is then used for connection.
| You can also use a certificate that is signed by a certificated authority (CA) to
| communicate with web browsers. Data Protection for VMware To use a certificate
| from a CA, see Using a third-party certificate for web browser sessions.
| For communication with the Tivoli Storage Manager server, the use of the TLS
| protocol depends on the version of the server.
| If you are using Tivoli Storage Manager server V7.1.7 or V8.1.1 or earlier
| The use of the TLS protocol to communicate with the server is optional.
| You can manually enable the Data Protection for VMware vSphere GUI to
| communicate with the server over the TLS protocol by creating or
74 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
| updating the truststore and importing a certificate as described in
| “Enabling secure communication with the Tivoli Storage Manager server”
| If you are using Tivoli Storage Manager server V7.1.8 or V8.1.2 later
| The TLS protocol is required. In most cases, the truststore is created
| automatically on first use by using the default security settings that are
| described in “Configuring by using the default security settings (fast
| path)” on page 69. However, in some scenarios, you might be required to
| manually create the truststore. .
| If you are using server V7.1.8 or V8.1.2 or later, the TLS protocol is required and a
| truststore with a certificate is created automatically on first use by using default
| security settings that are described in “Configuring by using the default security
| settings (fast path)” on page 69. However, in some scenarios, you might be
| required to manually create the truststore and configure the Data Protection for
| VMware vSphere GUI as described in this topic.
| The following procedure uses the Java™ key and certificate management tool
| keytool.
| You might need to specify the full path when you run the keytool command.
| Procedure
| 1. From the command line, change the directory to the truststore location:
| v On Linux: /opt/tivoli/tsm/tdpvmware/common/scripts/
| v On Windows: C:\Program Files (x86)\Common Files\Tivoli\TDPVMware\
| VMwarePlugin\scripts\
| 2. Create the truststore and import the certificate with the following command. To
| obtain the certificate, contact your Tivoli Storage Manager server administrator.
| Where:
| -alias my-cert
| The unique alias that identifies the certificate in the truststore.
| -file cert.pem
| The file that contains the server self-signed certificate or the CA root
| certificate.
| -storepass password
| The keystore password. Ensure that you remember this password for
| future use.
| 3. Start the Data Protection for VMware vSphere GUI and go to the Configuration
| window.
| v If you are creating an initial configuration, click Tasks > Run Tivoli Storage
| Manager Configuration Wizard and go to the Server Credentials page.
| v If you are modifying an existing configuration, click Tasks > Edit Tivoli
| Storage Manager Configuration and go to the Server Credentials page.
| 4. Enter the port number in the Tivoli Storage Manager Admin Port field. This is
| the server port that allows administrative connections using SSL or TLS.
| 5. Select Use SSL communications on the Admin Port.
| 6. If you want to use this setting for future GUI sessions, select Save the
| administrator ID, password, and port settings.
| 7. Click OK to apply the changes.
| The following procedures use the standard key and certificate management tool
| called keytool.
| You might need to specify the full path when running keytool from the command
| line.
| Procedure
| 1. Obtain access to the keystore.
| 2. Create a certificate signing request (CSR).
| 3. Send the certifiate signing request to the certificate authority for signing.
| 4. Receive the signed certificate into the Data Protection for VMware vSphere
| GUI.
|
76 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
| Obtaining access to the keystore:
| Certificates are stored in a Java keystore. The keystore contents are protected with
| a password. To manipulate the certificates in the keystore, you must obtain access
| to the keystore.
| Complete the following procedure to replace the original keystore with a new
| keystore and a new self-signed certificate. The new keystore is protected by a
| password of your choice.
| Procedure
| 1. Stop the Data Protection for VMware vSphere GUI service.
| 2. From the command line, change the directory to the keystore location.
| v On Linux: /opt/tivoli/tsm/tdpvmware/common/webserver/usr/servers/
| veProfile/resources/security/
| v On Windows: C:\IBM\tivoli\tsm\tdpvmware\webserver\usr\servers\
| veProfile\resources\security\
| 3. Make a backup copy of the keystore file (key.jks) by renaming it or moving it
| to a different location.
| 4. Create a new keystore and a new self-signed certificate by issuing the following
| command:
| keytool -genkeypair -alias vekey -dname
| CN=fqdn,OU=Tivoli_Storage_Manager_for_VMware,O=IBM -keyalg RSA
| -sigalg SHA256withRSA -keysize 2048 -validity days -keystore
| key.jks -storepass password -keypass password
| Where:
| -dname CN=fqdn,OU=Tivoli_Storage_Manager_for_VMware,O=IBM
| fqdn is the DNS name or fully qualified domain name of the computer
| on which the Data Protection for VMware vSphere GUI is installed.
| -validity days
| The certificate validity period.
| -storepass password
| The keystore password. Ensure that you remember this password for
| future use.
| -keypass password
| The private key password for the certificate. This password must match
| the keystore password.
| 5. Encode the keystore password by using the securityUtility tool. Issue the
| following command.
| v On Linux: /opt/tivoli/tsm/tdpvmware/common/webserver/bin/
| securityUtility encode
| v On Windows: C:\IBM\tivoli\tsm\tdpvmware\webserver\bin\
| securityUtility.bat encode
| After you obtained access to the keystore, you must create a certificate signing
| request (CSR).
| Procedure
| Where:
| -alias mykey
| mykey is the unique alias that identifies the certificate in the keystore. It
| is renamed when the signed certificate is received.
| -dname CN=fqdn,OU=unit,O=organization
| fqdn is the DNS name or fully qualified domain name of the computer
| on which the Data Protection for VMware vSphere GUI is installed.
| Unit and organization are the organization information that is required
| by your policies or by the certificate authority.
| -validity days
| The certificate validity period.
| -storepass password
| The keystore password. If you do not know or forgot the keystore
| password, see “Obtaining access to the keystore” on page 77.
| -keypass password
| The private key password for the certificate. This password must match
| the keystore password.
| 3. Create a CSR by issuing the following command:
78 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
| keytool -certreq -alias mykey -file certreq.pem -keystore key.jks
| Where:
| -alias mykey
| The certificate alias from the previous step.
| -file certreq.pem
| The file to store the certificate signing request.
| After you create the certificate request (certreq.pem), you must send it to the
| certificate authority for signing. Follow the specific instructions from the certificate
| authority.
| After you get the signed certificate from the certificate authority (CA), you must
| receive the certificate in the keystore.
| Procedure
| Where:
| -alias ca-intermediate
| The unique alias that identifies the certificate in the keystore. Each
| intermediate certificate must have a unique alias.
| -file intermediate.pem
| The intermediate certificate file that is obtained from the CA.
| -storepass password
| The keystore password.
| 6. Import the CA root certificate by issuing the following command. When you
| are prompted to trust this certificate, answer yes.
| keytool -importcert -alias ca-root -file root.pem -keystore
| key.jks -storepass password
| Where:
| -alias mykey
| The alias for the signed certificate. The alias must be the same one
| that was used when you generated the certificate signing request
| (CSR).
| -file signedcert.pem
| The signed certificate file received from the CA.
| -storepass password
| The keystore password.
| 8. Delete the existing certificate that contains the vekey alias:
| keytool -delete -alias vekey -keystore key.jks -storepass password
| Where:
| -alias mykey
| The alias of the signed certificate.
| -storepass password
| The keystore password.
| 10. Start the Data Protection for VMware vSphere GUI service.
| Related reference:
| “Starting and running services for Data Protection for VMware” on page 96
To install the vSphere Client plug-in or IBM Data Protection extension view for the
Data Protection for VMware vSphere GUI, the vSphere user requires the Extension
> Register extension, Unregister extension, Update extension privileges. From the
VMware vSphere client, you can create a role and add to the role the extension set
80 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
of associated privileges. You must then assign this role to the vCenter object in the
VMware vCenter Server hierarchy for the user ID that you plan to use during the
installation process. You must enter this user ID when prompted for the vCenter
user name on the following pages of the Tivoli Storage Manager for Virtual
Environments installation wizard:
v vSphere Client plug-in: Plug-in Registration vCenter page
v IBM Data Protection extension: Data Protection for VMware vSphere GUI
information page
Tip: Alternatively, rather than creating a specific role for the installation, you can
enter the administrator user name when prompted for the vCenter user name.
The vCenter Server user ID that signs on to the browser or plug-in views for the
Data Protection for VMware vSphere GUI must have sufficient VMware privileges
to view content for a datacenter that is managed by the GUI.
The VMware vCenter Server defines a set of privileges collectively as a role. A role
is applied to an object for a specified user or group to create a privilege. From the
VMware vSphere web client, you must create a role with a set of privileges. To
create a vCenter Server role for backup and restore operations, use the VMware
vSphere Client Add a Role function. You must assign this role to a user ID for a
specified vCenter Server or datacenter. If you want to propagate the privileges to
all datacenters within the vCenter, specify the vCenter Server and select the
propagate to children check box. Otherwise, you can limit the permissions if you
assign the role to the required datacenters only with the propagate to children
check box selected. Enforcement for the browser and plug-in view GUIs is at the
datacenter level.
The following example shows how to control access to datacenters for two
VMware user groups. First, create a role that contains all of the privileges defined
in technote 7047438. The set of privileges in this example are identified by the role
named “TDPVMwareManage”. Group 1 requires access to manage virtual
machines for the Primary1_DC and Primary2_DC datacenters. Group 2 requires
access to manage virtual machines for the Secondary1_DC and Secondary2_DC
datacenters.
The users in each VMware user group can use the Data Protection for VMware
GUI to manage virtual machines in their respective datacenters only.
Tip: When you create a role, consider adding extra privileges to the role that you
might need later to complete other tasks on objects.
The Tivoli Storage Manager backup-archive client that is installed on the vStorage
Backup server (the data mover node) requires the VMCUser and VMCPw options. The
VMCUser option specifies the user ID of the vCenter or ESX server that you want to
back up, restore, or query. The required privileges that are assigned to this user ID
(VMCUser) ensure that the client can run operations on the virtual machine and the
VMware environment. This user ID must have the VMware privileges that are
described in technote 7047438.
To create a vCenter Server role for backup and restore operations, use the VMware
vSphere Client Add a Role function. You must select the propagate to children
option when you add privileges for this user ID (VMCUser). In addition, consider
adding other privileges to this role for tasks other than backup and restore. For the
VMCUser option, enforcement is at the top-level object.
The IBM Data Protection extension requires a set of privileges that are separate
from the privileges that are required to sign in to the GUI.
During the installation the following custom privileges are created for the IBM
Data Protection extension:
v Datacenter > IBM Data Protection
v Global > IBM Data Protection
Custom privileges that are required for the IBM Data Protection extension are
registered as a separate extension. The privileges extension key is
com.ibm.tsm.tdpvmware.IBMDataProtection.privileges.
These privileges allow the VMware administrator to enable and disable access to
IBM Data Protection extension content. Only users with these custom privileges on
the required VMware object can access the IBM Data Protection extension content.
One IBM Data Protection extension is registered for each vCenter Server and is
shared by all GUI hosts that are configured to support the vCenter Server.
From the VMware vSphere web client, you must create a role for users who can
complete data protection functions for virtual machines by using the IBM Data
Protection extension. For this role, in addition to the standard virtual machine
administrator role privileges required by the web client, you must specify the
Datacenter > IBM Data Protection privilege. For each datacenter, assign this role
for each user or user group where you want to grant permission for the user to
manage virtual machines.
The Global > IBM Data Protection privilege is required for the user at the vCenter
level. This privilege allows the user to manage, edit, or clear the connection
between the vCenter Server and the Data Protection for VMware vSphere GUI web
server. Assign this privilege to administrators that are familiar with the Data
Protection for VMware vSphere GUI that protects their respective vCenter Server.
Manage your IBM Data Protection extension connections on the extension
Connections page.
82 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
The following example shows how to control access to datacenters for two user
groups. Group 1 requires access to manage virtual machines for the NewYork _DC
and Boston_DC datacenters. Group 2 requires access to manage virtual machines for
the LosAngeles_DC and SanFranciso_DC datacenters.
From the VMware vSphere client, create for example the “IBMDataProtectManage”
role, assign the standard virtual machine administrator role privileges and also the
Datacenter > IBM Data Protection privilege.
For Group 1, assign the “IBMDataProtectManage” role to the NewYork _DC and
Boston_DC datacenters. For Group 2, assign the “IBMDataProtectManage” role to
the LosAngeles_DC and SanFranciso_DC datacenters.
The users in each group can use the IBM Data Protection extension in the vSphere
web client to manage virtual machines in their respective datacenters only.
When the web browser or vSphere Client plug-in view user does not have
sufficient permissions for any datacenter, access to the view is blocked. Instead, the
error message GVM2013E is issued to advise that the user is not authorized to
access any managed datacenters due to insufficient permissions. Other new
messages are also available that inform users of issues that result from insufficient
permissions. To resolve any permissions-related issues, make sure that the user role
is set up as described in the previous sections. The user role must have all
privileges that are identified in the Required privileges vCenter Server user ID and
data mover table, and these privileges must be applied at the datacenter level with
the propagate to children check box.
When the IBM Data Protection extension user does not have sufficient permissions
for a datacenter, the data protection functions for that datacenter and its content
are made unavailable in the extension.
When the Tivoli Storage Manager user ID (specified by the VMCUser option)
contains insufficient permissions for a backup and restore operation, the following
message is shown:
ANS9365E VMware vStorage API error.
"Permission to perform this operation was denied."
When the Tivoli Storage Manager user ID contains insufficient permissions to view
a machine, the following messages are shown:
Backup VM command started. Total number of virtual machines to process: 1
ANS4155E Virtual Machine ’tango’ could not be found on VMware server.
ANS4148E Full VM backup of Virtual Machine ’foxtrot’ failed with RC 4390
To retrieve log information through the VMware Virtual Center Server for
permission problems, complete these steps:
1. In vCenter Server Settings, select Logging Options and set "vCenter Logging to
Trivia (Trivia).
2. Re-create the permission error.
3. Reset vCenter Logging to its previous value prevent recording excessive log
information.
4. In System Logs, look for the most current vCenter Server log (vpxd-wxyz.log)
and search for the string NoPermission. For example:
This log message indicates that the user ID did not contain sufficient
permissions to create a snapshot (createSnapshot).
When a node is registered on the Tivoli Storage Manager server, the server
automatically creates an administrator ID with client owner authority for the node.
The server also assigns a privilege class to that administrator ID. This privilege
class is a level of authority that determines which tasks the administrator ID can
run. As a result, the tasks you run with the Data Protection for VMware vSphere
GUI are based on the privilege class that is assigned to the administrator ID that
you specify.
When the administrator ID does not have unrestricted policy domain privileges,
you cannot register new nodes or set their proxy relationship on the Tivoli Storage
Manager server. If you do not enter an administrator ID, a macro script is created
so you can run on the Tivoli Storage Manager server.
84 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Table 17. Available functions based on Tivoli Storage Manager Administrator ID privilege
requirements (continued)
Restore tab
Run a Restore Yes Yes Yes Yes
task
Reports tab
Events No Yes Yes Yes
Recent Tasks Yes Yes Yes Yes
Backup Status No Yes Yes Yes
Application No Yes Yes Yes
Protection
Datacenter No Yes Yes Yes
Occupancy
Configuration tab
Node No No No2 Yes
Registration
(Configuration
Status -> Run
Configuration
Wizard)
Change Tivoli Yes Yes Yes Yes
Storage Manager
Admin ID
Credentials
(Configuration
Status -> Edit
Configuration)
1. When both Data Protection for VMware and Tivoli Storage FlashCopy Manager for
VMware are installed, an offloaded backup schedule is supported.
2. You cannot register the node because an unrestricted domain policy is required.
3. You can add or remove VMware datacenters and register datacenter nodes.
Important:
v If the Tivoli Storage Manager administrator ID authority level changes on the
Tivoli Storage Manager server, the Data Protection for VMware vSphere GUI
must be restarted to reflect this change.
v When changing the User Role, you must click OK to save your changes before
going to another Configuration Settings page or attempting another
configuration change. Otherwise your User Role changes do not take effect.
86 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Data Protection for VMware GUI registration keys
Depending on the options you select during installation, you can access the Data
Protection for VMware GUI by using different methods. Registration keys are
created for the Data Protection for VMware GUIs.
The phrase “Data Protection for VMware GUI” applies to the following GUIs:
v Data Protection for VMware vSphere GUI accessed in a web browser
v Data Protection for VMware vSphere GUI accessed as a plug-in from either of
the vSphere GUIs
v IBM Data Protection extension in the vSphere Web Client GUI
The Data Protection for VMware vSphere GUI plug-in registration key is
com.ibm.tsm.tdpvmware@hostname. This key is registered when you select the
Register GUI as vCenter plug-in check box during the installation. A separate key
is registered for each web GUI host. When multiple web GUI hosts exist, then
multiple instances of the Data Protection for VMware vSphere GUI plug-in are
registered.
A registration key is not created for the Data Protection for VMware vSphere GUI
that is accessed in a web browser.
To view the registration keys, log in to the VMware Managed Object Browser
(MOB). After you log in to the MOB, go to Content→Extension Manager to view
the registration keys.
Important: Information about how to complete tasks with the Tivoli Storage
Manager recovery agent GUI is provided in the online help that is installed with
the GUI. Click Help in any of the GUI windows to open the online help for task
assistance.
Procedure
1. Linux Log on to the Linux system with root user authority. Tivoli Storage
Manager recovery agent must be installed on this Linux system.
a. Start the Tivoli Storage Manager recovery agent by clicking the Tivoli
Storage Manager recovery agent GUI icon or running the
TDPVMwareMountRestore.sh script from the shell prompt.
88 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
a. Enter the name of the target node (the node where the VM backups
are located) in the Target Node field.
b. Enter the name of the proxy node in the Authentication node field.
c. Enter the password for the proxy node in the Password field.
d. Click OK to save these settings and exit the Tivoli Storage Manager
information dialog.
When you use this method, the Tivoli Storage Manager recovery agent
user knows only the proxy node password, and the target node
password is protected.
Fromnode
Select this option to use a node with access limited only to the snapshot
data of specific VMs in the target node.
Typically, this node is given access from the target node that owns the
VM backups by using the set access command:
set access backup -TYPE=VM vmdisplayname mountnodename
For example, this command gives the node named myMountNode the
authority to restore files from the VM named myTestVM:
set access backup -TYPE=VM myTestVM myMountNode
If you select this option, complete the following steps:
a. Enter the name of the target node (the node where the VM backups
are located) in the Target Node field.
b. Enter the name of the node that is given limited access in the
Authentication node field.
c. Enter the password for the node that is given limited access in the
Password field.
d. Click OK to save these settings and exit the Tivoli Storage Manager
information dialog.
When you use this method, you can see a complete list of backed-up
VMs. However, you can restore only those VM backups to which the
node was granted access. In addition, the snapshot data is not
protected from expiration on the server. As a result, instant restore is
not supported in this method.
Direct Select this option to authenticate directly to the target node (the node
where the VM backups are located).
If you select this option, complete the following steps:
a. Enter the name of the target node (the node where the VM backups
are located) in the Authentication node field.
b. Enter the password for the target node in the Password field.
c. Click OK to save these settings and exit the Tivoli Storage Manager
information dialog.
Use Password access generate
When this option is selected and the password field is empty, the Tivoli
Storage Manager recovery agent authenticates with an existing
password that is stored in the registry. If not selected, you must
manually enter the password.
To use this option, you must first manually set an initial password for
the node to which the option applies. You must specify the initial
password when you connect to the Tivoli Storage Manager node for the
Tivoli Storage Manager recovery agent queries the specified server for a list of
protected VMs, and shows the list.
4. Set the following mount, backup, and restore options by clicking Settings:
Virtual Volume write cache
The Tivoli Storage Manager recovery agent that is running on the
Windows backup proxy host saves data changes that are created during
Linux instant restore and mount. These changes are saved on a virtual
volume in the write cache. By default, the write cache is enabled and
specifies the C:\ProgramData\Tivoli\TSM\TDPVMware\mount\ path and
the maximum cache size is 90% of the available space for the selected
folder. To prevent the system volume from becoming full, change the
write cache to a path on a volume other than the system volume.
Folder for temporary files
Specify the path where data changes are saved. The write cache
must be on a local drive and cannot be set to a path on a
shared folder. If the write cache is disabled or full, attempting
to start an instant restore or mount session on Linux fails.
Cache size
Specify the size of the write cache. The maximum allowed
cache size is 90% of the available space for the selected folder.
Note: When the storage type is changed, you must restart the
service for the changes to take effect.
90 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Disable expiration protection
During a mount operation, the snapshot on the Tivoli Storage
Manager server is locked to prevent it from expiring during the
operation. Expiration might occur because another snapshot is
added to the mounted snapshot sequence. This value specifies
whether to disable expiration protection during the mount
operation.
v To protect the snapshot from expiration, do not select this
option. The snapshot on the Tivoli Storage Manager server is
locked and the snapshot is protected from expiration during
the mount operation.
v To disable expiration protection, select this option. This
option is selected by default. The snapshot on the Tivoli
Storage Manager server is not locked and the snapshot is not
protected from expiration during the mount operation. As a
result, the snapshot might expire during the mount
operation. This expiration can produce unexpected results
and negatively impact the mount point. For example, the
mount point can become unusable or contain errors.
However, expiration does not affect the current active copy.
The active copy cannot expire during an operation.
When the snapshot is on a target replication server, the
snapshot cannot be locked because it is in read-only mode. A
lock attempt by the server causes the mount operation to fail.
To avoid the lock attempt and prevent such a failure, disable
expiration protection by selecting this option.
Read Ahead size (in 16-KB blocks)
Specify the number of extra data blocks that are retrieved from
the storage device after a read request is sent to a single block.
The default values are as follows:
v Disk or file: 64
v Tape: 1024
v VTL: 64
The maximum value for any device is 1024.
Read Ahead cache size (in blocks)
Specify the size of the cache where the extra data blocks are
stored. The default values are as follows:
v Disk or file: 10000
v Tape: 75000
v VTL: 10000
Since each snapshot has its own cache, make sure to plan how
many snapshots are mounted or restored simultaneously. The
cumulative cache size cannot exceed 75000 blocks.
Driver timeout (seconds)
This value specifies the amount of time to process data requests
from the file system driver. If processing is not completed in
time, the request is canceled and an error is returned to the file
system driver. Consider increasing this value when you
experience timeouts. For example, timeouts might occur when
Make sure the command output for each node includes the following
statement:
Backup Delete Allowed?: Yes
If this statement is not included, update each node with this command:
UPDate Node <nodename> BACKDELete=Yes
Run the Query Node command again for each node to verify that each node
allows backups to be deleted.
6. When you use the Tivoli Storage Manager recovery agent in an iSCSI network,
and the Recovery Agent does not use a data mover, go to the
C:\ProgramData\Tivoli\TSM\RecoveryAgent\mount\RecoveryAgent.conf file
and specify the [IMOUNT] tag and Target IP parameter:
[IMOUNT config]
Target IP=<IP address of the network card on the system
that exposes the iSCSI targets.>
For example:
[General config]
param1
param2
...
[IMount config]
Target IP=9.11.153.39
After you add or change the Target IP parameter, restart the Recovery Agent
GUI or Recovery Agent CLI.
92 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Locale settings
Locale settings identify the language that is used for interfaces, messages, and
online help.
The phrase “Data Protection for VMware GUI” applies to the following GUIs:
v Data Protection for VMware vCloud GUI accessed in a web browser
v Data Protection for VMware vSphere GUI accessed in a web browser
v Data Protection for VMware vSphere GUI accessed as a plug-in from either of
the vSphere GUIs
v IBM Data Protection extension in the vSphere Web Client GUI
v Tivoli Storage FlashCopy Manager for VMware GUI
The Data Protection for VMware GUIs do not support running in an environment
that contains inconsistent locale settings among the processors that run the Data
Protection for VMware GUI, the VMware vSphere Client, the VMware vCloud
Director, and the Tivoli Storage Manager server.
Specify the same locale settings among the systems that run the Data Protection for
VMware GUI, the VMware vSphere Client, the VMware vCloud Director, and the
Tivoli Storage Manager server.
When a Data Protection for VMware GUI help page is accessed through the "Learn
more" link for the first time, the help displays in the language that is specified by
the locale setting of the system that runs the Data Protection for VMware GUI. The
help does not display in the language that is specified by the locale of the VMware
vSphere Client the first time the help is accessed. In this situation, after the Data
Protection for VMware GUI help page displays, click at least two links within the
help, then close the help. The next time that the help is started from the "Learn
more" link, it displays in the language that is specified by the locale setting of the
VMware vSphere Client.
The interface content and message prompt language is determined by the language
setting of the web browser that accesses the Tivoli Storage Manager file restore
interface.
For error messages that are logged to the fr_api.log file, the Tivoli Storage
Manager file restore interface uses the language that is specified by the locale
setting of the system that runs the Data Protection for VMware vSphere GUI.
Data Protection for VMware log files are plain text files that use an .sf file
extension.
Important: Existing log files are overwritten every time an installation is started. If
you encounter an installation issue and must reinstall the product, retrieve the
existing TDPVMwareInstallation.log file from the %allusersprofile% directory
before you try the installation again.
Note: While the Data Protection for VMware service is running, several log files
are held in an open state. As a result, some file managers do not display the
current state of these files, and might report a file size of zero. Selecting or opening
one of these files forces the file manager to update the file's details.
The Data Protection for VMware vSphere GUI or Data Protection for VMware
vCloud GUI places log files in this directory:
Windows C:\IBM\tivoli\tsm\tdpvmware\webserver\usr\servers\veProfile\logs
Linux /opt/tivoli/tsm/tdpvmware/common/webserver/usr/servers/veProfile/
logs
When you are collecting log files, make sure to include all subdirectories in your
compressed file.
The Data Protection for VMware command-line interface places log files in this
directory:
Windows C:\Program Files (x86)\Common Files\Tivoli\TDPVMware\VMwarePlugin\
logs
/opt/tivoli/tsm/tdpvmware/common/logs
Linux
When you are collecting log files, make sure to include all subdirectories in your
compressed file.
94 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Tivoli Storage Manager file restore interface log files
The Tivoli Storage Manager file restore interface logs error messages to the
fr_api.log, fr_gui.log, and messages.log files. These files are in the following
default directory:
Windows C:\IBM\tivoli\tsm\tdpvmware\webserver\usr\servers\veProfile\logs
Linux /opt/tivoli/tsm/tdpvmware/common/webserver/usr/servers/veProfile/
logs
You can change the name and location of the fr_api.log file by setting the
API_LOG_FILE_NAME and API_LOG_FILE_LOCATION options in the file restore log
activity file (FRLog.config).
File restore operations are also logged by the Tivoli Storage Manager server. You
can search these messages with a server administrative command-line client.
v To start an administrative client session in command-line mode, enter this
command on your workstation:
dsmadmc -id=admin -password=admin -dataonly=yes
By entering the DSMADMC command with the -ID and -PASSWORD options as
shown, you are not prompted for a user ID and password.
v To search the SQL summary extended table to view results about file restore
operations, issue the select command from the administrative command-line
client:
select * from SUMMARY_EXTENDED where ACTIVITY_TYPE=’File Restore’
You can narrow the search by including one or more of the following criteria in
the select statement:
* ENTITY=’DATA_MOVER_NODE_NAME’
* AS_ENTITY=’DATA_CENTER_NODE_NAME’
* SUB_ENTITY=’VM_HOST_NAME’
* START_TIME=’yyyy-MM-dd HH:mm:ss’
For example:
select * from SUMMARY_EXTENDED where ACTIVITY_TYPE=’File Restore’
and ENTITY=’LOCAL_MP_WIN’ and AS_ENTITY=’DC_NODE’ and SUB_ENTITY=’testvm’
and START_TIME>’2015-03-11 17:30:00’
The START_TIME criteria supports queries with the following signs: equal (=), less
than (<), or greater than (>).
v To search the SQL activity log table to view events about file restore operations,
issue the select command from the administrative command-line client:
select * from ACTLOG
You can narrow the search by including one or more of the following criteria in
the select statement:
* NODENAME=’DATA_CENTER_NODE_NAME’
* DATE_TIME=’yyyy-MM-dd HH:mm:ss’
For example:
select * from ACTLOG where NODENAME=’DC_NODE’ and DATE_TIME>’2015-03-11 17:30:00’
Specify the DATA_MOVER_NODE_NAME and DATA_CENTER_NODE_NAME in
uppercase characters.
When you start the Tivoli Storage Manager recovery agent from the Windows Start
menu, the service is automatically stopped. When the Tivoli Storage Manager
recovery agent, started from the Start menu finishes, the service starts
automatically. In addition, for these operating systems, the service does not
provide a GUI. In order to use the GUI, go to the Windows Start menu and select
All Programs > Tivoli Storage Manager > Data Protection for VMware > Tivoli
Storage Manager recovery agent.
You can verify that the Data Protection for VMware command-line interface is
running by completing the following task:
Windows Go to Start > Control Panel > Administrative Tools > Services and
verify that the status of Data Protection for VMware command-line interface is
Started.
These init scripts can also be used to stop and start the daemon:
./vmclid stop
./vmclid start
96 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Appendix A. Advanced configuration tasks
You must manually configure and verify each component using the available
application interfaces.
Make sure that the following conditions exist before proceeding with this task:
v A Tivoli Storage Manager server must be available to register the nodes.
v The Data Protection for VMware vSphere GUI is installed on a system that
meets the operating system prerequisites. It must have network connectivity to
the following systems:
– vStorage Backup Server
– Tivoli Storage Manager server
– vCenter Server
Procedure
1. Log on to the Tivoli Storage Manager server and complete the tasks described
in “Setting up the Tivoli Storage Manager nodes in a vSphere environment” on
page 98.
2. Log on to the vStorage Backup Server and complete the tasks described in
“Setting up the data mover nodes in a vSphere environment” on page 99.
3. Log on to the system where the Data Protection for VMware vSphere GUI is
installed and complete the tasks described in “Configuring the Data Protection
for VMware command-line interface in a vSphere environment” on page 107.
4. On the system where the Data Protection for VMware vSphere GUI is installed,
start the vSphere Client and log on to the vCenter. If the vSphere Client is
already running, you must stop and restart it.
5. Go to the Home directory in the vSphere Client. Click the Data Protection for
VMware vSphere GUI icon in the Solutions and Applications panel.
Tip: If the icon is not shown, then the Data Protection for VMware vSphere
GUI was not registered or a connection error occurred.
a. In the vSphere Client menu, go to Plug-ins > Manage Plug-ins to start the
Plug-in Manager.
b. If you can locate the Data Protection for VMware vSphere GUI and a
connection error occurred, verify connectivity to the machine where the
Data Protection for VMware vSphere GUI is installed by issuing the ping
command.
Results
The Data Protection for VMware vSphere GUI is ready for backup and restore
operations.
All steps in this procedure are completed on the Tivoli Storage Manager server.
Tip: This task can also be completed by using the Data Protection for VMware
vSphere GUI configuration wizard or edit configuration notebook. Start the Data
Protection for VMware vSphere GUI by opening a web browser and going to the
GUI web server. For example:
https://guihost.mycompany.com:9081/TsmVMwareUI/
Procedure
1. Log on to the Tivoli Storage Manager server and start an administrative client
session in command-line mode:
dsmadmc -id=admin -password=admin -dataonly=yes
2. Issue the REGister Node command to register the following nodes to the Tivoli
Storage Manager server:
a. The node that represents the VMware vCenter (vCenter node):
REGister Node MY_VCNODE <password for MY_VCNODE>
b. The node that communicates between Tivoli Storage Manager and the Data
Protection for VMware vSphere GUI (VMCLI node):
REGister Node MY_VMCLINODE <password for MY_VMCLINODE>
c. The node that represents the data center and is where the VM data is stored
(datacenter node):
REGister Node MY_DCNODE <password for MY_DCNODE>
d. The node that "moves data" from one system to another (data mover node):
REGister Node MY_DMNODE <password for MY_DMNODE>
Remember: Target nodes own the data and agent nodes act on behalf of the
target nodes. When granted proxy authority to a target node, an agent node
can perform backup and restore operations for the target node.
a. Grant proxy authority to the vCenter node by issuing this command:
GRant PROXynode TArget=MY_VCNODE AGent=MY_DCNODE,MY_VMCLINODE
98 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
This command grants MY_DCNODE and MY_VMCLINODE the authority to backup
and restore VMs on behalf of MY_VCNODE.
b. Grant proxy authority to the datacenter node by issuing this command:
GRant PROXynode TArget=MY_DCNODE AGent=MY_VMCLINODE,MY_DMNODE
What to do next
After successfully setting up the Tivoli Storage Manager nodes, the next manual
configuration task is to set up the data mover nodes as described in “Setting up
the data mover nodes in a vSphere environment.”
A data mover node typically uses the SAN to back up and restore data. If you
configure the data mover node to directly access the storage volumes, turn off
automatic drive letter assignment. If you do not turn off letter assignments, the
client on the data mover node might corrupt the Raw Data Mapping (RDM) of the
virtual disks. If the RDM of the virtual disks is corrupted, backups fail. Consider
the following conditions for restore configurations:
The data mover node is on a Windows Server 2008 or Windows Server 2008 R2
system:
If you plan to use the SAN to restore data, you must set the Windows
SAN policy to OnlineAll. Run diskpart.exe and type the following
commands to turn off automatic drive letter assignment and set the SAN
policy to OnlineAll:
Restriction: Data Protection for VMware does not support scheduling the vStorage
Backup Server (that is used as the data mover) to back up itself. Make sure that
the vStorage Backup Server is excluded from its own schedules. Use a different
vStorage Backup Server to perform the backup of a VM that contains a vStorage
Backup Server.
Tip: All steps in this procedure are completed on the vStorage Backup Server.
Procedure
1. Update the backup-archive client options file with these settings:
v Windows Specify these options in the dsm.opt options file.
v Linux Specify these options in the dsm.sys file, in the stanza for the data
mover node.
NODENAME
Specify the name of a previously defined data mover node. Tivoli
Storage Manager schedules are associated with the data mover node.
PASSWORDACCESS
Specify GENERATE so that the password is generated automatically
(instead of a user prompt).
VMCHOST
Specify the host name of the vCenter (or ESX server) where the off-host
backup commands are directed.
VMBACKUPTYPE
Specify FULLVM. This setting designates that a full VM backup is run.
This value is necessary to run full VM and full VM incremental
backups.
MANAGEDSERVICES
Specify this option to direct the client acceptor to manage both the web
client and the scheduler (schedule webclient).
100 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
TCPSERVERADDRESS
Specify the TCP/IP address for the Tivoli Storage Manager server.
TCPPORT
Specify the TCP/IP port address for the Tivoli Storage Manager server.
COMMMETHOD
Specify the communication method to be used by the Tivoli Storage
Manager server. For data mover nodes, you must specify TCP/IP as the
communication method. If another method is specified, operations fail.
HTTPPORT
This option specifies a TCP/IP port address and is required only when
more than one client acceptor service is used. For example, if two data
mover nodes (and two client acceptor services) are used, then the
option file for each data mover node must specify a different HTTPPORT
value.
For instant access, instant restore, or mount (file restore) operations, make sure
to add VMISCSISERVERADDRESS to the backup-archive client options file. Specify
the iSCSI server IP address of the network card on the vStorage Backup Server
that is used for the iSCSI data transfer during instant operations. The physical
network interface card (NIC) that is bound to the iSCSI device on the ESX host
must be on the same subnet as the NIC on the vStorage Backup Server that is
used for the iSCSI transfer.
2. Issue this command to set the VMware vCenter user and password for the data
mover node:
dsmc set password -type=vm vcenter.mycompany.xyz.com <administrator> <password1>
3. Start a backup-archive client command-line session with the -asnodename and
-optfile command-line parameters:
dsmc -asnodename=VC1_DC1 -optfile=dsm_DM1.opt
Make sure that after your initial sign-on, you are not prompted for your
password.
Attention: To prevent the Tivoli Storage Manager scheduler from failing,
make sure that the asnodename option is not set in the dsm.opt file (Windows)
or dsm.sys file stanza (Linux). The scheduler queries the Tivoli Storage
Manager server for schedules associated with nodename (data mover node), not
asnodename (datacenter node). If asnodename is set in dsm.opt or dsm.sys,
schedules associated with asnodename (and not nodename) are queried. As a
result, scheduling operations fail.
Complete these tasks:
a. Verify the connection to the Tivoli Storage Manager server by issuing this
command:
dsmc query session
Tip: When you configure more than one data mover node on the same
machine, you must specify a different port value for each client acceptor
instance.
– Select Help me configure the TSM Client Scheduler. Enter the
information as prompted.
a. When you enter the scheduler name, make sure to select the Use the
Client Acceptor daemon (CAD) to manage the scheduler option.
b. In the When do you want the service to start? option, select
Automatically when Windows boots.
c. In the Would you like to start the service upon completion of
this wizard? option, select Yes.
v Linux For the backup-archive client on Linux, complete the following
steps:
a. Specify the following options in the dsm.sys file, in the stanza for the
data mover node:
– Specify the managedservices option with these two parameters:
managedservices schedule webclient
This setting directs the client acceptor to manage both the web client
and the scheduler.
102 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
– (Optional) If you want to direct schedule and error information to log
files other than the default files, specify the schedlogname and
errorlogname options with the fully qualified path and file name in
which to store log information. For example:
schedlogname /vmsched/dsmsched_dm.log
errorlogname /vmsched/dsmerror_dm.log
b. Start the client acceptor service:
The installation program creates a startup script for the client acceptor
(dsmcad) in /etc/init.d. The client acceptor must be started before it can
manage scheduler tasks, or manage the web client. As root, complete the
following steps:
1) Configure the client acceptor service and backup-archive scheduler
service to act as a vStorage Backup Server. You must set the
LD_LIBRARY_PATH environment variable to the client installation
directory and the Java shared library libjvm.so. The path to
libjvm.so is also used for tagging support when you enable the
vmtagdatamover client option on the data mover.
Ensure that Java software is installed and the JAVA_HOME environment
variable is exported correctly.
The following paths are typical examples of the path to libjvm.so:
– For IBM Java: $JAVA_HOME/jre/bin/classic/libjvm.so
– For Oracle Java: $JAVA_HOME/jre/lib/amd64/server/libjvm.so
You must set the LD_LIBRARY_PATH environment variable in the
/etc/init.d/dsmcad file. For example:
– For IBM Java, set the following environment variable:
export LD_LIBRARY_PATH=/opt/tivoli/tsm/client/ba/bin:$JAVA_HOME/jre/bin/classic/
Tip: If you want to run the dsmc command directly from the Linux
command-line, you must also apply the LD_LIBRARY_PATH environment
variable to the command shell.
5. Verify that the client acceptor and agent are set up correctly:
a. Log on to a remote system.
b. Use a web browser to connect to the HOST1 system by using this address
and port:
http://HOST1.xyz.yourcompany.com:1581
Tip: When the IP address changes on the system where the Data Protection for
VMware vSphere GUI is installed, you must complete the following:
a. Set up the client acceptor again (Step 3) so that the Data Protection for
VMware vSphere GUI becomes enabled for operations. Otherwise, the
Plug-in Manager shows the Data Protection for VMware vSphere GUI status
as disabled.
After successfully setting up the data mover nodes, the next manual configuration
task is to configure the VMCLI profile as described in “Configuring the Data
Protection for VMware command-line interface in a vSphere environment” on page
107.
Procedure
1. Update the backup-archive client options file with these settings:
v Windows Specify these options in the dsm.opt options file.
v Linux Specify these options in the dsm.sys file, in the stanza for the data
mover node.
NODENAME
Specify the name of a previously defined data mover node. Tivoli
Storage Manager schedules are associated with the data mover node.
PASSWORDACCESS
Specify GENERATE so that the password is generated automatically
(instead of a user prompt).
VCDHOST
Specify the host name of the VMware vCloud Director server that
manages vApps that you want to protect.
VMCHOST
Specify the host name of the VMware VirtualCenter or ESX server that
you want to back up, restore, or query.
MANAGEDSERVICES
Specify this option to direct the client acceptor to manage both the web
client and the scheduler (schedule webclient).
104 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
TCPSERVERADDRESS
Specify the TCP/IP address for the Tivoli Storage Manager server.
TCPPORT
Specify the TCP/IP port address for the Tivoli Storage Manager server.
COMMMETHOD
Specify the communication method to be used by the Tivoli Storage
Manager server. For data mover nodes, you must specify TCP/IP as the
communication method. Operations fail if another method is specified.
HTTPPORT
This option specifies a TCP/IP port address and is required only when
more than one client acceptor service is used. For example, if two data
mover nodes (and two client acceptor services) are used, then the
option file for each data mover node must specify a different HTTPPORT
value.
2. Issue this command to set the vCloud Director user and password for the data
mover node:
dsmc set password -type=vcd vcloud1.example.com <vcloud_administrator1> <vcloud_password1>
3. Issue this command to set the vCenter user and password for the data mover
node:
dsmc set password -type=vm vcenter1.example.com <vcenter_administrator1> <vcenter_password1>
4. Start a backup-archive client command-line session with the -asnodename and
-optfile command-line parameters:
dsmc -asnodename=PVDC_vcloud1 -optfile=dsm_MYDM.opt
Make sure that after your initial sign-on, you are not prompted for your
password.
Attention: To prevent the Tivoli Storage Manager scheduler from failing,
make sure that the asnodename option is not set in the dsm.opt file (Windows)
or dsm.sys file stanza (Linux). The scheduler queries the Tivoli Storage
Manager server for schedules associated with nodename (data mover node), not
asnodename (provider vDC node). If asnodename is set in dsm.opt or dsm.sys,
schedules associated with asnodename (and not nodename) are queried. As a
result, scheduling operations fail.
Complete these tasks:
a. Verify the connection to the Tivoli Storage Manager server by issuing this
command:
dsmc query session
This command shows information about your session, including the current
node name, when the session was established, server information, and
server connection information.
b. Verify you can back up a vApp by issuing this command:
Tip: When you configure more than one data mover node on the same
machine, you must specify a different port value for each client acceptor
instance.
– Select Help me configure the TSM Client Scheduler. Enter the
information as prompted.
a. When you enter the scheduler name, make sure to select the Use the
Client Acceptor daemon (CAD) to manage the scheduler option.
b. In the When do you want the service to start? option, select
Automatically when Windows boots.
c. In the Would you like to start the service upon completion of
this wizard? option, select Yes.
v Linux For the backup-archive client on Linux, complete the following
steps:
a. Specify the following options in the dsm.sys file, in the stanza for the
data mover node:
– Specify the managedservices option with these two parameters:
managedservices schedule webclient
This setting directs the client acceptor to manage both the web client
and the scheduler.
– (Optional) If you want to direct schedule and error information to log
files other than the default files, specify the schedlogname and
errorlogname options with the fully qualified path and file name in
which to store log information. For example:
106 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
schedlogname /vmsched/dsmsched_dm.log
errorlogname /vmsched/dsmerror_dm.log
b. Start the client acceptor service:
The installation program creates a startup script for the client acceptor
(dsmcad) in /etc/init.d. The client acceptor must be started before it can
manage scheduler tasks, or manage the web client. As root, complete the
following steps:
1) Configure the client acceptor service and backup-archive scheduler
service to act as a vStorage Backup Server. You must set the
LD_LIBRARY_PATH environment variable to the client installation
directory and the Java shared library libjvm.so.
Ensure that Java software is installed and the JAVA_HOME environment
variable is exported correctly.
The following paths are typical examples of the path to libjvm.so:
– For IBM Java: $JAVA_HOME/jre/bin/classic/libjvm.so
– For Oracle Java: $JAVA_HOME/jre/lib/amd64/server/libjvm.so
You must set the LD_LIBRARY_PATH environment variable in the
/etc/init.d/dsmcad file. For example:
– For IBM Java, set the following environment variable:
export LD_LIBRARY_PATH=/opt/tivoli/tsm/client/ba/bin:$JAVA_HOME/jre/bin/classic/
Tip: If you want to run the dsmc command directly from the Linux
command-line, you must also apply the LD_LIBRARY_PATH environment
variable to the command shell.
6. Verify that the client acceptor and agent are set up correctly:
a. Log on to a remote system.
b. Use a web browser to connect to the HOST1 system by using this address
and port:
http://HOST1.xyz.yourcompany.com:1581
The profile (vmcliprofile) is located in this directory on the system where the
Data Protection for VMware vSphere GUI is installed:
Linux /opt/tivoli/tsm/tdpvmware/common/scripts
All steps in this procedure are completed on the system where the Data Protection
for VMware vSphere GUI is installed.
Tip: This task can also be completed by using the Data Protection for VMware
vSphere GUI configuration wizard or configuration notebook. Go to the Data
Protection for VMware vSphere GUI Configuration window and click Run
Configuration Wizard or Edit Configuration.
Procedure
1. Update the profile with these settings:
VE_TSMCLI_NODE_NAME
Specify the node that connects the Data Protection for VMware
command-line interface to the Tivoli Storage Manager server and the
agent node (MY_VMCLINODE).
Restriction: The VMCLI node does not support the SSL protocol or
LDAP authentication when communicating with the Tivoli Storage
Manager server.
VE_VCENTER_NODE_NAME
Specify the virtual node that represents a vCenter (MY_VCNODE).
VE_DATACENTER_NAME
Specify the virtual node that maps to a data center. The correct syntax
is shown here:
datacenter_name::datacenter_node_name
v The datacenter_name value is case-sensitive.
v Make sure to set this parameter for each data center in your
environment (MY_DCNODE).
v The Data Protection for VMware vSphere GUI does not support data
centers with the same name in the vCenter.
VE_TSM_SERVER_NAME
Specify the hostname or IP of the Tivoli Storage Manager server.
VE_TSM_SERVER_PORT
Specify the port name to use for the Tivoli Storage Manager server. The
default value is 1500.
108 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
a. Issue the echo command to create a text file that contains the password:
Linux echo password1 > pwd.txt
Windows echo password1> pwd.txt
WindowsA space must not exist between the password (password1) and the
greater-than sign (>).
b. Issue this vmcli command to set the password for the VMCLI node:
vmcli -f set_password -I pwd.txt
Important:
v You must issue the vmcli -f set_password command as
Linux
tdpvmware user, and not as root.
v Linux Windows If you plan to generate application protection
reports, you must specify the -type VMGuest parameter to identify that
the password applies to a VM. For example:
vmcli -f set_password -type VMGuest -I password.txt
3. Verify that the Data Protection for VMware command-line interface is running:
Windows Click Start > Control Panel > Administrative Tools > Services and
verify that the status of Data Protection for VMware command-line interface
is Started.
Linux Go to the scripts directory (/opt/tivoli/tsm/tdpvmware/common/
scripts/) and issue this command:
./vmclid status
v If the daemon is running, proceed to Step 4.
v If the daemon is not running, issue this command to manually start the
daemon:
/opt/tivoli/tsm/tdpvmware/common/scripts/vmcli --daemon
These init scripts can also be used to stop and start the daemon:
./vmclid stop
./vmclid start
4. Issue this vmcli command to verify that the Data Protection for VMware
command-line interface recognizes the Tivoli Storage Manager node
configuration:
vmcli -f inquire_config -t TSM
5. Validate the nodes to confirm that no configuration errors occurred:
a. Start the Data Protection for VMware vSphere GUI by clicking the icon in
the Solutions and Applications window of the vSphere Client.
b. Go to the Configuration window.
c. Select a node in the table and click Validate Selected Node. Status
information is shown in the Status Details pane.
What to do next
Procedure
110 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
TCPSERVERADDRESS
TCPPORT
COMMMETHOD
HTTPPORT
Note: The HTTPPORT is required only when more than one Client Acceptor
Service (CAD) is used. For example, if there are two data mover nodes (and
two CAD services), then the option file for each data mover node must
specify a different HTTPPORT value.
An example dsm.dm.opt file with these options is provided here:
NODename MY_DMNODE
PASSWORDAccess generate
VMCHost vcenter.storage.usca.example.com
VMBACKUPType FUllvm
MANAGEDServices schedule webclient
TCPServeraddress tsmserver.mycompany.xyz.com
TCPPort 1500
COMMMethod tcpip
HTTPPORT 1583
4. Verify the connection to the Tivoli Storage Manager server by issuing this
command:
dsmc query session
5. Issue this command to set the VMware vCenter user and password for the
data mover node:
dsmc set password -type=vm vcenter.mycompany.xyz.com <administrator>
<password1>
6. Set up the following Tivoli Storage Manager services:
v Windows
This setting directs the client acceptor to manage both the Web client and
the scheduler.
7. LinuxTo configure the Client Acceptor Service and Backup-Archive
Scheduler Service to act as a vStorage Backup Server, set the following
environment variable in the /etc/init.d/dsmcad file:
export LD_LIBRARY_PATH=/opt/tivoli/tsm/client/ba/bin
8. Linux Start the Client Acceptor Service: The installation program creates a
startup script for the client acceptor daemon (dsmcad) in /etc/init.d. The
Windows
112 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
net start
Linux Issue this command:
./vmclid status
c. Issue this vmcli command to verify that the Data Protection for VMware
command-line interface recognizes the Tivoli Storage Manager node
configuration:
vmcli -f inquire_config -t TSM
For example:
define mgmtclass tape tape DISK
For example:
define copygroup tape tape DISK destination=Diskpool
For example:
activate policyset tape tape
If the Tivoli Storage Manager server environment uses disk to tape migration,
consider the following guidelines before migrating:
v Set the disk storage pool MIGDELAY to a value that supports most mount
requests to be satisfied from disk. Typical usage patterns indicate that a high
percentage of individual file recoveries occurs within few days. For example,
usually 3 - 5 days from the time a file was last modified. Therefore, consider
keeping data on disk for this brief period to optimize recovery operations.
In addition, if client side deduplication is being used with the disk storage pool,
set the MIGDELAY option that accommodates frequent full VM backups. Do not
migrate data from the deduplicated storage pool to tape until at least two full
backups are completed for a VM. When data is moved to tape, it is no longer
deduplicated. For example, if full backups are run weekly, consider setting
MIGDELAY to a value of at least 10 days. This setting ensures that each full
backup identifies and uses duplicate data from the previous backup before being
moved to tape.
v Use a device class file storage pool rather than a DISK device class storage pool.
A typical value for a volume size, specified by a device class MAXCAPACITY
parameter, would be 8 GB to 16 GB. For the associated storage pool, consider
applying collocation by file space. Each VM that is backed up is represented as a
separate file space in the Tivoli Storage Manager server. Collocating by file space
saves the data from multiple incremental backups for a given VM in the same
volume (disk file). When migration to tape occurs, collocation by file space
locates multiple incremental backups for a given VM together on a physical
tape.
114 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
v To mount a snapshot volume on physical tape, the recovery agent mount
must be operating in Tape Mode. In this mode, only one VM snapshot
volume can be mounted at a time from the recovery agent. The limit is
one disk when mounting an iSCSI target or one volume when creating a
virtual volume from a selected partition. You can have multiple Tivoli
Storage Manager tape storage pool volume mounts for different VM
snapshots. Create this scenario by installing the recovery agent on
multiple physical systems or on multiple VM guests. Enable Tape Mode
by selecting Storage Type=Tape in the recovery agent GUI Settings
menu.
v While recovery agent mount does not prevent an attempt to mount a
snapshot on physical tape, performance can vary significantly and might
be severely affected. The recovery agent mount does not control the way
data is accessed on tape. Data access patterns can be random and cause
extensive challenges associated with tape positioning operations. For
Linux VMs, Tape Mode is only supported when directly using the iSCSI
initiator. Tape Mode is not supported from the Linux recovery agent
user interface.
While a limited number of files can be recovered from a mounted volume
snapshot on physical tape, consider running a full VM restore from
physical tape if you must recover a large quantity of data or many files.
Typically the performance associated with a file restore from a VTL is
quicker than physical tape. But, performance delays can be encountered.
For example, mount might require a virtual tape volume that is in use by
another restore operation. Tape volumes in a VTL cannot be shared. In this
case, mount processing is delayed until the restore operation with the
virtual tape volume completes.
When a mount or instant restore operation requires the same tape storage
simultaneously in use by a backup operation, the backup operation
becomes interrupted.
Instant restore from physical tape
The Tivoli Storage Manager recovery agent instant restore operation is not
supported for snapshot volumes on physical tape.
The failure behavior for instant restore depends on the mode of operation:
v Tape mode: Instant restore fails when the restore operation is selected.
v Non-tape mode: Instant restore fails when an attempt is made to access
data on a tape volume.
This failure can occur when the user interface tries to show partition
information or when the operation is restoring data. The latter condition
occurs only if disk to tape migration is being used, and part of the
snapshot data (the partition information) is on disk and some of the actual
snapshot data is on tape.
If you try to run instant restore in Tape Mode, the following message is
shown:
Instant Restore is not supported in Tape Mode.
If you try to run instant restore while not in Tape Mode, and the data is on
tape, the following message is shown:
This procedure describes how to configure a Linux system that is used during an
iSCSI mount operation. The VM snapshot is mounted from Tivoli Storage Manager
server storage.
During an iSCSI mount, an iSCSI target is created on the Tivoli Storage Manager
recovery agent system. Microsoft iSCSI Initiator is not required on the Tivoli
Storage Manager recovery agent system.
Tip: Open-iSCSI Initiator is provided with Red Hat Enterprise Linux and SUSE
Linux Enterprise Server.
Review the following iSCSI requirements before you proceed with this task:
v You can connect to the iSCSI target from any system to create a volume that
contains the backup data. You can mount this volume from another system.
v An iSCSI initiator is required on any system that must connect to the iSCSI
target.
v An iSCSI initiator must be installed on the system where the data is to be
restored.
v If a volume spans several disks, you must mount all the required disks. When
mirrored volumes are used, mount only one of the mirrored disks. Mounting
one disk prevents a time-consuming synchronization operation.
Complete these steps to configure the Linux system that is used during an iSCSI
mount operation:
Procedure
1. Record the iSCSI initiator name on the system where data is to be restored. The
iSCSI initiator name is located in the /etc/iscsi/initiatorname.iscsi file. If
the InitiatorName= value is empty, create an initiator name with the following
command:
twauslbkpoc01:~ # /sbin/iscsi-iname
116 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
3. Complete the following steps on the system where the Tivoli Storage Manager
recovery agent (or iSCSI target) is installed:
a. Start the Tivoli Storage Manager recovery agent. Complete the Select TSM
server and Select snapshot dialogs and click Mount.
b. In the Choose mount destination dialog, select Mount an iSCSI target.
c. Create a target name. Make sure that it is unique and that you can identify
it from the system that runs the iSCSI initiator. For example:
iscsi-mount-tsm4ve
d. Enter the iSCSI Initiator name that was recorded in Step 1 and click OK.
e. Verify that the volume you just mounted is displayed in the Mounted
Volumes field.
4. Locate and start the iSCSI Initiator program on the initiator system that was
selected in Step 1:
a. Verify that the iSCSI service is running by issuing this command:
Red Hat Enterprise Linux:
service iscsi status
If the service is not running, issuing this command to start the service:
Red Hat Enterprise Linux:
service iscsi start
For an LVM volume, complete the following tasks on the Linux guest:
a. Make sure that the vgimportclone script is available on the Linux system.
This script is not shipped in the base (default) LVM package. As a result,
you might need to update the LVM package to a level which provides this
script.
b. Issue the vgimportclone command and include a new base volume group
name (VolGroupSnap01). For example:
vgimportclone --basevgname /dev/VolGroupSnap01 /dev/sdb1
c. Issue the lvchange command to mark the logical volume as active. For
example:
lvchange -a y /dev/VolGroupSnap01/LogVol00
d. Issue these commands to mount the volume:
mkdir /mountdir
mount -o ro /dev/VolGroupSnap01/LogVol00 /mountdir
This procedure describes how to configure a Windows system that is used during
an iSCSI mount operation. The snapshot is mounted from Tivoli Storage Manager
server storage.
Review the following iSCSI requirements before you proceed with this task:
v During an iSCSI mount, an iSCSI target is created on the Tivoli Storage Manager
recovery agent system. You can connect to the iSCSI target from any system to
create a volume that contains the backup data. Also, you can then mount this
volume from another system.
v iSCSI initiator is required on any system that must connect to the iSCSI target.
v Make sure that an iSCSI initiator is installed on the system where the data is to
be restored.
v Microsoft iSCSI Initiator is not required on the Tivoli Storage Manager recovery
agent system.
Review the following disk and volume requirements before you proceed with this
task:
118 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
v If a volume spans several disks, you must mount all the required disks. When
mirrored volumes are used, mount only one of the mirrored disks. Mounting
one disk prevents a time-consuming synchronization operation.
v If multiple dynamic disks were used on the backup system, these disks are
assigned to the same group. As a result, Windows Disk Manager might consider
some disks as missing and issue an error message when you mount only one
disk. Ignore this message. The data on the backed up disk is still accessible,
unless some of the data is on the other disk. This issue can be solved by
mounting all the dynamic disks.
Complete these tasks to configure the Windows system that is used during an
iSCSI mount operation:
Procedure
1. On the Tivoli Storage Manager recovery agent system, open port 3260 in the
LAN firewall and the Windows client firewall. Record the iSCSI initiator name
on the system where data is to be restored.
The iSCSI initiator name is shown in the iSCSI initiator configuration window
of the Control Panel. For example:
iqn.1991-05.com.microsoft:hostname
2. Complete these tasks on the system where the Tivoli Storage Manager recovery
agent (or iSCSI target) is installed:
a. Start the Tivoli Storage Manager recovery agent GUI. Complete the Select
TSM server and Select snapshot dialogs and click Mount.
b. In the Choose mount destination dialog, select Mount an iSCSI target.
c. Create a target name. Make sure that it is unique and that you can identify
it from the system that runs the iSCSI initiator. For example:
iscsi-mount-tsm4ve
d. Enter the iSCSI Initiator name that was recorded in Step 1 and click OK.
e. Verify that the volume you just mounted is displayed in the Mounted
Volumes field.
f. When you use the Tivoli Storage Manager recovery agent in an iSCSI
network, and the Recovery Agent does not use a data mover, go to the
C:\ProgramData\Tivoli\TSM\RecoveryAgent\mount\RecoveryAgent.conf file
and specify the [IMOUNT] tag and Target IP parameter:
[IMOUNT config]
Target IP=<IP address of the network card on the system
that exposes the iSCSI targets.>
For example:
[General config]
param1
param2
...
[IMount config]
Target IP=9.11.153.39
After you add or change the Target IP parameter, restart the Recovery Agent
GUI or Recovery Agent CLI.
3. Locate and start the iSCSI Initiator program on the initiator system that was
selected in Step 1:
Complete this task to add a mount proxy node to a remote Linux system.
This task sets up the mount proxy nodes by updating the backup-archive client
options and verifying connectivity to the Tivoli Storage Manager server.
Procedure
1. Specify these options in the dsm.sys file, in the stanza for the mount proxy
node.
NODENAME
Specify the name of a previously defined mount proxy node. Tivoli
Storage Manager schedules are associated with this node.
120 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
PASSWORDACCESS
Specify GENERATE so that the password is generated automatically
(instead of a user prompt).
MANAGEDSERVICES
Specify this option to direct the client acceptor to manage both the Web
client and the scheduler (schedule webclient).
TCPSERVERADDRESS
Specify the TCP/IP address for the Tivoli Storage Manager server.
TCPPORT
Specify the TCP/IP port address for the Tivoli Storage Manager server.
COMMMETHOD
Specify the communication method to be used by the Tivoli Storage
Manager server. For mount proxy nodes, you must specify TCP/IP as
the communication method. Operations fail if another method is
specified.
HTTPPORT
This option specifies a TCP/IP port address and is must be specified
only when more than one Client Acceptor Service (CAD) is used. For
example, if there are two mount proxy nodes (and two CAD services),
then the option file for each mount proxy node must specify a different
HTTPPORT value.
This setting directs the client acceptor to manage both the Web client and
the scheduler.
– If you want to direct schedule and error information to log files other than
the default files, specify the schedlogname and errorlogname options. Each
option must contain the fully qualified path and file name in which to
store log information. For example:
schedlogname /vmsched/dsmsched_mp_lnx.log
errorlogname /vmsched/dsmerror_mp_lnx.log
v To configure the Client Acceptor Service and Backup-Archive Scheduler
Service to act as a backup server, set the following environment variable in
the /etc/init.d/dsmcad file:
export LD_LIBRARY_PATH=/opt/tivoli/tsm/client/ba/bin
v Start the Client Acceptor Service:
The installation program creates a startup script for the client acceptor
daemon (dsmcad) in /etc/init.d. The client acceptor daemon must be started
before it can manage scheduler tasks, or manage the web client. As root, use
the following command to start the daemon:
export LD_LIBRARY_PATH=/opt/tivoli/tsm/client/ba/bin
service dsmcad start
Complete this task to add a mount proxy node to a remote Windows system. This
task is required when you want to add a second Windows mount proxy node to
your environment.
Before you proceed with this task, make sure the primary Windows mount proxy
node is configured.
122 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
About this task
Procedure
1. Install the following products on the remote Windows mount proxy system:
v Tivoli Storage Manager recovery agent
v Tivoli Storage Manager backup-archive client
Access both products on the Tivoli Storage Manager for Virtual Environments
product DVD or download image. Step-by-step installation instructions are
available in IBM Knowledge Center at
“Installing the Data Protection for VMware components on Windows systems”
on page 25
2. Retrieve the sample options file content from the Windows mount proxy node
that was created and add it to the options file on the remote Windows mount
proxy system:
a. On the primary Windows mount proxy system, go to the Configuration
window in the Data Protection for VMware vSphere GUI.
b. Click Edit TSM Configuration in the Tasks list. The configuration notebook
might take a few moments to load.
c. Go to the Mount Proxy Node Pairs page.
d. In the Primary Node column of the table, go to the Windows mount proxy
node with the pending location and click View Settings.
e. Copy the sample dsm.opt file content that is shown in the Mount Proxy
Settings dialog.
f. Paste (or add) the sample dsm.opt file content to the options file on the
remote Windows mount proxy system. Name the options file with a
convention that identifies its role as a remote mount proxy node.
For example: dsm.REMOTE1_MP_WIN.opt.
Tip: To start the dsmc command line, open the Windows Start menu and
select Programs→ Tivoli Storage Manager → Backup Client Command Line.
dsmc set password -type=vm vcenter.mycompany.xyz.com <administrator> <password1>
-optfile=dsm.REMOTE1_MP_WIN.opt
4. Verify the connection to the Tivoli Storage Manager server by issuing this
command:
dsmc query session -optfile=dsm.REMOTE1_MP_WIN.opt
This command shows information about your session, including the current
node name, when the session was established, server information, and server
connection information.
5. Set up the Client Acceptor Service (CAD) and Backup-Archive Scheduler
Service by completing these steps:
This step uses the Tivoli Storage Manager Client GUI Configuration wizard to
Tip: When you configure more than one mount proxy node on the same
system, you must specify a different port value for each client acceptor
instance.
b. Select Help me configure the TSM Client Scheduler. Enter the information
as prompted.
1) When you enter the scheduler name, make sure to select the Use the
Client Acceptor daemon (CAD) to manage the scheduler option.
2) In the When do you want the service to start? option, select
Automatically when Windows boots.
3) In the Would you like to start the service upon completion of this
wizard? option, select Yes.
6. Verify that the client acceptor and agent are set up correctly. Use a web browser
to connect to the HOST1 system by using this address and port:
http://HOST1.xyz.yourcompany.com:1581
This task sets up multiple dsmcad instances to run and start automatically at
system start:
Procedure
1. Create two unique node stanzas in the dsm.sys file (by default, this file is in
/opt/tivoli/tsm/client/ba/bin/):
124 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
# cat /opt/tivoli/tsm/client/ba/bin/dsm.sys
SErvername node1
COMMMethod TCPip
TCPPort 1500
TCPServeraddress localhost
nodename node1
errorlogname /opt/tivoli/tsm/client/ba/bin/dsmerror-node1.log
schedlogname /opt/tivoli/tsm/client/ba/bin/dsmsched-node1.log
managedservices webclient sched
httpport 1581
passwordaccess generate
SErvername node2
COMMMethod TCPip
TCPPort 1500
TCPServeraddress localhost
nodename node2
errorlogname /opt/tivoli/tsm/client/ba/bin/dsmerror-node2.log
schedlogname /opt/tivoli/tsm/client/ba/bin/dsmsched-node2.log
managedservices webclient sched
httpport 1582
passwordaccess generate
4. Make two copies of the default rc.dsmcad init script (by default, this script is
in /opt/tivoli/tsm/client/ba/bin):
# cp /opt/tivoli/tsm/client/ba/bin/rc.dsmcad /opt/tivoli/tsm/client/ba/bin/rc.dsmcad-node1
# cp /opt/tivoli/tsm/client/ba/bin/rc.dsmcad /opt/tivoli/tsm/client/ba/bin/rc.dsmcad-node2
5. Edit rc.dsmcad-node1:
a. Change this line for Red Hat Enterprise Linux distributions:
daemon $DSMCAD_BIN
To this line:
daemon $DSMCAD_BIN -optfile=/opt/tivoli/tsm/client/ba/bin/dsm-node1.opt
6. Edit rc.dsmcad-node2:
a. Change this line for Red Hat Enterprise Linux distributions:
daemon $DSMCAD_BIN
To this line:
daemon $DSMCAD_BIN -optfile=/opt/tivoli/tsm/client/ba/bin/dsm-node2.opt
To this line:
startproc $DSMCAD_BIN -optfile=/opt/tivoli/tsm/client/ba/bin/dsm-node2.opt
7. Create new links in /etc/init.d/ to point to the two new rc.dsmcad init
scripts. These links allow the Linux init service to start the dsmcad services at
system start:
# ln -s /opt/tivoli/tsm/client/ba/bin/rc.dsmcad-node2 dsmcad-node2
# ln -s /opt/tivoli/tsm/client/ba/bin/rc.dsmcad-node1 dsmcad-node1
# ls -la dsm*
lrwxrwxrwx. 1 root root 45 Aug 2 08:04 dsmcad-node1 -> /opt/tivoli/tsm/client/ba/bin/rc.dsmcad-node1
lrwxrwxrwx. 1 root root 45 Aug 2 08:04 dsmcad-node2 -> /opt/tivoli/tsm/client/ba/bin/rc.dsmcad-node2
9. Test the configuration with the service dsmcad start command to make sure
the scripts load and start without issue:
# service dsmcad-node1 start
Starting dsmcad-node1: [ OK ]
# service dsmcad-node2 start
Starting dsmcad-node2: [ OK ]
# ps -ef | grep dsmcad
root 2689 1 0 09:04 ? 00:00:00 /opt/tivoli/tsm/client/ba/bin/dsmcad
-optfile=/opt/tivoli/tsm/client/ba/bin/dsm-node1.opt
root 2719 1 0 09:04 ? 00:00:00 /opt/tivoli/tsm/client/ba/bin/dsmcad
-optfile=/opt/tivoli/tsm/client/ba/bin/dsm-node2.opt
126 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
The command text is placed on two lines in this example to accommodate
page formatting.
The Data Protection for VMware installation process requires that a user specifies a
vCenter or vCloud Server IP address and whether to enable access to the GUI by a
web browser. However, after installation, the server IP address and GUI access
method cannot be modified by the installer.
To update these settings, you can manually edit the VMCLI configuration file
(vmcliConfiguration.xml). This file is created during installation in the following
locations:
On Windows systems:
C:\IBM\tivoli\tsm\tdpvmware\webserver\usr\servers\veProfile\tsmVmGUI
On Linux systems:
/opt/tivoli/tsm/tdpvmware/common/webserver/usr/servers/veProfile/tsmVmGUI/
To modify whether to enable access to the GUI by a web browser, enter one of the
following values in the <enable_direct_start></enable_direct_start> parameter:
v yes The GUI can be accessed directly by a web browser. For example:
<enable_direct_start>yes</enable_direct_start>
To modify whether to use the GUI for vSphere protection or vCloud protection,
specify one of the following values in the <mode></mode> parameter:
v vcenter The GUI is used for vSphere protection. For example:
<mode>vcenter</mode>
The https:// value is required at the beginning of the vCloud Director server IP
address.
The https:// value is required at the beginning of the vCenter server IP address.
The /sdk value is required at the end of the vCenter server IP address.
128 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Appendix B. Migrating to an incremental forever backup
strategy
Use this procedure to migrate existing backup schedules, policies, and data mover
nodes for use in an incremental forever backup strategy.
You can use the periodic full backup strategy that was implemented in Data
Protection for VMware version 6.2 and 6.3. If you want to continue to use the
periodic full backup strategy, you do not need to change your policy or schedules.
You must ensure that you upgrade only your data mover nodes to version 6.4 (or
later), as documented in the following procedure. However, if you want to use the
incremental forever backup strategy, in addition to updating the data mover nodes
to version 6.4 (or later), you must also update the schedules and policy for those
data mover nodes that move to this incremental forever backup strategy.
Important:
v Although some tasks are discrete, all applications and components must be
upgraded eventually to completely benefit from the incremental forever strategy.
This publication provides all information to guide you through each task.
v There are several methods available to complete the entire migration process.
However, the methods documented in this publication are considered efficient
methods for typical Data Protection for VMware environments.
v The schedule to be migrated in this procedure is a schedule that was created
with the Data Protection for VMware vSphere GUI backup wizard. If the
schedule to be migrated was created manually, then the schedule updates
identified in this procedure must also be made manually.
The standard type=backup entries are default values and are not required to
be specified. They are included in this example to illustrate that the copy
group name is STANDARD and that the type of copy group is backup (instead
of archive).
c. Update the backup copy group with the appropriate version, retention, and
expiration settings:
Remember: In Data Protection for VMware version 6.2 and 6.3, backup
version, retention, and expiration is based on a backup-chain granularity
level. This method means that even though both full and incremental
backups are taken (as part of the 6.2 and 6.3 periodic full backup strategy),
version expiration counts only full backups. In Data Protection for VMware
version 6.4 (or later), backup version, retention, and expiration is based on a
single-backup granularity level. This method means that version expiration
counts both full and incremental backups.
The verexists parameter specifies the maximum number of VM backup
versions to retain on the server. If an incremental forever backup operation
causes the number to be exceeded, the server expires the oldest backup
version that exists in server storage. This example specifies verexists=28.
This value means that a maximum of 28 VM backup versions are retained
on the server.
The retextra parameter specifies the maximum number of days to retain a
VM backup version, after that version becomes inactive. This example
specifies retextra=nolimit. This value means that the maximum number of
inactive VM backup versions are retained indefinitely. However, when
verexists is specified, the nolimit value is superseded by the verexists
value. As a result, in this example, a maximum of 28 inactive VM backup
versions are retained on the server.
Based on the settings described in this step, the backup copy group is updated
as follows:
update copygroup domain1 prodbackups mgmt_ifincr28 verexists=28
retextra=nolimit
In this example, the existing Data Protection for VMware version 6.3
environment consists of the following hosts and schedules:
v An ESX cluster (esxcluster) that contains two ESX hosts (esxhost1,
esxhost2).
v The bup_esxcluster_full schedule runs a weekly full backup of each ESX
host with data mover node dm1.
130 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
v The bup_esxcluster_incr schedule runs a daily incremental backup of each
ESX host with data mover node dm2.
Complete the following backup schedule tasks in the Data Protection for
VMware vSphere GUI:
a. Start the Data Protection for VMware vSphere GUI by clicking the icon in
the Solutions and Applications window of the vSphere Client.
b. In the Getting Started window, click the Backup tab to open the Managing
backup schedules window.
c. Locate the backup schedule (used for periodic full or incremental backups)
to update. In this procedure, the periodic full bup_esxcluster_full schedule
is used.
d. Right-click the schedule and select Properties.
e. Go to the Schedule page and specify Incremental forever from the Backup
strategy drop-down list.
f. Click OK to save your update.
g. Locate the backup schedule used for incremental backups. Right-click the
schedule and select Delete. Since the periodic full bup_esxcluster_full
schedule was updated to incremental forever, this incremental schedule is
no longer needed.
3. Now that you have an incremental forever backup schedule, you can reduce
the number of data mover nodes by consolidating them:
This example consolidates two data mover nodes into one data mover node.
a. On the vStorage Backup Server, open a command prompt and go to the
directory where the options file for dm1 is located.
b. Using a text editor (such as Notepad), update this file with the following
options:
1) Specify vmmaxparallel to control the number of VMs backed up at one
time by dm1:
vmmaxparallel=2
The default value and minimum value are 1. The maximum value is 50.
Tip: For every data mover node you remove, increase the
vmmaxparallel value by 1.
Alternatively, you can specify vmlimitperhost to control the number of
VMs backed up at one time by dm1 from the same ESX host:
vmlimitperhost=1
Results
Upon successful completion of each task, the environment is ready for use in an
incremental forever backup strategy.
In this schedule migration example, Data Protection for VMware version 6.3 uses
the following two backup schedules:
v -mode=full: A weekly full backup is scheduled (Sundays) and the maximum
number of VM backup versions to retain on the server is four (verexists=4).
v -mode=incr: A weekday incremental backup is scheduled (Monday through
Saturday).
The number of backups taken for a four week period is 28:
v Four full backups (one weekly full backup multiplied by four weeks)
v 24 incremental backups (six weekday incremental backups multiplied by four
weeks)
Since Data Protection for VMware version 6.3 counts only full backups, the
verexists=4 value preserves all 28 backups.
To provide the same level of protection with Data Protection for VMware version
6.4 (or later) and the incremental forever backup strategy, create the following
schedule:
-mode=iffull: A daily incremental forever full backup is scheduled and the
verexists parameter is set to 28.
The number of backups taken for a four week period is 28:
v One incremental forever full backup (initial backup multiplied by one day)
v 27 incremental forever incremental backups (daily incremental forever backups
multiplied by 27 days)
Since Data Protection for VMware version 6.4 (or later) counts both full and
incremental backups, the verexists=28 value preserves all 28 backups.
132 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Appendix C. Integrating with Tivoli Storage FlashCopy
Manager for VMware
Integration allows offload backups of the Tivoli Storage FlashCopy® Manager
hardware snapshots to a Tivoli® Storage Manager server for long-term retention.
The benefits of integrating Tivoli Storage FlashCopy Manager for VMware with
Data Protection for VMware are as follows:
v In addition to the hardware snapshots that are retained on disk, backup versions
of virtual machines are retained on the Tivoli Storage Manager server based on
Storage Management policies that are set up by the Tivoli Storage Manager
administrator.
v The data movement to Tivoli Storage Manager can be offloaded using a vStorage
backup server to minimize the load on the resources available to the virtual
machines in the vCenter server. The vStorage backup server can be a physical or
virtual machine.
Comparing solutions
Compare the key features for each Tivoli Storage Manager for Virtual
Environments and Tivoli Storage FlashCopy Manager for VMware solution to
determine which configuration best meets your data protection requirements.
Notes:
1. Use the Tivoli Storage Manager file restore interface to restore files with a
web-based interface.
2. Individual files that you want to restore are located in virtual disks that are
part of a virtual machine backup. For individual file restore operations from a
Tivoli Storage FlashCopy Manager for VMware backup, you must attach the
virtual disks to the ESXi host where the target virtual machine is running, and
use the tools within the guest virtual machine to mount the virtual disks and
copy the individual files to the target virtual machine.
Procedure
To integrate Tivoli Storage Manager for Virtual Environments with Tivoli Storage
FlashCopy Manager for VMware, complete the following tasks:
1. Install Tivoli Storage Manager for Virtual Environments and the data mover
feature V7.1.8. Follow the instructions in “Installing Data Protection for
VMware on Linux systems” on page 26.
2. Configure Tivoli Storage Manager for Virtual Environments V7.1.8. Follow the
instructions in Chapter 2, “Configuring Data Protection for VMware,” on page
57.
3. Install Tivoli Storage FlashCopy Manager for VMware V4.1.6. Follow the
instructions in Installing by using the installation wizard
4. Configure Tivoli Storage FlashCopy Manager for VMware V4.1.6. Follow the
instructions in Configuring Tivoli Storage FlashCopy Manager for VMware
134 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
What to do next
Appendix C. Integrating with Tivoli Storage FlashCopy Manager for VMware 135
136 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Appendix D. Accessibility features for the Tivoli Storage
Manager product family
Accessibility features help users who have a disability, such as restricted mobility
or limited vision to use information technology products successfully.
Accessibility features
The IBM Tivoli Storage Manager family of products includes the following
accessibility features:
v Keyboard-only operation using standard operating-system conventions
v Interfaces that support assistive technology such as screen readers
The command-line interfaces of all products in the product family are accessible.
The Operations Center and the Tivoli Storage Manager server can be installed in
console mode, which is accessible.
The Operations Center help system is enabled for accessibility. For more
information, click the question mark icon on the help system menu bar.
Vendor software
The Tivoli Storage Manager product family includes certain vendor software that is
not covered under the IBM license agreement. IBM makes no representation about
the accessibility features of these products. Contact the vendor for the accessibility
information about its products.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.
Licensees of this program who want to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Corporation
2Z4A/101
11400 Burnet Road
Austin, TX 78758
US
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
COPYRIGHT LICENSE:
140 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Each copy or any portion of these sample programs or any derivative work, must
include a copyright notice as follows:
Portions of this code are derived from IBM® Corp. Sample Programs.
© Copyright IBM® Corp. _enter the year or years_. All rights reserved.
Trademarks
IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at "Copyright and
trademark information" at www.ibm.com/legal/copytrade.shtml.
Linear Tape-Open, LTO, and Ultrium are trademarks of HP, IBM Corp. and
Quantum in the U.S. and other countries.
Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Permissions for the use of these publications are granted subject to the following
terms and conditions.
Applicability
These terms and conditions are in addition to any terms of use for the IBM
website.
Personal use
You may reproduce these publications for your personal, noncommercial
use provided that all proprietary notices are preserved. You may not
distribute, display or make derivative work of these publications, or any
portion thereof, without the express consent of IBM.
Commercial use
You may reproduce, distribute and display these publications solely within
your enterprise provided that all proprietary notices are preserved. You
may not make derivative works of these publications, or reproduce,
distribute or display these publications or any portion thereof outside your
enterprise, without the express consent of IBM.
Rights Except as expressly granted in this permission, no other permissions,
Notices 141
licenses or rights are granted, either express or implied, to the publications
or any information, data, software or other intellectual property contained
therein.
IBM reserves the right to withdraw the permissions granted herein
whenever, in its discretion, the use of the publications is detrimental to its
interest or, as determined by IBM, the above instructions are not being
properly followed.
You may not download, export or re-export this information except in full
compliance with all applicable laws and regulations, including all United
States export laws and regulations.
IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESE
PUBLICATIONS. THE PUBLICATIONS ARE PROVIDED "AS-IS" AND
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
IMPLIED, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES
OF MERCHANTABILITY, NON-INFRINGEMENT, AND FITNESS FOR A
PARTICULAR PURPOSE.
This Software Offering does not use cookies or other technologies to collect
personally identifiable information.
If the configurations deployed for this Software Offering provide you as customer
the ability to collect personally identifiable information from end users via cookies
and other technologies, you should seek your own legal advice about any laws
applicable to such data collection, including any requirements for notice and
consent.
For more information about the use of various technologies, including cookies, for
these purposes, see IBM’s Privacy Policy at http://www.ibm.com/privacy and
IBM’s Online Privacy Statement at http://www.ibm.com/privacy/details in the
section entitled “Cookies, Web Beacons and Other Technologies,” and the “IBM
Software Products and Software-as-a-Service Privacy Statement” at
http://www.ibm.com/software/info/product-privacy.
142 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
Glossary
A glossary is available with terms and definitions for the IBM Tivoli Storage Manager family of products.
146 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
silent upgrade VMCLI
Linux 48 configuring in vSphere environment 107
Windows 32-bit 47 VMCLI configuration file
Windows 64-bit 47 modifying 127
software requirements 13 vmcliConfiguration.xml 127
SSL vSphere GUI 41
configuring 74, 75
system requirements 13
W
Windows 32-bit
T installation procedure
tagging support silent 35
enable 64 silent Suite installer 30
tape storage uninstalling
configuring 113 server core 53
third-party certificate silent mode 53
configuring TLS 76 typical 50
create a certificate signing request 78 upgrading
keystore access 77 silent 47
receive the signed certificate 79 Windows 64-bit
send the certificate signing request 79 installation procedure
Tivoli Storage Manager nodes silent Suite installer 30
configuring uninstalling
vSphere environment 98 server core 53
Tivoli Storage Manager recovery agent GUI silent mode 54
configuring 87 typical 50
options 87 upgrading
TLS communication silent 47
configuring 74
U
uninstalling
Linux
silent mode 55
typical 50
Windows 32-bit
server core 53
silent mode 53
typical 50
Windows 64-bit
server core 53
silent mode 54
typical 50
upgrading
data mover nodes 49
from Tivoli Storage FlashCopy Manager for VMware
standard 44
from Tivoli Storage FlashCopy Manager for VMware V3.x
and Data Protection for VMware V6.x
standard 45
from V6.x
standard 42
Linux
silent 48
overview 42
Windows 32-bit
silent 47
Windows 64-bit
silent 47
user
permissions 16
V
vCloud GUI 42
Index 147
148 IBM Tivoli Storage Manager for Virtual Environments: Data Protection for VMware Installation Guide
IBM®
Printed in USA