Recover Data - File Archiver for Windows

Topics | How To | Related Topics

Overview

How to Setup and Run a Recovery Operation

Recover a File from Windows Explorer

Recovering Multiple Files from Stubs

Recovering Files with Alternate Data Streams

Recall Throttling

Application Filtering

Recovery Destinations

In-Place Recovery

Out-of-Place Recovery

Cross-Platform Recoveries

Recover to Network Drive

Recovery Considerations for these Agents

Common

Local Archiving

NAS Archiving

Registry Keys for Recovery Operations

Overview

The File Archiver Agents support the following types of recoveries:

Recoveries can be performed in-place or out-of-place, and in certain scenarios cross-application recoveries and recoveries to a network drive or NFS-mounted file systems are also supported. (See, Recovery Destinations for comprehensive information.)

Recoveries using file paths for the File Archiver Agents can be performed from the archive set level in the CommCell Browser. Depending on the agent, browse and recovery operations for these agents can be performed from the client, agent, and subclient levels in the CommCell Browser.

When there is a problem with the file system, and/or operating system of the client computer full system restores may be required. The File Archiver Agents rely upon the corresponding File System iDataAgent to perform a full system restore of client data. See Disaster Recovery for more information.

Back to Top

How to Set Up and Run a Recovery Operation

The following section provides the steps to set up and run a Recovery Operation:

  1. Enable the Archiving Rules for the subclient that contains the content you wish to archive. See Enable (Disable) Archiving Rules for step-by-step instructions and configure the Archiving Rules. In particular, decide if you want to create stubs in your environment. Even if the Archiving Rules are disabled, the Stub Rules will apply. See Configure Archiving Rules - File Archiver Agents for step-by-step instructions.
  2. Optionally, create an On Demand File List to archive data though the use of an external list of files on a given subclient. This file can be used with or without enabling the Archiving Rules.  See How to Set Up and Run an On Demand Archive Operation. 
  3. Run an archive operation. See Start a Migration Archiving Operation for step-by-step instructions.
  4. Optionally, if using stubs in your environment, decide if you want to throttle stub recovery requests. See Recall Throttling for more information.
  5. Optionally, determine if you want to to prevent specified applications from initiating recalls of archived files. See Application Filtering for further information.
  6. Determine your Recovery Destinations.
  7. Recover one or more files with a Browse and Recovery or recall operation.

Recover a File from Windows Explorer

There are several common methods for recovering an archived file. Users can provide a path to the archived files to be recovered from the CommCell Console, browse and recover archived files from the CommCell Console or, if the subclient is configured to create stubs, perform a recall operation from a Windows workstation. A recall is any action that causes an open and read to be executed for the archived file, which automatically initiates a recovery operation. For example, clicking on the stub file from Windows Explorer.

  • If a subclient is configured with the Archive files only, do not create stub archiving rule option enabled, the archived files will be removed from the computer and a stub recovery is not possible. To recover files that were archived using this option, perform the procedure to Recover a File from the CommCell Console.

  • When a mount point contains stubbed files and it is moved, a reboot is required in order to recall the stubs.

For step-by-step instructions, see Recover a File from Windows Explorer.

Back to Top

Recovering Multiple Files from Stubs

There are several common methods for recovering an archived file. Users can provide a path to the archived files to be recovered from the CommCell Console, browse and recover archived files from the CommCell Console or, if the subclient is configured to create stubs, perform a recall operation from a Windows workstation. A recall is any action that causes an open and read to be executed for the archived file, which automatically initiates a recovery operation. For example, clicking on the stub file from Windows Explorer.

  • If a subclient is configured with the Archive files only, do not create stub archiving rule option enabled, the archived files will be removed from the computer and a stub recovery is not possible. To recover files that were archived using this option, perform the procedure to Recover a File from the CommCell Console.

  • When a mount point contains stubbed files and it is moved, a reboot is required in order to recall the stubs.

For step-by-step instructions, see Recover Multiple Files from Windows Explorer.

Back to Top

Recovering Files with Alternate Data Streams

File Archiver instances archive both the main stream and the alternate data streams. A stub recall triggers the following for the various instances:

Local File System

Network File Share

Celerra

FPolicy

File Archiver for Windows Stub Icons

When a file is archived with the create stub option enabled, offline attributes are set and the icon for the file will change to a special stub icon in Windows Explorer so that you can easily distinguish archived files. Some examples of commonly used stub icons are below:

Adobe Acrobat Document
JPG File
Microsoft Excel Worksheet
Microsoft Project Document
Microsoft Word Document
MP3 File
Text File
Text File (Windows 2008 or Windows Vista)

(The displayed item is a product of Microsoft and beyond the control of this agent.)

