V11 SP8
Loading...

Advanced Configuration - OnePass for UNIX File Systems

Table of Contents

User Defined Subclient

The default subclient has the root directory as the subclient content. Therefore a backup and the archive job run on the default subclient results in backing up the entire root directory. In order to run a backup and archive of selective data files, a user defined subclient with specific content can be created.

Follow the steps given below create a user defined subclient:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | defaultBackupSet.

    Right-click the defaultBackupSet and select All Tasks.

    Click New Subclient.

  1. Enter Subclient Name.

  1. Click the Content tab.

    Browse to the folder that has files to be backed up.

    Select the folder and click Add.

    Click Close.

    Important: When a symbolic link pointing to a file is specified as subclient content, the file itself is not stubbed.

    Do not create subclients configured for backup and archiving with overlapping content in the same backup set.

  1. Click the Storage Device tab.

    In the Storage Policy box, select the storage policy.

    Click OK.

    If you do not have Storage Policy created, follow the step given below to create a storage policy.

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.

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 get stubbed.

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

By default files that are less than or equal to the file system block size are skipped from archiving. To archive all the files follow the steps given below:

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the <Client> and then click Properties.
  3. Click Advanced and then click Additional Settings tab.
  4. Click Add.
  5. In the Name field, type sCXHSM_SKIP_FILES_SMALLER_THAN_FSBLOCK.

    The Category and Type fields are populated automatically.

  6. In the Value field, type N.
  7. Click OK.

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 | <Client> | File System | <Backup Set>.
  2. Right-click the Subclient and click Properties.
  3. Select the Disk Cleanup tab.
  4. Select the Enable Archiving with these rules check box.
  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 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 | <Client> | File System | <Backup Set>.
  2. Right-click the Subclient and click Properties.
  3. Select the Disk Cleanup tab.
  4. Select the Enable Archiving with these rules check box.
  5. Enter the number of days elapsed since the file was last modified in the 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 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.

  1. From the CommCell Console, navigate to Client Computers | <Client> | File System | <Backup Set>.
  2. Right-click the Subclient and click Properties.
  3. Select the Disk Cleanup tab.
  4. Select the Enable Archiving with these rules check box.
  5. Enter the minimum file size in the File size greater than n KB box.
  6. Enter the maximum file size in the 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 more than 120KB but less than 500KB:

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

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

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 | <Client> | File System.
  2. Right-click <Subclient>, and then click Properties.
  3. Click the Disk Cleanup tab.
  4. Click 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.

Note: Archiving is supported on unsupported kernel versions with the ability to remove files from the disk after archiving, by selecting Delete the file option. When you enable Delete the file option, synthetic full backup jobs with Check for Deleted Stubs check box selected, are not supported. For more information, see KB Article UFSOP0003.

  1. From the CommCell Console, navigate to Client Computers | <Client> | File System.
  2. Right-click <Subclient>, and then click Properties.
  3. Click the Disk Cleanup tab.
  4. Click 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.

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

    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.

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.

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.

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 | <Client> | File System | <Backup Set>.
  2. In the right pane, right-click the Subclient and select Properties.
  3. Select the Content tab and select the Only backup files that qualify for archiving check box and click OK.

    When this option is selected, do not run an incremental job after the synthetic full backup job with Verify Synthetic Full option enabled.

  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.

Archiving Based on Access Time Rule using Native Snapshot

Backing up a file will cause the file access time to change to the time of the backup. This might have an undesired effect when you archive files based on the access time rule. To prevent the file access time from changing, you can enable the backup process to create a snapshot of the volume to be archived and then perform a backup of the snapshot copy.

The following client configurations are supported for creating native snapshots. The archive job will fail if the volume is not supported for creating native snapshots.

Software Storage Array
LVM on Linux
CXBF on Linux
LVM on AIX (jfs2)
CXBF on AIX
HP-UX (vxfs)
ZFS on Solaris
CXBF on Solaris

When you enable the Use native snapshot to preserve file access time option, the backup job will fail at the start of the scan phase if any of the subclient content paths are not valid.

