Advanced Configuration - File Archiver

In order to perform archiving operations, you need to initially configure archiving rules. Archiving rules specify the criteria for the type of data to be archived. The basic archving criteria is the maximum file size in a particular scanned volume/directory. Files that meet this criteria are rendered available for archiving if they satisfy any or all the archiving rules.

File System Size

The backed up files can be stubbed based on the available free space on the volume. During a backup job if the free space on the volume is less than this value, files matching the remaining rules will become candidates for stubbing.

From the CommCell Console, navigate to the Client Computers | <Client> | File Archiver | Instance | ArchiveSet.
Right-click the Subclient and click Properties
Select Rules tab.
Enter the low watermark value for the volume in Begin scan for file selection when free volume is less than n%.
Enter the high watermark value for the volume in End scan if volume is freed to n%.
Click OK.

Based on File Access Time

You can set rules to archive files based on the last accessed date of each file within the volume or folder/directory. Files older than the specified date will be archived.

From the CommCell Console, navigate to the Client Computers | <Client> | File Archiver | Instance | ArchiveSet.
In the right pane right-click the Subclient and click Properties.
Select the Rules tab.
Enter the number of days elapsed since the file was last accessed in the Archive file access time older than n Days box.
Select Any one of the file selection rules are satisfied.
Click OK.

Based on File Modified Time

You can also set rules to archive file based on the last modified time. Files that were modified earlier than the specified time will be archived.

From the CommCell Console, navigate to the Client Computers | <Client> | File Archiver | Instance | ArchiveSet.
In the right pane right-click the Subclient and click Properties.
Select the Rules tab.
Enter the number of days elapsed since the file was last modified Archive file modified time older than n Days box.
Select Any one of the file selection rules are satisfied.
Click OK.

Based on File Size

You can also set archiving rules to archive files depending on the file size. This can be done by specifying a file size range such as files greater than 5 KB but less than 20 KB should be archived. If a file size within a scanned volume or folder/directory is in between the specified size limit, it will get stubbed.

From the CommCell Console, navigate to the Client Computers | <Client> | File Archiver | Instance | ArchiveSet.
In the right pane right-click the Subclient and click Properties.
Select the Rules tab.
Enter the minimum file size in Archive file if size is greater than n KB box.
Enter the maximum file size in Maximum file size box.

These options can be used individually or in combination to specify a range.

Select All of the file selection rules are satisfied.
Click OK.

Based on File Attribute

You can also archive the files that have the Read Only attribute set on them.

From the CommCell Console, navigate to the Client Computers | <Client> | File Archiver | Instance | ArchiveSet.
In the right pane right-click the Subclient and click Properties.
Select the Rules tab.
Select Enable all Rules.
Select Migrate Read-Only Files.
Select Any one of the file selection rules are satisfied.
Click OK.

Configuring Post Archiving Options

Replacing Archived Files With Stubs

The configuration to delete the files after they have been archived can be modified to stub the original file after archiving. This can be done by following the steps mentioned below.

From the CommCell Console, navigate to the Client Computers | <Client> | File Archiver | Instance | ArchiveSet.
In the right pane right-click the Subclient and click Properties.
Select the Rules tab.
Select the Stub Rules tab.
Click Replace File with a Stub.
Click OK.

Deleting Archived Files

You can choose to delete the files from your computer after an archiving operation in order to reclaim storage space.

From the CommCell Console, navigate to the Client Computers | <Client> | File Archiver | Instance | ArchiveSet.
In the right pane right-click the Subclient and click Properties.
Select the Rules tab.
Select the Stub Rules tab.
Click Delete the File.
Click OK.

Setting up Stub Retention Rules

By default, the stubs are pruned in 90 days from the day of stubbing. However, you can set the number of days after which the stubs will be pruned by following the steps given below.

From the CommCell Console, navigate to the Client Computers | <Client> | File Archiver | Instance | ArchiveSet.
In the right pane right-click the Subclient and click Properties.
Select the Rules tab.
Select the Stub Rules tab.
Click Replace File with a Stub.
In the Prune Stubs Only After <n> days box type the number of days.
Click OK.

Configuring for Optimized Stub Recall

Extend the Persistent Pipeline Timeout