no image Due to limitations inherent in certain file types, including but not limited to *.html and *.ttf files, no icons will be displayed in Windows Explorer for those files after archiving. This is normal for some files, and the stubs can still be recovered by clicking on the filename from Windows Explorer.

After a stub has been recovered, the icon will change back to the normal icon for the respective file type. Keep in mind that the File Archiver for Unix Agent does not support stub icons.

Back to Top

File Archiver Notification

This tool is available on the computers where File Archiver for Windows Agent is responsible for periodically retrieving unused or infrequently used Windows File System and NAS File Server data from a secondary storage.

The tool allows the user with administrative privileges to disable recalls with custom popup messages, which are displayed at the time of the recall.

File Archiver Notification

See How to Set File Archiver Notification for step-by-step instructions.

Once the popup message is set; it is sent at the time of the recall to the active session user. In case the file was recalled from a remote computer, the popup message is sent through either the Net Send or MSG command.

Recall Throttling

The number of stub recovery requests that can be run on an agent can be limited within a specified timeframe. Limits can be established that not only optimize performance but can also prevent the inadvertent recovery of a large number of files. Setting the recall throttling parameters involves configuring the maximum number of recalls, interval, and cool-down period for the agent. These parameters are entered on the Agent Properties dialog box.

See Set Stub Recovery Parameters for step-by-step instructions.

Examples are provided below to illustrate how this feature functions.

Scenario

For the examples below, we will assume that the recovery administrator has established the following recall throttling parameters:

- Maximum Stub Recovery (i.e., limit) is set to 10
- Time Between Recall to Count as Successive in Seconds (i.e., interval) is set to 30 seconds
- Time to Wait after Maximum Successive Recalls Limit is Reached in Seconds (i.e., cool-down) is set to 60 seconds

Example 1 - Maximum Limit is Not Exceeded (with no additional recall requests)

Action: A user submits 4 stub recovery requests at the same time on a given client, and no other stub recovery requests are submitted on that client during the 30 second interval that follows.

Result: As each stub recovery request is received, it will begin processing immediately and the 30 second interval countdown will begin where the system will wait to see if any more stub recovery requests are submitted. There is no cool-down period since the limit was not reached, and all 4 files will be recovered.

Example 2 - Maximum Limit is Exceeded (with no additional recall requests)

Action: A user submits 20 stub recovery requests at the same time on a given client, and no other stub recovery requests are submitted on that client during the 30 second interval that follows.

Result: The first 9 stub recoveries will begin immediately, the 30 second waiting interval does not apply here since the limit has been reached, and the 60 second cool-down period begins where no other stub recovery requests will be accepted. Note that 11 stub recovery requests (out of 20) that were over the limit will not be processed, and an event will be issued in the CommCell Console's Event Viewer and the Windows Event Viewer indicating that the limit has been reached. The first 9 files will be recovered, and depending on the agent the user will see one of the following results for the 11 stub recovery requests that were over the limit:

File Archiver for Windows: Assuming they were text files, 11 blank Notepad sessions appear on the desktop.

Example 3 - Maximum Limit is Not Exceeded (with additional recall requests received within the Interval)

Action: A user submits 4 stub recovery requests at the same time on a given client, and 4 other stub recovery requests are submitted on that client by another user during the 30 second interval that follows.

Result: As each stub recovery request is received from the user, it will begin processing immediately and the 30 second interval countdown will begin where the system will wait to see if any more stub recovery requests are submitted. After 20 seconds have elapsed, the 4 additional stub recovery requests are received so the 30 second interval countdown will begin again (i.e., the count is initialized to zero) to allow one more request to be submitted. Since the limit has not been reached, the cool-down period does not apply, and all 8 files will be recovered on a first-in first-out basis.

Example 4 - Maximum Limit is Not Exceeded (with additional recall requests received outside the Interval)

Action: A user submits 4 stub recovery requests at the same time on a given client, and 8 additional stub recovery requests are submitted on that client by another user 35 seconds later.

Result: As each stub recovery request is received from the user, it will begin processing immediately and the 30 second interval countdown will begin where the system will wait to see if any more stub recovery requests are submitted. After 35 seconds have elapsed, 8 additional stub recovery requests are received and the 30 second interval countdown will begin again (i.e., the count is initialized to zero) to allow one more request to be submitted. Since the limit was never reached during the first or second interval, the cool-down period does not apply, and all 12 files will be recovered on a first-in first-out basis.

  • Recall operations are blocked from the Windows 2000 version of Windows Explorer (e.g., operations such as copy/paste do not trigger a recall).

  • The interval value for FPolicy, Network File Share, and Celerra instances should be set to 200 for complete Recall Throttling effect.

Back to Top

Application Filtering

