Advanced - Windows File System Configuration

Table of Contents

Understanding the CommCell Console

Creating an On Demand Backup Set

Creating a Subclient to Backup Specific Files

Creating a Subclient to Backup UNC Paths

Configuring the Default Subclient for Wildcard Support

Configuring Backups of Locked Files

Configuring Backups Using VSS

Configuring Backups Using QSnap

Configuring System State Backups

Configuring Backup of Office Communication Server (OCS)

Enabling OCS Backup

Including OCS Data in a Subclient

Configuring Filters for Backups

Filtering Files from a Backup

Filtering System State Components from a Backup

Configuring Exclusions to Filters

Excluding CommCell Console Directories

Configuring the Scan Method for Detecting Changed Files

Configuring Change Journal Scan

Configuring Classic File Scan

Configuring Data Classification Scan

Configuring Multiple Streams for Backups

Configuring Pre/Post Processing for Backups

Setting up Pre/Post Processes

Setting up Pre/Post Processes to Run During Failures

Configuring User Accounts

Configuring Windows Users on an Individual Server

Configuring Windows Users on a Domain Controller

Configuring Windows Users for Specific Folders

Configuring Credentials for UNC Path Content

Configuring Credentials for Restricted Drives or Directories

Configuring Index for Backups

Creating a New Index on a Full Backup

Converting to a Full Backup on Index Failure

Configuring Folder Size for Backups

Modifying an Agent, BackupSet or Subclient

Deleting an Agent, BackupSet or Subclient

Command Line Operations

Log on to the CommServe

Configure Subclients

List Schedule Policy Association

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 at the time of 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:

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

Formatting Content and Directive Files

Content File entries should be in the following format with no filters, wildcards, or regular expressions included:

\\client1\shares\ondemand_content\test1.txt

c:\data\datafile.txt

Similarly, Directive File entries should be in the following format with no filters, wildcards, regular expressions, or blank lines:

c:\temp\ContentFile1.txt

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/folders with Unicode characters. Make sure to 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. The file will automatically be 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 backs up the files listed in the Content File. If the Content file has two entries for the file, the file can be backed up twice.

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

/usr/

/usr/textfile

In this scenario, a backup operation will back up the contents of all data residing in the textfile folder twice as the Content File already has the entry for the parent folder to be backed up.

It is recommended that Content Files do not include such duplicate entries. If you are not able 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 Backup Specific Files

You can create 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 and enter the paths of the directories or files to be backed up.

  9. Click Close.
  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, note the following:

  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 files and directories that you want to backup.
  8. Click As User to provide user name and password required to access the UNC path.
  9. Click Close.
  10. Click OK.

Configuring The Default Subclient for Wildcard Support

You can use the wildcards to specify the content of a default subclient in any backup set. Note that you can use wildcards only in the default subclient. Hence, if you want to use wildcards to specify the pattern of files or directories as a subclient content, it is recommended to create a new backup set.

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | <User Defined Backup Set>.
  2. Right-click the default subclient in the right pane and then click Properties.
  3. In the Subclient Name box, type a name.
  4. Click the Storage Device tab.
  5. In the Storage Policy list, select a storage policy.
  6. Click the Content tab.
  7. Click Add Paths.
  8. Select the Treat characters as regular expressions or wildcards check box.
  9. Enter the pattern of the directories or files to be backed up.

  10. Click OK.
  11. Click OK.

If you modified the content of a default subclient using wildcards, make sure to perform a full backup.

You can use the following wildcards for a default subclient:

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 have the name beginning with "a".

? Any one character

This wildcard is used in following scenarios:

Backup all files (or folders) for which the name begins with a specific word and the last character of the word is variable.

access? will backup any folder 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 will not backup because the last two characters in the name are variable.
[ ] Set of characters. You can combine this wildcard with *.
  If the default subclient is associated with a subclient policy and these wildcards are used in the subclient policy, then the wildcards will be treated as literal characters.
C:\[a-m]*.doc will backup any file with .doc extension on the C drive for which the name begins with the letters "a" through "m”.

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

