Version 6.3: Updates for IBM Tivoli Storage Manager for Windows Backup-Archive Clients Installation and User's Guide

Product documentation


Abstract

This document contains updates for "IBM Tivoli Storage Manager for Windows Backup-Archive Clients Installation and User's Guide V6.3". The updates are for the V6.3 online information center at http://pic.dhe.ibm.com/infocenter/tsminfo/v6r3/index.jsp?.

Content

Tivoli Storage Manager client documentation updates

Corrections for Version 6.3.0 (applies to all modifications of version 6.3)

Global changes (changes that affect several topics in one or more sections of the publication)

Per APAR IC90806, remove all references to Network File System (NFS). NFS is not valid in Windows environments.



Installation

Per APAR IC84883
Installing the Tivoli Storage Manager backup-archive clients (UNIX, Linux, and Windows)>Installing the Tivoli Storage Manager Windows client

Text has been added to this topic to describe that the backup-archive client installs Microsoft C++ redistributable files, and how a reboot might occur, in spite of attempts to prevent one. This new text appears in the Attention: paragraphs.



Installing the Tivoli Storage Manager Windows client

You can install the Tivoli® Storage Manager Windows client from the product DVD, or other installation media.

About this task

If the Logical Volume Snapshot Agent (LVSA) component is going to be installed, you must restart the system to install or update the tsmlvsa.sys filter driver.

You can install the backup-archive clients on the following Windows platforms:

· Windows Vista

· Windows 7

· Windows Server 2003

· Windows Server 2003 R2

· Windows Server 2008

· Windows Server 2008 R2

Attention: The Tivoli Storage Manager backup-archive Windows client package installs the Microsoft Visual Studio 2010 C++ redistributable package, if they are not already present on the workstation, or if they are installed but need to be updated.
If the C++ redistributable library is updated, you might need to reboot the workstation so the C++ software can be registered and reloaded. This reboot is required by the Microsoft Visual Studio C++ redistributable upgrade process, even under any of the following conditions:

· An automatic client deployment pushes a client upgrade to a node, and the client or the scheduler sets the AUTODEPLOY=NOREBOOT option.

· A manual installation or upgrade of the client is performed.

· A client silent installation is performed, and the options to suppress reboot prompts, and the client reboot itself, are set.

Additionally, because the Microsoft Visual Studio C++ redistributable package is a shared Windows component, other applications that have dependencies on the package might be stopped or restarted by Windows as part of the installation or upgrade of the C++ redistributable package. Schedule client installations and upgrades during a maintenance window when other applications will not be adversely affected if they are stopped or restarted when the C++ redistributable package is installed. Monitor other applications after the client is installed to see whether there are any applications that were stopped and not restarted.

Follow these steps to install the software on your Windows system.

Procedure

1. Insert the DVD that contains the Tivoli Storage Manager Windows client into your DVD drive. If you have autorun enabled, the installation dialog should start when the DVD loads. If the installation dialog does not start automatically, you can start it manually. Select Run from the Start menu and at the prompt, type: x:\setup where x is your DVD drive. Click OK.

2. Follow the instructions displayed on the screen. If files from a previous version are in the installation directory, the Windows installer presents these options: Modify, Repair, and Remove. To install a new version of the product, first remove the currently installed version using the Remove option. To add a component that was not initially installed, select the Modify option.

Results

Installation setup types:
There are two setup types:

· Choosing Typical installs the minimum necessary to provide normal backup and archive functions. This includes the Backup-Archive Client, the API Runtime files, and the Web Client.

· Choosing Custom takes you to the Custom Setup window. From this window, you can click on any program feature icon to modify that feature if it is not mandatory for installation. You can select from the following program features:

  • Backup-Archive Client
  • Backup-Archive Client GUI Files (Mandatory; cannot be deselected)
  • Backup-Archive Client Web Files (Mandatory; cannot be deselected)
  • Client API Runtime Files (Mandatory; cannot be deselected)
  • Client API SDK Files (Optional; not enabled by default)
  • Administrative Client Command Line Files (Optional; not enabled by default)
  • Logical Volume Snapshot Agent (LVSA) (Optional; not enabled by default)
  • VMware backup tool (Optional; not enabled by default)
  • The Tivoli Storage Manager client now makes use of language packs for non-English language support. Each supported language has its own installation package that must be installed in order to use Tivoli Storage Manager in a supported, non-English language. The Tivoli Storage Manager client is a prerequisite for installing a Tivoli Storage Manager Client Language Pack.

Note:

1. The Backup-Archive Client, the API, and the Web Client are interdependent. If you select the Backup-Archive Client, you must also select the API. Similarly, if you select the Web client, you must also select the Backup-Archive Client and the API.

2. The Backup-Archive Client component includes the client scheduler files.

3. The installer displays the exact amount of disk space that is required for each program feature. Ensure that there is enough disk space on the destination drive for the files you choose to install. The installation program will not install to a destination drive with insufficient disk space.

4. If you do not have a dsm.opt file, a setup wizard is launched automatically when you start the GUI. The setup wizard can help you configure an initial options file.



Per APAR IC79126
Installing the Tivoli Storage Manager backup-archive clients (UNIX, Linux, and Windows) > Installing the Tivoli Storage Manager Windows client>Upgrading, modifying, reinstalling, or uninstalling the Tivoli Storage Manager Windows client

This topic has been updated to include a link to a Wiki site that contains an article that explains how to remove the client from a Windows system if you do not intend to use Tivoli® Storage Manager on a Windows computer in the future. The list of stoppable services has also been revised to include the service display names, and not the executable file names. The new topic is as follows:

Windows operating systems
Upgrading, modifying, reinstalling, or uninstalling the Tivoli Storage Manager Windows client

The Windows Backup-Archive Client can be upgraded, modified, reinstalled, or uninstalled.

Note: Using the Windows Control Panel option to uninstall the client (see step 3) removes the client software but does not remove client services, log files, and other items created outside of the software installation process. This is not an issue if you intend to reinstall the client at a later date. However, if you do not intend to use Tivoli® Storage Manager on a Windows computer in the future, see the following article for instructions to thoroughly remove the client and related files and settings: https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/Tivoli%20Storage%20Manager/page/How%20to%20completely%20remove%20the%20Backup-Archive%20client%20from%20Microsoft%20Windows

If you have previously installed the client and you want to reinstall it into a different directory, uninstall the older client files before you install the new client files.

Wait for any in-process Backup-Archive Client tasks to complete before you uninstall or modify the backup-archive Windows client.

Stop any running services before reinstalling or modifying the client. Use the Windows control panel or service manager commands to display the services that are running. Stop the services shown in Table 1 using either the control panel or a command prompt window.

Table 1. Stoppable services

Control panel display name
Command line procedure
TSM Journal Service net stop "tsm journal service"
TSM Client Acceptor net stop "tsm client acceptor"
TSM Client Scheduler net stop "tsm client scheduler"
TSM Remote Client Agent net stop "tsm remote client agent"

To remove any of these services without uninstalling the client, use the Help me configure options in Utilities > Setup wizard in the GUI (dsm.exe). You can also use the setup wizard to remove configuration information for online image support and open file support.