It is recommended to leave the persistent pipeline open for longer periods of time to cache important information for subsequent recall attempts. By default this timeout is set to 24 hours.

From the CommCell Browser, right-click the client computer that has Windows Archiver Agent installed.
Click Properties.
Select Registry Key Settings.
Click Add.
Enter nDMRSIDLETIMEOUT in the Name field.
Enter EventManager in the Location field.
From the Type list, select REG_DWORD.
Enter the number of seconds after which the pipeline will close. The valid range is 0 to 2147483647 seconds.
Click OK.

Once this key is activated, services must be restarted on the client computer.

Limit the Number of Persistent Pipeline Threads During Recoveries

You can increase the number of persistent pipeline threads allowed for recoveries, thereby potentially improving stub recall speed. The recommended number of threads would be the number of Media Agents, which could possibly be used for recoveries. By default two threads will be used. Therefore if more than two Media Agents are potential targets for stub recalls increase the number of threads accordingly as follows:

From the CommCell Browser, right-click the client computer that has Windows Archiver Agent installed.
Click Properties.
Select Registry Key Settings.
Click Add.
Enter nDMRMaxRestoreThreads in the Name field.
Enter EventManager in the Location field.
From the Type list, select REG_DWORD.
Enter the number of persistent pipelines to be allowed.
Click OK.

Once this key is activated, services must be restarted on the client computer.

Enhance the Stub Recall Speed

By default during each stub recall operation a check is run to verify if the original data has been erased from the media. In case the Erase Data feature is not enabled on the CommServe you can create the nDMRSkiperasecheck key to skip the erase check and enhance the recall speed.

From the CommCell Browser, right-click the client computer that has Exchange Mailbox Archiver Agent installed.
Click Properties.
Select Registry Key Settings.
Click Add.
Enter nDMRSkiperasecheck in the Name field.
Enter EventManager in the Location field.
From the Type list, select REG_DWORD.
Enter 1 to disable Erase Check.
Click OK.

Once this key is activated, services must be restarted on the client computer.

Stub Recall from Any Available Data Copy

By default if the primary copy of the data is unavailable the stub recall will fail. However you can configure to trigger stub recall from an alternate data copy as follows:

In the Comcell Browser double-click the Control Panel.
Click the Browse/Search/Recovery option.
Select the Automatically switch copy to read data from any copy option.
Click Ok.

Configuring Filters

Prior to archiving the files, you can set filters to prevent specific type of files from being archived. Filters can also be used to exclude certain system-related files and database application files which consistently fail during a archive operation and are not integral to the operation of the system or application.

Filtering Files from Archiving

You can manually set filters on selected file types, folders or files to be excluded from archiving. For example if you specify *.txt in the filters then all the text files will be excluded from being archived.

Client Computers | <Client> | File Archiver | Instance | ArchiveSet.
In the right pane right-click the Subclient and click Properties.
Click the Filters tab.
Click Add from the Exclude these files/folders/patterns group.
Enter the complete path of the file, folder, or directory that you want to exclude from the archiving operations
or

Click the Browse and expand the file system of the client computer. Click the file, folder, or directory that you want to exclude from the archiving operations and then click Add.
Click OK to save your changes.

Configuring Exclusion to Filters

When excluding files from archiving, you can also provide exceptions to the data that you are excluding. For example, if you want to exclude all the files in the My Documents folder except the Downloads sub-folder, you can add a subclient filter to exclude the My Documents directory from being archived and also add a corresponding subclient filter to allow the Downloads sub-folder to be archived.

Client Computers | <Client> | File Archiver | Instance | ArchiveSet.
In the right pane right-click the Subclient and click Properties.
Click the Filters tab.
Click Add from the Include these files/folder/patters: group.
Enter the complete path of the file, folder, or directory that you want to be included in the archiving operation.
or

Click the Browse and expand the file system of the client computer. Click the file, folder, or directory that you want to be included in the archiving operation. and then click Add.
Click OK.

Deleting a Filter

Filters can be deleted, when not in use. These does not included the default filters but only include the filters that were added manually. Whenever you delete a filter from the exclusion list, the system automatically deletes any exceptions that are part of the deleted exclusion filter.

Client Computers | <Client> | File Archiver | Instance | ArchiveSet.
In the right pane right-click the Subclient and click Properties.
Click the Filters tab.
Select the filter to be deleted and click Delete.
Click OK.