Use the following steps to enable preserving of file access time when you want to archive files based on their access time:

  1. From the CommCell Browser, expand Client Computers > Client > File System > Backup Set.
  2. Right-click the Subclient and then click Properties.
  3. In the Subclient Properties dialog box, click the General tab.
  4. Select the Enable OnePass check box. You can perform only incremental and synthetic full backups after you enable this option. This option is automatically enabled and grayed out for existing OnePass subclients.  
  5. Click the Disk Cleanup tab.
  6. Select the Use native snapshot to preserve file access time check box.
  7. Click OK.

Snapshot Cleanup:

  • If the backup job fails during the scan phase or is suspended, the snapshots will be unmounted and deleted. If the snapshot has any open files or directories, the snapshot cannot be unmounted. In such cases, the snapshot will be cleaned up the next time a job is run for the subclient.
  • Snapshots will be unmounted and deleted if the jobs are suspended during the backup phase. The snapshots will be re-created when the backup job is resumed.
  • If the backup job crashes or ends abruptly, the leftover snapshots will be cleaned up during the scan phase the next time a job is run for the subclient.

For more information about the options not supported with the Use native snapshot to preserve file access time option, refer FAQ.

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.

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

  • AIX -  /**/*.imp, /**/*.exp
  • Darwin - /**/*.dylib,  /**/*.scpt,  /Applications/**,  /Developer/**,  /Library/**,  /Network/**,  /System/**,  /Volumes/**,  /private/**
  • Solaris - /platform/**
  • FreeBSD - /rescue/**

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 Console, navigate to Client Computers | <Client> | File System | <Backup Set>.
  2. Right-click the <Subclient> and click Properties.
  3. Select the Filters tab.
  4. Click Add from the Exclude 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.

Configuring Exclusions 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 from your migration archive operation 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 and also add a corresponding subclient filter to allow the Maintenance file to be archived.

  1. From the CommCell Console, navigate to Client Computers | <Client> | File System | <Backup Set>.
  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.

Additional Filters

You can specify additional filters for an archive operation like:

*.so
*.so.*
*.a
*.lib
*.sh
*.ksh
*.csh
/usr/**
/bin/**
/lib/**
/etc/**
/var/**

To specify additional filters:

  • On your client computer, add the sSTUB_PRUNE_PATTERNS additional setting with the value file_name_pattern. For example, *.sh *.ksh *.csh.

    For instructions on adding the additional setting from the CommCell Console, see Add or Modify an Additional Setting.

    Refer to the following table for applicable values:

    Property Value
    Name sSTUB_PRUNE_PATTERNS
    Category FileSystemAgent
    Type String
    Value  file_name_pattern

To set exceptions to the filters defined using the sSTUB_PRUNE_PATTERNS setting and the default filters:

  • On your client computer, add the sSTUB_PRUNE_EXCEPTIONS additional setting with the value file_name_pattern. For example, /var/log/abcd/**.

    Note: Multiple values can be specified using a space delimiter. To replace spaces within a user path, use */? wildcards

    For instructions on adding the additional setting from the CommCell Console, see Add or Modify an Additional Setting.

    Refer to the following table for applicable values:

    Property Value
    Name sSTUB_PRUNE_EXCEPTIONS
    Category FileSystemAgent
    Type String
    Value  file_name_pattern

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.

Deleting Empty Sub-Directories

When you run OnePass jobs, if Delete File option is selected at the subclient level, files that satisfy archiving rules will be archived and deleted but the resulting empty sub-directories are not deleted.

Use the following steps to delete such empty sub-directories in the subclient content:  

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the <Client> and then click Properties.
  3. Click Advanced and then click Additional Settings tab.
  4. Click Add.
  5. In the Name field, type DeleteEmptyFolderOnSystemDelete.

    The Category and Type fields are populated automatically.

  6. In the Value field, type Y.
  7. 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 nDMRSIDLETIMEOUT additional setting as follows:

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the <Client> and 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. On the Advanced Client Computer Properties dialog box, click the Additional Settings tab.
  5. Click Add.
  6. On the Add Additional Settings on Unix Client dialog box, perform the following:
    • 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.

    • In the Value box, enter the number of seconds after which the pipeline will close. The valid range is 0 to 2,147,483,647 seconds.
  7. Click OK.
  8. Click OK to save the setting.
  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 the stub recall speed. However, increasing the number of persistent pipelines may impact the 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 four MediaAgents for stub recalls, set the value to 4.

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

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

  3. On the Client Computer Properties dialog box, click Advanced.
  4. On the Advanced Client Computer Properties dialog box, click the Additional Settings tab.
  5. Click Add.
  6. On the Add Additional Settings on Unix Client dialog box, perform the following:
    • In 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.

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