The following files are not overwritten if you upgrade or reinstall a client by installing it into the same directory used by the previous installation:

  • dsm.opt
  • dsmerror.log
  • dsmsched.log
  • dsmwebcl.log
The configuration settings from the previous version, are in the dsm.opt file, and are preserved for use with the new client software.

During a reinstallation, you are prompted to see if you want the installer to overwrite existing exe, ini, mst, dll, xml, and .properties files. Select Yes to all to overwrite these existing files to ensure that you have the current libraries and initialization files.

Follow these steps to uninstall or modify the IBM® Tivoli Storage Manager Backup-Archive Client:
1. Open the control panel feature used to add, modify, or remove programs. Click Start > Control Panel > Programs and Features.
2. Select the IBM Tivoli Storage Manager client from the list of installed programs.
3. To uninstall an existing client, click Uninstall.
4. To fix missing or corrupted files, shortcuts, and registry entries, select the Repair option.
5. To remove individual components, select Change and then click Next. Next to the installable features that you want to uninstall, select This feature will not be available
6. Complete and close the setup wizard.
7. Reboot the computer if you are prompted to do so. Rebooting removes locked files that must be removed before you upgrade or reinstall the client. Rebooting also updates locked files that must be preserved and reused when you reinstall or upgrade the client.




Per APAR IC79546

Installing Tivoli Storage Manager clients >Automatic client deployment

Customers running Tivoli Data Protection for Enterprise Resource Planning applications should not schedule automatic deployments of the backup archive client.

Text has been added to the topic entitled Automatic client deployment to explain why this is. The new text reads as follows:

The Tivoli® Storage Manager server administrator can automatically deploy a Backup-Archive Client to workstations that already have the Backup-Archive Client installed.

When you schedule automatic Backup-Archive client deployments, the updated client packages (which include the client components and the API library) are installed on the workstations that receive them. A dependency check is performed by the client installation program to ensure that the API library does not conflict with the client package that is currently installed.

Tivoli Data Protection for Enterprise Resource Planning applications do not use the same installation technology that is used by the client installation program. Because of that, the client installation dependency check is not able to detect whether the API library that is being used by the Tivoli Data Protection for Enterprise Resource Planning applications are compatible with the API library that will be installed by automatic client deployments. If a client package is automatically deployed to and installed on a workstation, the API library that is installed might not be compatible with the API library that was installed by the Tivoli Data Protection for Enterprise Resource Planning application. The newly deployed API library can cause the Tivoli Data Protection for Enterprise Resource Planning applications to fail.

Do not schedule automatic client deployments to workstations that have a Tivoli Data Protection for Enterprise Resource Planning application installed on them.

Per defect 79427
Installing the Tivoli Storage Manager backup-archive clients (UNIX, Linux, and Windows) > Upgrading the backup-archive client

The text in this topic that describes where the log and trace files are created when a client update is automatically deployed has been revised.

In the Windows portion of this topic, in the information center, the following text has been replaced with new text:

The deployment manager writes log and trace data for a deployment operation to the client’s disk. The default location of the logs is in the following directory on the client’s disk: C:\Program Files\Tivoli\TSM\IBM_ANR_WIN\Vxxxx\log\; where xxxx represents the version, release, modification, and fix pack information for the deployed Backup-Archive Client.

The new text reads as follows:

When you perform automatic client deployments from the Tivoli Storage Manager Server, the scheduler installs the updated client by running a command that is specified on a postschedulecmd option that is associated with the schedule. By default, the log and trace files for a deployment operation are written to the client's disk in C:\Program Files\Tivoli\TSM\IBM_ANR_WIN\Vxxxx\log; where xxxx represents the version for the newly deployed client.

If you did not use the default installation directory when you installed the client, when an automatic client deployment is performed, the log and trace data for the deployment operation are still copied to the IBM_ANR_WIN\Vxxxx\log folder, and this folder is created one directory level up (../) from where the client executable files (dsm.exe, dsmc,exe, dsmcad.exe, and so on) were installed. For example, if you originally installed the client into E:\IBM\Tivoli\baclient, the log and trace files resulting from the automatic deployment are created in E:\IBM\Tivoli\IBM_ANR_WIN\Vxxxx\log folder.

Per APAR IC79548
Installing the Tivoli Storage Manager backup-archive clients (UNIX, Linux, and Windows)
>Upgrade path for clients and servers

The TSM 6.3 Backup-Archive Client documentation published on the IBM Publications Center could not be updated in time to include a recently revised statement that describes the backward compatibility of the TSM 6.3 Backup-Archive Client with earlier versions of the client.

If you downloaded either of the following documents from the IBM Publication Center at http://www.ibm.com/e-business/linkweb/publications/servlet/pbi.wss?&&FNC=SRH&, be aware that the corresponding PDFs in the TSM 6.3 Information Center contain revised information:

  • IBM Tivoli Storage Manager for UNIX and Linux: Backup-Archive Clients Installation and User's Guide version 6.3
  • IBM Tivoli Storage Manager for Windows: Backup-Archive Clients Installation and User's Guide version 6.3

In the PDFs available in the IBM Publications Center, a topic in each PDF, entitled, "Upgrade path for client and servers" contains the following statement in a bulleted list item:
  • If you back up or archive data from a Tivoli Storage Manager Version 6.3 client, you cannot restore or retrieve that data by using a Tivoli Storage Manager Version 6.1 or earlier UNIX or Linux client, or by using a Version 6.2 or earlier Windows client.

The corrected text for this list item is contained in the PDF files and HTML topics that are published in the Tivoli Storage Manager 6.3 Information Center. The revised text reads as follows:
  • If you back up or archive data from a Tivoli Storage Manager Version 6.3 client, you cannot restore or retrieve that data by using a Tivoli Storage Manager Version 6.2 or earlier client.

You can download the revised PDF files from http://pic.dhe.ibm.com/infocenter/tsminfo/v6r3/index.jsp? to ensure that you have the corrected backward compatibility statement.




Configuration

Configuring backup-archive clients >
Configuring the Tivoli Storage Manager client >
Configuring your system for journal-based backup >
Configuring the journal engine service

Per APAR IC85285, a note is added after the second paragraph:


Configuring the journal engine service

Journal-based backup can be used for all Windows clients. If you install the journal engine service and it is running, then by default the incremental command automatically performs a journal-based backup on selected file systems that are being monitored by the journal engine service.

Journal-based backup is enabled by installing and configuring the Tivoli® Storage Manager journal service. The Tivoli Storage Manager journal service can be installed with the GUI Setup wizard or with the dsmcutil command. Basic journal service configuration can be done with the GUI Setup wizard, more advanced configuration can be done by editing the journal service configuration file, tsmjbbd.ini.

Important: The default location for tsmjbbd.ini is C:\Program Files\Tivoli\TSM\baclient. If this is the first time you are configuring the journal engine service and a copy of tsmjbbd.ini does not already exist, copy the sample file C:\Program Files\Tivoli\TSM\config\tsmjbbd.ini.smp to C:\Program Files\Tivoli\TSM\baclient, naming it tsmjbbd.ini.


Per APAR IC85873, the default journal name is corrected as follows:

...JournalPipe=pipename
Specifies the pipe name of the journal service session manager to which backup clients initially connect, when establishing a journal-based backup session. This setting is used in conjunction with the backup client option of the same name. The default pipe name is \\.\pipe\jnlSessionMgr1. For example, in dsm.opt:
  JournalPipe \\.\pipe\jnlSessionMgr1

Under tsmjbbd.ini [JournalSettings] stanza:

JournalPipe=\\.\pipe\jnlSessionMgr1

 

Per APAR IC81310
Configuring backup-archive clients > Configure the Tivoli Storage Manager client>Configuring NetApp and Tivoli Storage Manager for snapshot difference incremental backups

Step 1 in this procedure has been clarified to indicate where you enter the commands. A new step 2 has been added that explains what options need to be enabled on the NetApp filer. The remaining step numbers are incremented, but the text is otherwise unchanged.

Windows operating systemsAIX operating systemsLinux operating systems
Configuring NetApp and Tivoli Storage Manager for snapshot difference incremental backups

You must configure the NetApp file server connection information to run the snapshot difference incremental backup command on the Tivoli® Storage Manager client. You must also use the set password command to specify the file server hostname, and the password and user name used to access the file server.

Procedure
1. Establish a console session on the NetApp filer and define a new user on the file server using the following steps:
a. Add the user ID to a group that permits users to log in to the file server with http and running API commands.
b. From the file server, enter the following command to list the user ID to verify the settings and verify that the output is similar:
useradmin user list snapdiff_user
Name: snapdiff_user
Info:
Rid: 131077
Groups: snapdiff_group
Full Name:
Allowed Capabilities: login-http-admin,api-*

c. If the security.passwd.firstlogin.enable option for the user ID on the NetApp server is set to "on", ensure that all groups have the login-telnet and cli–passwd* capabilities.
Tip: When security.passwd.firstlogin.enable option is enabled, the user ID is set to "expired" when created. The user cannot run any commands, including snapshot difference incremental, until their password is changed. Users in groups that do not have these capabilities cannot log in to the storage system. Refer to the NetApp documentation for details on defining a user ID and a password on the NetApp file server.
2. Configure the NetApp Data ONTAP built-in HTTP server:
a. The HTTP server must be running. Verify that the NetApp httpd.enable option is set to "on".
b. You need administrative access to the filer, using HTTP. Verify that the NetApp httpd.admin.enable option is set to "on".
c. From the Tivoli Storage Manager client node, test the connection between the Tivoli Storage Manager client computer and the NetApp ONTAP server to ensure that firewalls or other NetApp configuration options do not prevent you from connecting to the NetApp server.
Tip: See the NetApp ONTAP documentation for instructions on how to test the connection.
3. Windows operating systemsExport the NetApp volumes and consider the following recommended settings:
Tip: See the NetApp documentation for details on exporting the NetApp volumes for use with Windows.

  • Map the NetApp volumes using CIFS.
  • Ensure the NetApp volumes have the NTFS security setting.
4. AIX operating systems Linux operating systemsExport the NetApp volumes and consider the following recommended settings:
AIX operating systems Linux operating systemsTip: See the NetApp documentation for details on exporting the NetApp volumes for use with AIX®, or Linux hosts.
  • Map the NetApp volumes using NFS mount.
  • Ensure the NetApp volumes have the UNIX security setting
5. Set the user ID, and password on Tivoli Storage Manager client for the user ID that you created in step 1 using the following steps:
a. AIX operating systems Linux operating systemsLog in as the root user ID.
b. Windows operating systemsLog on as the user with read/write access to the CIFS share.
c. From the Tivoli Storage Manager client command line, enter the following command:
dsmc set password –type=filer my_file_server   snapdiff_user   newPassword
Substitute the following values:
my_file_server
This value is the fully qualified hostname of your NetApp file server.
snapdiff_user
This value is the user ID that you created in step 1.
newPassword
This value is the user ID that you created in step 1.




Getting started

Per APAR IC85460

Configuring backup-archive clients > Getting started>Backup-archive client operations and security rights

The table of user security rights is updated:


Operating system Account What can I back up and restore?
Windows 2008, Windows 2008 R2, Windows 7, and Windows Vista Member of Administrators group
  • Back up and restore all files and directories
  • Back up and restore system state
Windows 2008, Windows 2008 R2, Windows 7, and Windows Vista Member of Backup Operators group
  • Back up and restore all files and directories
  • Back up system state, except for ASR Writer

    Note: Backup Operator group members cannot restore system state.
Windows 2008, Windows 2008 R2, Windows 7, and Windows Vista Member of Users or other group
  • Back up and restore all files and directories
    Note: Users must have the following Microsoft Windows security privileges in order to back up and restore files and directories:
    • Back up files and directories
    • Restore files and directories

    Attention: These privileges represent a potential security risk since they allow the user to back up any file, or restore any file for which a backup copy exists. The privileges should be granted only to trusted users. Refer to the Microsoft Windows documentation for further information about these privileges.

    Note: System state cannot be backed up or restored.
Windows 2003 Member of Administrators group or member of Backup Operators group
  • Back up and restore all files and directories
  • Back up and restore system state
Windows 2003 Member of Users or other group
  • Back up and restore all files and directories to which the account has access
    Note: Users must have the following Microsoft Windows security privileges in order to back up and restore all files and directories on the system:
    • Back up files and directories
    • Restore files and directories

    Attention: These privileges represent a potential security risk since they allow the user to back up any file, or restore any file for which a backup copy exists. The privileges should be granted only to trusted users. Refer to the Microsoft Windows documentation for further information about these privileges.
    Note: System state cannot be backed up or restored.

    Note: System Access Control Lists (SACL) used for auditing entries are not backed up or restored
Note: The information in this table assumes that the default privileges for the "Administrators", "Backup Operators", and "Users" groups have not been altered.


Per APAR IC92829
Getting started>User account control

A new subtopic has been added under "User account control" to explain how network shares must be mapped with elevated privileges, in order for the shares to be accessed by the backup-archive client. The new topic text is as follows:

Windows operating systems
Enabling client access to network shares when UAC is enabled

When Windows User Account Control (UAC) is enabled, the backup-archive client cannot access existing network share mappings. The solution is to map the network shares from an elevated command prompt before you start the client.

About this task
When you map a network share, the share is linked to your current Windows login access token. That token has only standard user privileges. Because the Tivoli® Storage Manager backup-archive client must run with elevated privileges, a different access token is used. Since the network share is not linked to this other access token, the mapped network share is not visible to the client. The network share must be linked to the access token that has the elevated privileges to make the share visible to the client.
Procedure

Complete the following steps to enable the client to access data on network shares.
1. Create a desktop shortcut for the Windows command prompt. The default location of the command prompt executable file is C:\Windows\System32\cmd.exe.
2. Right-click the shortcut and select Run as Administrator. A UAC prompt is displayed with instructions that describe how to proceed.

  • If you are logged in as a member of the Administrators group, click Yes to allow the client to run with elevated privileges.
  • If you are not logged in as a member of the Administrators group, enter your credentials when prompted to do so, and then click Yes to allow the client to run with elevated privileges.

Perform the remaining steps in the elevated command prompt window that you just opened.

