V11 SP8
Loading...

Advanced Configuration - OnePass for Windows File System

Table of Contents

Enable OnePass for Your Subclient

Important: This topic applies to new clients on Commvault version 11 software. If you upgrade the client from the previous version, and the client still operates on indexing version 1, then do not complete the procedure below. Instead, see Enable OnePass for Your Subclient.

You can enable archiving at the subclient level to archive the data specified in your subclient content. You can perform backup and archive operations for the same client using separate subclients.

  1. Open the CommCell Console.
  2. In the CommCell Browser, click Client Computers | <Client> | File System.
  3. In the CommCell Browser, click <Backup Set>.
  4. Point to All Tasks, and then click New Subclient.
  5. In the Subclient Properties dialog box, click the General tab.
  6. In the Subclient Name box, enter a name for the subclient.
  7. Click the Content tab, and then click Browse to select the content.
  8. Click the Storage Device tab, and then select a storage policy from the Storage Policy list.
  9. Click Advanced.
  10. In the Advanced Subclient Properties dialog box, click the Retention tab, and then select the Extend storage policy retention check box to archive your subclient content.

    Note: Once you enable this option you can perform only incremental and synthetic full archive or backup operations for your subclient.

  11. Click the Disk Cleanup tab and select the Enable archiving with these rules checkbox.
  12. To archive your files, set the rules accordingly based on file access time, modified time or file size.
  13. To accept the default values, click OK.

    Note: Once you click OK, you cannot clear the Extend storage policy retention check box in the Retention tab of your subclient.

  14. Click OK.
  15. Click OK.
Settings Types of Backup License Consumed
  1. In the Advanced Subclient Properties dialog box, click the Retention tab.
  2. Select the Extend storage policy retention check box and then select the Backup Retention check box.

Perform incremental, and synthetic full backups

Backup Capacity License
  1. In the Advanced Subclient Properties dialog box, click the Retention tab.
  2. Select the Extend storage policy retention check box and then select the Archive retention check box.
Perform only incremental backups Archive Capacity License
  1. In the Advanced Subclient Properties dialog box, click the Retention tab.
  2. Select the Extend storage policy retention check box and then select the Archive retention and Backup Retention check boxes.
Perform incremental, and synthetic full backups Archive Capacity License

Configuring Rules for Archiving

Archiving rules specify the criteria for the type of data to be archived. For a file to get archived, it has to meet all of these rules/criteria. You can configure these rules on a requirement basis.

You can use the File Level Analytics Report to determine the values that need to be specified while configuring the Archiving Rules below.

 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.

  1. From the CommCell Console, navigate to Client Computers | File System | <backupset>
  2. Right-click the Subclient and point to Properties.
  3. Select Disk Cleanup tab.
  4. Select the Enable Archiving with these rules check box.
  5. Enter the low watermark value for the volume in Start cleaning up disk when it is less than n% Free box.
  6. Enter the high watermark value for the volume in Stop cleaning up disk when it is up to n% Free box.
  7. Click OK.

To ignore the Start cleaning up disk when it is less than n% Free or Stop cleaning up disk when it is up to n% Free rules, enter a value of 100.

File Access Time

This configuration will stub files based on the last accessed date of each file within the volume or folder/directory. In case it is older than the number of days specified, the files will get stubbed.

  1. From the CommCell Console, navigate to Client Computers | File System | <backupset>.
  2. Right-click the Subclient and point to Properties.
  3. Select the Disk Cleanup tab.
  4. Select the Enable Archiving with these rules checkbox.
  5. Enter the number of days elapsed since the file was last accessed in the File access time older than n Days box.
  6. Click OK.

To ignore the File access time older than n Days rule, enter a value of 0.

File Access Time for Windows Vista and Windows Server 2008

For Windows Vista, Windows Server 2008 and newer versions of Windows operating system, by default the access time is not updated for any files and folders. If you want to archive files based on access time, perform the following:

  1. From the CommCell Browser, expand Client Computers > client.
  2. Right-click File System and then click Properties.

    The File System Properties dialog box appears.

  3. Select the Track access time check box.
  4. Click OK.
  5. Right-click the subclient and then click Properties.

    The Subclient Properties dialog box appears.

  6. On the Disk Cleanup tab, in the File access time older than n Days box, type the number of days elapsed since the file was last accessed.
  7. Click OK.

File Modified Time

This configuration will stub files based on the last modified date of each file within the volume or folder/directory.

  1. From the CommCell Console, navigate to Client Computers | File System | <backupset>.
  2. Right-click the Subclient and point to Properties.
  3. Select the Disk Cleanup tab.
  4. Select the Enable Archiving with these rules checkbox.
  5. Enter the number of days elapsed since the file was last modified in File modified time older than n Days box.
  6. Click OK.

To ignore the File modified time older than n Days rule, enter a value of 0.

File Creation Time

This configuration will stub files based on the time the files were created within the volume or folder/directory.

  1. From the CommCell Console, navigate to Client Computers | File System | <backupset>.
  2. Right-click the Subclient and point to Properties.
  3. Select the Disk Cleanup tab.
  4. Select the Enable Archiving with these rules checkbox.
  5. Enter the number of days elapsed since the file was created in the File created time older than n days box.
  6. Click OK.

To ignore the File created time older than n days rule, enter a value of 0.

File Size