[ ! ] The negation of a set 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 of characters.

  If the default subclient is associated with a subclient policy and these wildcards are used in the subclient policy, then the wildcards will be treated as literal 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.
** 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 directories starting with sys will be filtered.

Configuring Backups of 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.

Configuring Backups Using VSS

In some cases, it may be desirable to allow write operations on data being backed up to continue while the backup runs. Enabling VSS for backups provides this capability.

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 or QR Volumes (when used with the Quick Recovery Agent).

VSS can be enabled for backups of local volumes in both clustered and non-clustered environments. VSS can be enabled only on the NTFS 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.

VSS is supported on all the Windows operating systems listed in the System Requirements, except Windows 2000. You cannot enable VSS on Windows 2000.

  1. From the CommCell Console, navigate to Client Computers | File System | Backup Set | Subclient.
  2. Right-click the subclient and click Properties.
  3. Ensure that the Use VSS check box is selected.
  4. Click OK.

Configuring Backups using QSnap

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

Using QSnap to Backup 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.

Enabling Backup of Locked Files

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 the Registry Key Settings tab.
  4. Click Add.
  5. In the Name field, type nOverrideVSSSnapSelection.
  6. In the Location list, type HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\File System iDataAgent.
  7. In the Type list, select REG_DWORD.
  8. In the Value field, type 1.
  9. Click OK.

Configuring System State Backups

By default, system state data is backed up along with file system data by the default subclient. System state data includes the following:

You can also create a separate subclient to back up the system state. Within any backup set, however, only one subclient can back up the system state. To back up System State data, the service user must be either an administrator or a backup operator. Also, system state backups require backup operator group permissions on the HKLM\SYSTEM\SETUP key to enable system-protected file backups.

  1. In the CommCell browser, right-click the default backup set and select New Subclient.
  2. Click the Content tab.
  3. Select the Backup System State check box.

    Clear the Backup System State check box on the Content tab of the defaultBackupSet.

  4. Click OK.

This subclient will be used to backup the system state. Additionally, system state data will be removed from all subsequent backups of the default subclient.
  By default, VSS will be used to perform system state backup.

For Windows 2008, the Use VSS for System State Backup check box is not available. However, VSS will be used to perform the system state backup.

Configuring Backup of Office Communication Server (OCS)

The Office Communications Server is made up of data, settings, and metadata. OCS data and settings are backed up and restored using the OCS enabled Windows File System iDataAgent. You can perform the backup of following OCS versions:

The OCS application stores its metadata in a SQL database. Use the SQL Server iDataAgent to backup and restore the OCS database that contains the OCS metadata.

The following sections describe how to include the OCS data and settings in the File System backup.

Enabling OCS Backup

If you have Office Communications Server on multiple computers, you must install Windows File System iDataAgent and enable OCS backup on all servers.

Follow the steps given below to enable OCS 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.

Including OCS Data in a Subclient

OCS data and settings can be backed up by any subclient of a Windows File System iDataAgent backup set, for which the OCS backup is enabled. Within a backup set, only one subclient can back up the OCS data and settings. The OCS data and settings is always backed up in full irrespective of the backup type selected for the subclient that includes the OCS.

Follow the steps given below to include the OCS data and settings in a subclient:

  1. From the CommCell Console, navigate to Client Computers | File System | Backupset.
  2. Right-click the subclient in the right pane and select Properties.
  3. In the the Subclient Properties dialog box, click Content
  4. On the Content tab, select the Backup Communication Server check box.
  5. If the OCS credentials, displayed on the Content tab, are incorrect, click Edit.
  6. Enter the credentials for Office Communication Server.
  7. Click OK on the Office Communication Server Credentials dialog box.
  8. Click OK on the Subclient Properties dialog box.

Configuring Filters For Backups

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

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

Filtering Files from a Backup

Subclient-level backup filters are available for the File System iDataAgent to exclude specified directories and files from being backed up. Follow the steps given below to configure filters on a subclient:

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

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

  7. Click Close.
  8. Click OK.