3. Use the Windows net use command to map the network shares. Contact your system administrator if you need help with the net use command.
Note: Do not use Windows Explorer to map the network share because Windows Explorer runs with the standard user rights token.
4. Change to the directory where the client is installed. The default installation directory is C:\Program Files\Tivoli\TSM\baclient.
5. Start the client GUI (dsm.exe) or the command-line client (dsmc.exe) and backup or restore data that is on network shares.



Backing Up Your Data



Per APAR IC84084
Backing up your data > Display backup processing options

The explanation of "Total bytes before deduplication:" is enhanced as follows:
Specifies the number of bytes to send to the Tivoli Storage Manager server if the client does not eliminate redundant data. Compare this amount with Total bytes after deduplication. Includes metadata and might be greater than bytes inspected.

The explanation of "Total bytes after deduplication:" is enhanced as follows:
Specifies the number of bytes that are sent to the Tivoli Storage Manager server, after deduplication of the files on the client computer. Includes metadata and might be greater than bytes processed.



Per APAR IC79757
Back up and restore data with backup-archive clients > Backing up your data > Back up NAS file systems using Network Data Management Protocol > Methods for backing up and recovering data on NAS file servers when using CIFS

A new bullet item has been added the paragraphs that begin with "These are some limitations of NAS file server data when using CIFS:"

The following bulleted text is replaced with new text. The old text is:
  • Security information that is associated with the files and directories might not be processed.

The new text is:
  • File and directory security information might be inaccessible when the Windows account performing the backup is not a member of the Domain Administrators group of the domain the NAS file server is a trusted member of. It is also possible that these security access failures might prevent the entire file or directory from being backed up.


Per APAR IC79529
Backing up your data > Scenario: Backing up your virtual machines

A new step is added to this procedure to illustrate how to override a default management class by adding the management class name to an include statement the identifies the virtual machine and files.

The follow text is added after step 5.

5a. Optional: If you want to override the default management class when backing up files, use an include statement and add the name of the management class to use instead of the default management class. Identify the virtual machine and files that you want to use a different management class for when performing backups. In this example, the new management class is used when performing a backup of all files on the C disk of the virtual machine identified by "vm-name".

include "\\vm-name\c$\*" new_management_class_name


Back up and restore data with backup-archive clients > Backing up your data > Backing up virtual machines on a Windows Hyper-V system > Hyper-V backup support limitations

In the Tivoli Storage Manager 6.3 Information Center, in the topic entitled "Hyper-V backup support limitations", the paragraph that describes limitations present when backing up virtual machines that have files on a cluster shared volume is missing text that describes how snapshots can be used to back up the virtual machines. The revised topic text is as follows:

Hyper-V backup support limitations

Due to the tight integration of Microsoft Failover Clustering with Cluster Shared Volumes and Hyper-V, the following limitations apply when using Tivoli® Storage Manager.

Microsoft Hyper-V support is provided for the following configurations:

  • A dedicated Hyper-V system
  • A Hyper-V configuration that is part of Microsoft Failover Clustering
  • A Hyper-V configuration that is part of Microsoft Failover Clustering with Cluster Shared Volumes

VM backups can only be performed by a backup-archive client installed on the cluster node that is the current owner of the VM. To see which VMs are owned by the node, navigate the Windows menu items: ServerManager->Roles->Hyper-V Manager.

A VM should be restored only by a backup-archive client installed on the cluster node that is the current owner of the VM. To determine the VM configurations of the cluster, navigate the Windows menu items: ServerManager > Features > Failover Cluster Manager > cluster name > Services and Applications.. Use the Services and Applications window to change which node is the owner of the VM before you restore the VM.

VMs currently owned by different nodes which have files on a common Cluster Shared Volume cannot be backed up simultaneously when using the default system VSS provider. The second backup will fail as the shared volume will be owned by the first node. You can significantly reduce the amount of time that the first node owns the shared volume by using hardware snapshots through the VSS provider supplied by your storage hardware vendor. Once the hardware snapshot is completed, the backup process can be initiated from the second node, therefore the backups can be running concurrently from both nodes. To determine which node owns the volume, navigate the Windows menu items: ServerManager > Features > Failover Cluster Manager > cluster name > Cluster Shared Volumes. The Cluster Shared Volume windows displays the status of the volume, including ownership, and if a backup is in progress (with redirected I/O enabled).

If your cluster environment typically has all VMs owned by a single node, and other nodes only provide failover support, the following applies:

  • Consider using CLUSTERNODE YES for backup from the active node and restore to failover nodes (if needed).
  • Consider running the Tivoli Storage Manager scheduler as a failover service to periodically backup all VMs. For example: dsmc backup vm * -vmbackuptype=hypervfull. A failover will start the scheduler on the failover node.

If your cluster environment typically has some VMs owned by one node, and other VMs owned by other nodes, the following applies:
  • Consider using the asnodename option to allow for backups from multiple nodes and restore to failover nodes (if needed).
  • Consider running the Tivoli Storage Manager scheduler as active on each node to periodically backup the VMs owned by each node. The schedules need to be defined with non-overlapping start times to avoid contention for common shared volumes. If the scheduler on each node backs up with -vmlist=*, there is no need for the scheduler service to failover since the scheduler service on the other node will automatically pick up nodes which move over on the next backup.



Per APAR IC87966
Back up and restore data with backup-archive clients > Backing up your data > Backup (Windows): Additional considerations > Microsoft Dfs file protection methods

The method applies to Windows Server 2003 and Windows Server 2008.



Restoring Your Data



Per APAR IC76747
Back up and restore data with backup-archive clients > Restoring your data>
Recovering a computer when the operating system is not working (Windows Vista, Windows 7, and Windows Server 2008)

The documentation has been rewritten, corrected, expanded, and moved from the product manuals to the IBM Tivoli Storage Manager Wiki.
The updated documentation can be found in the Tivoli Storage Manager Wiki. Go to https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/Tivoli%20Storage%20Manager and search for "Best Practices for Recovering Windows Server 2008, Windows Server 2008 R2, Windows 7, and Windows Vista"



Tivoli Storage Manager scheduler overview

Per APAR IC83229
Schedule operations for backup-archive clients
> Tivoli Storage Manager scheduler overview>
>Client-acceptor scheduler services versus the traditional scheduler services

The traditional scheduler services text (last two list items) has been updated as follows:

Tivoli Storage Manager traditional scheduler services
· Started with command dsmc sched command.
· Remains active, even after scheduled backup is complete.
· Requires higher use of system resources when idle.
· Tivoli Storage Manager client options and Tivoli Storage Manager server override options are only processed once when dsmc sched is started; if you delete an option from a client options set, you must restart the scheduler so the scheduler is made aware of the changes.
· You must restart the scheduler process for updated Tivoli Storage Manager options to take effect.

Tip: Restart the traditional scheduler periodically to free system resources
previously used by system calls



Processing Options



Per APAR IC82250
Backup-archive client options and commands > Processing options > Using options with commands->Client options that can be set by the Tivoli Storage Manager server

Managedservices is incorrectly displayed as a client option that can be set on the server. Managedservices is being deleted from this topic.

and

Backup-archive client options and commands > Processing options > Client options reference->Managedservices

In this topic, the Supported clients paragraph contains text that says: "The server can also define this option." That statement is incorrect and is being removed.


Per APAR IC90417
Topic: Using processing options
Section: Clusterdisksonly
The following scenario is removed:

Scenario 2: Back up a node which manages the local (non-clustered) drives and
the system state information in a clustered environment using volume mount
points as cluster resources. This node is dedicated to the restoration of the physical system
if there is a hardware failure. There are clustered drives which appear as volume
mount points in this environment (for example, IBM Tivoli SANergy,
Windows Server operating systems). Also, be sure to remove any volume
mount points from the incremental processing domain.

Per APAR IC94432
Backup-archive client options and commands > Processing options > Client options reference->DOMAIN.VMFULL and DOMAIN.VMFILE

The value that you specify for the vmhost parameters on these options must match the host name, as it is displayed in the vCenter server, in the Hosts and Clusters view.

The new descriptions read as follows:

Description for DOMAIN.VMFULL

vmhost= hostname
Process all virtual machines that are defined to the Virtual Center or to the ESX server that is specified on the VMCHOST option. The host name that you specify must match the fully qualified host name or IP address, as it is displayed in the vCenter server in the "Host and Clusters" view. Host name can include multiple ESX servers separated by commas. When the Virtual Center contains multiple ESX servers, this option does not determine the ESX server from which a snapshot is taken. The ESX server from which a snapshot is taken is determined by the VMware VirtualCenter Web service.


Description for DOMAIN.VMFILE

vmhost=hostname
Process all virtual machines that are defined to the Virtual Center or to the ESX server that is specified on the VMCHOST option. The host name that you specify must match the fully qualified host name or IP address, as it is displayed in the vCenter server in the "Host and Clusters" view. The virtual machines also must be running on the ESX server that is specified by the host name. Host name can include multiple ESX servers separated by commas. Allows for automatic inclusion of newly added virtual machines.


Per APAR IC83510
Backup-archive client options and commands>Processing options>Client options reference>Include options

The text that describes how to associate a management class with a backup group on an include statement is not clear. It has been replaced with the following description:

optional_parameter
management_class_name
Specifies the name of the management class to assign to the objects. If a management class is not specified, the default management class is used. To associate a management class with a backup group on an include statement, use the following syntax:

include virtual_filespace_name\group_name management_class_name

where:

virtual_filespace_name
Specifies the name of the Tivoli Storage Manager server virtual filespace that you associated with the group, on the Backup Group command.

group_name
Is the name of the group that you created when you ran the Backup Group command.

management_class_name
Is the name of the management class to associate with the files in the group.

For example, to associate the TEST management class with the group named MyGroup. MyGroup files are stored on the server in the virtual file space named MyVirtualFileSpace, use the following syntax:

include MyVirtualFileSpace\MyGroup TEST

Additional text updates for IC83510 are included in Using commands->Backup Group


Per APAR IC85873
Backup-archive client options and commands > Processing options > Client options reference->Journalpipe

The default journal name is corrected as follows:
...
Place this option in the client options file (dsm.opt).

  JournalPipe \\.\pipe\jnlSessionMgr1

You can also specify this option in the journal configuration file (tsmjbbd.ini).

  [JournalSettings]
 JournalPipe=\\.\pipe\
jnlSessionMgr1






Per APAR IC85304
Backup-archive client options and commands > Processing options > Client options reference->Lanfreeshmport

The default value of the port_address parameter is 1510 for all clients except Windows. The documentation is changed as follows:
...
Parameters

port_address
Specifies the number that is used to connect to the storage agent. The range of values is 1 through 32767; the default is 1 for Windows and 1510 for all other platforms.



Per defect 79403
Backup-archive client options and commands > Processing options > Client options reference > Lanfreetcpport

The abbreviated form for the LANFREETCPPORT option is incorrect in the product documentation. The correct abbreviation for LANFREETCPPORT is LANFREETCPP.

Per APAR IC97752
Processing options > Passwordaccess

New text has been added to the bulleted list of text at the top of this topic that describes the why users might be prompted to enter their password when establishing a session with the server, even if the server is not configured to require authentication. The new text is in the last bullet item in the following text:

If a password is required, you can choose one of the following methods:

  • Set the password for your client node yourself and have Tivoli® Storage Manager prompt for it each time you request services.
  • Let Tivoli Storage Manager automatically generate a new password for your client node each time it expires, encrypt and store the password in a file, and retrieve the password from that file when you request services. You are not prompted for the password.
  • If the server is not configured to require a password to log on to it, you can still be prompted to enter your node password when the backup-archive client establishes a connection with the server. This behavior occurs if this option, passwordaccess, is allowed to default or if you set it to passwordaccess prompt. The password that you supply in response to the prompt is used only to encrypt your login information; it is not used to log onto the server. In this configuration, you can avoid entering a password by setting this option to passwordaccess generate. Setting passwordaccess generate causes the client to create, store, and submit the password for you. When passwordaccess generate is set, the password option is ignored.


Processsing Options > Postschedulecmd/Postnschdulecmd
Per APAR IC77687, the description of postschedulecmd/postnschedulecmd has been revised to clarify how return codes can affect scheduled events.
Per APAR IC79447, The list of notes near the beginning of this topic needs additional information. Note 3 (below) needs to be added.

The new description is as follows:

Postschedulecmd/Postnschedulecmd

The postschedulecmd/postnschedulecmd option specifies a command that the client program processes after it runs a schedule.

If you want the client program to wait for the command to complete before it continues with other processing, use the postschedulecmd option. If you do not want to wait for the command to complete before the client continues with other processing, specify the postnschedulecmd option.

Notes:
1. For scheduled operations where the scheduled action is something other than COMMAND:
If the postschedulecmd command does not complete with return code 0 (zero), the return code for the scheduled event is either 8, or the return code of the scheduled operation, whichever is greater. If you do not want the postschedulecmd command to be governed by this rule, you can create a script or batch file that invokes the command and exits with return code 0. Then configure postschedulecmd to invoke the script or batch file.
2. For scheduled operations where the scheduled action is COMMAND:
The return code from the command specified on the postschedulecmd option does not affect the return code that is reported to the server when the scheduled event completes. If you want the results of postschedulecmd operations to affect the return code of the scheduled event, include the postschedulecmd operations in the scheduled action command script instead of using the postschedulecmd option.
3. The return code from an operation specified on the postnschedulecmd option is not tracked, and does not influence the return code of the scheduled event.
4. The server can also define the postschedulecmd option (and the postnschedulecmd option).

Supported Clients

This option is valid for all clients. The Tivoli® Storage Manager client API does not support this option. The server can also define this option.

Options File

Place this option in the client options file (dsm.opt). You can set this option on the Scheduler tab, Schedule Command button of the Preferences editor.

Syntax

>>-+POSTSChedulecmd--+--cmdstring----------------------------<<
  '-POSTNSChedulecmd -'


Parameters
cmdstring
Specifies the command to process. You can enter a command to be run after a schedule with this option. Use only one postschedulecmd option.

Specify the command string just as you would enter it from the operating system command prompt. If the command string contains any blank spaces, enclose the command string in single quotation marks. For example:
'net stop someservice'

Use a blank, or null, string for cmdstring if you want to prevent any commands from running that the Tivoli Storage Manager server administrator uses for postschedulecmd or preschedulecmd. If you specify a blank or null string on either option, it prevents the administrator from using a command on both options.