This configuration will stub files based on the file size. If a file size within a scanned volume or folder/directory is in between the two limit values set, it will get stubbed. Follow the steps given below to stub files based on their size:

  1. From the CommCell Console, navigate to Client Computers | File System | <backupset> .
  2. Right-click the Subclient and point to Properties.
  3. Select the Disk Cleanup tab.
  4. Enter the minimum file size in File size greater than n KB box.
  5. Enter the maximum file size in Maximum file size box.

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

  1. Click OK.

For Example:

To archive files with size more than 120KB but less than 500KB:

  • Enter 120 KB in File size greater than n KB.
  • Enter 500 KB in Maximum file size.

To ignore the File size greater than n KB and Maximum file size rules, enter a value of 0.

Based on File Attribute

You can also archive the files that have the Read Only attribute set on them. Any read only file that meets archiving rules will get archived.

  1. From the CommCell Console, navigate to Client Computers | File System.
  2. In the right pane right-click the Subclient and click Properties.
  3. Select the Disk Cleanup tab.
  4. Select Enable archiving with these rules.
  5. Select Archive Read-Only files.
  6. Click OK.

Enabling Redundancy for Files that Qualify for Archiving

Before archiving or deleting files, you can perform a redundancy check to ensure that multiple copies of the files are available on the storage media. A file that meets the archiving rules is stubbed only if the data is available in two distinct storage policy copies.

Before You Begin

  • The redundancy feature is available only for new subclients.
  • For default and upgraded subclients, redundancy feature is turned off by default.
  • Redundancy feature is not available on clients that are upgraded from Version 10.
  • Redundancy feature is not honored on subclients that have storage policies configured to use GlusterFS or cloud storage.
  • You cannot enable the redundancy feature using subclient policy.

Benefits

This feature is useful when you have one or more of the following scenarios:

  • You have only one copy of a file on storage media (including tape), and the storage media is corrupted, or the tape is misplaced.
  • You configured retention settings incorrectly, so that the only copy was pruned from the storage media.

Procedure

  1. From the CommCell Browser, expand Client Computers > client > File System > backup_set.
  2. Right-click the appropriate subclient, and then click Properties.

    The Subclient Properties dialog box appears.

  3. On the General tab, enter the name of the subclient.
  4. On the Content tab, specify the subclient content.
  5. Click Advanced.

    The Advanced Properties dialog box appears.

  6. Click the Retention tab and click Extend storage policy retention check box and specify the desired retention settings.
  7. Click OK.
  8. Click the Disk Cleanup tab and select the Enable redundancy check for archived data check box. You can set the archiving  rules based on which your files will be archived.
  9. Click the Storage Device tab and select a storage policy from the Storage Policy list.
  10. Click OK.

What to Do Next

Run an archive job for your subclient. For instructions, see Advanced Archive Options.

Configuring Entity and Pattern Based Archiving Rules

You can create archiving rules based on the types of entities and different patterns that are present in your data. For more information, see Configuring Entity and Pattern Based Archiving Rules.

Synchronizing Data on the Disk and the Index

You can enable the synchronization of data on the source disk and the index. This topic describes how you enable this feature.

After you enable this feature, the subsequent archive job compares and identifies the missing files from the subclient content on the disk and the index. The missing files are then included in the archive job.

 A scenario that might result in the discrepancy is a cut and paste operation on a file that does not change the modified time of the file. As a result, when you use the recursive scan method, the file is not picked up during the archive operation.

Note: We recommend that you upgrade the client and the CommServe computer to the latest service pack version. You can also enable this feature using the subclient policy.

Before You Begin

  • You must have Indexing Version 2 on your client computer.
  • This feature is not selected by default on upgraded clients and subclients created using the command line interface.
  • Until you run a new archive cycle, the previous cycles are not pruned. If you want to prune the previous archive cycles, then disable the Retain jobs in previous cycle until Source Files and backup index are synchronized in latest cycle parameter.
  • This feature is not supported on the following subclients:
    • IntelliSnap subclients
    • Block-level backup subclients
    • Subclients that have only archiver retention enabled
    • Days-based retention subclients

Procedure

  1. From the CommCell Browser, expand Client Computers > client > File System > backup_set.
  2. Right-click the appropriate subclient  and click Properties. The Subclient Properties dialog box appears.
  3. In the Subclient Properties dialog box, specify the basic settings for the subclient:
    1. In the Subclient name box, type the name of the subclient.
    2. On the Content tab, add the content to be backed up.
    3. Click Advanced.

      The Advanced Properties dialog box appears.

    4. On the Advanced Options tab, verify if the Synchronize Source files and Backup Index check box is selected.

      Note: If you experience slowness in scan time after you enable this option, create the bIgnoreTrueUpChangeTimeCheck additional setting on the client computer. For instructions on adding the additional settings from the CommCell Console, see Add or Modify an Additional Setting.

    5. In the Every n days from the previous backup job box, enter the number of days after which any archive job will automatically synchronize the missing files.

      Note: By default, the synchronization runs after every incremental job that runs after a synthetic full backup.

    6. Click OK.
    7. On the Storage Device tab, in the Storage Policy list, click a storage policy name to associate with the subclient.

      Tip: To create a new storage policy, click Create Storage Policy and follow the instructions in the storage policy creation wizard.

    8. Click OK.

Configuring Post Archiving Rules

You can decide if the file has to stubbed or deleted after an archive job using the following methods:

Replace the File with a Stub

After an archive job, the files can be replaced with a stub by enabling the following option:

  1. From the CommCell Console, navigate to Client Computers | File System.
  2. In the right pane right-click the Subclient and click Properties.
  3. Select the Disk Cleanup tab.
  4. Select Replace the File with a Stub.
  5. Click OK.

Delete the File