It is recommended to perform a full backup after deleting the filters.

Creating a Subclient to Backup Stubs

Protecting stubs is useful for recovery operations. For example, if there is a disk failure, the data can be restored along with the stubs.

From the CommCell Browser, navigate to Client Computers | <Client> | File System | BackupSet.
Right-click the Backup Set and point to All Task.
Select New Subclient.
Enter Subclient Name box enter the name of the subclient.
Click the Storage Device tab.
In the Storage Policy box select a Storage Policy from list.
Click the Content tab and browse to the stubs that you want to backup and click Add.
Click OK.

Protecting Stubs using Incremental Backups

By default the stubs are not included in Incremental Backups. Therefore stubs created after the most recent full backup may be lost if the operating system or file structure where the stubs reside is rendered unusable before the next full backup is run. Follow the steps give below to configure for stubs to be backed up during incremental backups.

From the CommCell Browser, navigate to Client Computers | <Client> | File System
Right-click the Backup Set and select Properties.
Click Use Classic File Scan and select Check archive bit during backups check box.
Click OK.

Setting Up on demand archiving

On Demand archiving allows for content to be specified as an external input at the time of initiating an archiving operation. Whereas traditional archiving is performed using subclients, which contain fixed content configured prior to performing the operation. On Demand Archiving allows you to specify content each time you perform an archive job.

Content for On Demand Archiving is defined through:

a Content File, which is a text file that defines the location of the data that you want to protect. Each Content File contains the fully qualified paths from the root directory to files, links, and devices to be archived.

Once these entities are defined, an On Demand Archive Set is then created. Archives run from this Archive Set will provide the facility to select the Content Files to be included.

Creating Content File

Content File entries should be in the following format with no filters, wildcards, regular expressions or paths to the FAT partition:

c:\data\datafile.txt
c:\data\wordfile.doc
d:\my documents\webdoc.html

Creating On Demand Archive Set

Create one ore more Content Files defining the content to be backed up.

From the CommCell Console, navigate to Client Computers | <Client>.
Right-click File Archiver, point to All Tasks and then click New On Demand Archive Set.
In the New Archive Set Name box, type a name (up to 32 characters).
In the Storage Policy box select a storage policy.
Click OK

Once an On Demand Archive Set has been created, it cannot be changed into a traditional archive set.

Adding Files and Folders with Unicode Characters to Content Files

If the path or the filename contains Unicode characters, the Content File must be converted to a format that can be used by the data protection operation. The Unicode Conversion utility must be used to convert the Content File to a format that can be provided as input.

Using a text editor, create a file that contains a list of files/folders with Unicode characters. Make sure to save the file as a Unicode text file.
From the Command Line, navigate to the <software install folder>/base folder and type the following:
cvconvertunicode <source file> <destination file>

Where:

<source file> is the full path and name of the file created in Step 1.

<destination file> is the full path and name of the destination file. The file will automatically be created by the utility.
Use the destination file as the content file to perform an On-Demand archive.

Preventing Duplicates

On Demand Archive explicitly archives the files listed in the Content File. If the Content File contains two entries for a file, the file will be backed up twice.

For example:

c:\data

c:\data\files

In this scenario, an archiving operation will archive the contents of all data residing in the files folder twice as the Content File has already called for the entirety of the parent folder to be archived. It is recommended that Content Files not include such duplicate entries.

However, if it is not feasible to monitor a Content File for such duplicate entries, the OnDemand_AutoExpandDir registry key can be created on the computer in which the Content File is located. This key prevents the scan phase of an archive job from expanding through all subfolders within a path listed in the Content File.

In the case of the above example, only the root contents of the files will be included in the archiving operation. The subfolders will not be included to prevent duplicate data.

To create this key, perform the following steps:

From the CommCell Console, navigate to Client Computers | <Client>.
Right-click File Archiver.
Select Properties.
Select the Registry Key Settings tab.
Click Add.
In the Name box enter FileSystemAgent.
In the Location box enter HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\.
In the Type box select DWORD.
In the Value box enter OnDemand_AutoExpandDir.
Click OK.

Configuring the Maximum Number of Simultaneous Stub Recalls (Recall Throttling)