If your administrator uses a blank or null string on the postschedulecmd option, you cannot run a post-schedule command.

Examples
Options file:
posts startdb.cmd
posts 'rename c:\myapp\logfile.log logfile.new'
posts 'net start "simple service"'
posts 'rename "c:\myapp\log file.log" "log file.new"'
posts '"C:\Program Files\MyTools\runreport.bat"
  log1.in log2.in'

Command line:
-postschedulecmd="'restart database'"

This option is valid only on the initial command line. It is not valid in interactive mode.




Per APAR IC80331

Backup-archive client options and commands > Processing options > Client options reference Section

A new client option (Windows clients only) has been added to the documentation. The option text is as follows:


Systemstatebackupmethod
Use the systemstatebackupmethod option to specify which backup method to use to back up the system writer portion of the system state data. The method you select is used when you backup the system state data.

Supported clients
This option is valid for Windows Server 2008, Windows Server 2008 R2, Windows Server 2003, Windows Server 2003 R2, Windows Vista, and Windows 7.

Options file
Place this option in the client options file (dsm.opt). When specified in the dsm.opt file, the option affects system state backups created by BACKUP SYSTEMSTATE commands, and system state data backed up by INCREMENTAL commands. However, the only command that you can specify this option on is the BACKUP SYSTEMSTATE command.

Schedule definitions
You can also specify this option on the options parameter of a schedule definition on schedules that have both action=backup and subaction=systemstate set. Defining an infrequent schedule with this option set to FULL ensures that you periodically perform a full backup of Windows system state data.

Syntax

                            .-PROGressive---.   
>>-SYSTEMSTATEBACKUPMethod--+---------------+----------------><
                            +-OPPortunistic-+   
                            '-FULL----------'  

Parameters
PROGressive
With the PROGressive method, the system writer portion of the system state data is backed up using the progressive incremental backup method. That is, if system writer files have not changed since the last system state backup, they are not included in this backup. Only the changed system writer files are backed up. This is the default system state backup method.

This type of system state backup uses the least network bandwidth and Tivoli® Storage Manager server storage, but it increases the amount of Tivoli Storage Manager database processing required to keep track of the changes.

OPPortunistic
With the OPPortunistic method, if any system writer files have changed since the last system state backup, all system writer files are backed up.

This method, like the PROGressive method, also uses the least network bandwidth and Tivoli Storage Manager server storage if system writer files have not changed since the last system state backup. If any system writer files have changed since the last system state backup then the system writer is backed up in full, which uses more network bandwidth and Tivoli Storage Manager server storage. With the OPPortunistic method, the amount of Tivoli Storage Manager database processing that occurs is less than that caused by the PROGressive method.

FULL
When FULL is specified, all system writer files are backed up, even if they have not changed since the last system state backup.

This type of system state backup uses the most network bandwidth and Tivoli Storage Manager server storage because all system writer files are backed up during each system state backup operation. However, this system state backup method causes little Tivoli Storage Manager database processing.

Examples
Options file:
SYSTEMSTATEBACKUPMETHOD FULL
SYSTEMSTATEBACKUPMETHOD OPPORTUNISTIC

Command line:
backup systemstate -SYSTEMSTATEBACKUPMETHOD=FULL



Per APAR IC85812:
Topic: Using processing options
Section: Tcpwindowsize

The TCPWINDOWSIZE option overrides the operating system's default TCP/IP session send and receive window sizes.



Per APAR IC83591:
Topic: Using processing options
Section: Timeformat

When you include the timeformat option in a command, it must precede the fromtime, pittime, and totime options.


Per defect 80775

Backup-archive client options and commands > Processing options > Client options reference> vmcpw

The following paragraph has been updated to include information about how to specify the password that is to be encrypted and saved.

Putting the password in the client options file is a security risk because the file is not encrypted. Use the client preferences editor to save the encrypted password locally:

  1. Click Edit > Client Preferences > Authorization > Save encryption key password locally.
  2. Click Edit > Client Preferences > VM Backup. In the Password field, type the password that you want to have saved and encrypted.
  3. Click OK.



Per APAR IC87541

Backup-archive client options and commands > Processing options > Client options reference > Vmctlmc

This topic does not accurately describe the option. The topic has been rewritten as follows:

Vmctlmc
This option specifies the management class to use when backing up VMware control files.
By default, VMware control files are bound to the default management class. The vmmc option can be used to specify a different management class to which VMware data and VMware control files are bound.

The vmctlmc option overrides the default management class and the vmmc option for VMware control files.

Under certain conditions it might be desirable or necessary to bind VMware control files to a different management class than the VMware data files.

One condition where vmctlmc is necessary is if VMware data files are backed up to tape. VMware control files must be backed up to a disk based storage pool that does not migrate to a tape. The storage pool can be composed of random access volumes and sequential file volumes; the storage pool can also be a dedupe pool.

Use the vmctlmc option to specify a management class that stores data in such a storage pool.Note: The management class specified by the vmctlmc option only determines the destination storage pool for VMware control files. Retention of VMware control files is determined by the vmmc option, if specified, or by the default management class. That is, the retention for the VMware control files always matches that of the VMware data files.

Supported Clients
This option is valid for clients that are configured to back up VMware virtual machines. The server can also define this option.
Options File
Place this option in the client options file dsm.opt.
Place this option in the system options file dsm.sys.

Syntax

>>-VMCTLmc--class_name-----------------------------------------><

Parameters
class_name
Specifies a management class that applies to backing up VMware control files.
If you do not set this option, the management class specified on the vmmc option is used. If you do not set this option and the vmmc option is not set, the default management class of the node is used.

Examples

Options file:
vmctlmc diskonlymc

Command line:
Does not apply

Per APAR IC81310

Backup-archive client options and commands > Processing options > Client options reference > vmvstortransport
This topic does not explain that this option can be used when backing up or restoring VMware virtual machines. The introductory paragraph has been rewritten as follows:

The vmvstortransport option specifies the preferred transports order (hierarchy) to use when backing up or restoring VMware virtual machines.



Per APAR IC89830

Backup-archive client options and commands > Processing options > Client options reference > Webports
This topic lists default port numbers for Windows clients. The port numbers vary depending on which version of Windows is used. The default port range is being removed to avoid providing misleading information. The description now simply states the following:

Windows operating systemsIf you do not specify this option, the default value, zero (0), is used for both ports. This causes TCP/IP to randomly assign a free port number for the client acceptor service and the Web Client Agent service. The port value TCP/IP assigns is in the range of 1024 through 5000.



Commands




Chapter 13: Commands
Section: Archive and Selective commands

Per APAR IC83251, the filespec (file specification) parameter descriptions for the Archive and Selective commands were revised to explain how it is possible for a directory to be archived, or backed up, more than once. The new filespec description reads as follows:

filespec
Specifies the path and name of the file you want to archive or back up. Use wildcard characters to include a group of files or to include all files in a directory.

To include multiple file specifications, separate each filespec with a space character. If multiple file specifications are included, and two or more of the specifications have common parent directories, then it is possible for the common directory objects to be archived or backed up more than once. The conditions under which this behavior occurs is runtime-dependent, but it has no adverse effects.