After an archive job, the files can be deleted from the source by enabling this option. When you enable this option, disable Check for Deleted Stubs check box before you start a synthetic full backup. See Configuring a Check for Deleted or Moved Files to disable this option.

  1. From the CommCell Console, navigate to Client Computers | File System.
  2. In the right pane right-click the Subclient and click Properties.
  3. Select the Disk Cleanup tab.
  4. Select Delete the file.
  5. Click OK.

Configuring Retention Criteria

You can configure the options that define how OnePass for Windows File System retains items. This topic describes how to enable retention. For descriptions of the all the retention options, see Retention Options for OnePass.

Retention options, which you define at the subclient level, determine when storage policy retention begins for archived items and deleted items. You can retain items immediately, or you can begin retaining items after a delay. Before the items are retained, users can browse and restore items from the most recent backup cycle. Synthetic full backup operations manage the application of subclient retention options.

Items on the client computer are deleted by a user or by an archive job. To delete the items by using an archive job, enable the Delete the file option on the Disk Cleanup tab. See Delete the file for more information.

If a file or a stub is not found in an incremental backup because it was deleted, moved, or renamed, then the file or stub is treated as a deleted item.

Items that are moved from one subclient to another are also considered deleted items and the subclient retention options apply to those items as well.

Items that are retained by subclient retention are carried forward in backup storage by synthetic full backup operations. When you run the synthetic full backup operation at the end of a specified retention period, the deleted items are not carried forward for retention.

Before You Begin

  • After the retention period for items is completed, the items are aged. For more information about data aging, see Data Aging-Overview and Data Aging - Getting Started.
  • Make sure that the CommServe computer and MediaAgent computer have Commvault version 11 Service Pack 7 installed.

Procedure

  1. From the CommCell Browser, expand Client Computers > client > File System > backup_set.
  2. Right-click the subclient for which you want to modify retention options, and then click Properties.

    The Subclient Properties dialog box appears.

  3. Click Advanced.

    The Advanced Subclient Properties dialog box appears.

  4. On the Retention tab, specify the retention criteria, select the Extend storage policy retention check box. For more information about the retention options see Retention Options for OnePass.

    Note: If you are upgrading from the previous version to the current version, see Transitioning from a Previous Version to the Current Version.

  5. Click OK.

Delayed Stubbing

Delayed stubbing prevents data loss in the event that you must perform a disaster recovery (DR) restore. Without delayed stubbing, when you perform a DR restore, recalls might fail for files that were backed up after the DR backup that is selected to be restored. By delaying stubbing, you can roll back to a previous CommServe DR version (within the minimum DR backups setting) without any data loss.

Stubbing is delayed by the number of DR backups plus the number of days that must pass after a DR backup. By default, this is set to three (3) DR backups + two (2) days.

Delayed stubbing is disabled on a client when the agent is installed initially and remains disabled until seven (7) days after the first backup job is run on the client. After those seven days have passed, delayed stubbing automatically becomes enabled using the default value of three DR backups plus two days. The default value is the minimum recommended value for effective data loss prevention. However, you can change the number of DR backups and the number of days to delay the stubbing process by configuring the nMinDRBackupBeforeStubbing (DR backups) and nMinDaysBeforeStubbing (days passed) additional settings at the CommServe level.

About This Task

Consider the following when you use synthetic full backups:

  • Synthetic full backup jobs must be run less frequently than the DR backup jobs.
  • Retention of the DR backup job must be longer than the frequency of the synthetic full backup job schedule.
  • The time interval between the synthetic full backup jobs must be greater than the maximum value of (m*x, n).

    where m and n are nMinDRBackupBeforeStubbing and nMinDaysBeforeStubbing additional setting values respectively, and x is the DR backup frequency in days.

  • Each time a synthetic full backup job is run, the count for the number of DR backups and the number of days to delay the stubbing process is reset to additional setting values. If the additional settings are not present on the CommServe computer, then the count for the number of DR backups and the number of days to delay the stubbing process is reset to the default values of three and two respectively.

Notes:

  • If the nMinDRBackupBeforeStubbing additional setting is not present (null) at the CommServe level, then stubbing is delayed by three DR backups.
  • If the nMinDaysBeforeStubbing additional setting is not present (null) at the CommServe level, then stubbing is delayed by two days.
  • Both the additional settings are required for delayed stubbing. To disable delayed stubbing, set the value of both additional settings to 0.

Procedure

Modify the number of DR backups to run before the stubbing process:

  1. From the CommCell Console, right-click the CommServe, and then click Properties.

    The CommCell Properties dialog box appears.

  2. Click the Additional Settings tab.
  3. Click Add.

    The Add Additional Settings dialog box appears.

  4. In the Name box, type nMinDRBackupBeforeStubbing.
  5. In the Value box, type the number_of_DR_backups_to_delay_stubbing_after_backup.
  6. Click OK.

Modify the number of days to delay the stubbing process:

  1. From the CommCell Console, right-click the CommServe, and then click Properties.

    The CommCell Properties dialog box appears.

  2. Click the Additional Settings tab.
  3. Click Add.

    The Add Additional Settings dialog box appears.

  4. In the Name box, type nMinDaysBeforeStubbing.
  5. In the Value box, type the number_of_days_to_delay_stubbing_after_backup.
  6. Click OK.

Example

To delay the stubbing process for 7 DR backups and 3 days, configure the settings as follows:

  • nMinDRBackupBeforeStubbing = 7
  • nMinDaysBeforeStubbing = 3