Ensure that the subclient content does not have any UNC paths. The data from a UNC path will not get backed up if you are using wildcards in a subclient content. You can create another subclient to backup the UNC paths.

Supported Wildcards

You can use the following wildcards to specify the pattern of files as a filter.

wildcard

definition

example

* Any number of characters.

This wildcard is used in following scenarios:

  • filter all files of a specific extension
  • filter all files when the file name starts with a specific pattern
C:\*.log  will filter all files with the .log extension on root of the C drive. If you want to filter files with the .log extension from a folder on the C drive, you must include the path to the folder in the filter. (e.g. C:\Test\*.log)

ntuser* will filter all files for which the file name starts with the word ntuser.

? Any one character

This wildcard is used in following scenarios:

Filter all files (or folders) for which the name begins with a specific word and the last character of the word is variable.

To filter files:

C:\access?.doc will filter any files with the extension .doc on the C drive for which the name begins with- "access" followed by any one character such as access1.doc or access5.doc. However, access12.doc or access15.doc will not be filtered because the last two characters in the name are variable.

To filter folders:

C:\access?\**\* will filter any on the C drive for which the name begins with- "access" followed by any one character such as C:\access1 or C:\access5. However, C:\access12 or C:\access15 will not be filtered because the last two characters in the name are variable.

**\*

All files under a specific directory C:\Test\Data\**\* will filter all files and subdirectories under and including C:\Test\Data

C:\**\Data\**\* will filter all files and subdirectories below and including any directory called "Data" at any level in the C: volume

G:\Users\**\xpprofile\*.log will filter all files with the .log extension from any xpprofile subdirectory under Users directory

G:\Users\**\xpprofile\ntuser* will filter all filenames starting with ntuser from any xpprofile subdirectory under Users directory

Filtering System state components from a Backup

By default, the system state is backed up along with file system data by the default subclient of a Backup Set. A system state backup is always a full backup whether you select full, incremental, or differential backup for the subclient that includes the system state. You can, however, filter out some components from system state backup.

  1. From the CommCell Console, navigate to Client Computers | File System | Backup set.
  2. Right-click the subclient in the right pane and click Properties.
  3. Click the Filters tab.
  4. Click Add from the Exclude these files/folders/patterns group.
  5. Enter the path within curly brackets. Following are the entries that can be made:
    • {System Protected Files}
    • {IIS}
    • {COM+ Database}
    • {Event Logs}
    • {One Touch Files}
    • {RSM}
    • {Terminal Services Licensing}
    • {Disk Quotas}
    • {Content Indexing Catalogs}
    • {WMI Database}
    • {DHCP}
    • {WINS}
    • {UDDI Database}
    • {Remote Storage Database}
    • {Certificate Services }
    • {Offline Files}
    • {Active Directory Application Mode}
    • {File Server Resource Manager}
    • {NPS Database}
  1. Click Add.
  2. Click OK to save your changes.

Configuring Exclusions 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.

  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. Click the Filters tab.
  4. 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.
  6. Click Close.
  7. Click OK.

 

Excluding CommCell Console Directories

Software Installation, Index Cache, Job Control, and Job Results directories are by default included in the backups performed by the Windows File System iDataAgent. To exclude them from data protection operations follow the steps given below:

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the <Client>, and then click Properties.
  3. Click the Registry Key Settings tab.
  4. Click Add.
  5. In the Name field, type nFilterGalaxyDirectories.
  6. In the Location list, type HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\.
  7. In the Type list, select Reg_ DWORD.
  8. In the Value field, type 1.
  9. Click OK.

Deleting a Filter