The maximum number of simultaneous stub recalls can be limited to a specified amount of time. This will not only optimize performance but can also prevent the inadvertent recovery of a large number of files.

From the CommCell Console, navigate to Client Computers | <Client>.
Right-click File Archiver.
Select Properties.
Click Stub Recovery Parameters.
In the Maximum Stub Recovery box select a value.
In the Time between recall to count as successive in seconds box select a value.
In the Time to wait after maximum successive recalls limit is reached in seconds box select a value.
Click OK.
It might take some time for the changes to take effect. Restart the File Archiver services for it to take effect immediately.

Examples of Recall Throttling

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 description

user action

result

Maximum Limit is Not Exceeded (with no additional recall requests).

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.

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.

Maximum Limit is Exceeded (with no additional recall requests).

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.

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.

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. Assuming they were text files, 11 blank Notepad sessions appear on the desktop.

Maximum Limit is Not Exceeded (with additional recall requests received within the Interval).

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.

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.

Maximum Limit is Not Exceeded (with additional recall requests received outside the Interval).

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.

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.

enabling notifications for end Users

This tool is available on the computers where File Archiver for Windows Agent is installed. A user with administrative privileges can use this tool to display customized messages for the end user at the time of the recall. The tool displays recall messages depending on the secondary storage like disk or tape. By default during a recall the following message will be displayed:

Recalling file <-Filename-> from secondary disk storage. Please standby.<title> File Recall

Recalling file <-Filename-> from secondary tape storage. Please standby.<title> File Recall

The following tag options can be used:

The <-FILENAME-> or %s tag can be used in these fields to represent the file name. When a recall occurs the tags will get replaced with the file name being recalled, before displaying the message to the user. The file name is shortened when it exceeds 100 characters. First 48 characters and the last 48 characters of the file name are used in this shortened version.
<-FILENAMEFULLPATH-> tag can be used if user wants to insure that the message always contains the full name of the file.
The <excludefilename> tag can be used to exclude the file name from the message. This tag can be placed anywhere within the message, and it gets removed before being displayed to the user.
The <title> tag can be used to replace the text in the title bar of the popup.

This notification tool can be configured by following the steps given below:

On the computer with File Archiver for Windows Agent, right click the File Archiver Notification icon available on the system tray.
Select Setting.
Select the Data Archiver Popup tab.
Select the Enable Recall Popup Message check box.
In the Maximum Popup Message Display Time box type the value in seconds. The message will be displayed for the entered number of seconds.
Click Close.

Modifying an Archive Set, Instance or Subclient

The following table describes the properties that can configured from the agent, instance, archive set, and subclient levels.