The delayed stubbing process involves two steps:

  1. Find a DR backup that meets the requirement of 3 days, and greater than or equal to the 7th DR backup (counting from the latest DR job to the oldest DR job).
  2. Any file that is backed up before the start time of the DR backup determined in the previous step will become eligible for stubbing.

Configuring Days-Based Retention for Archived Data

Important: This topic does not apply to new clients on Commvault version 11 software. If you still want to configure days-based retention for your subclient, select the Archiver Retention check box on the Retention tab of the Subclient Properties dialog box. If you upgrade the client from the previous version, and the client still operates on indexing version 1, then complete the procedure below.

You can archive data to tape libraries. Archived data is retained based on the archiver retention days configured on the storage policy copy instead of days- or cycles-based retention.

You can enable days-based retention either at the agent or subclient level, but not both.

When you enable days-based retention at the agent level, all the OnePass subclients under the agent honor days-based retention.

When you enable days-based retention at the subclient level, only those OnePass subclients for which you have enabled days-based retention honor days-based retention. In the same backup set, you can also have OnePass subclients without days-based retention enabled.

For instructions on transitioning to enable days-based retention at the subclient level, see Transitioning from Enabling Days-Based Retention at the Agent Level to the Subclient Level.

Note: Review these important considerations before you enable days-based retention:

  • Synthetic full backups are not supported with this option. Do not configure full or synthetic full backup schedules; only incremental backup schedules are honored.
  • An archive capacity license is consumed when you perform full and incremental backups. The data aging job ages data that meets the archiver retention criteria of the storage policy and releases the capacity license.
  • If you are performing a restore operation by selecting the Restore data instead of stub option, enable the Skip errors and continue option in the Advance Restore Options dialog box. When you enable this option, data is restored for files with valid data version and stubs are restored for files whose data version is aged.

About This Task

  • A new index cycle is automatically created  each year when you enable the Honor Archiver Retention option.
  • The Honor Archiver Retention option does not support mask-based erase, user and group quota restores, end-user erase, and carry forward n versions of files options.

Before You Begin

Procedure

  1. From the CommCell Browser, expand Client Computers > client.
  2. Do one of the following operations:
    Expand All

    To configure days-based retention at the agent level

    1. Right-click File System, and then click Properties.

      The File System Properties dialog box appears.

    2. Select the Honor Archiver Retention check box.

      Restriction: You cannot disable the option later.

      Notes:

      • The stubs created on the disk are retained until the media is pruned. To prune stubs based on access time or modified time, see Stub Pruning feature for more information.
      • In the case of classic archiver stubs, to enable stub pruning when the media is pruned, you must set the nAllowArchiverStubPruning additional setting to 1 on the client computer. For instructions on adding the additional setting, see Add or Modify an Additional Setting.
      • OnePass for Windows does not support CommCell Migration. If you have the CommCellMapping additional setting on the client computer, media-based stub pruning operations are disabled for the stubs.
    3. Click OK.

    To configure days-based retention at the subclient level

    1. Right-click the subclient for which you want to enable days-based retention, and then click Properties.

      The Subclient Properties dialog box appears.

    2. Click Advanced.

      The Advanced Subclient Properties dialog box appears.

    3. On the Retention tab, select the Honor Archiver Retention check box.

      Restriction: This option is available only if you have not run a synthetic full job on the subclient.

      Note: The stubs that are created on the disk are retained until the media is pruned.

    4. Click OK.
  3. Back up files and folders that satisfy the archiving rules:
    1. From the CommCell Browser, expand File System > backup set.
    2. Right-click the subclient, and then click Properties.

      The Subclient Properties dialog box appears.

    3. On the Content tab, select the Only backup files that qualify for archiving check box.
    4. Click OK.
  4. Set the index retention time:
    1. From the CommCell Browser, expand Storage Resources > MediaAgents.
    2. Right-click the MediaAgent for the subclient, and then click Properties.

      The MediaAgent Properties dialog box appears.

    3. On the Catalog tab, in the Retain Index for n days box, change the value to twice the number of days as the archive job.

      Note: To prevent the index from expiring, you must set the value to twice the number days as the archive job, unless the schedules are stopped.

      For example, if you scheduled the archive job to run every 7 days and set Retain Index for n days to 15, the index will be updated every 7 days.

    4. Click OK.

Pruning Stubs Based On File Access Time, File Modified Time, or Stub Creation Time

You can prune stubs from the source disk using either of the following methods:

  • You can use the Stub Pruning feature to prune the stubs from the source disk based on the access time of the file, modified time of the file, or the creation time of stubs (time at which the file was archived).
  • For stubs created using Classic Archiver, the stubs on the source disk are pruned automatically when the media is pruned.

About This Task

Stubs are pruned from the source disk based on the File Access time, File Modification time, or Stub Creation time (time at which the file is archived) even if the data associated with the stub resides on the media.

When the stubs are pruned from the source disk, you can continue to restore the associated files. When the subclient retention and storage policy retention criteria are met, the data associated with the stubs are pruned from the media thereby reclaiming the secondary storage space.

Before You Begin

You must create the appropriate additional setting that enables the pruning of stubs.

  1. Create the bShowStubPruning additional setting on the CommServe computer and set the value to True.
  2. If you created stubs using the Classic Archiver Agent, on the proxy or client computer, create the nAllowArchiverStubPruning additional setting.

    For more information on creating the additional setting, see Add or Modify an Additional Setting.

