Advanced Configuration - Windows File System iDataAgent

Table of Contents

Understanding the CommCell Console

Windows File System iDataAgent uses the following main components to perform backup and restore operations from the CommCell Console.

Backup Set - collective information about all the data that needs to be backed up for the client.

Subclient - defines the data to be backed up.

Creating an On-Demand Backup Set

On Demand backups allow content to be specified as an external input when initiating a backup. Whereas traditional backups are performed using subclients, which contain fixed content configured prior to performing the operation, On Demand backups allow you to specify content each time you perform a backup.

Content for On Demand backups is defined through two entities:

  • a Content File, which is a text file that defines the location of the data that you want to protect. Each Content File contains the fully qualified paths from the root directory to files, links, and devices to be backed up.
  • a Directive File, which is a text file that defines where each Content File is located. The Directive File contains the fully qualified paths from the root directory to one or more Content Files. Only one Directive File is needed for a single On Demand backup.

Once these entities are defined, an On Demand Backup Set is then created. Backups performed from this Backup Set will allow you to select the Content and Directive Files to be included.

Formatting Content and Directive Files

Content File entries should be in the following format:

\\client1\shares\ondemand_content\test1.txt

c:\data\datafile.txt

Similarly, Directive File entries should be in the following format:

c:\temp\ContentFile1.txt

Filters, wildcards, regular expressions and blank lines should not be included in Content or Directive files.

Configuring On-Demand Backups

Create one or more Content Files defining the content to be backed up.
  1. From the CommCell Browser, navigate to Client Computers | <Client>.
  2. Right-click the File System, point to All Tasks and then click New On Demand Backup Set.
  3. In the New Backup Set Name box, type a name (up to 32 characters).
  4. Click OK.

Create a Directive File defining the locations of each Content File.

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

Adding Files and Folders with Unicode Characters to Content Files

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

  1. Using a text editor, create a file that contains a list of files or folders with Unicode characters and save the file as a Unicode text file.
  2. From the command line, navigate to the <software install folder>/Base folder and type the following:

    ./CVconvertUnicode <source file> <destination file>

    where:

    • <source file> is the full path and name of the file created in Step 1.
    • <destination file> is the full path and name of the destination file. This file is automatically created by the utility.
  1. Use the destination file as the content file to perform an On-Demand backup.

Preventing Duplicate Backups of Files

On-Demand Backups explicitly back up the files listed in the Content File. If the Content file has two entries for the same file, the file will be backed up twice.

For example, consider a Content File that lists the following entries:

/usr/

/usr/textfile

In this scenario, the textfile folder will be backed up twice because the Content File also has an entry for the parent folder usr.

It is recommended that Content Files avoid such duplicate entries. If you are unable to avoid duplicate entries, use the following steps to prevent the duplication of data.

Configuring Content File to Exclude Duplicate Entries

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the <Client> on which you want to add the additional setting, and then click Properties.
  3. Click Advanced.
  4. Click the Additional Settings tab.
  5. Click Add.
  6. In the Name field, type OnDemand_AutoExpandDir.
  7. The Category and Type fields are populated automatically.
  8. In the Value field, type 0.
  9. Click OK.

Creating a Subclient to Back Up Specific Files

You can create an user defined subclient to manage and back up specific data files.

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | Backup Set.
  2. Right-click the Backup Set, point to All Tasks and then click New Subclient.
  3. In the Subclient Name box, type a name.
  4. Click the Storage Device tab.
  5. In the Storage Policy list, click a storage policy name.
  6. Click the Content tab.
  7. Click Browse.
  8. Select the directory or file to be backed up and click Add.

    Repeat this step to include all the files and directories to be backed up. You can also select Add Paths to enter the paths of the directories or files to be backed up. 

    NOTE: If you change the subclient content from "\" to a specific directory, the next backup job is a Full backup, irrespective of the backup type you selected.

  9. Click Close.
  10. Click OK.

You can also use wildcards to define the subclient content. The following table describes how to use wildcards while defining the subclient content:

If the subclient content consists of wildcard characters and no eligible files are found for backup, then the backup operation will complete successfully even though no files were backed up.

Wildcards

Description

Example

* Any number of characters

This wildcard is used in following scenarios:

  • Back up all files of a specific extension
  • Backup all files under a specific directory
  • Backup all files of a specific extension where the file name starts with a specific pattern.
*.doc will backup all files with the extension .doc (e.g., status.doc, mission.doc) on all drives on the client computer.

C:\Test\*.doc will backup all .doc files only in the C:\Test\directory

a*.dll will backup all files with the extension .dll (e.g., alsvc.dll, advdcc.dll) on the client computer which has the name beginning with the letter "a".

C:\Finance\Test\* will backup only the files in the "Test" folder under the "Finance" folder on the C drive. Any sub-folder under the "Test" folder will not be backed up.

** Any directory level. C:\**\move.cpp - the file named move.cpp located at any directory level under the c: drive. (e.g., c:\info\com\move.cpp)

C:\sys*\** - all folders and files under C drive that start with "sys" will be included. All the sub-folders and files under these folders will also be included.

? Any one character

This wildcard can be used to backup following files or folders:

All files (or folders) for which any one character in the file name or the folder name is variable.

access? will backup any folder/file on the C drive for which the name begins with- "access" followed by any one character such as access1 or access5. However, access12 or access15, for example will not backup because the last two characters in the name are variable. To backup access12 or access15, you must specify access?? in the subclient content.

Class?report will backup any folder/file for which the character in the place of ? is variable. For example: Class1report and Class2report will backup. However, Class15report will not get backed up.

[ ] Set or range of characters. C:\[a-m]*.doc backs up any file with .doc extension on the C drive for which the name begins with the letters "a" through "m”.

C:\[AEIOU]*.doc backs up any file name that ends with .doc and begins with the letters A, E, I, O, or U.

Numbers within square brackets are treated as single digits, and a dash between two digits indicates the complete range of numbers between those two digits.

For example,

test[1-5].txt backs up all files test1.txt, test2.txt, test3.txt, test4.txt, and test5.txt.

test1[0-9][0-9][0-9].txt backs up all files starting from test1000.txt to test1999.txt.

To back up files test 10 to test 39, enter test[1-3][0-9]. If you enter [10-39], it would back up test1, test0, test3, and test9.

If you want to treat [] as literal characters and not as wildcards, you must use a special syntax. This will be useful when you want to add a file which has [] in the file name. The special syntax allows you to define an escape character. Each character immediately following the escape character will then be treated literally and not as a wildcard.

For example: You want to backup a file with the name report[finance].doc on the C drive. In order for the square brackets to not be treated as wildcards, you must define an escape character. In the following example, the escape character is defined as the apostrophe (‘). The "e=" syntax is used to define the escape character. Since the square brackets are to be treated as literals, they both must be preceded by apostrophes. The content entry in the subclient should look like this:

<P:e='>C:\report'[finance'].doc

Any character can be used as the escape character, as long as it is defined after the “e=” in the syntax and it precedes any character that is to be treated as a literal.

In addition, the escape character can itself be used as a literal. This can be achieved by prefixing it with another escape character. To backup a file with the name Test[Report]’2011’Financials.doc on the C drive, the following syntax should be used:

<P:e=’>C:\Test’[Report’]’’2011’’Financials.doc

[ ! ] The negation of a set or range of characters. You can use the wildcard in following scenario:

Back up all files in a directory except the files for which the name starts with any character from the specified set or range of characters.

C:\Windows\[!AEIOU]*.doc would backup all .doc files in the C:\Windows directory that start with a letter other than A, E, I, O, or U.

Creating a Subclient to Back Up Predefined Content

The Content Library folder on any client will automatically collect frequently accessed data such as images, audio, video etc.You can select the required content category under the Content Library and add to the subclient content. The following predefined content categories are available:

  • Audio
  • Executable
  • Image
  • Office
  • System
  • Video

Use the following steps create a subclient to backup predefined content:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | Backup Set.
  2. Right-click the Backup Set, point to All Tasks and then click New Subclient.
  3. In the Subclient Name box, type a name.
  4. Click the Storage Device tab.
  5. In the Storage Policy list, click a storage policy name.
  6. Click the Content tab.
  7. Click Browse.
  8. Navigate to <Client> | Content Library.
  9. Click the desired file type.

    For example, click Audio to select all the audio files on a client.

  10. Click OK.

Creating a Subclient to Backup UNC Paths

A UNC path describes the location of a volume, directory, or file. You can add UNC paths as a content in a subclient.

Before adding UNC paths as a content in a subclient, make sure that the UNC path is from the same domain as that of the client's domain.

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | Backup Set.
  2. Right-click the Backup Set, point to All Tasks and then click New Subclient.
  3. In the Subclient Name box, type a name.
  4. Click the Storage Device tab.
  5. In the Storage Policy list, click a storage policy name.
  6. Click the Content tab.
  7. Click Add Paths and enter the UNC path of the files and directories that you want to backup.

    You can also use wildcards to define the content from a UNC path. Ensure that the UNC path starts with \\<Computer Name>\<Share>\ .

    For example: \\mycomputer.testdomain.com\C\*.doc  will backup all the .doc files from the C: drive of mycomputer in the testdomain domain.

  8. Click As User to provide user name and password required to access the UNC path.
  9. Click Close.
  10. Click OK.

    Tip: By giving valid credentials, if you are still unable to log on to the UNC path, create the ImpersonationMethod additional setting on the client computer and set its value to 2. The additional setting uses the LOGON32_LOGON_NEW_CREDENTIALS parameter, which retains the default process credentials for local operations and uses the specific credentials automatically for all external network access.

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

Using VSS for Backups

By default, the Windows File System iDataAgent will perform the backup from the live volume and not from the Snapshot of the volume.

Microsoft Volume Shadow Service is the default and only supported VSS software provider. The VSS software provider takes a snapshot of the source volume, database or file, which is then used to create backups.

You can use VSS as follows:

Use VSS to Back Up All Files

The action of backing up a file will cause the file access time to change to the time of the backup. This action may have an undesired effect on the application that utilizes file access time. For example: The Simpana OnePass archive files based on access times. In this situation, you can use a software snapshot to perform the backup of all the files.

Follow the steps given below to perform the file system backup using VSS:

  1. From the CommCell Console, navigate to Client Computers | File System | <Backupset>.
  2. Right-click the subclient and click Properties.
  3. Select the Use VSS for all files option from the Use VSS options.
  4. A software snapshot creation may fail if the VSS service is unavailable or it is unable to quiesce a volume. Select one of the following options to control the actions in such scenario:
    • Fail the job

      If you select this option the backup job will fail and not continue in the case where the software is unable to create the snapshot. Use this option, if you want to perform the backup using only the software snapshot.

    • Continue and reset access time

      If you select this option, the File System iDataAgent will perform the backup from the live volume . After backing up the file, the access time will be reset to its original time before the backup occurred. Use this option, if you are archiving files based on access time. Note that resetting the access time may slow down the backup operation.

    • Continue and do not reset access time

      This is the default option. The File System iDataAgent will perform the backup from the live volume. After backing up the file, the access time will NOT be reset to its original time. Use this option, if you are NOT archiving files based on access time.

  5. Click OK.

Use VSS to Back Up Locked Files

Some applications and system programs lock certain files while in use (open). Files that are locked are skipped during the backup job. The Windows File System iDataAgent automatically attempts to obtain any skipped files in the next backup job.

In some cases, it may be desirable to allow write operations on data being backed up to continue while the backup runs. In such a situation, you can backup using VSS for locked files and live volume for all other files.

Follow these steps given to enable VSS for backup of only the locked files:

  1. From the CommCell Console, navigate to Client Computers | File System | <Backupset>.
  2. Right-click the subclient and click Properties.
  3. Select the For locked files only option from the Use VSS options.
  4. Click OK.

When enabling VSS for the backup of files, keep in mind:

  • VSS can be enabled for backups of local volumes in both clustered and non-clustered environments.
  • VSS can only be enabled on NTFS and ReFS volumes and not on the FAT or FAT32 volumes. If the operating system fails to create a shadow copy of the data a traditional backup of the data will be performed, and a corresponding message will appear in the Event Viewer.
  • When you have enabled VSS for a subclient, the locked database files are backed up in an inconsistent state. You can filter the Exchange, SQL, and Oracle database files, by creating the FilterSqlExchOracleFiles additional setting on the client computer where you have installed the Windows File System iDataAgent. Note that you can filter Oracle database files only if your version of Oracle supports VSS. Follow the steps to create the additional setting:
    1. On the CommCell Browser, right-click the <Client>, and then click Properties.
    2. In the Client Computer Properties dialog box, click Advanced.
    3. In the Advanced Client Properties, click the Additional Settings tab, and click Add.
    4. In the Name box, type FilterSqlExchOracleFiles.
    5. In the Category box, type or select FileSystemAgent.
    6. In the Type box, type or select INTEGER.
    7. In the Value box, enter 1.
    8. Click OK and the additional setting appears in the list on Additional Settings tab.
    9. Click OK.
  • VSS is supported on all the Windows operating systems listed in the System Requirements, except Windows 2000.
  • If you have third-party snapshot providers available and you wish to use Microsoft VolSnap Software provider, add the nUseVSSSoftwareProvider additional setting on the client computer and set the DWORD value to 1.

Configuring File Level Information for a Subclient

File Level Analytics provides granular file level details of files in the backup. The granular details include information like:

  • The name and location of each file.
  • The size of each file.
  • The time at which it was last modified.
  • The time at which the file was last accessed. To update the Last Access Time attribute of files accurately, see Track Last Access Time.
  • The time at which the file was created.
  • The name of the primary user of the file.
  • The name of the primary user group of the file.

For detailed information on File Level Analytics see, File Level Analytics documentation.

Enable this option at the subclient level before performing a backup to collect information about files, volumes, and directories within the subclient being backed up.

Follow the steps given below to enable this option:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | <backupset>.
  2. Right-click the <Subclient> in the right pane and click Properties.
  3. Click the Advanced Options tab and select  Catalog additional file and system attributes.
  4. Click OK.

Managing Encryption Pass-Phrase

  • The Pass-Phrase feature is deprecated. For similar functionality, use Privacy.
  • Clients with existing Pass-Phrase configurations are supported.

Data encryption for backups can be enabled with a pass-phrase, which would be required for restoring the data.  The following sections describes the various operations related to the pass-phrase.

Setup Encryption Pass-Phrase

Data encryption keys can be protected with a pass-phrase before being stored in the database. The pass-phrase will be required for restoring the data.

If the database is accessed by unauthorized users, and the media is stolen, the data will still not be recoverable without the pass-phrase.

Use the following steps to enable the encryption pass-phrase:

  1. From the CommCell Console, right-click the Client and click Properties.
  2. From the Client Computer Properties for <client> dialog box, click Advanced button.
  3. From the Advanced Client Properties dialog box, select the following:
    1. Click the Encryption tab.
    2. Click the Encrypt Data check box.
    3. In the Cipher box, select the encryption algorithm.
    4. In the Key Length box, select a key length.
    5. From the Direct Media Access (External Restore Tools) area, click either the Via Pass-Phrase or the No Access option.
    6. From the Restore Access area, click the With a Pass Phrase option.

      A Warning message will be displayed. Click OK.

    7. In the Enter Pass-Phrase dialog box, specify the Pass-Phrase and click OK.
    8. Click OK to close the Advanced Client Properties dialog box.
  4. Click OK to close the Client Computer Properties for <client> dialog box.

Export an Encryption Pass-Phrase

You can export the file containing the scrambled pass-phrase.  This is useful for restore operations, especially scheduled restores, to complete successfully.

A <hostname>.pf file is copied to the <software installation path>\PF folders and is named for the source client.

Exporting the pass-phrase will also facilitate immediate restores, bypassing the need to enter the pass-phrase for each restore operation.

When using pass-phrase security for:
  • Migration Archiver Agents - you must export the pass-phrase to the destination client before you can run a Stub data recovery.
  • Image Level iDataAgents - you must export the pass-phrase to the MediaAgent as well as the destination client, since a portion of the volume information is restored to the MediaAgent Index Cache. When using Alternate Data Paths (GridStor), this would apply to any MediaAgent involved in the restore.
  1. From the CommCell Console, right-click the Client and click Properties.
  2. From the Client Computer Properties for <client> dialog box, click Advanced button.
  3. From the Advanced Client Properties dialog box, select the following:
    1. Click the Encryption tab.
    2. Click the Export button.
    3. In the Destination Computer, select the name of the destination client.
    4. Enter the pass-phrase and click Export.
  4. Click OK to close the Advanced Client Properties dialog box.
  5. Click OK to close the Client Computer Properties for <client> dialog box.

Reset a Pass-Phrase

Pass phrases can be changed using the reset option.

When a pass-phrase is reset, it can be used to recover data - both from the current and past backups. For example, if you ran a few encrypted backups with the pass-phrase set to “violet”, and then changed the pass-phrase to “purple”, you will need to enter “purple” when recovering that data. It works like this because pass-phrase is used to lock encryption keys rather than encrypt the data itself. When pass-phrase is modified, the keys are re-locked with the new pass-phrase.

  1. From the CommCell Console, right-click the Client and click Properties.
  2. From the Client Computer Properties for <client> dialog box, click Advanced button.
  3. From the Advanced Client Properties dialog box, select the following:
    1. Click the Encryption tab.
    2. Click the Reset button.
    3. Enter the old and new pass-phrase and then click the Reset button.
  4. Click OK to close the Advanced Client Properties dialog box.
  5. Click OK to close the Client Computer Properties for <client> dialog box.

Setup the Pass-Phrase for Synthetic Full Backups

Explicitly enabling synthetic full backups in the CommCell Console will create a copy of unlocked encryption keys in the database, which will be accessible only to synthetic full backup operations. In this case the regular restore operations will continue to prompt for a pass-phrase, but synthetic backups will not prompt for the pass-phrase.

  1. From the CommCell Console, right-click the Client and click Properties.
  2. From the Client Computer Properties for <client> dialog box, click Advanced button.
  3. From the Advanced Client Properties dialog box, select the following:
    1. Click the Encryption tab.
    2. Click the Encrypt Data check box.
    3. In the Cipher box, select the encryption algorithm.
    4. In the Key Length box, select a key length.
    5. From the Direct Media Access (External Restore Tools) area, click either the Via Pass-Phrase or the No Access option.
    6. From the Restore Access area, click the With a Pass Phrase option.

      A Warning message will be displayed. Click OK.

    7. Click the Enable Synthetic Full check box.
    8. In the Enter Pass-Phrase dialog box, specify the Pass-Phrase and click OK.
    9. Click OK to close the Advanced Client Properties dialog box.
  4. Click OK to close the Client Computer Properties for <client> dialog box.

Using QSnap to Back Up Locked Files

For Windows XP clients, you can use QSnap to perform the backup of locked files. Before you enable this option, install QSnap on the client. Follow the steps given below to use QSnap as a snap engine:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | Backupset.
  2. Right-click the <Subclient> in the right pane and then click Properties.
  3. Select Use QSnap to handle backup of locked files.
  4. Click OK.

You can ignore the file lock detection and backup the files with mandatory locks 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 select the Additional Settings tab.
  4. Click Add.
  5. In the Name field, type nOverrideVSSSnapSelection.
  6. In the Category list, select iDataAgent.
  7. In the Type list, select BOOLEAN.
  8. In the Value list, select true.
  9. Click OK.

Configuring System State Backups

You can configure subclients to back up the system state.

About this Task

  • You can have only one subclient within a backup set to back up the System State.
  • By default, System State data is backed up along with file system data by the default subclient during a Full backup. However,if you change the content of the default subclient, system state will not be backed up when a subsequent backup is performed. A message appears that says the Backup system state option will be disabled. To continue, click Yes.

    Note: Backing up the system state is essential for full system recovery, so consider your disaster recovery planning when you exclude the System State from the default subclient content.

  • You can also create a separate subclient to back up the System State.
  • By default, System State is backed up with a full backup.
  • System State components include the following components:
    • System File Protection catalog and files
    • Performance monitor configuration files
    • Active Directory
    • Quotas
    • SYSVOL (if this is a domain controller)
    • Certificate Services database (if this is a certificate server)
    • Cluster database (if this server is part of a cluster)
    • Registry
    • COM+ database
    • DHCP
    • WINS
    • IIS
    • UDDI (only with Windows Server 2003 using VSS)
    • Disk quota information
    • Event logs
    • RSM database
    • WMI database
    • Terminal Server Licensing database
    • Content Indexing catalogs
    • File Server Resource Manager (FSRM)
    • Network Policy Server (NPS)
    • Offline Files (only when the client computer does not have UEFI)

Before You Begin

  • Service user must be either an administrator or a backup operator to back up the System State.
  • You must have backup operator group permissions on HKLM\SYSTEM\SETUP key to back up system protected files.
  • VSS services are mandatory to perform System State backup if you are using Windows Vista or later versions.
  • You cannot perform System State backups on virtual nodes of a cluster.

Procedure

  1. From the CommCell Console, expand Client Computers > client > File System > backup_set.
  2. Right-click the subclient and click Properties.
  3. In the Subclient Properties dialog box:
    1. In the Subclient Name box, type the name of the subclient.
    2. On the Content tab, add the content to be backed up and select the Backup System State check box.

      By default, Only with Full Backup check box is selected. Clear this check box if you want to back up system state during incremental backups.

    3. On the Storage Device tab, in the Storage Policy list, click a storage policy name. To create a new storage policy, click Create Storage Policy and follow the instructions in the storage policy creation wizard.
    4. Click OK.

Result

  • The subclient created backs up the system state of the client computer.
  • System state data will be removed from all subsequent backups of the default subclient.

Configuring Backups for Recently Modified or Created Data

You can configure backups only for the data that has been modified or created after a specified date. This option is useful if you need to filter out data that was modified before a certain date.

Note the following before configuring backups for recently modified or created data.

  • After enabling the date option for an existing subclient if you do not run a full backup, the data filtered out based on date rule will be marked as deleted.
  • After moving the date forward for a configured subclient if you do not run a full backup, the data backed up by the previous jobs will be marked as deleted.
  • A full backup is mandatory after disabling the date option or after moving the date backward.
  • This option is applicable to file system backups and laptop backups only.
  1. From the CommCell Browser, navigate to the <CommServe>.
  2. Right-click the <CommServe>, and then click Properties.
  3. On the CommCell Properties dialog box, click the Additional Settings tab.
  4. Click Add.
  5. On the Add Additional Settings on Windows Client dialog box, perform the following:
    1. In the Name box, type bAllowBackupFilesCreatedOrModifiedOnAfter. The Category and Type details will be automatically populated.

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

    2. In the Value box, select  TRUE.
    3. Click OK.
  6. Click OK to close the CommCell Properties dialog box.
  7. Restart the CommCell Console.
  8. From the CommCell Browser, navigate to Client Computers | <Client> | File System | <Backup Set>.
  9. Right-click the <Subclient>, and then click Properties.
  10. On the Subclient Properties of <Subclient> dialog box, click the Content tab.
  11. Select the Only Backup files created or modified on and after check box.
  12. In the Time Zone box, select the time zone.
  13. In the Date box, type or select the date after which the data modified or created has to be backed up.
  14. Click OK.

Configuring Backups of Cluster Shared Volume

You can configure backup for a Windows Cluster such that the cluster shared volume is seamlessly backed up.

Before You Begin

  • Create a separate subclient for backing up the cluster shared volume.
  • You must use the Recursive scan method to back up the cluster shared volume.

Procedure

  1. From the CommCell Console, expand Client Computers > client > File System > backup_set.
  2. Right-click the backup_set, point to All Tasks, and then click New Subclient.
  3. In the Subclient Properties dialog box make the following selections:
    1. In the Subclient name box, enter the name of the subclient.
    2. Click the Content tab, click Browse, and then select the Cluster Storage directory. For example, select C:\ClusterStorage.
    3. Click the Storage Device tab and select a storage policy from the Storage Policy list. To create a new storage policy, click Create Storage Policy and follow the instructions in the storage policy creation wizard.
    4. Click the Advanced Options tab and then click Recursive Scan.
  4. Click OK.

Configuring Backup of Communication Server

You can use the File System iDataAgent to backup and restore the data on the Communication Servers. If the communication server is setup across multiple computers, you must install Windows File System iDataAgent on all computers.

Server

What Gets Backed Up

What Does Not Get Backed Up

Live Communications Server

Office Communication Server (OCS)

OCS data and settings OCS Metadata

 

Lync Frontend Server

Lync Backend Server

Lync Archiving Server

Lync Monitoring Server

Lync data and settings Lync Metadata

Response Group Configuration

Lync Metadata

Lync Archiving Database

Lync Monitoring Database

Use SQL Server iDataAgent to backup and restore these databases. For performing backup and restore of these databases refer to:

Enabling Communication Server Backup

Follow the steps given below to enable communication server backup using the Windows File System iDataAgent:

  1. From the CommCell Console, navigate to Client Computers.
  2. Right-click the File System and select Properties.
  3. In the General tab of the File System Properties dialog box, select the Enable Office Communication Server Backup check box.
  4. Click OK.

If the communication server is setup across multiple computers, enable communication server backup on all computers.

Configuring a Subclient for Communication Server

You can configure a default or a user defined subclient for OCS and Lync server. Follow the steps given below to configure a subclient for communication server:

  1. From the CommCell Console, navigate to Client Computers | File System | <Backup Set>.
  2. Right-click the subclient in the right pane and select Properties.
  3. In the Subclient Properties dialog box, click Content.
  4. Select the Backup Office Communication Server check box.

    The OCS or Lync Server credentials are displayed. If they are incorrect, click Edit to change the credentials.

    Enter the User Name and Password for OCS or Lync Server and click OK. The user must have read permissions on the Lync server.

  5. Click OK on the Subclient Properties dialog box.

Configuring Filters for Backups

Filters are used to exclude specific types 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.

Filtering Files from a Backup

Subclient-level backup filters are available to exclude specified directories and files from being backed up.

About this Task

  • You can use wildcards to filter files or folders with a pattern. For information on using wildcards, see Wildcards for Windows File System.
  • You can use regular expressions to filter files or folders. For more information, see Content, Filters, and Regular Expressions.
  • You can filter files and folders from a UNC path. Make sure that the UNC path starts with \\<Computer Name>\<Share>\ .

    For example: \\mycomputer.testlab.com\C\*.doc  will exclude all the .doc files from the C: drive of "mycomputer" in the "testlab" domain.

Procedure

  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, specify the following selections:
    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. On the Filters tab, under Exclude these files/folders/patterns, click Browse.

      Optional: Click Add under Exclude these files/folders/patterns and type the path to files and folders that you want to exclude.

    4. On the Storage Device tab, in the Storage Policy list, click a storage policy name. To create a new storage policy, click Create Storage Policy and follow the instructions in the storage policy creation wizard.
    5. Click OK.

Result

When you run a backup job, the file or folder added is excluded from the backup.

Examples

To Filter... Use...
All directories that begin with a particular word, for example My_Filter
  • *:\**\My_Filter*\** to filter from all drives. However, the My_Filter folder itself is not filtered and is included in the backup.
  • C:\**\My_Filter*\** to filter from drive C. However, the My_Filter itself folder is not filtered and is included in the backup.
Fixed USB disks <SF,UsbConnectedDrives>**\*
Recycle Bin Directories
  • <SF,RecycleBin *> to filter every Recycle Bin directory on all drives.
  • <SF,RecycleBin <drive_letter:>> to filter the Recycle Bin directory on a particular drive.
  • <SF,RecycleBin C:> to filter the Recycle Bin on drive C.
  • <SF,RecycleBin \\unc_path_name\share_name> to filter the Recycle Bin directory on a UNC path.
  • <SF,RecycleBin \\hfiler.domain.company.com\Share> to filter the Recycle Bin directory on hfiler.domain.company.com
a particular folder and the contained subfolders and files on a particular drive
  • *:\**\.CV_STAGING to filter all files and folders under CV_STAGING on any drive on the client computer. The CV_STAGING folder itself is also filtered.
  • C:\**\.CV_STAGING to filter all files and folders under CV_STAGING on drive C on the client computer. The CV_STAGING folder itself is also filtered.
all content that contains a special character
  • *:\**\*<special_character>*
  • C:\**\*~* to filter all files, folders, subfolders that has the tilde in the file or folder name. However, names of files and folders that begin with tilde are not filtered.
System Protected Files <BIF,-SystemProtectedFiles> to disable the SystemProtectedFiles filter.

You can disable the SystemProtectedFiles filter by adding the <BIF,-SystemProtectedFiles> entry in the subclient content or to the subclient's filter.

Temporary files
  • [!~]*.extension as an exception to the subclient content filters.
  • [!~]*.7z as an exception to filter all temporary files that start with tilde and have a .7z extension are filtered from the backup.

    All files that have a .7z extension and that do not start with a tilde are backed up.

Temporary directories
  • *:\**\temp\** to filter every directory named temp on all drives.
  • C:\**\temp\** to filter every directory named temp on drive C.
Existing snaps in a CIFS share
  • \**\~snapshot\***
  •  \**\.snapshot\***
  •  \**\~SNAPSHT\***

    Use this filter when the subclient content consists of UNC paths.

Page File C:\pagefile.sys

Filtering System State Components from a Backup

By default, the default subclient backs up the system state along with file system data. A system state backup is always a Full backup irrespective of whether you select Incremental or Differential backup. You can, however, filter out some components from system state backup.

Critical Components

Critical components are components that are essential and necessary for the operating system to come back alive after the restore of system state.

  • {Cluster Database}
  • {Registry}
  • {System Info Archive}
  • {System Protected Files}
  • {System Volume}

    You may filter critical system state components from a backup operation. However, you cannot restore the server to the state in which it was at the time of backup thereby leading to a incomplete restore of the server and system state.

Non-Critical Components

Non-Critical components are components that are part of system state but are not essential for the operating system to come back alive after the restore of system state.

  • {Active Directory Application Mode} (ADAM)
  • {BITS service}
  • {Certificate services}
  • {COM+ database}
  • {Content indexing catalogs}
  • {DDR explicit content}
  • {DFS replication services}
  • {DHCP}
  • {Disk quotas}
  • {Event logs}
  • {File Server Resource Manager} (FSRM)
  • {IIS}
  • {Metadata}
  • {NPS database}
  • {Offline files}
  • {One touch files}
  • {Remote storage database}
  • {RSM}
  • {Terminal Services Licensing}
  • {UDDI database}
  • {WMI database}
  • {WINS}

Procedure

  1. From the CommCell Console, expand Client Computers > client > File System > backup_set.
  2. Right-click the subclient and click Properties.
  3. In the Subclient Properties dialog box, specify the following selections:
    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 the Filters tab.
    4. On the Filters tab, click Add from the Exclude these files/folders/patterns group.
    5. Type the component to be filtered inside braces ({component}).

      For example:

      {IIS}
      {Content Indexing Catalogs}

    6. Click Add and then click OK.
    7. On the Storage Device tab, in the Storage Policy list, click a storage policy name. To create a new storage policy, click Create Storage Policy and follow the instructions in the storage policy creation wizard.
    8. Click OK.

Result

When you run a system state backup, the system state components added to the filters are not backed up.

Adding Exceptions to Filters

Once you set the filters, you can also provide exceptions for the filters. The files or folders added to the exception list will be included in the backup operations. For example, if you want to exclude from your back up 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 backed up and also provide an exception to allow the Maintenance file to be backed up.

You can add exceptions to filters. The files or folders added to the exception list are included in the next backup job.

For example, if you filter a folder from a backup, but you want to back up a particular file in that folder, you can add the file as an exception to the filter.

About this Task

  • You can use wildcards to to define exceptions to filters. The wildcards available for defining content of a subclient can be used for defining exceptions to filters.

    For information on using wildcards, see Wildcards for Windows File System.

  • You can filter files and folders from a UNC path. Make sure that the UNC path starts with \\<Computer Name>\<Share>\ .

    For example: \\mycomputer.testlab.com\C\*.doc  will exclude all the .doc files from the C: drive of "mycomputer" in the "testlab" domain.

Procedure

  1. From the CommCell Browser, expand Client Computers > client > File System > backup_set.
  2. Right-click the Subclient  and click Properties.
  3. In the Subclient Properties dialog box, specify the following selections:
    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 the Filters tab.
    4. On the Filters tab, under Except for these files/folders/patterns, click Browse.
    5. Click the file, folder, or directory that you want to include in the backups and then click Add.

      Otherwise, click Add and enter the paths of the directories or files which you want to backup. 

    6. Click OK.
    7. On the Storage Device tab, in the Storage Policy list, click a storage policy name. To create a new storage policy, click Create Storage Policy and follow the instructions in the storage policy creation wizard.
    8. Click OK.

Result

When you run a backup job, the file or folder added under Except for these files/folders/patterns is backed up.

Example

All the files within the C:\User folder are backed up. On the Filters tab under Exclude these files/folders/patterns, you add the asterisk (*) wildcard. The asterisk (*) wildcard filters all folders, subfolders and files within the User folder. When a backup runs, no files are backed up.

You now add the following under Except for these files/folders/patterns:

  • [!~]*.7z
  • [!~]*.7-zip

When a backup runs, all files within the User folder that start with tilde (~) and have .7z and .7-zip extensions are not included in the backup job.

However, all files that have .7z and .7-zip extensions and do not begin with tilde (~)  are included in the backup.

Excluding CommCell Console Directories from a Backup

You can use the nFilterGalaxyDirectories additional setting to exclude any of these directories from a backup operation.

About this Task

You can filter the following Simpana directories:

  • Software Installation directory
  • Index Cache directory
  • Job Control directory
  • Job Results directory

Procedure

  1. From the CommCell Browser, expand Client Computers.
  2. Right-click the client and click Properties.
  3. In the Client Computer Properties dialog box, click Advanced.
  4. In the Advanced Client Properties dialog box, click the Additional Settings tab.
  5. On the Additional Settings tab, click Add.

    The Add Additional Settings dialog box appears.

  6. In the Name box, type nFilterGalaxyDirectories.
  7. The Category and Type details populate automatically.
  8. In the Value box, type 1.
  9. Click OK.
  10. Click OK.

Result

When you run a backup, the CommCell Console Directories are not backed up.

Deleting Filters

You can delete a filter when the filters are no longer required.

Procedure

  1. From the CommCell Browser, expand Client Computers > client > File System > backup_set.
  2. Right-click the subclient and click Properties.
  3. In the Subclient Properties dialog box, click Advanced.
  4. In the Advanced Subclient Properties dialog box, click the Filters tab.
  5. On the Filters tab, under Exclude these files/folders/patterns, click on the filter that you want to delete.
  6. Click Delete and then click OK.
  7. Click OK.

Result

The files or folders added to the filter are included in the next backup.

Filtering Temporary Files from Backup

The Temporary Files folder automatically filters some temporary internet files, backup files, and recycle bin files. You can choose to filter these temporary files from your backup.

About this Task

  • You can filter the following temporary files:
    • **\.DS_Store
    •  **\thumbs.db
    • <SF,RecycleBin *>
    • <WKF,LocalAppData>\Temp
    • <WKF,TemporaryInternetFiles>
    • ~$*
  • You can use regular expressions to filter files or folders. For more information, see Content, Filters, and Regular Expressions.

Procedure

  1. From the CommCell Browser, expand Client Computers > client > File System > backup_set.
  2. Right-click the subclient and click Properties.
  3. In the Subclient Properties dialog box, specify the following selections:
    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 the Filters tab.
    4. On the Filters tab, click Browse.
    5. Go to Client > Temporary Files.
    6. In the File Extension list, click the file type you want to filter from your backup.

      For example, click ~$* to select all the temporary files stored on the client computer.

    7. Click Add and then click OK.
    8. On the Storage Device tab, in the Storage Policy list, click a storage policy name. To create a new storage policy, click Create Storage Policy and follow the instructions in the storage policy creation wizard.
    9. Click OK.

Result

When you run a backup, the temporary files are excluded from the backup.

Enabling ACLs (Access Control Lists) during Backups

During backups, the metadata information associated with the files is collected, stored in the backup index and is available for search/browse. By default, end-users can browse and search all the data backed up from a common resource like a shared laptop or file server. You can control the end-user access on such common resources by enabling access control on the client data.

When you enable access control on client data, the access control lists (ACLs) for the data are also included in the backup, which in turn, allow users to access only the files and folders for which they have access permissions. Other files and folders for which the user does not have permissions will be filtered and hidden during Find, Browse, Restore, and Erase Data operations.

Remember: This option is only available for users who log in with their Active Directory credentials.

Before You Begin

  • To view the user data, ensure that End User Access capability is configured on the client computer. For instructions, see Configuring End-User Operations on Client Computers.

    Assigning the End User Access capability helps maintain multiple user profiles on the same laptop (or desktop) and ensures that each user has the ability to access only the data for which the user has access permissions.

  • By default, you can access data backed up by the Default subclient on the Web Console. To browse user data backed up by non-default subclients on the Web Console, enable browse for non-default subclients. For instructions, see Enabling Data Browse from Non-Default Subclients.

To enable browse or search based on end-user access control, complete the following steps:

  1. From the CommCell Browser, expand Client Computers > Client > File System > Backup Set.
  2. Right-click the subclient and click Properties.
  3. Click the Advanced Options tab and select  Catalog ACL (end user access control list).
  4. Click OK.

After enabling access control, run a full backup on the subclient to include the ACLs in the backup data. Conversely, if you run a differential or incremental backup, only the newer data will include the ACLs.

Configuring the Scan Method for Detecting Changed Files

You can use one of the following scan methods to determine which files in a backup set have changed and/or have been backed up.

Configuring Change Journal Scan

Change Journal is selected as the method for scanning files to determine which files have changed and/or have been backed up. When you use the Change Journal scan method, the incremental backup will backup all the new or changed data since the last incremental or full backup.

  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 Advanced Options tab
  4. Select Change Journal.
  5. Click OK.

Refs file systems do not support Change Journal scan method. If you specify Change Journal scan, it would automatically convert to Recursive scan and run the backup operation successfully.

Configuring Recursive Scan

There are some instances in which the Recursive Scan is always used, including but not limited to:

  • When backing up FAT Volumes.
  • Files that reside in a volume configured to use Microsoft deduplication.

    In this situation, disable the Check archive bit during backups check box.

Follow the steps given below to configure Recursive Scan:

  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 Advanced Options tab.
  4. Select Recursive Scan.
  5. Select Preserve File Access Time. Enabling this option maintains the file access time during backups making sure that they are not modified at the time of backup. Selecting this option may however increase the time required to complete a backup.
  6. Select Check archive bit during backups. Enabling this option checks 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.
  7. Click OK.

Configuring Optimized Scan

By default, Optimized Scan is selected as the default method for scanning files to determine which files have changed and/or have been backed up. However Optimized Scan is the preferred method of scanning the files during a regular and SnapProtect Backup, as this method is much faster as compared to the Recursive Scan.

We recommend that you use Optimized Scan method for NTFS volumes but not for the FAT volumes.

  1. From the CommCell Console, navigate to <Client> | <Agent> | defaultBackupSet | Subclient.
  2. Right-click the Subclient and select Properties.
  3. Click Advanced Options.
  4. Click Optimized Scan.

Configuring Multi-thread Scan

Multi-thread scan uses multiple threads to scan the subclient content. Instead of scanning one folder at a time, multiple folders or sub-folders are scanned simultaneously.

TIP: When the subclient content consists of multiple folders at the same level and you find that the backups are slow, add a non-existent wildcard to the subclient content. For example, add *no_match to the subclient content. The wildcard *no_match must not match with any file or folder name.

For more information on adding wildcards to your subclient content, see Wildcards for Windows File System.

Before You Begin

  • The subclient content must be a UNC path or a local volume.
  • If the subclient content consists of a UNC path, the path must be exposed as a CIFS (Common Internet File System) share.

Procedure

To enable multi-thread scan for your subclient, create the MTScanThreads additional setting on your client computer.

  1. Log on to the CommCell Console.
  2. On the CommCell Browser, right-click the <client computer> and click Properties.
  3. Click Advanced.

    The Advanced Properties dialog box appears.

  4. Click the Additional Settings tab, and click Add.

    The Add Additional Settings dialog box appears.

  5. In the Name box, type MTScanThreads.
  6. In the Category box, select FileSystemAgent.
  7. In the Type box, select Integer.
  8. In the Value box, type 100.
  9. Click OK.

    The additional setting appears in the list on the Additional Settings tab.

  10. 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, navigate to Client Computers | <Client> | File System | Backup Set.
  2. Right-click the <Subclient> in the right pane and click Properties.
  3. In the Advanced Options tab,  type or select the number of data streams in the Number of Data Readers box.
  4. Select the Allow multiple data readers within a drive or mount point checkbox.
  5. Click OK.

The number of streams configured in the Storage Policy should be equal to, or greater than the specified Number of Data Readers .

Configuring Job Progress Based on the Amount of Data Transferred

The Job Controller progress bar displays the progress of backup and restore jobs based on the number of files processed, by default. Use the following steps to display the job progress based on the amount of data transferred.

  1. From the CommCell Console, navigate to Client Computers.
  2. Right-click the <Client>, and then click Properties.
  3. On the Client Computer Properties for <Client> dialog box, Click Advanced.
  4. On the Advanced Client Properties for <Client> dialog box, click the Additional Settings tab.
  5. Click Add.
  6. On the Add Additional Settings on Windows Client dialog box, perform the following:
    • In the Name box, type EnableJobProgressByBytes. The Category and Type details are automatically populated.

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

    • In the Value box, type  1.
    • Click OK.
  7. Click OK to close the Advanced Client Properties for <Client> dialog box.
  8. Click OK to close the Client Computer Properties for <Client> dialog box.

Configuring Deletion of Backed Up PST Files

You can choose to delete backed up PST files from your client computer if these files are not modified since the last backup.

Follow the steps given below to enable deletion of PST files.

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | Backup Set.
  2. Right-click the <Subclient> in the right pane and click Properties.
  3. In the Advanced Options tab, select the Delete protected PSTs check box.

Configuring Pre and Post Processing for Backups

Setting Up Pre and Post Processes

You can add and modify Pre/Post processes for a subclient. These are batch files or shell scripts that you can run before or after certain job phases. For example, you can use an echo command to check the level of a backup. Similarly, you can include a case statement within a script to run specific operations based on the level of the backup job.

A Save As Script file can also be run as a pre/post process, if you include the absolute path of the associated input file in the script file.

See Pre and Post Processes - Commands and Arguments for information on additional arguments that the CommServe sends to the Pre and Post processes.

  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 Pre/Post Process tab.
  4. Depending on the process you want to set up, click the corresponding Browse button.
  5. Select the process and then click OK.

Setting Up Post Processes to Run during Failures

By default, a specified post process command is executed only on successful completion of the scan or backup operation or if the job is killed.

Use the following steps to run a post process even if the scan or backup operation did not complete successfully. For example, this may be useful to bring a database online or release a snapshot.

  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 Pre/Post Process tab.
  4. Select  the Run Post Scan Process for all attempts check box.
  5. Select the Run Post Backup Process for all attempts check box.
  6. Click OK.

Configuring User Accounts

Users performing backups must be either an administrator or a backup operator. The LocalSystem Account is the default account used to backup all files. Backup operators (or Service Users) are designed to have full control to the registry and the installation folder.

Role Privileges
An administrator or a backup operator in a local group Able to back up any file and folder on the local computer to which the local group applies.
An administrator or backup operator on a domain controller Able to back up any file and folder on:
  • a computer in the domain
  • a computer in a domain where a two-way trust relationship exists

If you are not an administrator or backup operator, you must be the owner of the files and folders you want to back up or have one or more of the following permissions.

  • Read
  • Read and execute
  • Modify
  • Full Control

The following sections describe the procedures for modifying user permissions and rights.

Users can be configured at the server and domain control levels to perform backups using the following procedures:

Configuring Windows Users on an Individual Server

To add a user to the Backup Operators Group, perform the following steps on an individual server:

  1. Navigate to Start | Settings | Control Panel | Administrative Tools.
  2. Double-click Computer Management.
  3. Navigate to Local User and Groups | Users.
  4. Right-click the user who will be performing backups and click Member of.
  5. Add the Backup Operators group to the User.
  6. Click OK.
  7. Log off and log in as the domain controller Administrator for the policies to take effect.

Configuring Windows Users on a Domain Controller

To add a user to the Backup Operators Group, perform the following steps on the domain controller:

  1. Create or prepare to manage a Windows user who will run the services.
  2. Navigate to Active Directory Users | Computers | Users.
  3. Right-click the user who will be performing backups and click Member of.
  4. Add the Backup Operators group to the User.
  5. Click OK.
  6. Log off and log in as the domain controller Administrator for the policies to take effect.

Configuring Windows Users for Specific Folders

  1. Right-click the folder to be backed up and select Properties.
  2. Select the Security tab
  3. Enable Add Backup Operators with full control rights.
  4. Click OK.

Configuring Credentials for UNC Path Content

The user must have privileges to:

  • Access the share to which the UNC Path is pointing.
  • Log on to the client machine that is running the backup.
  • The logs on the client machine.

To perform backup or restore operations using a UNC Path as either the content of the subclient or the destination for a restore, the user account should have Administrative privileges.

Use the following steps to change the User Account for the UNC Path content:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | Agent.
  2. Right-click the <Subclient> and click Properties.
  3. Click Content tab.
  4. Click Add Paths and type in the UNC path of the share that you want to add.

    Repeat this step if you want to add more files and/or folders to the content.

  5. Click As User.
  6. Type the new user name in the User Name box.
  7. Type the new password in the Password box and retype it in the Confirm Password box.
  8. Click OK.

Configuring Credentials for Restricted Drives or Directories

You can define a user or an account with permissions to restore data to either mapped/shared network drives or directories to which you have no write privileges.

  1. From the CommCell Browser, right-click File System, click All Tasks, and then click Browse and Restore.
  2. From the Restore Options dialog box, click Advanced.
  3. Select Impersonate Windows User.
  4. Enter the appropriate user name and password.
  5. Click OK to save the settings.

Configuring Retention for Deleted Items

You can set up subclient retention settings, which determine when storage policy copy retention starts for deleted files. Storage policy copy retention can start immediately or be delayed for a specified period of time. Delaying the application of storage policy copy retention on deleted files allows you to browse and restore the deleted files from the latest backup cycle.

Synthetic full backups manage the application of subclient retention settings. Files that exceed the subclient retention criteria are not included in the next synthetic full backup.

About this Task

Consider the following guidelines or limitations:

  • Files that are moved from one subclient to another are also considered as deleted files and the subclient retention settings apply to those files as well.
  • By default, the deleted files will be retained for 730 days before the retention criteria for the associated storage policy is applied against the deleted files.
  • Files retained by subclient retention are carried forward in backup storage by synthetic full jobs. When you run the synthetic full backup at the end of specified retention period, the deleted files are no longer carried forward for retention.
  • If a full backup is run during the retention period, the deleted files may get removed earlier from the backup cycle.

Before You Begin

Review Data Aging-Overview and Data Aging - Getting Started before you set the retention for your subclient.

Procedure

By default, when any backed up file is deleted by a user, it will be retained for 730 days before the associated storage policy’s retention criteria is applied on the deleted files.

  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 Retention tab.
  4. On the Retention tab, specify the retention criteria:
    1. If you are upgrading from the previous version to the current version, see Transitioning from a Previous Version to the Current Version.
    2. To retain or drop files that are deleted on the client computer, see Retention Options for Deleted Files.
  5. Click OK.

From the Command Line Interface

Optionally, you can set the retention criteria using the command line interface as follows:
  1. Open the command prompt and go to installation_path\Base directory.
  2. Enter the QLogin.exe and type your user name and password.
  3. Execute one of the following commands based on your requirement:
    • To set the subclient retention to Immediately, execute the following command:

      qoperation execscript -sn SetRetentionForUserDeletedItems.sql -si '<ClientGroupName>' -si 'Immediately'

    • To set the subclient retention to After n days, execute the following command:

      qoperation execscript -sn SetRetentionForUserDeletedItems.sql -si '<ClientGroupName>' -si 'Days' -si '<number_of_days>'

      For example, to set the subclient retention to After 14 days, execute the following:

      qoperation execscript -sn SetRetentionForUserDeletedItems.sql -si '<ClientGroupName>' -si 'Days' -si '14'

    • To set the subclient retention to Never, execute the following command:

      qoperation execscript -sn SetRetentionForUserDeletedItems.sql -si '<ClientGroupName>' -si 'Never'

Retaining Additional Versions of a File during Synthetic Full Jobs

By default, synthetic full backups only keep the latest version of files.

Use the following procedure to retain additional versions of a file during a synthetic full backup:

  1. From the CommCell Browser, navigate to Client Computers | <Client> | <Agent> | <BackupSet>.
  2. Right-click the Subclient on the right pane, and then click Properties.
  3. Click the Retention tab.
  4. Select Keep at least and enter a value for the number of versions you want to maintain.
  5. Click OK.

Managing Encryption Pass-Phrase

  • The Pass-Phrase feature is deprecated. For similar functionality, use Privacy.
  • Clients with existing Pass-Phrase configurations are supported.

Data encryption for backups can be enabled with a pass-phrase, which would be required for restoring the data.  The following sections describes the various operations related to the pass-phrase.

Setup Encryption Pass-Phrase

Data encryption keys can be protected with a pass-phrase before being stored in the database. The pass-phrase will be required for restoring the data.

If the database is accessed by unauthorized users, and the media is stolen, the data will still not be recoverable without the pass-phrase.

Use the following steps to enable the encryption pass-phrase:

  1. From the CommCell Console, right-click the Client and click Properties.
  2. From the Client Computer Properties for <client> dialog box, click Advanced button.
  3. From the Advanced Client Properties dialog box, select the following:
    1. Click the Encryption tab.
    2. Click the Encrypt Data check box.
    3. In the Cipher box, select the encryption algorithm.
    4. In the Key Length box, select a key length.
    5. From the Direct Media Access (External Restore Tools) area, click either the Via Pass-Phrase or the No Access option.
    6. From the Restore Access area, click the With a Pass Phrase option.

      A Warning message will be displayed. Click OK.

    7. In the Enter Pass-Phrase dialog box, specify the Pass-Phrase and click OK.
    8. Click OK to close the Advanced Client Properties dialog box.
  4. Click OK to close the Client Computer Properties for <client> dialog box.

Export an Encryption Pass-Phrase

You can export the file containing the scrambled pass-phrase.  This is useful for restore operations, especially scheduled restores, to complete successfully.

A <hostname>.pf file is copied to the <software installation path>\PF folders and is named for the source client.

Exporting the pass-phrase will also facilitate immediate restores, bypassing the need to enter the pass-phrase for each restore operation.

When using pass-phrase security for:
  • Migration Archiver Agents - you must export the pass-phrase to the destination client before you can run a Stub data recovery.
  • Image Level iDataAgents - you must export the pass-phrase to the MediaAgent as well as the destination client, since a portion of the volume information is restored to the MediaAgent Index Cache. When using Alternate Data Paths (GridStor), this would apply to any MediaAgent involved in the restore.
  1. From the CommCell Console, right-click the Client and click Properties.
  2. From the Client Computer Properties for <client> dialog box, click Advanced button.
  3. From the Advanced Client Properties dialog box, select the following:
    1. Click the Encryption tab.
    2. Click the Export button.
    3. In the Destination Computer, select the name of the destination client.
    4. Enter the pass-phrase and click Export.
  4. Click OK to close the Advanced Client Properties dialog box.
  5. Click OK to close the Client Computer Properties for <client> dialog box.

Reset a Pass-Phrase

Pass phrases can be changed using the reset option.

When a pass-phrase is reset, it can be used to recover data - both from the current and past backups. For example, if you ran a few encrypted backups with the pass-phrase set to “violet”, and then changed the pass-phrase to “purple”, you will need to enter “purple” when recovering that data. It works like this because pass-phrase is used to lock encryption keys rather than encrypt the data itself. When pass-phrase is modified, the keys are re-locked with the new pass-phrase.

  1. From the CommCell Console, right-click the Client and click Properties.
  2. From the Client Computer Properties for <client> dialog box, click Advanced button.
  3. From the Advanced Client Properties dialog box, select the following:
    1. Click the Encryption tab.
    2. Click the Reset button.
    3. Enter the old and new pass-phrase and then click the Reset button.
  4. Click OK to close the Advanced Client Properties dialog box.
  5. Click OK to close the Client Computer Properties for <client> dialog box.

Setup the Pass-Phrase for Synthetic Full Backups

Explicitly enabling synthetic full backups in the CommCell Console will create a copy of unlocked encryption keys in the database, which will be accessible only to synthetic full backup operations. In this case the regular restore operations will continue to prompt for a pass-phrase, but synthetic backups will not prompt for the pass-phrase.

  1. From the CommCell Console, right-click the Client and click Properties.
  2. From the Client Computer Properties for <client> dialog box, click Advanced button.
  3. From the Advanced Client Properties dialog box, select the following:
    1. Click the Encryption tab.
    2. Click the Encrypt Data check box.
    3. In the Cipher box, select the encryption algorithm.
    4. In the Key Length box, select a key length.
    5. From the Direct Media Access (External Restore Tools) area, click either the Via Pass-Phrase or the No Access option.
    6. From the Restore Access area, click the With a Pass Phrase option.

      A Warning message will be displayed. Click OK.

    7. Click the Enable Synthetic Full check box.
    8. In the Enter Pass-Phrase dialog box, specify the Pass-Phrase and click OK.
    9. Click OK to close the Advanced Client Properties dialog box.
  4. Click OK to close the Client Computer Properties for <client> dialog box.

Configuring Backups for ACFS Data

See the Oracle FAQ's for more information.

Configuring the Additional Setting for ACFS Support

  1. On the CommCell Browser, expand Client Computers > client.
  2. Right-click the client on which you want to add the additional setting, and then click Properties.
  3. In the Client Computer Properties dialog box, click Advanced.
  4. In the Add Additional Settings dialog box, enter the details for the additional setting:
    1. In the Name box, type EnableRamDiskAndOracleACFSSupport.
    2. In the Category box, type or select Machines\[Client]\FileSystemAgent.
    3. In the Type box, select String.
    4. In the Value box, type 1.
    5. Click OK to close the Add Additional Settings dialog box.
  5. Click OK to close the CommServe Properties dialog box.

ACFS  Mount Point as File System Subclient Content

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System.
  2. Right-click the <defaultBackupset>, point to All Tasks and select New Subclient.
  3. On the General tab of the Creating New Subclient dialog box, type the name for the subclient in the Subclient Name box.
  4. On the Content tab of the Creating New Subclient dialog box, click Add Paths. Type the path to the ACFS mount point and then click OK.
  5. If needed, on the Pre/Post-Processing tab of the Creating New Subclient dialog box, type or select the path to the pre-processing script.  This is optional.
  6. On the Storage Device tab of the Creating New Subclient dialog box, select the storage policy name for the Data Storage Policy.
  7. Click OK.

ACFS Snapshot as File System Subclient Content

  1. Create a pre-process script to delete any existing ACFS snapshot and create a new snapshot. The script is a batch file and the content is as follows:

    E:\oracle\grid\bin\acfsutil snap delete windows_acfs_snap E:\Oracle\ASM_DATA\ORADATA E:\oracle\grid\bin\acfsutil snap create windows_acfs_snap E:\Oracle\ASM_DATA\ORADATA

  2. From the CommCell Browser, navigate to Client Computers | <Client> | File System.
  3. Right-click the <defaultBackupset>, point to All Tasks and select New Subclient.
  4. On the General tab of the Creating New Subclient dialog box, type the name for the subclient in the Subclient Name box.
  5. On the Content tab of the Creating New Subclient dialog box, click Add Paths. Type the path to the new snapshot, and then click OK. For example, the path is "E:\Oracle\ASM_DATA\ORADATA\.ACFS\snaps\windows_acfs_snap".
  6. On the Pre/Post-Processing tab of the Creating New Subclient dialog box, type or select the path to the pre-processing script.
  7. On the Storage Device tab of the Creating New Subclient dialog box, select the storage policy name for the Data Storage Policy.
  8. Click OK.

Modifying an Agent, Backup Set or Subclient

The following table describes the properties that can 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 backup set, and then click Properties.
  2. Select the Preserve File Access Time check box.
  3. 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, right-click the subclient.
  2. Click Properties.
  3. Click Storage Device.
  4. Select the Storage policy from the drop-down menu.
  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, 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. Click the Data Transfer Option tab.
  3. Choose the appropriate software compression option for this subclient.
  4. Select the Throttle Network Bandwidth check box, and set the required bandwidth.
  5. 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, and then click Data Paths. The Data Paths dialog box appears.
  2. Click the Override Data Paths check box, and then click Refresh Priority.
  3. Select or modify the required data path, and then click OK.
  4. Click OK.
 
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 configure user security from the agent or subclient level.

You can perform the following functions:

  • Identify the user groups to which this CommCell object is associated.
  • Associate this object with a user group.
  • Disassociate this object from a user group.
  1. From the CommCell browser, right-click the subclient.
  2. Click Properties.
  3. Click Security.
  4. Select the appropriate user groups to which you want to associate to the CommCell object from the Available Groups pane, and then move the user group to the Associated Groups pane.
  5. Click OK.
Refer to User Administration and Security.
Enable and Disable Data Encryption When you configure encryption at the client level, it is configured automatically for all the subclients associated with all the agents installed on that client. If you want to disable or change the encryption at the subclient level, follow the steps given below:
  1. From the CommCell browser, right-click the subclient.
  2. Click Properties.
  3. Click Encryption.
  4. 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, right-click the agent.
  2. Click Properties.
  3. Click Version.
  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 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 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.