You can remove a filter by deleting it from the exclusion list.

  1. From the CommCell Browser, navigate to Client Computers | <Client> | File System | Backup set.
  2. Right-click the <Subclient> in the right pane, and then click Properties.
  3. Click the Filters tab.
  4. Under Exclude these files/folders/patterns, select the filter that you want to delete.
  5. Click Delete.
  6. Click OK.

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 default method for scanning files to determine which files have changed and/or have been backed up. When using this method of scanning the incremental backup will backup all the new or changed data since the last incremental or full backup, ignoring any differential backups performed prior to the current backup.

  1. From the CommCell Console, navigate to Client Computers | File System.
  2. Right-click the File System | Backup set
  3. Right-click Backup set  and click Properties.
  4. Select Use Change Journal.
  5. Click OK.

Configuring Classic File Scan

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

Follow the steps given below to configure Classic File Scan:

  1. From the CommCell Console, navigate to Client Computers | File System.
  2. Right-click the File System | Backup set
  3. Right-click Backup set  and click Properties.
  4. Select Use Classic File Scan.
  5. Select Preserve File Access Time.
  6. Select Check archive bit during backups.
  7. Click OK.

Configuring Data Classification Scan

By default Change Journal Scan is selected as the method for scanning files to determine which files have changed and/or have been backed up. However, you can also select Data Classification as the preferred method of scanning the files, as this method is much faster as compared to the Classic File Scan.

Before selecting Data Classification as the scan method, consider the following:

  1. From the CommCell Console, navigate to <Client> | <Agent> | defaultBackupSet.
  2. Right-click the defaultBackupSet and select Properties.
  3. Click Use Data Classification.
  4. Click OK to enable the data classification.

 

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. You can allocate a maximum of 63 streams for a subclient.

Note that, you do not have to enable multi-streaming if you have multiple mount points pointing to the same physical drive. Do not use multiple streams if you have added UNC paths to the subclient content.

Before enabling multi streaming, ensure that you can use multi-streaming when you restore the data and create an auxiliary copy.

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 Number of Data Readers box type or select the number of data streams.
  4. Select the Allow multiple data readers within a drive or mount point checkbox.
  5. Click the Storage Device tab.
  6. In the Storage Policy list, click a storage policy name.
  7. 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/Post Processing for Backups

The following sections provide the steps to configure pre/post scripts for backup operations. For additional information, see Pre/Post Process.

Setting Up Pre/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.

  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. 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 | BackupSet.
  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 operators. Backup operators (or Service Users) are designed to have full control to the registry and the install folder.

An administrator or a backup operator in a local group can 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 can back up any file and folder on any computer in the domain or any computer in a domain where a two-way trust relationship exists.

To back up files if you are not an administrator or a 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 for the files and folders you want to back up:

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

You can define from the subclient level an account to be used when configuring a UNC Path as part of the subclient's content.

The user name and password that you use must have sufficient rights to access the share to which the UNC Path is pointing. Also, the user name and password must have the right to log on to the client machine that is running the backup, as well as rights to the logs on that computer.

To perform a backup or a restore operation using a UNC Path as either the content of the subclient or the destination for a restore, we recommend using an account that has administrative privileges. Also, the User Account that is used must be an account that already exists. If you choose to use an account that does not exist, it must be created.

Once you establish the account, you can modify the account. See Change Account for Configuring UNC Paths for step-by-step instructions.

  1. From the CommCell Browser, right-click the Subclient and click Properties.
  2. From the Content tab, type in the UNC path of the share that you want to add in the Enter New Content field and click Add.

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

  3. Click As User.
  4. Enter the appropriate user name and password.
  5. 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 Index for Backups

Creating a New Index on a Full Backup

This option accelerates Full or On Demand backups and is enabled by default. Subsequently, when you perform a browse and restore operation, the default browse displays data up to the most recent full backup. To browse and restore older data you have to use the options to browse before or between specific dates.

When disabled, Full or On Demand backups may be slower. However, the default browse displays all data in the entire retention period; not just one full backup cycle.

Use the following steps to configure this option for all subclients. This option can also be set for the individual backups when initiating the job.

  1. From the CommCell Browser, navigate to Client Computers | <Client>.
  2. Right-click the File System on the right pane, and then click Properties.
  1. Click the Index tab.
  2. Select the Create new index on Full Backup check box.
  3. Click OK.