Procedure

  1. From the CommCell Browser, expand Client Computers > client > File System > backup_set.
  2. Right-click the appropriate subclient and click Properties.
  3. In the Subclient Properties dialog box, click the Disk Cleanup tab.
  4. On the Disk Cleanup tab, select the Stub pruning check box. Choose how the stubs become eligible for pruning based on your requirement:
    • To prune the stubs that were not modified in the last specified number of days, in the Remove stubs with file modification time older than n days box, enter the number of days.
    • To prune the stubs that were not accessed in the last specified number of days, in the Remove stubs not accessed in previous n days box, enter the number of days.
    • To prune the stubs that were created before the last specified number of days, in the Remove stubs with stub creation time older than n days, enter the number of days.
  5. Click OK.

Example: Pruning Stubs by Using the File Access Time

You want to prune all stubs that were not accessed in the last 10 days. Accordingly, in the Remove stubs not accessed in previous n days box, enter the number of days as 10. When you run subsequent incremental backups, all stubs that were not accessed in the last 10 days are deleted from the source disk. However, these deleted stubs are still available in the media.

You can view and restore the deleted stubs during a browse and restore operation by selecting the Show Deleted Items check box. When a synthetic full backup is run, the deleted stubs that meet the subclient retention settings are dropped from the backup cycle. However, you can do a point-in-time restore to recover the data for the deleted stubs if the previous jobs are not pruned.

When a data aging job is run, the jobs in the older cycles will be pruned if they meet the storage policy retention. The data associated with the pruned stubs is pruned from the media.

When Stubs created using Classic Archiver Stubs created using OnePass
File Access time is set to 10 days Stubs that were not accessed in the last 10 days are pruned from the source disk. However, the data associated with the stub may still be available on the media for restore operations. Stubs that were not accessed in the last 10 days are pruned from the source disk.

Subsequent incremental backups will mark the stub as deleted. A synthetic full backup may drop the data from the backup cycle depending on the subclient retention settings.

When the storage policy copy retention criteria is met, the data associated with the stubs is also pruned from the media.

Media is pruned Stubs on the source disk are deleted.  

Retaining Additional Versions of a File during Synthetic Full Jobs

When you perform a synthetic full backup, you can retain older versions of your file, including the latest version. By default, only the latest version is retained.

  1. From the CommCell Browser, expand Client Computers > client > agent > backup_set.
  2. Right-click the subclient, and then click Properties.

    The Subclient Properties dialog box appears.

  3. Click Advanced.
  4. The Advanced Subclient Properties dialog box appears.
  5. On the Retention tab, in Older file versions area, select one of the following options:
    • Keep older versions for n years n months, and n days

      Type a value for the time period for which you want to retain the older versions of the file. All older versions whose modified time is less than the value you specify in the Keep older versions for box are retained by the synthetic full backup operation. You will see this option only if your client is configured to use Indexing V2.

    • Keep n versions

      Type a value for the number of older versions you want to retain, starting from the latest backup.

  6. Click OK.

Examples:

  • Keep n versions

    A file has n+2 versions. If the latest version does not meet the retention criteria and you run a synthetic full backup operation, then the latest n+1 versions will be retained.

  • Keep older versions for 30 days

    A file has 4 versions and the modified time (mtime) of the versions are as follows:

    • Version 1: mtime is 60 days
    • Version 2: mtime is 20 days
    • Version 3: mtime is 15 days
    • Version 4: mtime is 10 days

    In this scenario, when you run a synthetic full backup operation, only versions 2, 3, and 4 are retained.

Configuring a Check for Deleted or Moved Files

Applies to: Upgraded clients that use indexing version 1.

You can check for deleted or moved files or stubs that are moved outside the scope of the subclient content. The client computer is scanned for the deleted or moved stubs during a synthetic full backup.

Use the Check for deleted stubs option when:

  • A stub is moved from one location to another or is deleted.
  • If you have two or more copies of the archived data and you want to backup only the copy that resides on the disk. This reduces the size of synthetic full backup.

    If your CommCell environment uses capacity licenses, the reduced size of the synthetic full backup frees up the space for capacity license consumption.

Do not enable this option if you have selected Delete the file option in the Disk Cleanup tab of the Subclient Properties dialog box. If you select the Delete the file option, synthetic full backup will carry forward only the latest copy of the data on the disk.

Procedure

  1. From the CommCell Console, expand Client Computers > File System.
  2. Right-click the subclient and then click Backup.
  3. In the Backup Options dialog box, select the following:
    1. Synthetic Full as the backup type.
    2. Under Job Initiation, select Immediately.
    3. Click Advanced.
    4. In the Advanced Backup Options dialog box, select the Check for deleted stubs check box, and click OK.
  4. Click OK.

Example

A user adds a folder as the subclient content for an OnePass enabled subclient. Several files within the folder that meet the archiving rules are archived and stubbed. One of the files is moved to another folder outside the scope of the subclient content. The next incremental job runs, marks the missing stub as “deleted,” and the subclient retention clock starts. On the scheduled synthetic full job, the user enables the Check for deleted stubs option. When the synthetic full job is run, it will scan all local drives of the client computer looking for stubs. If the moved file is found, it is added to the synthetic full backup.

Configuring OneDrive On OnePass Subclients

You can back up and archive the data that resides on the OneDrive folder on your client computer. For instructions, see Configuring OneDrive On OnePass Subclients.

Backing Up Files That Meet the Archiving Rules

By default while running a backup, files and folders defined as the subclient content are backed up. However, you can also define the files to be backed up based on the archiving rules. It means that only files and folders that meet the archiving rules will be backed up.