Option	Description	Related topics
Configure Activity Control	You can enable backup and restore operations from the agent and subclient level. However, you can enable recovery operations only from the agent level. Agent Level: From the CommCell browser, right-click the File Archiver Agent. Click Properties. Click Activity Control, select or clear Enable Archive and Enable recovery options. Click OK. Subclient Level: From the CommCell browser, right-click the subclient. Click Properties. Click Activity Control, select or clear Enable Archive option. Click OK.	Refer to Activity Control.
Release License	You can release a license for client, MediaAgent and agent. If releasing a license is successful, the tree element is dimmed and available for deletion. From the CommCell browser, right-click the File Archiver Agent. Click All Tasks and select Release License. Click OK to continue. Click Yes to continue with the deconfiguration or No to abort.
Change Storage Policies	You can modify the storage policies in any of the following situations. To include a different media for the backup operation. To use a storage policy with a different retention criteria. You can change the storage policies from the subclient level. From the CommCell Browser, right-click the subclient. Click Properties. Click Storage Device tab. Click Data Storage Policy tab and select a data storage policy to associate with this subclient. Click OK to save your settings.	Refer to Storage Policies.
Rename Instance	You can rename an existing Instance. From the CommCell Browser, right-click the Instance. Click Properties. Click General tab and type the new name in the Instance field. Click OK to save your settings.
Rename Archive Set	You can rename an existing Archive Set. From the CommCell Browser, right-click the Archive Set. Click Properties. Click General tab and type the new name in the Archive Set field. Click OK to save your settings.
Rename a Subclient	You can rename an existing subclient. From the CommCell Browser, right-click the subclient. Click Properties. Click General tab and type the new name in the Subclient Name field Click OK to save your settings.
Configure Data Transfer Options	You can efficiently configure the available resources for transferring data secured by data protection operations from the subclient level. This includes the following: Enable or disable Data Compression either on the client or the MediaAgent. Configure the transfer of data in the network using the options for Network Bandwidth Throttling and Network Agents. You can configure the data transfer options. From the CommCell Browser,right-click the subclient. Click Properties. Click Storage Device. Click Data Transfer Option tab. Choose the appropriate software compression option for this subclient. Select Throttle Network Bandwidth and set the required bandwidth. Click OK.	Refer to Data Compression and Network Bandwidth Throttling.
View Data Paths	You can view the data paths associated with the primary storage policy copy of the selected storage policy or incremental storage policy. You can also modify the data paths including their priority from the subclient level. From the CommCell browser, right-click the subclient. Click Properties. Click Storage Device. Select Storage Policy from the drop-down menu. Click Data Paths.
Configure account for Pre/Post Processing of Data Protection	You can add, modify or view Pre/Post processes for the subclient. These are batch files or shell scripts that you can run before or after certain job phases. From the CommCell browser, right-click the subclient. Click Properties. Click Pre/Post Process. Click one of the following phases and type the full path of the process that you want to execute during that phase. Alternatively, click Browse to locate the process (applicable only for paths that do not contain any spaces). PreBackup Process PostBackup Process Click OK. Select Run Post Scan Process for all attempts to run a post scan process for all attempts . Select Run Post Backup Process for all attempts to run a post backup process for all attempts. For subclients on Windows platforms, Run As displays Not Selected. If you want to change the account that has permission to run these commands, click Change. In the User Account dialog box, select Use Local System Account, or select Impersonate User and enter the user name and password. Click OK. If you selected Local System Account, click OK to the message advising you that commands using this account have rights to access all data on the client computer.	Refer to Pre/Post Processes.
Configure User Security	You can configure user security from the agent, backup set/archive set or subclient levels. You can perform the following functions: Identify the user groups to which this CommCell object is associated. Associate this object with a user group. Disassociate this object from a user group. From the CommCell browser, right-click the subclient. Click Properties. Click Security. Select the appropriate user groups to which you want to associate to the CommCell object from the Available Groups pane, and then move the user group to the Associated Groups pane. Click OK.	Refer to User Administration and Security.
Enable/Disable Data Encryption	You must export the pass-phrase to the local computer before performing a stub recovery operation of encrypted data. You can enable data encryption from the subclient level. Encryption must be enabled at the client level prior to configuring any instances residing on that client. From the CommCell browser, right-click the subclient. Click Properties. Click Encryption. Select the desired encryption. Click OK.	Refer to Data Encryption.
View Software Version and Installed Updates	The Version tab, at the Agent level displays the software version and post-release service packs and updates installed for the component. From the CommCell browser, right-click the agent. Click Properties. Click Version. Click OK.
CommCell Configuration Report	The CommCell Configuration Report provides the properties of the CommServe, MediaAgents, clients, agents, SRM agents, subclients, and storage policies within the CommCell based on the selected filter criteria. From the CommCell browser, click Reports icon. Select CommCell Configuration. Click Run.	Refer to CommCell Configuration.
Archive Job Summary Report	The Archive Job Summary Report provides the detailed archive information such as the start and end time (or current phase), the total size of the archive job, the elapsed time, the transfer time, the throughput, the number of objects archived, the amount of data, the failed folders and files, content indexing usage and failures (if any), and the filters used for the archive. From the CommCell browser, click Reports icon. Select Job Summary. Click General and select Archive/Compliance Archive. Click Run.	Refer to Archive/Compliance Archive Job Summary Report

Modifying a Client, Instance or Subclient from the Command Line

Modifying a Client

The GXHSMUtility provides additional options that can be set on the client. These options can be set from the command line and are not available from the Client Properties dialog in the CommCell Console.

Access the command prompt on the computer, where File Archiver for Windows is installed.
Navigate to the <File Archiver Windows >\Base> folder
Run the GXHSMUtility utility.

Usage: The following table lists the command line options and their description.