Manage Archiver Stubs Using the CXFS Utility

You can manage archiver stubs using the CXFS command line utility. It is located under the <Commvault Base directory>, for example, /opt/commvault/Base/.

  • To Retrieve List of File Systems Being Monitored

    Syntax:

    cxfs_util -l|--list

    Retrieves the list of file systems being watched from the CXFS driver, and displays them along with the mount points.

    Example:

    [root@finite Base]# /opt/commvault/Base/cxfs_util -l
    /dev/mapper/imagedcvg-img5g6 /img5g6
    /dev/cxbf/cxbf5 /img5g5
    nfsd /proc/fs/nfsd
    sunrpc /var/lib/nfs/rpc_pipefs
    none /proc/sys/fs/binfmt_misc
    /dev/mapper/imagedcvg-image10gvol1 /image10gvol1
    /dev/sdb5 /MAVOL
    /dev/sda6 /turbovol
    tmpfs /dev/shm
    /dev/sda3 /opt
    devpts /dev/pts
    sysfs /sys
    proc /proc
    /dev/sda2 /

  • To Determine If the File is a Stub

    Syntax:

    cxfs_util -l|--list <filename>

    Determines whether the specified file is a stub, and if it is, reads metadata and original file size from it and presents this information.

    Example:

    [root@finite Base]# /opt/commvault/Base/cxfs_util -l /renametes/f1
    /renametes/f1 is NOT a stub

    [root@finite Base]# /opt/commvault/Base/cxfs_util -l /image250gbvol/largefile/cvd.log.1
    Meta: 1:1023496:7:2284:8678:2:32:41bce4cef1677c307f0f27bf3f5f9fa3:303:ACB04374-40AF-4C6E-A8E9-A1F1BE7AD357:5243145|1364302227
    Size: 5243145

  • To Start Watching a File System

    Syntax:

    cxfs_util --start <dir>

    Starts watching the file system corresponding to the specified directory.

    Example:

    /opt/commvault/Base/cxfs_util --start /img5r1/

  • To Stop Watching a File System

    Syntax:

    cxfs_util --stop <dir>

    Stops watching the file system corresponding to the specified directory.

    Example:

    /opt/commvault/Base/cxfs_util --stop /img5r1/

  • To Stub a File

    Syntax:

    cxfs_util -s|--stub <filename> <meta>

    Converts the specified file to a stub by writing specified metadata in it and telling the CXFS driver to watch for I/O requests.

  • To Unstub a File

    Syntax:

    cxfs_util -u|--unstub <filename> [<success>]

    Tells the CXFS driver that the specified file should be treated like a regular file rather than a stub. If <success> is equal to 1 or is missing, the I/O for all processes waiting for the file to become unstubbed will be resumed, and the stub will turn into a regular file.

    If <success> is equal to 0, all waiting processes will get an I/O error, and the file will remain to be a stub.

  • To Get the Next File Restore Request Details

    Syntax:

    cxfs_util -gnr|--get-next-request

    Gets the next restore request from the driver, displays the name of the file to be restored and metadata describing the location of the file's data on media. Note that this call will compete with ClMgs service, and the request returned will be removed from the driver's queue, so the ClMgs service will never get it, and the file will never get restored. If there is no request pending, the program will print the appropriate message and return immediately.

Configuring Archiving for X9000 IBRIX

For X9000 IBRIX file system, by default the stubs are recalled during the data tiering process, which moves the files and the data stubs from one storage tier to another based on pre-determined parameters. However, you can configure seamless migration of data stubs from one storage tier to another without triggering a stub recall using the following steps:

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the <Client> and then click Properties.
  3. Click Advanced and then click Additional Settings tab.
  4. Click Add.
  5. In the Name field, type sTranProcName.

    The Category and Type fields are populated automatically.

  6. In the Value field, type the process name used to migrate stubs from one storage tier to another. For example, migrator_daemon.

    On specifying this value the stubs will not be recalled during the data tiering process.

  7. Click OK.

    This setting requires a restart of client services.