Use the following steps to configure rule based backups:

  1. From the CommCell Console, navigate to Client Computers | File System | <backupSet>.
  2. In the right pane, right-click the Subclient and point to Properties.
  3. Select the Content tab and select Only backup files that qualify for archiving checkbox and click OK on the Warning dialog box.

  4. Right-click the Subclient and click Backup.
  5. Select Incremental as backup type and Immediate to run the job immediately.
  6. Click OK.
  7. Once the job is complete, view the details of the job from the backup history. Right-click the Subclient and select Backup History.
  8. Click OK.
  9. Right-click the job and select View backup items.

    Note that the files that satisfied the archiving rules have been backed up.

    If this option is unchecked, the next backup job will run as an incremental backup but will backup all the files.

Track Last Access Time

Last Access Time is an attribute of a file that gets updated when a file is accessed or selected. By default, the Last Access Time of a file is not updated on computers operating on Windows Vista 2007 or later.

OnePass uses the Last Access Time attribute to archive files based on their last accessed time. For more information, see File Access Time.

About This Task

  • If you have already configured the NtfsDisableLastAccessUpdate registry key on your client computer, the Track access time check box is enabled automatically after the first backup job is run.
  • If a file is accessed or selected after you perform a full backup, the file is included automatically in the next backup.
  • You cannot modify the VSS options, once Track access time option is selected. Use VSS for all files option will be used once Track access time option is enabled.

Before You Begin

To update the last access time of your file accurately, you must:

  • Enable the Track access time check box, or
  • Create the NtfsDisableLastAccessUpdate registry key on your client computer at the following location:

    HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem

    For more information, see NtfsDisableLastAccessUpdate.

Procedure

  1. From the CommCell Console, expand Client Computers > Client > File System.
  2. Right-click File System and click Properties.

    The File System Properties dialog box appears.

  3. In the File System Properties dialog box, click the Track access time check box.
  4. Click OK.

    The Track access time dialog box is displayed.

  5. Click Reboot Now or Reboot Later. Your client computer restarts and the access time setting takes effect.

Disable Restubbing

By default, recalled files that are not modified are not backed up again as a result of which the capacity license is consumption is reduced. However, the recalled files are archived if the file meets the archiving rules.

To disable restubbing, modify the GXHSMSERVICEONEPASSRESTUB additional setting on the client computer and set the value to N.

For instructions on modifying the additional setting, see Add or Modify an Additional Setting.

Configuring Filters

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

The platform specific files that are automatically filtered from archiving are:

  • *.dll
  • *.bat
  • *.exe
  • *.cur
  • *.ico
  • *.lnk

See Content, Filters, and Regular Expressions for comprehensive information on filtering data from backup.

Filtering Files from Archiving

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

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | Backup Set.
  2. Right-click the Subclient in the right pane and then click Properties.
  3. Click the Filters tab.
  4. Under Exclude these files/folders/patterns, click Browse.
  5. Click the file, folder, or directory that you want to exclude from backup operations and click Add.
  6. Optionally, click Add under Exclude these files/folders/patterns and type the path to files and folders that you want to exclude. You can also enter patterns of files or folders using wild cards.

    You cannot enter Escape sequence to specify the path or file name.

  7. Click Close.
  8. Click OK.

Configuring Exceptions to Filters

When you exclude files from an archive or backup operation, you can also provide exceptions to the data that you plan to exclude. For example, if you want to exclude  all the files in the /Ops directory except the Maintenance file, you can add a subclient filter to exclude the /Ops directory from being archived or backed up and also add a corresponding subclient filter to allow the Maintenance file to be archived or backed up.

  1. From the CommCell Console, navigate to Client Computers | File System | <BackupSet>.
  2. Right-click the <Subclient> and click Properties.
  3. Select the Filters tab.
  4. Click Add from the Except for these files/folders/patterns: group, and type the file/folder name.

    Alternatively, you can click Browse and select the file/folders.

    You can also enter patterns of files or folders using wild cards. You cannot enter Escape sequence to specify the path or file name.

  5. Click OK.

Check Archive Bit during Backups

Enabling this option specifies whether files are considered modified and therefore backed up based on either the state of the archive bit or the file modification time. In addition, the system resets the archive bit of every file it backs up. This option influences the way incremental backups are conducted for all backups within a subclient. Follow the steps give below to make sure that the stubs are included during incremental backups.

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | <BackupSet>.
  2. Right-click the Subclient and point to Properties.
  3. Click the Advanced Options tab.
  4. Make sure that the Check archive bit during backups check box is selected.
  5. Click OK.

Viewing Stub Data Size

Use the following steps to view total size of the data archived by a specific archive job:
  1. From the CommCell Console, navigate to Client Computers | <Client> | File System | defaultBackupSet.
  2. Right-click the <Subclient> and click Backup.
  3. Click OK.
  4. Once job is complete, right-click the <Subclient> and select Backup History.
  5. Click OK.
  6. Right-click the job and select View Job Details.
  7. Select the Details tab.
  8. Click OK.

