Configuring the recovery agent GUI

Instructions about how to set up the recovery agent GUI for mount, file restore, or instant restore operations is provided.

Before you begin

These configuration tasks must be completed before you attempt an operation in the recovery agent GUI.
Important: Information about how to complete tasks with the 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. Log on to the system where you want to restore files. recovery agent must be installed on the system.
  2. Click Select TSM server in the recovery agent GUI to connect to an IBM Spectrum Protect™ server. When the recovery agent is installed on the same system as the Data Protection for VMware vSphere GUI, and the applications were successfully configured with the Data Protection for VMware vSphere GUI configuration wizard, the following conditions exist:
    • The data mover node and IBM Spectrum Protect server are populated in the recovery agent TSM Server field.
    • The following fields are populated in the TSM Server information panel:
      • Authentication node contains a list of available data mover nodes.
      • Target node contains a list of data center nodes that are available for the selected data mover node.

    When only one data mover node was defined locally with the configuration wizard, the recovery agent uses that node to authenticate when started.

    The recovery agent remembers the last node name that connected to the IBM Spectrum Protect server. If Use Password access generate is selected for this node (the last node name to connect), the recovery agent uses these credentials to connect to the IBM Spectrum Protect server on startup. If no previous connection to the IBM Spectrum Protect server was done, and only one data mover node and one data center node are configured with the wizard, the recovery agent uses these credentials to connect to the IBM Spectrum Protect server on startup.
    Specify the following options:
    Server address
    Enter the IP address or host name of the IBM Spectrum Protect.
    Server port
    Enter the port number that is used for TCP/IP communication with the server. The default port number is 1500.
    Node access method:
    Asnodename
    Select this option to use a proxy node to access the VM backups that are in the target node. The proxy node is a node that is granted "proxy" authority to perform operations on behalf of the target node.
    Typically, the IBM Spectrum Protect administrator uses the grant proxynode command to create the proxy relationship between two existing nodes.
    If you select this option, complete the following steps:
    1. Enter the name of the target node (the node where the VM backups are located) in the Target Node field.
    2. Enter the name of the proxy node in the Authentication node field.
    3. Enter the password for the proxy node in the Password field.
    4. Click OK to save these settings and exit the IBM Spectrum Protect information dialog.
    When you use this method, the 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:
    1. Enter the name of the target node (the node where the VM backups are located) in the Target Node field.
    2. Enter the name of the node that is given limited access in the Authentication node field.
    3. Enter the password for the node that is given limited access in the Password field.
    4. Click OK to save these settings and exit the IBM Spectrum Protect 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:
    1. Enter the name of the target node (the node where the VM backups are located) in the Authentication node field.
    2. Enter the password for the target node in the Password field.
    3. Click OK to save these settings and exit the IBM Spectrum Protect information dialog.
    Use Password access generate
    When this option is selected and the password field is empty, the 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 IBM Spectrum Protect node for the first time by entering the password in the Password field and selecting the Use Password access generate check box.
    However, when you use the local data mover node as the Authentication node, the password might already be stored in the registry. As a result, select the Use Password access generate check box and do not enter a password.

    recovery agent queries the specified server for a list of protected VMs, and shows the list.
  3. Set the following mount, backup, and restore options by clicking Settings:
    Virtual Volume write cache
    The recovery agent that is running on the Windows backup proxy host saves data changes that are created during 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 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.
    Restriction: To prevent any interruption during restore processing, exclude the write cache path from all antivirus software protection settings.
    Data Access
    Specify the type of data to be accessed. If you are using an offline device (such as tape or virtual tape library), you must specify the applicable data type.
    Storage type
    Specify one of the following storage devices from which to mount the snapshot:
    Disk/File
    The snapshot is mounted from a disk or file. This device is the default.
    Tape
    The snapshot is mounted from a tape storage pool. When this option is selected, it is not possible to mount multiple snapshots or run an instant restore operation.
    VTL
    The snapshot is mounted from an offline virtual tape library. Concurrent mount sessions on the same virtual tape library are supported.
    Note: When the storage type is changed, you must restart the service for the changes to take effect.
    Disable expiration protection
    During a mount operation, the snapshot on the IBM Spectrum Protect 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.
    • To protect the snapshot from expiration, do not select this option. The snapshot on the IBM Spectrum Protect server is locked and the snapshot is protected from expiration during the mount operation.
    • To disable expiration protection, select this option. This option is selected by default. The snapshot on the IBM Spectrum Protect 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:
    • Disk or file: 64
    • Tape: 1024
    • 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:
    • Disk or file: 10000
    • Tape: 75000
    • 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 the network is slow, the storage device is busy, or multiple mount or instant restore sessions are being processed. The default values are as follows:
    • Disk or file: 60
    • Tape: 180
    • VTL: 60
    Click OK to save your changes and exit the Settings.
  4. Verify that each IBM Spectrum Protect server node (that was specified with the Asnodename and Fromnode options) allows backups to be deleted. The recovery agent creates unused temporary objects during operations. The BACKDELete=Yes server option allows these objects to be removed so that they do not accumulate in the node.
    1. Log on to the IBM Spectrum Protect server and start an administrative client session in command-line mode:
      dsmadmc -id=admin -password=admin -dataonly=yes
    2. Enter this command:
      Query Node <nodename> Format=Detailed
      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.
  5. When you use the Recover 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.