Converting to a Full Backup on Indexing Failures

Use this option to ensure that the backup does not fail if the index is irretrievable. When disabled, the backup will fail if the index is irretrievable.
  1. From the CommCell Browser, navigate to Client Computers | <Client>.
  2. Right-click the File System on the right pane, and then click Properties.
  1. Click the Index tab.
  2. Select the Convert to full backup on indexing failures check box.
  3. Click OK.

Command Line Operations

You can add, modify or delete several configurable properties for the File System iDataAgent from command line.

Command line configuration enables you to:

The following sections describe the available command line configurations:

Log on to the Commserve

To run command line operations you must first login to the CommServe as follows:

Configure Subclients

Create Subclient

  1. Download the create_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af create_subclient_template.xml -appName 'File System' -clientName xxxxx -backupsetName xxxxx -subclientName xxxxx -contentOperationType ADD -content/path 'xxxxx'

Get Subclient Properties

  1. Download the get_subclient_properties_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af get_subclient_properties_template.xml -appName 'File System' -clientName xxxxx -backupsetName xxxxx -subclientName xxxxx

Modify Subclient

  1. Download the update_subclient_add_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af update_subclient_add_template.xml -appName 'File System' -clientName xxxxx -backupsetName xxxxx -subclientName xxxxx -contentOperationType xxxxx -content/path 'xxxxx'

Renaming a Subclient

  1. Download the update_subclient_add_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af update_subclient_add_template.xml -appName 'File System' -clientName xxxxx -backupSetName xxxxx -subclientName xxxxx -newName xxxxx

Delete Subclient

  1. Download the delete_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af delete_subclient_template.xml -appName 'File System' -clientName xxxxx -backupsetName xxxxx -subclientName xxxxx

Available Parameters for Subclients

The following table displays all the parameters you can use with the commands mentioned in the above sections. To add a parameter to your command, use the following syntax: (Some examples are provided at the end of the table.)

qoperation execute -af <template XML file> -<parameter name> <value>

Parameter Description of Parameter values
clientName Name of the client computer.
backupsetname Name of the backup set. If the backup set name is not specified in the command query, the default backup set is used by default.
appName Name of the application. In this case it would be 'File System'.
subclientname Name of the subclient.
newName New name of the subclient.
enableBackup Option to enable/disable backup.

Valid values are True/False.

encryptionFlag Option to set the encryption points during backups. Valid values are:
  • ENC_MEDIA_ONLY, to encrypt the backup data after transmission and prior to storage on the media.
  • ENC_NETWORK_AND_MEDIA, to encrypt the backup data before transmission. The data is stored encrypted on the media.
  • ENC_NETWORK_ONLY, to encrypt the backup data for transmission and then decrypt the data prior to storage on the media.
  • ENC_NONE, to disable data encryption.
networkAgents Number of Network Agents.
softwareCompression Option to enable compression on the Client or MediaAgent computer. Valid values are:
  • ON_CLIENT, to enable software compression on the client.
  • ON_MEDIAAGENT, to enable software compression on the MediaAgent.
  • OFF, to disable software compression.
throttleNetworkBandwidth Enhancing backup performance by reducing network bandwidth overhead.

Valid values are 0/1.

enableDeduplication Option to enable deduplication on subclient.

Valid values are True/False.

generateSignature A component of deduplication performed on the client or MediaAgent computer. Valid values are:
  • ON_CLIENT, to enable signature generation on the client.
  • ON_MEDIA_AGENT, to enable signature generation on the MediaAgent.
  • OFF, to disable signature generation.
storagePolicyName Name of the Storage Policy to be associated for backup.
useGlobalFilters Option to enable the use of global filters. Valid values are:
  • ON, to enable global filters for the subclient.
  • USE_CELL_LEVEL_POLICY, to enable the use of global filters if the Use Global Filters on All Subclients option is enabled on the Control Panel (Global Filters) dialog. If the option is disabled, USE_CELL_LEVEL_POLICY will disable global filters for the subclient.
  • OFF, to disable global filters.
