SnapProtect - Advanced Configuration - Windows File System iDataAgent

Table of Contents

Understanding the CommCell Console

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

Backup Set - collective information of 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> in which you want to add the registry key, and then click Properties.
  3. Click the Registry Key Settings tab.
  4. Click Add.
  1. In the Name box, type OnDemand_AutoExpandDir.
  2. In the Location list, type HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\
  3. In the Type list, select REG_DWORD.
  4. In the Value field, type 0.
  5. 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. 

    NOTES:

    • 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.
    • If a file is located under multiple directories and those directories are added as subclient content by different subclients within a backup set, then the file is not backed up multiple times. The file is backed up only once and other subclients within the same backup set skip the common files.
  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.

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.

If you have specified a proxy computer for your SnapProtect subclient, then use:

\**\My_Filter*\** to filter from all drives. However, the My_Filter folder itself is not filtered and is included in the backup. For more information on adding a proxy computer to the SnapProtect subclient, see SnapProtect Configuration.

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.

Configuring Exceptions to Filters

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

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 a Filter

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.

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.

Browse or Search Based on End-User Access Control

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 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 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 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. Make sure that the LocalSystem Account must have read or write access to the files being backed up, or have backup or restore privileges set on the computer where the files reside.

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 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

Subclient retention settings determine which files remain in the backup content. Subclient retention is managed by synthetic full backups.

You can specify the time period for which you want to retain the deleted files in the backup cycle. This enables you to restore the deleted files from the latest backup cycle and avoid point-in-time restores. This is useful to view (and restore) the deleted files from clients (like, laptop clients) that have backup cycles with frequent & numerous incremental backups after a full backup.

By default, when you delete any files from the source, they will be removed from the backup cycle during the next backup. You can specify the retention period for each subclient. When you run the synthetic full backup at the end of specified retention period, the deleted files will be removed from the backup cycle.

However, if a full backup is performed during the retention period, the deleted files may get removed from the backup cycle earlier. For more information about removing deleted files from the backup cycle, see Data Aging.

About this Task

  • 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.
  • You can also set retention for storage policy. The retention criteria set at the storage policy level takes a higher precedence over the one set at the subclient level.

Procedure

  1. From the CommCell Browser, expand Client Computers > client > Agent > 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 Advanced.
  4. In the Advanced Subclient Properties dialog box, to retain or drop the deleted files during synthetic full backup, choose one of the following options:
    Options Description
    Immediately Drops the deleted or moved files during synthetic full backup.
    After n days Retains the deleted or moved files for n number of days. The n days for a deleted or moved file starts from the date the next incremental backup runs after the file was deleted.
    Never Retains the deleted or moved file in the backup cycle forever.
  5. Click OK.
  6. 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.
  7. 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'

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 the following features:
    • Privacy to prevent other users (including administrators) from viewing the data from the client.
    • Enable Hardware Encryption to encrypt data on the media.
  • 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.

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.
  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 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 or 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.