Configuring Stub Recovery Parameters (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.
  1. From the CommCell Console, navigate to Client Computers | <Client>.
  2. Right-click File System.
  3. Select Properties.
  4. Click Stub Recovery Parameters.
  5. In the Maximum Stub Recovery box select a value.
  6. In the Time between recall to count as successive in seconds box select a value.
  7. In the Time to wait after maximum successive recalls limit is reached in seconds box select a value.
  8. Click OK.

    It might take some time for the changes to take effect. Restart the File Archiver services for it to take effect immediately.

Enhancing Recovery Performance

Several options are available for streamlining archive and recovery operations. Benefits include faster archive and recovery speed, reduced network bandwidth usage, and end-user computer resources. These options are described in the following sections.

Limit Persistent Pipeline Usage during Idle Recoveries

Open persistent pipelines reserve bandwidth for data transfer. In cases where recoveries become idle, it may be desirable to close these pipelines rather than keep them open with no data transfer occurring. By default the idle timeout is set for 24 hours. However, you can modify this time by using the additional setting nDMRSIDLETIMEOUT as follows:

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the <Client> and then click Properties.

    The <Client> is the computer on which OnePass has been enabled.

  3. On the Client Computer Properties dialog box, click Advanced.
  4. Click the Additional Settings tab.
  5. Click Add.
  6. In the Name box, type nDMRSIDLETIMEOUT. The Category and Type details will be automatically populated.

    Alternatively, you can click Lookup and search for the additional setting using the Find box.

  7. In the Value field, enter the number of seconds after which the pipeline will close. The valid range is 0 to 2,147,483,647 seconds.
  8. Click OK.
  9. Restart the services on the client computer.

Limit the Number of Persistent Pipelines during Recoveries

You can increase the number of persistent pipelines allowed for recoveries, thereby potentially improving stub recall speed. However, increasing the number of persistent pipelines may impact overall computer performance. Thus, it is recommended this number be increased incrementally and performance monitored.

Ideally, the value will be the number of possible MediaAgents used for recoveries. For example, if you plan to use up to 4 MediaAgents for stub recalls, set the value to 4.

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the <Client> and then click Properties.

    The <Client> is the computer on which the OnePass feature has been enabled.

  3. On the Client Computer Properties dialog box, click Advanced.
  4. Click the Additional Settings tab.
  5. Click Add.
  6. n the Name box, type nDMRMaxRestoreThreads. The Category and Type details will be automatically populated.

    Alternatively, you can click Lookup and search for the additional setting using the Find box.

  7. In the Value field, enter the number of persistent pipelines to be allowed.
  8. Click OK.
  9. Restart the services on the client computer.

Modifying an Agent, Backup Set or Subclient

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

Option Description Related Topics
Preserving the File Access Time This option allows you to prevent the file access time from being changed as a result of running data protection operations on the client. When this option is selected, the file access time will be preserved.
  1. From the CommCell Browser, right-click the subclient, and then click Properties.
  2. Click the Advanced Options tab.
  3. Select the Preserve File Access Time check box.
  4. Click OK.
 
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.

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | <Backup Set>
  2. Right-click the <user-defined Subclient> in the right pane, and then click Properties.
  3. Click the Storage Device tab.
  4. Select the Storage policy from the drop-down list.
  5. Click OK.
Refer to Storage Policies.
Rename a Backup Set or Subclient You can rename backup sets and subclients.

Renaming BackupSet:

  1. From the CommCell Bowser, navigate to Client Computers | <Client> | File System.
  2. Right-click the <Backup Set>, and then click Properties.
  3. In the Backup Set box, type a name.
  4. Click OK.

Renaming subclient:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | <Backup Set>.
  2. Right-click the <user-defined Subclient>, and then click Properties.
  3. In the Subclient Name box, type a name.
  4. Click OK.
 
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.

  1. From the CommCell Browser, expand Client Computers > client > File System > backup_set.
  2. Right-click the subclient and click Properties.

    The Subclient Properties dialog box appears.

  3. On the Storage Device tab, click the Data Transfer Option sub-tab and choose the appropriate software compression option for this subclient.
  4. Click Advanced.

    The Advanced Subclient Properties dialog box appears.

  5. On the Performance tab, select the Throttle Network Bandwidth (MB/HR) check box, enter the throughput limit, and then click OK. The Commvault software throttles the transfer on a per-network-agent basis.
  6. 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.
  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | Backup Set.
  2. Right-click the <Subclient> in the right pane, and then click Properties.
  1. Click the Storage Device tab.
  2. In the Storage Policy list, click a storage policy name.
  3. Click Data Paths.
 
Configure Activity Control You can enable backup and restore operations from the agent and subclient level. However, you can enable restore operations only from the agent level.
  1. From the CommCell Browser, navigate to Client Computers | <Client>
  2. Right-click the <Client> or <Subclient> in the right pane, and then click Properties.
  3. Click the Activity Control tab and select or clear option(s) as desired.
  4. Click OK.
Refer to Activity Control.
Configure User Security You can create a security association from the agent or subclient level. For instructions on creating a security association at the agent or subclient level, see Administering the Security Associations of an Entity. Refer to User Administration and Security.
Enable and Disable Data Encryption 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.
  1. From the CommCell browser, navigate to Client Computers | <Client> | File System | <Backup Set>
  2. Right-click the <Subclient> in the right pane, and then click Properties.
  3. Click the Encryption tab and select the desired encryption.
  4. 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.
  1. From the CommCell Browser, navigate to Client Computers
  2. Right-click the <Client> for which you want to view the version and the click Properties.
  3. Click the Version tab.
  4. Click OK.
 
CommCell Configuration Report The CommCell Configuration Report provides the properties of the CommServe, MediaAgents, clients, agents, subclients, and storage policies within the CommCell based on the selected filter criteria.
  1. On the CommCell Console menu bar, select the Reports tab.
  2. Click Configuration.

    The Report Selection dialog box appears.

  3. Click Run.
Refer to CommCell Configuration.

Deleting an Agent, Backup 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 Policiesfor 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.
  1. From the CommCell Browser, navigate to Client Computers | <Client>.
  2. Right-click the <Agent>, and then click Delete.
  3. 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.

  4. Click OK to continue with the deletion operation or click No to abort the deletion.

Deleting a Backup 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.
  1. From the CommCell Browser, navigate to Client Computers | <Client> | <Agent>.
  2. Right-click the <Backup Set>, and then click Delete.
  3. 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.
  1. From the CommCell Browser, navigate to Client Computers | <Client> | <Agent> | <Backup Set>.
  2. Right-click the <subclient> that you want to delete, and then click Delete.
  3. 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.

Configure a Client Computer after a Hardware Refresh

Hardware refresh is the process of moving the hardware on an existing computer to a new hardware. If you have File Archiver Agent installed on your client computer and the client computer undergoes a hardware refresh, follow the configuration steps to configure your new client.

Pre-Hardware Refresh Process

  1. Install the Windows File System iDataAgent on the client computer and make sure that it resides in the same CommCell Console.
  2. Create a new subclient:
    1. Right-click the <backupset>, point to All Tasks and then click New Subclient. The Subclient Properties dialog box appears.
    2. Click the Content tab and then click Browse. Add the data and the stubs (created by the File Archiver) that you want to backup.
    3. Click the Storage Device tab and select an existing storage policy, and then click OK.
    4. Right-click the <Subclient>, and then click Backup.
    5. In the Backup Options dialog box, click Full, and then click OK.

After the backup completes, the stubs created by the File Archiver Agent are backed up.

Post-Hardware Refresh Process

  1. After the hardware refresh, install the latest version of Windows File System iDataAgent and Driver for File Recalls on the new client computer. We recommend that you use the same client name when you perform the installation.
  2. Make sure that the new client computer resides in the same CommCell Console.
  3. Open the CommCell console.
  4. The File Archiver Agent appears de-configured and a new File System Agent is created under the client.
  5. You can create a new subclient to backup and archive your data.
    1. Right-click the newly added File System iDataAgent and point to Properties.
    2. In the File System Properties dialog box, click the General tab and verify if the Enable for Archiving check box is selected.
    3. In the Confirm dialog box, click No, and then click OK.
    4. Right-click the <backupset>, point to All Tasks and then click New Subclient. The Subclient Properties dialog box appears.
    5. Select the Enable OnePass check box.
    6. Click the Content tab and then click Browse. Add the files or folders that you want to backup.
    7. Click the Disk Cleanup tab, and select Enable archiving with these rules check box.
    8. To archive your files immediately, set the rules accordingly based on File Access time, File Modified time or File Size.
    9. Click the Storage Device tab and select an existing storage policy.

To recall File Archiver stubs (created by the old client computer) using the new client computer, follow the steps:

  1. Open the CommCell console.
  2. In the CommCell Browser, click the <client_computer>, and perform an in-place restore of the File Archiver stubs (that was backed up) to the new client computer.
  3. Double-click the stubs.

If you have multiple indexes of the File Archiver stubs, you can recall the stubs that are created with the latest index. To recall stubs created with the older index, create nDMRSSkipEraseCheck additional setting on your proxy computer with the value 1. For instructions on adding the additional setting from the CommCell Console, see Add or Modify an Additional Setting.

Switching from an Old Client Computer to a New Client Computer

If you have File Archiver for Windows installed on your old client computer and you plan to switch to a new client computer, follow the steps:

  1. Install the latest version of Windows File System iDataAgent and Driver for File Recalls on the new client computer.
  2. Open the CommCell console.
  3. In the CommCell Browser, click the <old_client_computer>, and click the <subclient> whose stubs you want to recall.
  4. Right-click the <subclient>  and then click Browse and Restore.
  5. In the Browse and Restore options dialog box, select the Time Range.
  6. Under Absolute Time do the following:
    • Select Start Time and enter a date and time.
    • Select End Time and enter a date and time.

    Data in between the time specified here will be browsed.

  7. Click View Content.
  8. Select the folder level containing the stubs to be restored under the <backupset>. Entire content is automatically selected in the right pane.

    Click Recover All Selected.

  9. In the Restore Options dialog box,
    1. Select the name of the new computer from the Destination Client list drop-down box.
    2. Based on the type of client, perform one of the following actions:
      • If you are switching from a OnePass client, clear the Restore data instead of stub check box .
      • If you are switching from a File Archiver client, no action is required.
    3. Clear the Recover to same folder check box and in the Specify destination path box, enter the UNC path to which you want the files to be restored.
    4. Select one of the following options:
      • Preserve <n> level from end of source path - Select this option and enter the number of levels. The specified levels of folders from the end of source path will be restored in the destination folder.

      For Example: If the selected data is Documents\Memos\Sales, this option is set to 1 and the Destination folder is temp, the data will be restored as \temp\Sales.

      • Remove <n> level from beginning of source path - Select this option and enter the number of levels. The specified levels of folders from the beginning of the source path will not be restored.

      For Example: If the selected data is Documents\Memos\Sales, this option is set to 2 and the Destination folder is temp, the data will be restored as \temp\Sales.

    5. Click OK.
  10. Once the restore process is complete, create the GXHSM_Use_FSAppType_ForFSDMRecalls additional setting on the new client computer with the value 1. After creating the additional setting, restart services on the new client computer.

    If you have multiple indexes of the File Archiver stubs, you can recall the stubs that are created with the latest index. To recall stubs created with the older index, create nDMRSSkipEraseCheck additional setting with the value 1 on your proxy computer. After creating the additional setting, restart services on the proxy computer. For instructions on adding the additional setting from the CommCell Console, see Add or Modify an Additional Setting.