Windows operating systemsFor example if the filespec is C:\proposals\drafts\ice.doc C:\proposals\drafts\fire.doc, then C:\proposals and C:\proposals\drafts might be archived or backed up twice. The file objects ice.doc and fire.doc are archived or backed up only once.End of change


Start of changeIf you want to avoid including the shared parent directory more than once, use separate, non-overlapping archive commands to archive or back up each file specification.End of change


Windows operating systemsStart of changeIf you archive or back up a file system, include a trailing slash (C:\). End of change

Windows operating systemsStart of changeYou can specify as many file specifications as available resources or other operating system limits allow.End of change

Start of changeYou can use the filelist option, instead of file specifications, to identify which files to include in this operation. However, these two methods are mutually exclusive. You cannot include file specification parameters and use the filelist option. If the filelist option is specified, any file specifications that are included are ignored.End of change



Chapter 13. Commands
Section Backup Group
Per APAR IC83510

The description of the processing rules used during a group backup has been revised to add a new list item ("Management class rebinding for grouped objects") that describes how a management class is rebound to objects that are included in a group backup. The new list of processing rules now reads as follows:

A group backup allows you to create a consistent point-in-time backup of a group of files that is managed as a single logical entity. Objects in the group are subject to the following processing rules:

  • Management class rebinding for grouped objects:
  • During full backups, all objects in a backup group are assigned to the same management class.
  • During differential backups, if a new management class is specified on an include statement for an existing backup group, the following behavior occurs:
  • Any new and changed objects in the backup group are bound to the new management class.
  • Any member objects of the group that are not changed appear as though they have not been bound to the new management class. These unchanged objects are not included in the "Total number of objects rebound" statistics that are displayed when the Backup Group command completes.
  • The unchanged objects are reassigned to a newly created backup group, and the new backup group is bound to the new management class. However, the original management class name is still displayed for the unchanged group objects.
Even though the original management class name is still displayed for the unchanged objects, they are effectively bound to the new management class of the backup group.
  • Existing exclude statements for any files in the group are ignored.
  • All objects in the group are exported together.
  • All objects in the group are expired together as specified in the management class. No objects in a group are expired until all other objects in the group are expired, even when another group they belong to gets expired.
  • If you are performing full and differential group backups to a sequential device, during a restore the data is in no more than two locations. To optimize restore time, perform periodic full backups to back up the data to one location on the sequential media.
  • During a full group backup, all objects in the filelist are sent to the server. During a differential group backup, only data that has changed since the last full backup is sent to the server. Objects in the filelist that have not changed since the last full backup are assigned as members of the differential group backup. This data is not resent to the server, reducing backup time.


Chapter 13. Commands
Section Query Inclexcl

The command description in the published manual was incomplete. The complete command description is provided here:

Windows operating systems
Query Inclexcl

The query inclexcl command displays a list of include-exclude statements in the order in which they are processed during backup and archive operations. The list displays the type of option, the scope of the option (archive, all, and so on), and the name of the source file.

Tivoli® Storage Manager excludes some files from file system backup and restore operations. You can use the query inclexcl command to display a list of these files. In the output of the command, these files have Operating System next to the path.

You can test the validity of patterns you want to use in your include-exclude list before you actually insert them in your options file. See the test pattern explanation.

Use the detail option to display the management class that is associated with an include-exclude statement.

Windows operating systemsUse the display option to display the files that are included or excluded from a file system back up operation.

Supported Clients

This command is valid for all clients.

Syntax
Windows operating systems
>>-Query INCLexcl-+--------------+--+----------+--+--------+<
                 '-test pattern='  '- -Detail-'  .-basic--|
                 '--Display=-------+--'-vssexcl-'
                                      '-all-'

Parameters

test pattern
Use for testing the validity of patterns you want to use in your include-exclude list. When you use a test pattern with this command, the following occurs:

  • The internal include-exclude list is not displayed
  • The pattern is processed as if it came from an include-exclude statement, including all the usual error checking
  • The pattern is displayed as it would appear in the include-exclude list
If the test pattern has no errors, the compiled pattern result is the same as the test pattern.

-DETail
Displays the management class that is associated with the include-exclude statement.


Windows operating systems-DISPLAY=basic | vssexcl | all
-DISPLAY=basic displays the files and directories that have been included or excluded by one of the following methods:
  • The objects were included or excluded in the client options file.
  • The objects were included or excluded in a server-side client option set.
  • The objects were excluded by the operating system because they are contained in the HKEY_LOCAL_MACHINES\SYSTEM\CurrentControlSet\BackupRestore\FilesNotToBackup registry key.
  • The objects were explicitly excluded by IBM® Tivoli Storage Manager.
This is the default if a display value is not specified.

-DISPLAY=vssexcl displays a list of files that are excluded from a file system backup, because they are included when a system state backup is performed. Files that are backed up by a backup systemstate operation are protected by the VSS writer; you cannot include these files in a file system backup by adding them to an include statement in the dsm.opt file, or client option set.

-DISPLAY=all displays all files that are included or excluded during a file system backup.

For a description of the use of delimiters to include or exclude files, see http://pic.dhe.ibm.com/infocenter/tsminfo/v6r3/topic/com.ibm.itsm.tshoot.doc/r_pdg_platspecfcinclexcl.html


Examples
Windows operating systemsTask
Exclude a file from deduplication by excluding it in the client options file:
Exclude Dedup c:\...\abcd

This statement excludes any directory or file named abcd, on the C drive, from deduplication, no where the directory or file resides on the disks.

Windows operating systemsTask
Exclude a directory from deduplication:
Exclude Dedup c:\...\abcd\*

This statement excludes any files that are in, or below, a directory named abcd, from deduplication processing.



Windows operating systemsTask
Display a basic list of include-exclude statements. Command:
query inclexcl

Windows operating systemsTask
Display a list of files that are excluded from file system backups because the VSS writer includes them in system state backups.
query inclexcl -display=vssexcl

Windows operating systemsTask
Display a list of include-exclude statements. Display the management class that is associated with each statement.
query inclexcl -detail

Windows operating systemsTask
Test the validity of this pattern: ..\?x?\*.log
query inclexcl ..\?x?\*.log



Chapter 13. Commands
Section Restore VM
Per APAR IC83401, the Restore VM command interleaves information that is applicable for restoring only VMware virtual machines with information that is applicable for restoring only Hyper-V systems. The content of the Restore VM command has been reorganized such that the hypervisor-specific options are more readily understood. The new command description is as follows:

Linux operating systems Windows operating systems
Restore VM

Use the restore vm command to restore a virtual machine that was previously backed up.

Windows operating systemsThe Restore VM command can be used to restore both Microsoft Hyper-V virtual machines and VMware virtual machines. The information for each type of restore is presented in its own heading. If you are restoring a virtual machine that is part of a Hyper-V setup, you can skip over the Restore VM for VMware virtual machines text. If you are restoring a VMware virtual machine, you do not need to read the Restore VM for Hyper-V virtual machines text.
Linux operating systemsWindows operating systems
Restore VM for VMware virtual machines

If you have the backup-archive client installed on a separate machine that is configured as a vStorage backup server, you can restore a full VM backups to the ESX or ESXi server that they came from, or to a different server. To restore a full VM backup to a different server, use the -host option. The client sends the command to the IBM® Tivoli® Storage Manager server, and the server sends the backed up disk to the ESX server using the transport method specified that you specify in the client options file.