The Application Filtering feature provides a means for the recovery administrator to prevent specified applications from initiating recalls of archived files. Certain applications will perform an open and read on files as part of their normal functioning, such as virus scanning software, but when a stub is opened and read the system initiates a recall (i.e., stub recovery) that in such cases would be an unintended consequence of running the application.

To prevent this from happening, a registry key can be added on the client computer that contains the name of the executable that is denied recall rights when accessing files of that application type. Once the registry key has been set up, if a user attempts stub recovery for a archived file associated with the application type specified in the registry key, the recall will be denied and an event will be issued in the CommCell Console's Event Viewer and the Windows Event Viewer indicating that the recall was denied due to application filtering. See ExcludeProcess for more information on the use of this registry key.

Recovery Destinations

By default, data is recovered to the client computer from which it originated; this is referred to as an in-place recovery. You can also recover the data to another Client computer in the CommCell. Keep in mind the following considerations when performing such recoveries:

The following sections enumerate the types of recovery destinations that are supported. See Recover Options - Recover Destinations - Support for a list of Agents supporting each restore/recovery destination type.

In-Place Recovery

When performing a recall of archived data from a stub, keep in mind that the data can only be recovered in-place to the same path/destination on the same client from which the data was archived.

When performing an In-Place Recovery for Recovery-by-Job the user has to provide the login credentials for FPolicy and Network File Share Instance.

Out-of-Place Recovery

Consider the following when performing out-of-place recoveries:

Cross-Platform Recoveries

When performing a cross-platform recovery of archived data from a newer version of an operating system to an older version, keep in mind that some file attributes/properties native to the newer version may not be recovered to the older version.

Consider the following when performing cross-platform recoveries:

Recover to Network Drive

Besides recovering data to a client computer’s local drive, you can also recover data to a UNC path. See Restore to Network Drive/NFS-Mounted File System for comprehensive information.)

Moved Stubs

If a stub has been moved to a new location, recall operations will recover the data to the new location and not the originating one.

Back to Top

Recovery Considerations for these Agents

Before performing any recovery procedures for these agents, review the following information.

Common

Local Archiving

NAS Archiving

Registry Keys for Recovery Operations

Use the following registry keys to modify the default behavior of the Migration Archiver Agent:

Topic Registry Key(s) Description
Access and Modified Times GXHSMSERVICEKEEPTIMES

GXHSMSTUBKEEPTIMES

Migration archiving and stub recovery operations change the access and modified time on files. An enhancement that allows the recovery administrator to preserve the original file access time and modified time during migration archiving and stub recovery. See Registry Keys (GXHSMSERVICEKEEPTIMES and GXHSMSTUBKEEPTIMES) for more information on enabling this feature for all instance types except Celerra.
  GXHSMSERVICEKEEPTIMES

GXHSMSTUBKEEPTIMES

Stub pruning looks at the modified time of the file to determine eligibility for pruning stubs. If you use the GXHSMSERVICEKEEPTIMES and GXHSMSTUBKEEPTIMES registry keys, the modified time will be preserved. This means that when you run a migration with these registry keys enabled, the preserved modified time will always be older than the time that the file was stubbed. As such, if you use the Prune stub only after n days option, you should ensure that the modified time is not being preserved. Therefore, be sure to disable the GXHSMSERVICEKEEPTIMES and GXHSMSTUBKEEPTIMES registry keys (which are enabled by default) when you use this option.
Stub Recalls GXHSMSERVICEMINRECALLFREESPACE If you would like to ensure that there is sufficient free space on a volume before initiating stub recalls, you can use the GXHSMSERVICEMINRECALLFREESPACE registry key to enable this feature.
  nRETRY_RECALL_TIMEOUT

nRETRY_RECALL_DELAY

Two registry keys are available for administering the timing of recalls. The nRETRY_RECALL_TIMEOUT registry key allows you to set the time of duration for a recall attempt. Once this time expires, the recall attempt will stop. The nRETRY_RECALL_DELAY key indicates the delay time for a recall attempt. Once this time expires, the recall attempt will resume. These keys work hand-in-hand with each other, and they are especially useful if the CommServe goes down.
  EVMGRC_REMOTE_PORT_OVERRIDE

EVMGRC_REMOTE_PORT

For File Archiver for Windows, you can override the stub file port number by using the EVMGRC_REMOTE_PORT_OVERRIDE registry key.  Use this key when the port number changes. Keep in mind that using this key defeats the benefit of being able to recall data using different port numbers for multiple Agents. When the key does not exist, the File Share Archiver client uses the stub content to determine port number. For 7.0 stubs, refer to the EVMGRC_REMOTE_PORT registry key.
  GXHSM_DISABLE_ARCHIVE_FILE_RECALL_AND_RESTORE This registry key disables stub recalls at the driver level and allows service to send custom popup messages. This key should be used with a service level key GXHSM_DISABLE_ARCHIVE_FILE_RECALL_AND_RESTORE_MESSAGE.