useVSS Option to enable/disable VSS for backing up the file system data.

Valid values are True/False.

useVSSForSystemState Option to enable/disable VSS for backing up the system state.

Valid values are True/False.

backupSystemState Option to enable/disable back up of the system state.

Valid values are True/False.

postBackupCommand Path to the post process script that will be run after the backup.
postScanCommand Path to the post process script that will be run after the scan phase
preBackupCommand Path to the pre process script that will be run before the backup.
preScanCommand Path to the pre process script that will be run before the scan phase
runAs Option to specify the user name who has permissions to run the pre/post process scripts. Valid values are:
  • USE_IMPERSONATION, to specify a user with enough privileges to run the scripts. When using this value, you also need to provide the user credentials:

    -prepostUserName/userName <user name> -prepostUserName/password <password>

  • USE_LOCAL_SYS_ADMIN, to use the administrator account to run the scripts.
content/path Location of the content to be backed up. This parameter must be used along with the contentOperationType parameter, for example:

-contentOperationType <value> -content/path '<path value>'

content/excludepath Location of the content to be excluded from backup. This parameter must be used along with the contentOperationType parameter, for example:

-contentOperationType <value> -content/excludepath '<path value>'

content/includepath Location of the content to be included in the backup from the excluded list. This parameter must be used along with the contentOperationType parameter, for example:

-contentOperationType <value> -content/includepath '<path value>'

contentOperationType Modification type. Valid values are
  • ADD, to add content to the subclient
  • OVERWRITE, to overwrite contents to the subclient.
  • DELETE, to delete the contents from the subclient.

The following examples show how to add a parameter for a command:

Adding Content To update the location for the subclient content, add the 'path' parameter to the following command:

qoperation execute -af update_subclient_add_template.xml -appName 'File System' -clientName client1 -backupSetName backupset1 -subclientName subclient1 -contentOperationType ADD -content/path '/etc'

Setting a Storage Policy To assign a storage policy to a subclient, add the 'storagePolicyName' parameter to the following command:

qoperation execute -af update_subclient_add_template.xml -appName 'File System' -clientName client1 -backupSetName backupset1 -subclientName subclient1 -storagePolicyName sp1

For detailed information on the Subclient parameters see Subclient Properties.

List Schedule Policy Association

  1. Download the sched_policy_association_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute –af sched_policy_association_template.xml –taskName mypolicy

Parameter Description of Parameter Values
taskName Name of the Schedule Policy to be associated.

Configuring Folder Size for Backups

You can use the Show Folder Size option to get a graphical representation of the space used by backed up data on a client. This can be done for each subclient for a given client. The graph gets refreshed every time a backup is run for the change in data. To use this option, you must enable SRM for a given client and run a Full Backup.

  1. Enable SRM
    • From the CommCell Browser, right-click the File System iDataAgent and select Properties.
    • Click Enable SRM Feature from the General tab.
    • Click OK.
  2. Run a Backup
    • Right-click the subclient, and click Backup in the CommCell Browser.
    • Click Full as backup type and then click Immediate.
    • Click OK.
  3. Show Folder Size
    • From the CommCell Browser, navigate to Client Computers | <Client> | File System | defaultBackupSet.
    • Right-click the subclient for which you want to display folder size information and click Show Folder Size.
    • Chart displaying the folder size of the backed up data will be displayed.

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 Storage Policy list, click a storage policy 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 | BackupSet.
  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 | BackupSet.
  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/Disable Data Encryption You can enable data encryption from the suclient level.Encryption must be enabled at the client level prior to configuring any instances residing on that client.
  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, SRM agents, subclients, and storage policies within the CommCell based on the selected filter criteria.
  1. From the CommCell Browser, double-click Reports icon.
  2. Select CommCell Configuration.
  3. Click Run.
Refer to CommCell Configuration.

Deleting an Agent,BackupSet 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.

  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 BackupSet

Consider the following before deleting a Backup Set:

  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:

  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.

Back to Top