Configuring Archiving for Lustre File System

Perform the following to configure archiving for Lustre File System:

  1. Mount the Lustre file system on all the nodes. By default the File Locks are not enabled for Lustre.

    In order to archive the files using the archiver agent, mount the file system with -o flock or localflock option.

    For example:

    [root@LustreClient01 ~]# mount –t lustre –o flock lustre192.168.0.10@tcp0:/lustre /mnt/lustre

  2. From the CommCell Browser, navigate to <Client> | File System.
  3. Right-click defaultBackupSet and then click All Tasks | New Subclient.
  4. In the General tab, enter Subclient Name.
  5. Click the Content tab.
  6. Click Add Paths to add the mount point created in Step 1 as the subclient content.
  7. Click the Storage Device tab.
  8. Select the Storage Policy from the drop down list.
  9. Click OK.

    Repeat the above mentioned procedure for all the nodes of the clustered file system.

Setting Up Stub Cache

After recalling the files, you can re-archive the recalled files by preserving them in a stub cache. The recalled file will be re-archived from the cache if the file meets the archiving rules and has not been modified after the recall. The following registry keys allow you to set the stub cache and re-stub the recalled files from the cache memory.

To configure a file to be re-stubbed after recall by preserving it in the cache memory:

  • On your client computer, add the nUSE_STUB_CACHE additional setting with the value Y.

    For instructions on adding the additional setting from the CommCell Console, see Add or Modify an Additional Setting.

    Refer to the following table for applicable values:

    Property Value
    Name nUSE_STUB_CACHE
    Category Machines\[Client]
    Type String
    Value  Y 

By default the stubs are cached under the jobResults/StubCache folder. To specify a different location of the root folder for the File Archiver stub cache:

  • On your client computer, add the dSTUB_CACHE_ROOT additional setting with the value new_folder_location. For example, /test/StubCache.

    For instructions on adding the additional setting from the CommCell Console, see Add or Modify an Additional Setting.

    Refer to the following table for applicable values:

    Property Value
    Name dSTUB_CACHE_ROOT
    Category Machines\[Client]
    Type String
    Value  new_folder_location

Reports

Archive Summary Report

The Archive Summary Report provides you with vital information, such as the compression rate and the space saved by archiving. Follow the steps given below to generate the report:
  1. From the CommCell Console, click Summary icon under the Reports menu.
  2. Navigate to Reports | Jobs | Archive Summary.
  3. Click Run.

    The generated report is displayed.

Sample Archive Summary Report:

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. Note that the ctime (changes in the file properties) is modified when you select this option though incremental backups do not honor it.
  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. In the Subclient Properties dialog box, click Advanced.
  4. In the Advanced Subclient Properties dialog box, click the Advanced Options tab.
  5. Click Recursive Scan in the Scan Using area.
  6. Select the Preserve File Access Time check box.
  7. Click OK.
 
Configuring Multiple Streams for Backups File System Multi-Streaming employs multiple data streams per subclient for data protection operations. This enables the subclient's contents to be distributed to all the streams, transmitting them in parallel to the storage media. Hence a subclient whose data is secured using three data streams, utilizes more of the available network resources, and can complete in as little as one third the time that the same data would require using a single stream.

Note that, you do not have to enable multi-streaming if you have multiple mount points pointing to the same physical drive.

Before enabling multi streaming, ensure that you can use multi-streaming when you restore the data and create an auxiliary copy. Restores by jobs use the same number of streams that you configure for the subclient. For more information on restoring by jobs, see Restore by Jobs.

Follow the steps given below to configure multi-streaming.

  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, 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.
  4. In the Advanced Subclient Properties dialog box, click the Performance tab.
  5. On the Performance tab, specify the number of data streams:
    1. Select the Allow multiple data readers within a drive or mount point check box
    2. Enter the number of data streams in the Number of Data Readers box.

      Important: The number of streams configured in the storage policy must be equal to or greater than the value entered in the Number of Data Readers box.

    3. Click OK.
  6. 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.

  7. 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. In the Subclient Properties dialog box, click Advanced.
  4. In the Advanced Subclient Properties dialog box, click the Encryption tab and select the desired encryption.
  5. 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 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.
  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 an 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.