It is created in computers which has File Share Archiver Client installed.

  DMReadMaxMountRetryVal By default no failure message is displayed when a recall job waits for the media to be imported. This key allows for setting a finite number of mount retries during restore.
Stub Recall History nDMRSendFileStatus

The stub recall history is viewable at the client and agent levels in the Commcell Console and is associated with the first instance, which was created in the Migration Archiver agent. Stub recall history can be turned on by creating nDMRSendFileStatus key and setting the value to 1.

You can use the nDMRSendFileStatus registry key to reduce the frequency at which the stub recovery job statistics are sent to Job Manager for updating the Recovery Job History views and reports. This is useful for increasing the efficiency of system resources in cases where there are frequent stub recalls and there is no need to update the Job History immediately after each stub recall.

  GXHSM_ENABLE_INPLACE_RESTORE By default the recalls occur on a staged path, and then the recalled files are copied to the target path. This is a user defined key which allows the user to direct the recalls in place rather than the staging path.
  GXHSM_ALTERNATE_GXHSMCACHE_PATH By default at the time of stub recall the stubs are stored in a stub cache path, which is generally in the root volume path. The Maximum supported path length for it is 1000. Any path longer than this specified length will get proportionately reduced if this key is specified.This user defined key allows the user to specify the path for all recalls.
Persistent Pipelines nDMRSIDLETIMEOUT

To change the default value of how long the persistent pipeline of this Archiver Agent will stay open during idle periods of a recovery operation, you can use the nDMRSIDLETIMEOUT registry key to accomplish this task. The pipeline stays persistent for 24 hours by default.

To ensure the registry key settings take effect, it is recommended that you restart the CommVault Client Event Manager Service (EvMgrc).
  nDMRMaxRestoreThreads If you would like to spawn multiple persistent pipelines when stub recall requests are from different archive file IDs, the nDMRMaxRestoreThreads registry key can be used to accomplish this task.
Recall Messages and Pop-Ups GXHSM_MAGNETIC_MSG_NAME You can use the GXHSM_MAGNETIC_MSG_NAME key to replace the default "MAGNETIC" key word for a recall message with a message of your choice.
  GXHSMNOPOPUP To enable the display of a pop-up message for stub recoveries indicating that the recovery operation has completed and showing the location of the file that was recovered, change the GXHSMNOPOPUP registry key value to N. To disable the pop-up, create the GXHSMNOPOPUP registry key and set the value to Y.
It is recommended to use UNC based stub recalls on computers with Vista or Windows 2008.

This is enabled by default on the local client for the File Archiver for Windows Agent when configured for NAS archiving.

The GXHSMNOPOPUP registry key is not supported in Celerra proxy.
  GXHSM_DISABLE_ARCHIVE_FILE_RECALL_AND_RESTORE_MESSAGE This is a service level key used in conjunction with the driver level key GXHSM_DISABLE_ARCHIVE_FILE_RECALL_AND_RESTORE on computers where File Share Archiver Cleint is installed. The key allows for customizing the popup message when GXHSM_DISABLE_ARCHIVE_FILE_RECALL_AND_RESTORE is used to disallow the recall.

The key can be used with the following to get desirable popup messages:

  1. "%s" can be used in the registry key value to represent the file name.

  2. The popup message can be customized into top and bottom fields. Anything before <gxhd> would be message in the bottom field. Anything after <gxhd> will go in the top field.
    File %s is being recalled. <gxhd>Please wait....
  GXHSM_MAX_DISPLAY_TIME_FOR_DISABLERECALLRESTORE_MESSAGE The key is used in conjunction with GXHSM_DISABLE_ARCHIVE_FILE_RECALL_AND_RESTORE_MESSAGE as it allows the user to set a desired popup message display time.
Log Files GXHSMSTUBLOGFAILFILESTRUNCATE For File Archiver for Windows, you can determine whether the existing log file associated with your job should be truncated or appended to. See GXHSMSTUBLOGFAILFILESTRUNCATE in Registry Keys for more information.
Sparse Files GXHSMSTUBCREATESPARSE If you have enabled the archive option to create stub files that are not sparse files (using the GXHSMSTUBCREATESPARSE registry key), you must use WordPad not Notepad to open the resulting text files.
  GXHSM_NAS_REMOVESPARSE_ON_RECALL In case of archiving FPolicy and Network File Share data, use GXHSM_NAS_REMOVESPARSE_ON_RECALL to remove the sparse attribute upon recall if the stub has been created as a sparse file.

 

Back to Top