Option	Description
RestubOn [x]	Enables restub logic in the recall phase
RestubOff	Disables restub logic in the recall phase
OffLineAtOn [x]	Enable setting offline attribute for NAS sub clients
OffLineAOff	Disable setting offline attribute for NAS sub clients
CheckAlwaysOn	Enable recall logic to ALWAYS check sub client recall property
SetExtPropStr	Set the extended property name.
GetExtPropStr	Retrieve the extended property name.
SetExtPropNum	Set the extended property number.
GetExtPropNum	Retrieve the extended property number.
CheckAlwaysOff [x]	Disable recall logic to check sub client recall property

Modifying an Instance

You can use the GXHSMutility to set additional options on the instance from the command line.

Access the command prompt on the computer, where File Archiver for Windows is installed.
Navigate to the <File Archiver Windows >\Base> folder
Run the GXHSMUtility utility.

Usage:

Option	Description
SetExtPropStr	Set the extended property name.
GetExtPropStr	Retrieve the extended property name.
SetExtPropNum	Set the extended property number.
GetExtPropNum	Retrieve the extended property number.

modifying a Subclient

You can use the GXHSMUtility to set additional options on subclients. These options are not available from the subclient properties dialog box in the CommCell Console. When using these additional options, make sure to specify the subclient name along with the setting. If the subclient name is not specified, the setting is applied to all the subclients.

Usage:

Option	Description
SysHid	Enables sub-client to migrate system and hidden files
SysHidOff	Disallow migration of system or hidden files
ModCreate	Maintain file modification and creation time on migration
AccessTimeM	Maintain file access time on migration [requires ModCreate]
AccTimeMOff	Disables access time preservation during migration
AccessTimeR	Maintain file access time on recall [requires ModCreate]
AccTimeROff	Disables access time preservation during recall
KeepTimeOff	Disables ALL time preservation during migration
SparseOn	Enable sparse; Enabled by default for local; For fpolicy, this option is only supported on OnTap 7.3 & higher, and it's enabled by default for supported versions
SparseOff	Disable sparse
RestubOn	Enables restub logic on migration per subclient
RestubOff	Disables restub logic on migration per subclient. Client level RestubOff needs to be used with subclient level restub options. The client level restub option is used in the recall phase, and applies to all sub-clients.
IgnreSparse	Ignore sparse attribute when migrating files; This is commonly used for fpolicy.
IgnrSprsOff	Turn off IgnreSparse option
DontStubOn	Do not stub file in stub phase, and do not delete; Only archive
nDontStubOff	Turn off DontStubOn option
NasSparse	When recalling NAS files, remove sparse
NasSprsOff	Turn off NasSparse option
DisableAcls	Disables restoring ACLs during recall
EnableAcls	Turn off DisableAcls option
StageRecall	Enable recalls to use staging folder (gxhsmcache)
StageOff	Disables StageRecall
RmtErrMsg	Remote error message handling on. When this is set, a popup message is sent to remote users when recall error occurs.
SetExtPropStr	Set the extended property name.
GetExtPropStr	Retrieve the extended property name.
SetExtPropNum	Set the extended property number.
GetExtPropNum	Retrieve the extended property number.
RmtErrMsgOf	Disables RmtErrMsg

Deleting an Agent, Instance, Archive Set or Subclient

The following sections describe the steps involved in deleting an agent, archive set or subclient.

When you delete an instance or backupset, the associated data is logically deleted and you can no longer access the corresponding data from CommCell Console for recovery purposes.

Refer to the troubleshooting article on Recovering Data Associated with Deleted Clients and Storage Policies for information on how to recover data if you accidentally delete an entity.

Deleting an Agent

You need to uninstall or DeConfigure the agent software from the client computer before deleting from CommCell Browser. After you delete the client software, you can either leave the corresponding data intact for appropriate action or you can remove the data immediately. If you choose to remove the data immediately, you must delete the agent from the CommCell Browser. If you delete the agent, all of the agent's data is irretrievably lost.

You cannot delete an agent while operations for that agent are running.

From the CommCell Browser, navigate to Client Computers | <Client>.
Right-click the <Agent>, and then click Delete.
A confirmation message is displayed with the following message:
This operation will permanently delete the data backed up from this level and it cannot be restored.
Click OK to continue with the deletion operation., or click No to abort the deletion.

Deconfiguring an Instance

Consider the following before deconfiguring an instance:

The Instance will appear dimmed or greyed-out in the CommCell Browser. Functionality related to issuing an archive job will not be available. However, browse and restore operations are available.
The related files and registry entries associated with the Instances will not be removed from the computer. For example, the subclients associated with the Instance will be hidden and can be re-displayed if the instance is reconfigured with the Reconfigure option.
To permanently delete all data and job history, delete the Instance in the CommCell Console.
The license is released if the Instance that is being deconfigured is the last instance to use that license. The license is re-enabled when a new Instance is created or if the Instance is reconfigured with the Reconfigure option.
All Data Archive/Data Recovery job schedules (independent and those part of a schedule policy), which are related to the specific Instance will continued to be displayed in the Schedule Details dialog box after the Instance has been deconfigured.

From the CommCell Browser, navigate to the instance that you want to deconfigure.
Right-click the instance, click All Tasks and then click Deconfigure.

Deleting an Instance

Consider the following before deleting an instance:

When you delete a specific instance all job schedules and job histories that pertain to any of the levels within the deleted instance are deleted.
You cannot delete an instance if it is being backed up. Attempts to delete an instance under such conditions cause the deletion to fail. If a backup is in progress, either wait for the backup to complete or kill the backup job using the Job Manager. Once the backup is no longer in progress, you can delete the instance level.
You cannot delete an instance if there is only one instance present for an agent. To delete the final instance, you must remove the agent software from the client computer.

From the CommCell Browser, right-click the instance that you want to delete, click All Tasks and then click Delete.
Click Yes to confirm the deletion. (Clicking No cancels the deletion and retains the node.)
Type the requested phrase in the Enter Confirmation Text dialog box and click OK. This should delete the instance.

Deleting an Archive Set

Consider the following before deleting a Backup Set:

You cannot delete a default Backup Set.
Schedules associated with the Backup Set are also automatically deleted.

From the CommCell Browser, navigate to Client Computers | <Client> | <Agent>.
Right-click the <Backup Set>, and then click Delete.
A confirmation message is displayed, asking if you want to delete the Backup Set.
Click No to cancel the deletion and retain the Backupset, or click Yes to continue the deletion.

Deleting a Subclient

Consider the following before deleting a subclient:

You cannot delete a default subclient.
Schedules associated with the subclient are also automatically deleted.

From the CommCell Browser, navigate to Client Computers | <Client> | <Agent> | <Backup Set>.
Right-click the <subclient> that you want to delete, and then click Delete.
A confirmation message is displayed, asking if you want to delete the subclient.
Click No to cancel the deletion and retain the subclient, or click Yes to continue the deletion.

Configuring Polyserve Cluster for Restoring Stubs Residing on the PolyServe File System

Use the following steps to recall stubs from the PolyServe cluster:

Make sure that the Archiver Agent is installed on the physical nodes of Polyserve cluster.
Make sure that the Use Classic File Scan option is enabled in the backupset as described in Setting up the Backupset.
Make sure that the Use VSS option is not selected from the subclient used to perform the PolyServe cluster backup as described in Setting up the Subclient.
To perform stub recall, add the EnableThirdPartyFS registry key on the physical nodes of PolyServe cluster as described in Configuring Stub Recalls.

Setting up the Backupset

From the CommCell Console, navigate to Client | File System | defaultBackupSet.
Right click <BackupSet> and make sure that the Use Classic File Scan option is selected.
Click OK.

Setting up the Subclient

Right-click the subclient used to perform backup and point to Properties.
Make sure that the Use VSS option is cleared.
Click OK.

Configuring Stub Recalls for PolyServe Cluster

In order to recall the stubs that reside on the PolyServe File System, you need to add the EnableThirdPartyFS registry key on the physical nodes Use the following steps to enable the registry key:

Click Start, click Run, type regedit, and then click OK.
Navigate to the following directory:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\cvmhsm\Parameters
Right click the Parameters and select New -> DWORD value, name it as EnableThirdPartyFS.
Double-click the EnableThirdPartyFS key and modify the Value data to 1 to enable the recall of stubs on a PolyServe File System.
Click OK.
Restart the machine for the changes to get applied.

Advanced Configuration - File Archiver

Table Of Contents

Configuring the Maximum Number of Simultaneous Stub Recalls (Recall Throttling)

example description

user action

result