Restoring a full VM backup creates a new virtual machine; the configuration information and content of the new machine is identical to what it was when the backup occurred. All virtual machine disks are restored to the specified point-in-time, as virtual disks in the newly created virtual machine.

To create a new virtual machine, specify the -vmname parameter and provide a name for the new virtual machine. The -vmname parameter creates a new VM with a configuration that is identical to what it was when the backup occurred.

Virtual machines are restored to their original Resource Pool, Cluster, or VM Folder, if the containers exist. During a restore, if the destination target (a vCenter or ESXi host) does not have the required containers the virtual machine is restored to the top-level default location on the target ESXi host. If you use the command-line client to restore a virtual machine, and if the virtual machine cannot be restored to its original inventory location, an informational message (ANS2091I) is displayed. If you use the Java™ GUI to restore a virtual machine, and if the virtual machine cannot be restored to its original inventory location, the informational message is not displayed, but the virtual machine is still restored to the top-level default location.

Windows operating systemsFull VM backups created using VCB must be restored using VCB. If you use VCB to restore a virtual machine, use the VMware converter program on the client to move the restored files to a running state on a VMware server. If the backup-archive client is running in a virtual machine, and if you have performed a file-level back up of the virtual machine’s files, you can restore the backed-up files to the virtual machine using the command line interface or the Java GUI.

Supported Clients

Linux operating systemsThis command is valid on supported Linux clients that are installed on a vStorage backup server for a VMware virtual machine.

Windows operating systemsThis command is valid on supported Windows clients that are installed on a vStorage backup server for a VMware virtual machine.

Syntax
Read syntax diagramSkip visual syntax diagram
>>-REStore VM--
sourcevmspec--+------------------------------+--->
                             +- --
 -VMNAme="newVMname"------+   
                             +- --
DATACENTER="myDatacenter"-+   
                             +- --
HOST="myHost"-------------+   
                             '- --
DATASTORE="myDatastore"---'   

>--+------------+--+---------------------+---------------------><
   '- --
options-'  '-destinationfilespec-'   


Parameters
Note: Any parameter that contains spaces must be enclosed in quotation (" ") marks.
sourcevmspec
Specifies the name of the virtual machine (or VM template) that was backed up.
VMNAme
This parameter is not valid for restoring VMware virtual machines that were backed up using VCB.
Specifies the new name for the virtual machine after it is restored (if you do not want to use the name specified by sourcevmspec). You cannot use wildcards in the virtual machine name.
DATACENTER
This parameter is not valid for restoring VMware virtual machines that were backed up using VCB.
Specifies the name of the datacenter to restore the VM to as it is defined in the vSphere vCenter. If the datacenter is contained in a folder, you must specify the -datacenter option when you restore the virtual machine and include the folder structure of the datacenter in the datacenter name. For example, the following syntax is valid:
-datacenter=folder_name/datacenter_name

When you restore a virtual machine using the GUI, you must restore the virtual machine to a different location. If you restore to the original location, you cannot specify the folder name of the datacenter. Without a folder name to help locate the original datacenter, the restore fails.

HOST
This parameter is not valid for restoring VMware virtual machines that were backed up using VCB.
Specifies the domain name of the ESX host server to restore to as it is defined in the vSphere vCenter.
DATASTORE
This parameter is not valid for restoring VMware virtual machines that were backed up using VCB.
Specifies the data store to restore the virtual machine to. The data store can be on a SAN, NAS, or iSCSI device. You can specify only one data store when restoring a virtual machine. If you do not specify a datastore parameter, the virtual machine's vmdk file is restored to the data store it was on when the backup was created.
Windows operating systemsdestinationfilespec
This parameter is for VMware VCB restores only. It specifies the location where VCB Full VM image files are restored. If this option is not specified the vmbackdir option is used.

Table 1. Restore VM command: Related options when restoring VMware virtual machines

Option
Where to use
datacenter Command line or options file. This parameter is not valid for restoring VMware virtual machines that were backed up using VCB.
datastore Command line or options file. This parameter is not valid for restoring VMware virtual machines that were backed up using VCB.
host Command line or options file. This parameter is not valid for restoring VMware virtual machines that were backed up using VCB.
inactive Command line.
pick Command line. This parameter is not valid for restoring VMware virtual machines that were backed up using VCB.
pitdate Command line. This parameter is not valid for restoring VMware virtual machines that were backed up using VCB.
pittime Command line. This parameter is not valid for restoring VMware virtual machines that were backed up using VCB.
vmbackdir Command line or client options file.
vmbackuptype Command line or client options file.
vmvstortransport Command line or client options file. This parameter is not valid for restoring VMware virtual machines that were backed up using VCB.

Examples

Task
Restore the most recent backup version of myVM to its original name. Use the VMware management interface to delete the original virtual machine, before you restore it using this syntax.
dsmc restore vm myvm  

Task
Restore the most recent backup version of myvm to a new machine that is created with the name "Test Machine", and with the restore target for the datacenter, ESX host, and datastore all specified on the command.
dsmc restore vm myvm  -vmname="Test Machine"
 -datacenter="myDatacenter" -host="myHostName"
  -datastore="myDatastore"


Task
Restore the most recent backup version of myvm. Restore to a datacenter named mydatacenter. The datacenter is within the vCenter; the relative path within the vCenter is dirA/datacenters/.
dsmc restore vm myvm -vmname="Test Machine"
 -datacenter="dirA/datacenters/myDatacenter"
 -host="myHostName" -datastore="myDatastore"








Windows operating systems
Restore VM for Microsoft Hyper-V virtual machines

If the virtual machine that you are restoring exists on the Hyper-V host server, it is shut down and deleted before it is restored from the image stored on the Tivoli Storage Manager. The Restore VM operation then creates the virtual machine such that its content and configuration is identical to what it was when the backup occurred. Even though the client shuts down the virtual machine before deleting it, manually shutting down the virtual machine before running Restore VM is a good practice to bring any in-progress application activities to an orderly stop.

Supported Clients

This command is valid on supported Windows clients that are installed on a Hyper-V host system.

Syntax
Read syntax diagramSkip visual syntax diagram
>>-REStore VM--
sourcevmspec--+------------+--------------------><
                             '- --
options-'   


Parameters

Any parameter that contains spaces must be enclosed in quotation (" ") marks.

Note: Any parameter that contains spaces must be enclosed in quotation (" ") marks.

sourcevmspec
Specifies the name of the virtual machine that was backed up.

Table 2. Restore VM command: Related options when restoring Hyper-V virtual machines

Option
Where to use
inactive Command line
pick Command line
pitdate Command line
pittime Command line
vmbackuptype Command line or client options file. To restore a Hyper-V virtual machine, this option must be set to HYPERVFULL.

Examples

Task
Restore the most recent backup version of a virtual machine named myVM.
dsmc restore vm myvm





Rate this page:

(0 users)Average rating

Add comments

Document information


More support for:

Tivoli Storage Manager
Client

Software version:

All Versions

Operating system(s):

Windows

Software edition:

All Editions

Reference #:

7022169

Modified date:

2014-01-28

Translate my page

Machine Translation

Content navigation