In order to perform advanced troubleshooting and other environment-specific modifications, Windows registry keys or an appropriate file in the Unix and NetWare file systems is used.
This document describes such parameters and how to modify them. Note the following convention used in this document:
Back up the registry before you edit it. You must also understand how to restore the registry if a problem occurs. For information on how to backup and restore the registry, refer to the appropriate Registry Help Topic provided in Regedit.exe or Regedt32.exe.
| WARNING: Using Registry Editor incorrectly can cause serious problems that may require a reinstall of the operating system. Microsoft does not guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk. You must also understand how to restore the registry if a problem occurs. |
It is recommended that you make a backup copy of the appropriate .properties file, before editing it. This will help you to restore the appropriate parameters if a problem occurs.
It is recommended that you make a backup copy of the appropriate GALAXY.INI file, before editing it. This will help you to restore the appropriate parameters if a problem occurs.
The following section provides a list of some of the useful registry keys. If you know the name of the registry key, use the Search facility in your browser to locate the information. Given below is a list of links under which the registry keys are categorized:
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\FileSystemAgent\ |
| Key | SKIP_1TOUCH_BACKUP (optional) |
| Value | Not applicable |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Not applicable |
| Default Value | None |
| Created In | The Client computer in which the iDataAgent is installed |
| Description | This key allows you to skip the backup of 1-Touch information during system state backups. |
| Applies To | All Windows File System iDataAgents that support system state backups (not supported on Microsoft Windows 4.0). |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | CommServe (standard) |
| Value | AUXCOPY_NOT_PICK_NEW_BACKUPS (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 or 1 |
| Default Value | None |
| Created In | CommServe computer |
| Description | If the value is set to 1, this registry key is enabled and auxiliary copy operations will not copy data protection operations that finish after the Auxiliary Copy operation has started. If the value is set to 0 or not set, then this registry key is disabled, and auxiliary copy operations will copy data protection operations that have finished after the auxiliary copy operation started. |
| Applies To | CommServe |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | CommServe (standard) |
| Value | AUXCOPY_MARKCOPIED_MINUTES (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 1 to infinite |
| Default Value | None |
| Created In | CommServe computer |
| Description | Determines the time interval in which Auxiliary Copy operations update the status of jobs currently being copied. If the value of this registry key is not set, Auxiliary Copy operations update the CommServe database hourly. |
| Applies To | CommServe |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | CommServe (standard) |
| Value | AUXCOPY_NOT_PRUNE_SPOOL_COPY (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 or 1 |
| Default Value | None |
| Created In | CommServe computer |
| Description | If defined and the value is set to 1, the auxiliary copy will not prune any job from the spool copy. By default, an auxiliary copy prunes copied jobs from the spool copy every hour or upon completion. The time interval can be changed by defining registry AUXCOPY_MARKCOPIED_MINUTES. |
| Applies To | CommServe |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | EventManager (standard) |
| Value | ClientCheckInterval (standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 1 - 1800 (seconds) |
| Default Value | 1800 (30 minutes) |
| Created in | CommServe |
| Description | This registry key sets the time interval (in seconds) at which clients will be checked for the CommNet Server. The start and end time of this client checking window are determined by the ClientCheckWindowStartHour and ClientCheckWindowEndHour registry keys. |
| Applies to | CommServe |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | EventManager (standard) |
| Value | ClientCheckWindowStartHour (standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 – 23 (Time: 24-Hour Clock) |
| Default Value | 13 (1:00 PM) |
| Created in | CommServe |
| Description | This registry key sets the ending time for the client readiness check window for the CommNet Server. |
| Applies to | CommServe |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | EventManager (standard) |
| Value | ClientCheckWindowEndHour (standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 1 – 24 (Time: 24-Hour Clock) |
| Default Value | 14 (2:00 PM) |
| Created in | CommServe |
| Description | This registry key sets the ending time for the client readiness check window for the CommNet Server. |
| Applies to | CommServe |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | EventManager (standard) |
| Value | QCMD_SUPPORT_MODIFY_SUBCLIENT (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 or 1 |
| Default Value | 0 |
| Created In | CommServe |
| Description | This registry key allows you to use the qmodify subclient command in the command line interface (CLI). Set the key to 1 to enable this support. By default, this key is set to 0 (disabling support for this command). |
| Applies To | Computers with agents installed |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Common\Data Classification\ |
| Key | NoSecurityForLocalAdministration (optional) |
| Value | 0 or 1 |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 if you do not want to bypass the security check for local administration of the Data Classification service from the Data Classification utility; 1 if you want to bypass the security check for local administration of the Data Classification service from the Data Classification utility. |
| Default Value | 0 |
| Created In | Computer in which the enabler is installed |
| Description | Use Value 1 to bypass the security check for local administration of the Data Classification service from the Data Classification utility. This helps administer the Data Classification service locally. By design, Data Classification utility users should be able to access other computers with Data Classification only when such users have administrator privileges on those computers. This level of security is provided by the NTLM or another authentication method. If the authentication method is disabled or not used, however, the computer access restriction is removed unless you set this registry key to 1 on the affected computers. Security checks are not bypassed if the registry key is not present. |
| Applies To | Windows computers with Data Classification |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\Data Classification\ |
| Key | DC_CREATE_INDEX (standard) |
| Value | 1 (Multi-Column Single Index and Full Path Index); 4096 (Multi-Column Single Index); 56 (Multi-Column Multi-Index); 8 (Full Path Index); 128 (File Size Index) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Use the preferred values identified in Value above. |
| Default Value | 1 |
| Created In | The client computer where the enabler and the agent are installed. |
| Description |
This key allows you to create and modify the indices for the Data
Classification databases. By assigning values to and applying the key,
you can use these indices to administer various items associated with
Data Classification. Depending on the agent, these items include the
size of the Data Classification database, the time required for database
initialization, the time required for Data Archiving, and the time
required for File System iDataAgent
backups using the Data Classification Enabler as the scan process. If you do not want to use this key (i.e, if you want to use the default index), be sure to set the key value to 0, stop the Data Classification services, delete the Data Classification database, and then restart the services. Also, if you want to change the value of the key to a preferred value, set the key to that value and then follow the procedure discussed in the previous sentence. The following list summarizes the effects of using this key. Set this key to one of the values identified in Value above and as appropriate per the notes in the following list.
|
| Applies To | File Archiver for Windows Agent with Data Classification, Windows File System iDataAgent with Data Classification. |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | CommServe (standard) |
| Value | SetLifeSpanForFailedDR (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | number in Days |
| Default Value | If it is not defined, the default is 90 days. |
| Created In | CommServe computer |
| Description | This key changes the default number of days. Partial disaster recovery backup sets will be kept when a disaster recovery backup is run. If this registry key is not used, the partial sets will be kept for 90 days and removed when the next disaster recovery backup is run. |
| Applies To | CommServe |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | CommServe (standard) |
| Value | DisableActivityOnDbCorruption (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | any non-zero value |
| Default Value | none |
| Created In | CommServe computer |
| Description | When this key is defined and the value is set to 0, CommServe job activities will NOT be disabled if during a Disaster Recovery Backup a database corruption is detected. By default, when a Disaster Recovery Backup detects database corruption, CommServe job activities are disabled. |
| Applies To | CommServe |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Platform Information\<focus>\CommServe |
| Key | CommServe (standard) |
| Value | ERStagingDirectory (optional) |
| Value Type (Windows only) | String Value |
| Valid Range | any valid directory path |
| Default Value | none |
| Created In | CommServe computer |
| Description | When this key is defined, Disaster Recovery Backup staging files will be copied to the folder specified rather than the default location in the software installation directory. |
| Applies To | CommServe |
| Location | |
|
Windows |
HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
|
Unix |
Not Applicable |
|
NetWare |
Not Applicable |
| Key | LotusNotesDBAgent (standard) |
| Value | nUSEBROWSETIMEFORDR (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 - 1 (0 = disabled, 1 = enabled) |
| Default Value | If not defined, the default is 0. |
| Created In | The Lotus Notes Database client computer in which the database disaster recovery operation will run, prior to executing the restore. |
| Description | This key is used by the Lotus Notes Database iDataAgent Disaster Recovery process to recover a database from a log sequence prior to the current log sequence. When browsing back in time, the Agent will recover from an earlier log extent. |
| Applies To | Lotus Notes Database iDataAgent |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | EventManager (standard) |
| Value | NMaxLogFileSize (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 5 through 50 MB |
| Default Value | None |
| Created In | CommServe computer |
| Description | This key sets the maximum value of the size of the log files. If the file is greater than the value in the key, the file gets rolled over to <filename>_1.log. |
| Applies To | CommServe |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | EventManager (standard) |
| Value | <logfilename>_MaxLogFileSize (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 10 through 50 MB |
| Default Value | If key does not exist or is set to 0, the default log file size is 5 MB. |
| Created In | All |
| Description | This key specifies the maximum log file size for a particular log file. If the file is greater than the value in the key, the file gets rolled over to <filename>_1.log. |
| Applies To | All |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | EventManager (standard) |
| Value | <logfilename>_MaxLogFileBackups (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 1 through 5 |
| Default Value | If key does not exist or is set to 0, the default number is 1. |
| Created In | All |
| Description | This key specifies the number of backup log files (_1, _2). |
| Applies To | All |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/OracleAgent/.properties |
| NetWare | Not Applicable |
| Key | OracleAgent (standard) |
| Value | sIGNORERMANWARNINGS (optional) |
| Value Type (Windows only) | STRING |
| Valid Range | Y or N where:
Y disables parsing of RMAN warnings N enables parsing of RMAN warnings |
| Default Value | N |
| Created in | The computer in which the Oracle iDataAgent is installed. |
| Description | This registry key is used to disable the parsing of RMAN warnings from a RMAN output for GUI backup jobs. If set to Y, the key disables parsing of RMAN warnings. By default, this registry key is not set and RMAN warnings are parsed. If any warning is found in the RMAN output, GUI backup jobs are completed with errors. |
| Applies to | Oracle iDataAgent |
| Location | |
| Windows | Not Applicable |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/OracleAgent/.properties |
| NetWare | Not Applicable |
| Key | OracleAgent (standard) |
| Value | sEnableMultiplexRestore (optional) |
| Value Type (Windows only) | Not Applicable |
| Valid Range |
Y or N Where:
Y enables automatic multiplexing of data streams when restoring data from multiplexed backups. N disables automatic multiplexing of data streams when restoring data from multiplexed backups. |
| Default Value | N |
| Created in | User-created in the computer in which the Oracle iDataAgent is installed. |
| Description | When this key is created and the value is set to Y, restores will be multiplexed. When the value of the key is set to N, restores will not be multiplexed even if the backup from which the data is being restored was multiplexed. |
| Applies to | Oracle iDataAgent on Unix |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx> |
| Key | QMachineMaint |
| Value | bCHECK_AUTOUPDATES (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 (Disabled) or 1 (Enabled) |
| Default Value | 1 |
| Created In | User-Created in CommServe |
| Description | When this key is defined, the default value is set to 1 (enabled). When enabled, the CommServe CVD will contact the configured Automatic Updates FTP site at six-hour intervals (360 minutes) to check if the CommServe Update Cache is up-to-date. If updates are missing, and the automatic update configuration is set to download the updates, the missing updates will be downloaded to the CommServe Update Cache. If this key is set to 0, this check will be disabled. |
| Applies To | CommServe |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | ContentIndexingServer |
| Value | nDocumentAgingPeriodInDays |
| Value Type (Windows only) | DWORD |
| Default Value | 14 days |
| Created In | Content Indexing Admin Node |
| Description | This key controls the frequency at which the successfully tagged items are pruned in the Tagging database. |
| Applies To | Content Indexing Admin Server Node. |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | ContentIndexingServer |
| Value | nTagSyncInterval |
| Value Type (Windows only) | DWORD |
| Default Value | 60 MINUTES |
| Created In | Content Indexing Admin Node |
| Description | This key controls the frequency at which the Tagging database is polled for items submitted for tagging. |
| Applies To | Content Indexing Admin Server Node. |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | ContentIndexingServer |
| Value | nDocCountUpdateIntervalMins |
| Value Type (Windows only) | DWORD |
| Default Value | 24 hours |
| Created In | Content Indexing Admin Node |
| Description | This key controls the frequency at which the total number of documents searchable in the Content Indexing engine are updated in the CommServe |
| Applies To | Content Indexing Admin Server Node. |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\PrimaryCIForExchange\ |
| Key | ContentIndexingServer |
| Value | exch2k7 |
| Value Type (Windows only) | DWORD |
| Default Value | 0 = Not for exchange server 2007 user, 1 = exchange server 2007 user |
| Created In | Content Indexing Admin Node |
| Description | This key is created by Exchange 2007 user on the client machine for OWA URL fetching. |
| Applies To | Online Content Indexing For Exchange Server 2007 |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | Not Applicable |
| NetWare | Not Applicable |
| Key | CommServe |
| Value | sDefaultFastServer |
| Value Type (Windows only) | String |
| Default Value | Admin node URL of the default Content Indexing Engine. |
| Created In | CommServe |
| Description | This key is used when you need to search from a different Content Indexing Engine other than the default from the CommCell Console. The admin node URL of the Content Indexing Engine is set in this registry key. |
| Applies To | Content Indexing Engine |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | Not Applicable |
| NetWare | Not Applicable |
| Key | MediaAgent |
| Value | bDoNotSkipBigFiles |
| Value Type (Windows only) | DWORD |
| Default Value | 0 (Indicates that the large files will be skipped for content indexing.) |
| Created In | MediaAgent |
| Description | This key is used when content indexing large files. When you set the key to 1, the metadata information of the large files will be content indexed and the files will be marked as failed to content index. |
| Applies To | Content Indexing Engine |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | MediaManager (standard) |
| Value | nAUTOSTUCKTAPERECOVERYINTERVALMIN (standard) |
| Value Type (Windows only) | DWORD Value |
| Default Value | 20 (minutes) |
| Created In | CommServe computer |
| Description | This key determines how often the Galaxy Media & Library Manager service on the CommServe should try recovering media that may be stuck in a drive. (Media that are not cache mounted but remains in drive.), when the Enable Auto-Recovery option is enabled in the Drive tab of the Library Properties dialog box. |
| Applies To | All configured libraries in the CommCell. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/MediaAgent/.properties |
| Key | MediaAgent (standard) |
| Value | DataMoverMaxMountRetryValue (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Integer (to indicate the number of retry attempts) |
| Created in | MediaAgent computer |
| Description | This key determines the number of times the
MediaAgent must retry to mount the media in the library for the job.
By default the registry key is not set and therefore retries are not attempted. The DataMoverMaxMountRetrySleepTime registry key must be created when you create this registry key. |
| Applies to | Libraries configured in the MediaAgent in which the registry key is established. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/MediaAgent/.properties |
| Key | MediaAgent (standard) |
| Value | DataMoverMaxMountRetrySleepTime (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Number in minutes. |
| Created in | MediaAgent computer |
| Description | This key determines the amount of time that a
job must wait before retrying a mount.
By default the registry key is not set. This key must be created when you create the DataMoverMaxMountRetryValue registry key. |
| Applies to | Libraries configured in the MediaAgent in which the registry key is established. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | Not applicable |
| NetWare | Not Applicable |
| Key | MediaAgent |
| Value | RevokeDeletePermissions (optional) |
| Value Type (Windows only) | DWORD |
| Valid Range | 1 |
| Created in | User-created on the MediaAgent computer |
| Description | Mount paths created on NTFS volumes when this key is present with a value of 1 are protected from accidental deletes. |
| Applies To | Mount paths created on MediaAgents installed with this registry key. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/MediaAgent/.properties |
| NetWare | Not Applicable |
| Key | MediaAgent |
| Value | DedupMagVolSzMBForSiloToCloud (optional) |
| Value Type (Windows only) | DWORD |
| Valid Range | Magnetic volume size in MB. |
| Created in | User-created on the MediaAgent computer |
| Description | This key determines the size of magnetic volumes created for deduplication-enabled backups in cloud gateway setup. See Cloud Gateway - Magnetic Volumes for more information. |
| Applies To | Deduplication-enabled backups in cloud gateway setup. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/MediaAgent/.properties |
| NetWare | Not Applicable |
| Key | MediaAgent |
| Value | DoNotCheckDedupMagVolSzForSiloToCloud (optional) |
| Value Type (Windows only) | DWORD |
| Valid Range | 0 or 1. |
| Created in | User-created on the MediaAgent computer |
| Description | Creating this registry key and setting the value to 1 overrides the magnetic volume size restrictions for cloud gateway and follows the size for regular magnetic volumes. |
| Applies To | Deduplication-enabled backups in cloud gateway setup. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance001\ |
| Unix | Not Applicable |
| NetWare | Not Applicable |
| Key | MSExchangeDMAgent (Standard) |
| Value | ManagedFolders (Optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range |
0 = To disable the creation of folders specified in the folder inclusion section on Subclient properties in the Content tab.. 1 = To enable the creation of any folder specified in the folder inclusion section on Subclient properties in the Content tab. |
| Default Value | None |
| Created in | User-created in the computer in which the agent is installed. |
| Description | This registry key allows you to create a custom folder in all user’s mailboxes that can be used along with the Folder inclusion filter in order to archive a specific custom folder. If this key is enabled, any folder specified in the folder inclusion section on the Subclient properties (Content tab) will be created. |
| Applies To | Exchange Mailbox Archiver |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | Not applicable |
| NetWare | Not applicable |
| Key | MSExchangeDMAgent (standard) |
| Value | movePSTstub (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 = move PST stub to mailbox folder 1 = copy PST stub to mailbox folder |
| Default Value | When this key is not present, PST stubs will remain in the original PST file. |
| Created in | User-created in the computer in which the agent is installed. |
| Description | This key instructs the system to move or copy PST stubs, created by a Migration Archiving Operation of PST Files, into the mailbox associated with the PST file. By default, the stubs will be placed into the PST Archived Items folder. Optionally, the StubDestFolder registry key can be used to customize the location where the PST stubs will be moved or copied. |
| Applies To | Exchange Mailbox Archiver |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | Not applicable |
| NetWare | Not applicable |
| Key | MSExchangeDMAgent (standard) |
| Value | StubDestFolder (optional) |
| Value Type (Windows only) | String Value |
| Valid Range | Any mailbox folder or subfolder (delimiter is "\\") where PST stubs will be copied or moved after a Migration Archiving Operation of PST Files. |
| Default Value | When this key is not present, PST stubs will remain in the default location of PST Archived Items mailbox folder. |
| Created in | User-created in the computer in which the agent is installed. |
| Description | When the movePSTstub registry key is used to move or copy PST stubs after a Migration Archiving Operation of PST Files, the StubDestFolder registry key provides the custom mailbox folder location where PST stubs will be placed. If the destination folder does not exist, it will be automatically created. |
| Applies To | Exchange Mailbox Archiver |
| Location | |
|
Windows |
HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance001\
(Exchange client) HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\ (Outlook client) |
| Unix | Not Applicable |
| NetWare | Not Applicable |
| Key | MSExchangeDMAgent MSExchangeMB Galaxy.Ex2KMBDM.CVEAAddin |
| Value |
RecoveredItemsFolderName (Optional) Where the value is the customized Recovered Items folder |
| Value Type (Windows only) | String |
| Default Value | None |
| Created in | User-created in the computer that the Outlook Add-In component is installed on. |
| Description | This registry key allows you to customize the Recovered Items folder. This key needs to be saved on both the Outlook Add-In client and Exchange client. In order to be able to customize the folder, the key must be identical on both clients. Therefore, any operation that makes use of the Recovered Items folder will be directed to the folder name specified in this key. |
| Applies To |
Exchange Mailbox iDataAgent Exchange Mailbox Archiver Outlook Add-In |
| Location | |
|
Windows |
HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance001\
(Exchange client) HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\ (Outlook client) |
| Unix | Not Applicable |
| NetWare | Not Applicable |
| Key | MSExchangeDMAgent Galaxy.Ex2KMBDM.CVEAAddin |
| Value |
EraseStubsFolderName (Optional) Where the value is the customized Erase Stubs folder |
| Value Type (Windows only) | String |
| Default Value | None |
| Created in | User-created in the computer that the Outlook Add-In component is installed on. |
| Description | This registry key allows you to customize the Erase Stubs folder. This key needs to be saved on both the Outlook Add-In client and Exchange client. In order to be able to customize the Erase Stubs folder, the key must be identical on both clients. |
| Applies To |
Exchange Mailbox Archiver Outlook Add-In |
| Location | |
| Windows |
HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance001\ (Exchange client) HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\ (Outlook client) |
| Unix | Not Applicable |
| NetWare | Not Applicable |
| Key | MSExchangeDMAgent Galaxy.Ex2KMBDM.CVEAAddin |
| Value | SocketTimeout (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 120 - 600 (seconds) |
| Default Value | 120 (seconds) |
| Created in | User-created in the computer that has the Outlook Add-In component, or OWAProxyEnabler installed in a proxy configuration. |
| Description | This registry key allows you to extend the
timeout interval during a stub recall before the recall fails while waiting
for a response from the server. By default, the timeout is 2 minutes.
In a proxy configuration, this key must be configured on both the Outlook Add-In client and the Exchange Server. If a pipeline is already running, a service restart on the proxy client where Exchange Mailbox Archiver is installed may be required. |
| Applies to | Exchange Mailbox Archiver Outlook Add-In |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\ |
| Unix | Not Applicable |
| NetWare | Not Applicable |
| Key | Galaxy.Ex2KMBDM.CVEAAddin |
| Value | ConnectOverHttp |
| Value Type (Windows only) | DWORD |
| Valid Range | 0 = Outlook Add-In will use normal connectivity
mode when performing stub recalls or opening Find and Recover. 1 = Outlook will use RPCoverHTTP mode when performing stub recalls or opening Find and Recover. |
| Default Value | 0 |
| Created in | Client |
| Description | This registry key sets the connectivity mode for Outlook Add-In functionality. |
| Applies To | Exchange Mailbox iDataAgent
Exchange Mailbox Archiver Outlook Add-In |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\ |
| Unix | Not Applicable |
| NetWare | Not Applicable |
| Key | Galaxy.Ex2KMBDM.CVEAAddin |
| Value | URL |
| Value Type (Windows only) | String |
| Default Value | None (User created) |
| Created in | Client |
| Description | URL of the DMProxy address configured on the client where WebProxy iDA is installed. Example: “https://server/DMProxy/DMProxy.asmx” |
| Applies To | Exchange Mailbox iDataAgent
Exchange Mailbox Archiver Outlook Add-In |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | MediaManager (standard) |
| Value | nAllowMagneticStorageForSilo (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 or 1 (0 = use of magnetic media not allowed, 1 = magnetic media allowed) |
| Default Value | None |
| Created in | CommServe computer |
| Description | This key determines if the Silo Storage is
allowed on magnetic media. By default, Silo Storage is allowed only on the tape media. Create this registry key and set it to '1' to allow magnetic media for Silo Storage. When this key is set, magnetic media can be selected for Silo data paths. |
| Applies to | Storage policy copy data path configuration for Silo Storage. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | CommServe (standard) |
| Value | OracleDeleteAgedBackupPiece (optional) |
| Value Type (Windows only) | String Value |
| Valid Range | Y or N (Yes or No) |
| Default Value | N/A |
| Created In | N/A |
| Description |
When created and
set to Yes, during a Data Aging operation, the CHANGE BACKUPPIECE
BackupPieceName DELETE command is automatically issued to RMAN to
remove specific backup pieces in the Oracle Recovery Catalog database
that were pruned from the Media Manager CommServe tables. With this, any
backup pieces that were aged from the system's database that have
exceeded their retention criteria will be marked as deleted in the
Oracle Recovery Catalog database. This registry key entry must be set on
the CommServe computer.
Following an upgrade of the CommServe to the current release, manually add the OracleDeleteAgedBackupPiece registry key on the CommServe. Even if this registry key was previously added as a matter of course and was on the CommServe, it must be added again following an upgrade of the specified CommServe. |
| Applies To | All Oracle iDataAgents in the CommCell. |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | iDataAgent (standard) |
| Value | ClusterBFmode (standard) |
| Value Type (Windows only) | DWORD |
| Valid Range | 0 - The persistence and savemerge bitmaps will
never be merged. 1 - The persistence bitmap will never be merged. The savemerge bitmap will be used instead. 2 - The persistence bitmaps will be merged. |
| Default Value | 1 |
| Created in | All nodes of the cluster. |
| Description | This key is used to specify which bitmaps are
merged in the event of restarts or failovers, which will determine whether
your next operation must be full. See the descriptions below: 0 - The persistence and savemerge bitmaps will never be merged. This solution always forces a full QR Volume creation or backup after a restart or failover. 1 - The persistence bitmap will never be merged. The savemerge bitmap will be used instead. This solution only allows incrementals after graceful restarts. Un-graceful restarts will force a full QR Volume Creation or backup. 2 - The persistence bitmaps will be merged. This solution allows incrementals after both graceful and ungraceful restarts and failovers. If you are changing this registry key value on a cluster, stop the cluster service resources before making the change. See Enable Persistence and Configure QSnap on Cluster for an example of when to change this registry key. |
| Applies To | Platforms: Windows 2000 Cluster and Windows Server
2003 Cluster Image Level iDataAgent Quick Recovery Agent for Windows |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\Machines\<client_name> |
| Key | <client_name> (standard) |
| Value | sServiceMonitorList (optional) |
| Value Type (Windows only) | String Value |
| Valid Range | Names of services to be monitored for a
specified instance, separated by a semicolon (";"). Example: GxCVD(Instance001);GxEvMgrC(Instance001) |
| Default Value | Not applicable. |
| Created in | User-created on all nodes of the cluster |
| Description | List of services that
GxClusPlugin
will
monitor on the active node of a cluster. If any of the services that it is
monitoring is in a stopped state,
GxClusPlugin
will quit, and if so
configured, will cause a failover of the cluster group. This registry key is
used in conjunction with
sServiceMonitorFrequency. For information about the services used by an Agent or MediaAgent, which can be listed in this registry key, see Services. For more information about failovers, see Clustering Support - Failovers. |
| Applies To | MediaAgents and Agents in a Windows cluster. |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\Machines\<client_name> |
| Key | <client_name> (standard) |
| Value | sServiceMonitorFrequency (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Integer |
| Default Value | 30 |
| Created in | User-created on all nodes of the cluster |
| Description | For the services listed in the sServiceMonitorList registry key, this registry key sets the time interval, in seconds, at which those services will be polled for status on the active node of a cluster. This value should be less than the service restart interval being monitored, if any. |
| Applies To | MediaAgents and Agents in a Windows cluster. |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Common\ |
| Key | Change Journal |
| Value | dwCJSizeAsPercentOfVolumeSize (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 through 100 (%) |
| Default Value | 10 (%) |
| Created in | The computer in which the agent or enabler is installed. |
| Description | This key is used only when the agent or enabler
creates a new Change Journal on a volume. The key is used to control the size of NTFS
Change Journal on Windows created by specific agents and enablers. The value
that you assign to the key dictates the percentage of volume size that will
be used to create Change Journal. However, when the key is set, a minimum
32MB and maximum of 4GB of volume space can be allocated for Change Journal
irrespective of the assigned value. If Change Journal is already active on a volume, the size of the Change Journal is not altered. If the key does not exist, 10% of the volume size is allocated for Change Journal. |
| Applies To | ContinuousDataReplicator on Windows, Data Classification on Windows, Windows File System iDataAgent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\CVD |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/CVD |
| NetWare | Open Galaxy.ini
on the client and add the following
section: [CVD] |
| Key | nNumPipelineBuffers (optional) |
| Value | Number of pipeline buffers between the client and the MediaAgent |
| Value Type (Windows only) | DWORD |
| Valid Range | 30 to 1024 When number of pipeline buffers is set to an out-of-range value: < 30 = defaults to 30 > 1024 = defaults to 1024 |
| Default Value | 30 |
| Created in | The computer in which the iDataAgent is installed. |
| Description | This key allows you to specify the number of pipeline buffers that will be used for transferring data between the client and the MediaAgent. This can help improve system performance. You can set this key on the MediaAgent as well as on the client; however, the setting on the client will be enforced regardless of the setting on the MediaAgent. |
| Applies To | Clients for all agents except the Quick Recovery Agent and all NAS NDMP agents |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\GalaxyInstallerFlags\ |
| Key | bPreImageMode |
| Value | 1 (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 or 1 A value of 1 will allow Decoupled Installs. A value of 0 will prevent Decoupled Installs. |
| Default Value | 0 |
| Created in | The computer in which a Decoupled install of the iDataAgent and/or MediaAgent is to be performed. |
| Description | Configure this key on a computer to allow software installation to be performed without connectivity to a CommServe. When the install completes, this key is automatically cleared -- its value is set to "0". For more information, see Decoupled Install. |
| Applies To | MediaAgent and/or iDataAgent on Windows. |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | NONE |
| Value | QSCacheVolume (optional) |
| Value Type (Windows only) | String |
| Valid Range | The drive letter for the RAW volume, in the
following format: \\?\G: Where G is the drive letter for the RAW volume (e.g., enter \\?\F: for the RAW volume F:). |
| Default Value | Not Applicable |
| Created in | The Client computer in which QSnap is installed. |
| Description | This value must be created to use a RAW volume
as the QSnap COW Cache volume. This value designates which RAW volume will
be used for the cache. Note that in order to use a RAW volume, the cache volume type must be set with the QSCacheVolumeType value below. If cache values are manually set in the registry, they will take precedence over the values set in the CommCell Console. |
| Applies To | QSnap on Windows 2000, XP and Server 2003 |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/HotspotSnapshotAgent/.properties |
| Key | NONE |
| Value | DisableWWNDetect (optional) |
| Value Type (Windows only) | String Value |
| Valid Range | n or N (to enable WWN detection), y or Y (disables WWN detection, which is the default behavior) |
| Default Value | WWN detection is disabled by default. |
| Created in | The Client computer in which the iDataAgent is installed. |
| Description | For fibre channel and SCSI disks, Volume Explorer can detect their World Wide Name (WWN) by sending the query to the hardware. Sometimes an incorrect WWN can be obtained because of the fabric configuration and/or storage array design, making two different volumes indistinguishable. WWN detection is turned off by default, to prevent incorrect detection. To enable WWN/LUN detection in Volume Explorer, create this registry key with a value of "N". |
| Applies To | Platforms: Windows 2000 and Windows Server
2003
Quick Recovery Agent (Windows and Unix) |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\QSnpWXXX\Parameters\QSBF |
| Key | QSBF (standard) |
| Value | BFActivateAll (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 - the QSnap
block filter is not enabled for all volumes
1 - the QSnap block filter is enabled for all volumes |
| Default Value | 1 |
| Created in | The Client computer in which QSnap is installed with the QuickRecovery, Image Level, or Image Level ProxyHost Agent. |
| Description | This registry key is used to specify that QSnap is to monitor the block filter of all volumes on the machine. |
| Applies To | QSnap |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\ |
| Unix | Not applicable. |
| NetWare | Not applicable. |
| Key | Galaxy.Ex2KMBDM.CVEAAddin (Standard) |
| Value | UIOptions (Standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range |
Integer Where the integer is a decimal value listed in the table below. |
| Default Value | The registry key's default value is determined by which User Interface Option is chosen during installation. |
| Created in | Computer that the Outlook Add-In component is installed on. |
| Description |
This registry key can be modified to change the current settings for the
Outlook Add-In user interface options. Calculate the UIOptions value
using the formula described below: Start with a value of 0, and then add the necessary values below for EACH of the items:
|
| Applies To |
Outlook Add-In, when used in conjunction with
any of the following
agents:
NOTES
|
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\ |
| Key | Galaxy.Ex2KMBDM.CVEAAddin (Standard) |
| Value | RecoveryOptions (Standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0, 1, 2, 3, 8, or 10 |
| Default Value | The registry key's default value is determined by which Recovery Option is chosen during installation. |
| Created in | Computer that the Outlook Add-In component is installed on. |
| Description |
This registry key can be modified to change the current settings for the Outlook Add-In
recovery options for recovery of data in an archived PST file and from
Non-PST stub recalls. For example:
NOTES
|
| Applies To |
Outlook Add-In, when used in conjunction with the following agent:
|
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\ |
| Unix | Not applicable. |
| NetWare | Not applicable. |
| Key | Galaxy.Ex2KMBDM.CVEAAddin (Standard) |
| Value | AutoLMJobFreq (Standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range |
Integer value in the range of 1 through
30 inclusive, where the value represents the
interval, in days, of how often an Offline Archive job will execute. For
example: If the value is set to 1, then the Offline Archive job will run every day. |
| Default Value | 1 |
| Created in | Computer that the Outlook Add-In component is installed on. |
| Description |
This registry key allows you to specify the interval, in days, of how
often that the Offline Archive job will execute; it is normally used in
conjunction with the
AutoLMJobRunTime
registry key for customizing automated Offline Archive operations. NOTES
|
| Applies To | Outlook Add-In when used in conjunction with Exchange Mailbox Archiver. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\ |
| Unix | Not applicable. |
| NetWare | Not applicable. |
| Key | Galaxy.Ex2KMBDM.CVEAAddin (Standard) |
| Value | AutoLMJobRunTime (Standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range |
Integer value in the range of 0 through
23 inclusive, where the value represents the
hour of the day when the Offline Archive job will execute. For example: If the value is set to 20, then the Offline Archive job will run around 8:00PM (+/- 1 hour). |
| Default Value | 20 |
| Created in | Computer that the Outlook Add-In component is installed on. |
| Description |
This registry key allows you to specify the time of day, in whole hours,
when the Offline Archive job will execute; it is normally used in
conjunction with the
AutoLMJobFreq
registry key for customizing automated Offline Archive operations. NOTES
|
| Applies To | Outlook Add-In when used in conjunction with Exchange Mailbox Archiver. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | Not applicable. |
| NetWare | Not applicable. |
| Key | MSExchangeDMAgent (Standard) |
| Value | nOfflineArchivingTimeout (Optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Integer value in the range of 1 through 365 inclusive, where the value represents the timeout, in days, of how long messages can be held in the offline archiving candidate state before stubbing them on the Exchange Server during the next archiving operation. |
| Default Value | When this key is not present, the default behavior is to keep messages in the offline archiving candidate state until an offline archiving operation is run from the Outlook client. If the value is not in the valid range, then a default timeout of 15 days will be used. |
| Created in | User-created in the computer in which the agent is installed. |
| Description |
This registry key allows you to specify the number of days that messages
marked as offline archiving candidates can exist before being
stubbed on the Exchange Server. If the timeout value is exceeded,
offline archiving candidates will be stubbed on the Exchange Server
during the next archiving operation. This avoids the problem where an archive operation is run from the CommCell Console and messages marked as offline archiving candidates are held indefinitely in that state until an offline archive operation is performed from the Outlook client. In the event that users do not run an offline archive operation, or the AutoLMJobFreq and AutoLMJobRunTime registry keys are unable to automatically run an offline archive operation because end-users' Outlook sessions are inactive, a timeout value can be established by this registry key to proceed with stubbing those messages on the Exchange Server during the next archiving operation, in order to save space. |
| Applies To | Exchange Mailbox Archiver |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\ |
| Unix | Not applicable. |
| NetWare | Not applicable. |
| Key | Galaxy.Ex2KMBDM.CVEAAddin (Standard) |
| Value | SearchPageURLOption (Optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range |
1 or 2,
where: 1 = enable End-User Search capabilities for the Search Console in Outlook 2 = enable Compliance Search capabilities for the Search Console in Outlook |
| Default Value | When this key is not present, the default behavior is to enable End-User Search capabilities for the Search Console in Outlook, assuming that the UIOptions registry key has been configured to enable the Search Console toolbar button. |
| Created in | User-created in the computer that the Outlook Add-In component is installed on. |
| Description |
This registry key allows you to enable Compliance Search capabilities for
the Search Console in Outlook. NOTES
|
| Applies To | Outlook Add-In |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\Galaxy.Ex2KMBDM.CVEAAddin |
| Key | LMOptions |
| Value | |
| Value Type (Windows only) | DWORD |
| Valid Range | Not Applicable |
| Default Value | On or Off |
| Created in | Computer that the Outlook Add-In component is installed on. |
| Description | If the value is set to 8 then the Offline Archive pruning will be disabled. If the key is missing or set to any other value then the pruning number of days configured will be used. |
| Applies To | Outlook Add-In |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\Galaxy.Ex2KMBDM.CVEAAddin |
| Key | LMPSTExpiry |
| Value | |
| Value Type (Windows only) | DWORD |
| Valid Range | Not Applicable |
| Default Value | |
| Created in | Computer that the Outlook Add-In component is installed on. |
| Description | Number of days before the offline archived files will be pruned. |
| Applies To | Outlook Add-In |
| Location | |
| Windows |
HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ For 32-bit agents installed on a Windows x64 platform: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\CommVault Systems\Galaxy\Instance001\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/Session/.properties |
| NetWare | Not applicable |
| Key | Session (Standard) |
| Value | nEVMGRCPORT (Standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Any valid port number is not used by any other services. |
| Default Value | 8402 |
| Created in | The computer in which the agent is installed. |
| Description | This key allows you to specify the network port number that will be used by the Client Event Manager (GxEvMgrC) to communicate with other components within a CommCell. |
| Applies To |
All Windows-based components. NOTES
|
| Location | |
| Windows |
HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ For 32-bit agents installed on a Windows x64 platform: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\CommVault Systems\Galaxy\Instance001\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/Session/.properties |
| NetWare | Not applicable |
| Key | Session (Standard) |
| Value | nCVDPort (Standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Any valid port number that is not used by any other services. |
| Default Value | 8400 |
| Created in | The computer in which the agent is installed. |
| Description | This key allows you to specify the network port number that will be used by the Communications Service (GxCVD) to communicate with other components within a CommCell. |
| Applies To |
All Windows-based components. NOTES
|
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | Not applicable |
| NetWare | Not applicable |
| Key | EventManager (Standard) |
| Value | sProxyExchangeServer (Optional) |
| Value Type (Windows only) | String Value |
| Valid Range | Fully qualified domain name (for example, proxyserver.company.com) |
| Default Value | N/A |
| Created in | User-created in the Exchange Server 2007 computer in which the agent is installed. |
| Description |
This key allows you to specify the fully qualified domain name of the
off-host proxy client that will be used for conducting data recovery
operations from Outlook Add-In clients. NOTES
|
| Applies To |
Required by the following 32-bit MAPI-based agents for Exchange Server
2007 when they are installed on a 32-bit off-host proxy client:
|
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | Not applicable |
| NetWare | Not applicable |
| Key | EventManager (Standard) |
| Value | nProxyEvMgrCPortNumber (Optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Any valid port number |
| Default Value | 0 |
| Created in | User-created in the Exchange Server 2007 computer in which the agent is installed. |
| Description |
This key allows you to specify the network port used by the Client Event
Manager Services on the Exchange Server to communicate with off-host proxy
clients for conducting recovery operations from Outlook Add-In clients. NOTES
|
| Applies To |
Required by the following 32-bit MAPI-based agents for Exchange Server
2007 when they are installed on a 32-bit off-host proxy client:
|
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\ |
| Unix | Not applicable |
| NetWare | Not applicable |
| Key | Galaxy.Ex2KMBDM.CVEAAddin (Standard) |
| Value | nEvMgrCPortNumber (Standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Any valid port number |
| Default Value | 0 |
| Created in | The computer in which the Outlook Add-In is installed. |
| Description | This key allows you to specify the network port used by the Client Event
Manager Services on the Outlook Add-In client to communicate with the
Exchange Server for conducting data recovery operations. NOTES
|
| Applies To | Outlook Add-In |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/FileSystemAgent/.properties |
| Key | FileSystemAgent (standard) |
| Value | OnDemand_AutoExpandDir (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 Any non-zero value Examples:
|
| Default Value | 0 |
| Created in | The client computer. |
| Description |
When this key is set to 0, any directories listed in the
Content File(s) for
On Demand
Data Protection Operations will not be auto-expanded during
the scan. The Content File(s) must contain the path for every directory
whose contents are to be included in the data protection operation. When this key is set to any non-zero value, or is not present, any directories listed in the Content File(s) for On Demand Data Protection Operations will be auto-expanded during the scan, so that the contents of all subdirectories within the specified directory will automatically be included in the data protection operation. |
| Applies To | Macintosh, Unix, and Windows File System iDataAgents and the File Archiver for Windows Agent. |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | ExchangeArchiver (standard) |
| Value | sDoNotArchiveAfter (optional) |
| Value Type (Windows only) | String Value |
| Valid Range | A date in the format of
mm-dd-yyyy where mm is the 2-digit month, dd is the 2-digit date, and yyyy is the 4-digit year For example: 02-25-2005 |
| Default Value | N/A |
| Created In | User-created in the client computer in which the agent is installed. |
| Description | This registry key can be used to force the system to only archive messages in the Journal Mailbox that are older than the specified date. You can also use this key conjunction with the sDoNotArchiveBefore registry key to establish a date range to further limit the amount of data that is archived. |
| Applies To | Exchange Compliance Archiver |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | ExchangeArchiver (standard) |
| Value | sDoNotArchiveBefore (optional) |
| Value Type (Windows only) | String Value |
| Valid Range | A date in the format of
mm-dd-yyyy where mm is the 2-digit month, dd is the 2-digit date, and yyyy is the 4-digit year For example: 02-25-2007 |
| Default Value | N/A |
| Created In | User-created in the client computer in which the agent is installed. |
| Description | This registry key can be used to force the system to only archive messages in the Journal Mailbox that are newer than the specified date. You can also use this key conjunction with the sDoNotArchiveAfter registry key to establish a date range to further limit the amount of data that is archived. |
| Applies To | Exchange Compliance Archiver |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node |
| Unix | Not Applicable |
| NetWare | Not Applicable |
| Key | GalaxyInstallerFlags (optional) |
| Value | bAllow32BitInstallOn64Bit (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 or 1 |
| Default Value | 0 |
| Created In | User-created in the client computer in which the agent will be installed. |
| Description | Set the value of this registry key to 1 if you wish to install a 32-bit Agent on a Microsoft Windows x64 platform. |
| Applies To |
|
| Location | |
| Windows |
HKEY_LOCAL_MACHINE\SOFTWARE\ For 32-bit agents installed on a Windows x64 platform: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ |
| Unix | /tmp/ |
| Key | |
| Windows | GalaxyInstallerFlags (optional) |
| Unix | cvpkgadd_unlock_inst (optional) |
| Value | |
| Windows | bAllowMultiInstances (optional) |
| Unix | Not applicable |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 or 1 |
| Default Value | 0 |
| Created In | User-created in the computer in which the components will be installed. |
| Description | Set the value of this registry key to 1 to allow multiple instances to be installed one computer. |
| Applies To | All Agent and MediaAgent components that support Multi Instancing. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\QSnpWXXX\Parameters\QSBF |
| Key | QSBF (standard) |
| Value | BackupExtSize |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Size specified in bytes. (Must be a power of 2) |
| Default Value | 512 KB |
| Created in | The Client computer in which QSnap is installed with the Image Level iDataAgent. |
| Description | This registry key is used to specify the backup extent size. Specifies the number of bytes represented by one bit in the bitmap that is used to identify used and/or changed data on a disk volume. This field is expanded to 64 bits with the use of the BackupExtSizeHigh registry key. After changing the default value of this key, the computer requires a reboot for the changes to take effect. |
| Applies To | Image Level iDataAgent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\QSnpWXXX\Parameters\QSBF |
| Key | QSBF (standard) |
| Value | BackupExtSizeHigh (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Size specified in bytes. (Must be a power of 2) |
| Default Value | 0 |
| Created in | The Client computer in which QSnap is installed with the Image Level iDataAgent. |
| Description | This registry key is used to specify the backup extent size to be greater that 4GB. Specifies the upper 32-bits of 64-bit backup extent size. Before specifying a value for this registry key, see BackupExtSize. |
| Applies To | Image Level iDataAgent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\QSnpWXXX\Parameters\QSBF |
| Key | QSBF (standard) |
| Value | ReplicaExtSize |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Size specified in bytes. (Must be a power of 2) |
| Default Value | 256 KB |
| Created in | The Client computer in which QSnap is installed with the Quick Recovery Agent. |
| Description | This registry key is used to specify the replica extent size for both full and incremental updates. Specifies the number of bytes represented by one bit in the bitmap that is used to identify used and/or changed data on a disk volume. This field is expanded to 64 bits with the use of the ReplicaExtSizeHigh registry key. After changing the default value of this key, the computer requires a reboot for the changes to take effect. |
| Applies To | Quick Recovery Agent for Windows |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\QSnpWXXX\Parameters\QSBF |
| Key | QSBF (standard) |
| Value | ReplicaExtSizeHigh (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Size specified in bytes. (Must be a power of 2.) |
| Default Value | 0 |
| Created in | The Client computer in which QSnap is installed with the Quick Recovery Agent or Image Level iDataAgent. |
| Description | This registry key is used to specify the replica extent size to be greater that 4GB. Specifies the upper 32-bits of 64-bit backup extent size. Before specifying a value for this registry key, see ReplicaExtSize. |
| Applies To | Quick Recovery Agent for Windows |
| Location | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/Hotspot/SnapshotAgent/.properties |
| Key | SnapshotAgent (optional) |
| Value | sSNAPPPART (optional) |
| Value Type | String Value |
| Valid Range | Valid directory |
| Default Value | Install directory |
| Created in | Client computer in which QSnap is installed with the Unix File System iDataAgent or the Image Level iDataAgent |
| Description | Unlike in previous releases, the user is no longer prompted for the snap cache directory during a QSnap install. Instead, the snap cache directory defaults to the install directory. However, after the install, you can use this key to change the location of the snap cache directory. Simply change the value of the key to a valid directory. |
| Applies To | Unix File System iDataAgents, Image Level on Unix iDataAgent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx> |
| Unix |
/etc/CommVaultRegistry/Galaxy/Instance |
| NetWare | Not applicable |
| Key | Session (Standard) |
| Value | nEnableSessionBlacklist (Standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 or 1 (1 = enable, 0 = disable) |
| Default Value | None |
| Created in | User-created in the client computer to be configured for session blacklisting. |
| Description | This key allows to enable or disable session blacklisting. |
| Applies To | All |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx> |
| Unix |
/etc/CommVaultRegistry/Galaxy/Instance |
| NetWare | Not applicable |
| Key | Session (Standard) |
| Value | nEnableSessionBlacklistLogging (Standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 or 1 (1 = enable, 0 = disable) |
| Default Value | None |
| Created in | User-created in the client computer enabled with session blacklisting. |
| Description | This key is used to enable or disable the creation of a log file containing the list of blacklisted clients. |
| Applies To | All |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | FileSystemAgent (standard) |
| Value | nDisableGalaxyMerge (standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 or 1 0 - The registry is merged and all CommCell related files are restored normally 1 - This will trigger the following actions:
|
| Default Value | The default value is 0. |
| Created In | The computer in which the full system restore is performed. |
| Description | Use this key to disable registry merging. |
| Applies To | Windows 2000, XP and Server 2003 iDataAgents |
| Location | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/Db2Agent/.properties |
| Key | Db2Agent (optional) |
| Value |
sBKPRESTARTFAILEDNODESTimeOut
x
(optional) where x is the appropriate value in seconds |
| Value Type (Windows only) | Not Applicable |
| Valid Range | Any number greater than or equal to 0 (seconds) |
| Default Value | None |
| Created In | The computer in which the iDataAgent is installed. |
| Description | If a DB2 DPF iDataAgent data management job goes to a pending state, and if the job has completed on one or more of the nodes, the restart option will start the job on all the nodes unless this registry key is set appropriately. The key value is used to specify the maximum amount of time that can elapse before a job can be restarted on a successful node. For example, suppose a backup job completes on Node 0 but goes to a pending state on Node 1, and suppose the key is set to 1800 seconds. If the restart is issued after 3600 seconds, for example, the job will also be restarted on Node 0 since the 1800 seconds setting has been exceeded. But if the restart is issued after 900 seconds, the job will be restarted only on Node 1 since the 1800 seconds setting has not been exceeded. |
| Applies To | DB2 DPF iDataAgent |
| Location | |
| Windows | Not Applicable |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/mysql/.properties |
| NetWare | Not Applicable |
| Key | mysql (optional) |
| Value |
sAdvancedBackupOptions
(optional) ---Set to any mysql dump command line option. Ex: "max_allowed_packet=" |
| Value Type | String |
| Valid Range | Not Applicable |
| Default Value | Not Applicable |
| Created in | This Key is user-created (not created by default). |
| Description | This key is used to set a value to mysql dump command. |
| Applies To | MySQL iDataAgents |
| Location | |
| Windows | Not Applicable |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/mysql/.properties |
| NetWare | Not Applicable |
| Key | mysql (optional) |
| Value |
sAdvancedRestoreOptions (optional) ---Set to any mysql dump command line option. Ex: "max_allowed_packet=" |
| Value Type (Windows only) | String |
| Valid Range | Not Applicable |
| Default Value | Not Applicable |
| Created in | This Key is user-created (not created by default). |
| Description | This key is used to set a value during restore of dumps/logs to mysql command. |
| Applies To | MySQL iDataAgents |
| Location | |
| Windows | Not Applicable |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/mysql/.properties |
| NetWare | Not Applicable |
| Key | mysql |
| Value | sLogStagingPath |
| Value Type (Windows only) | String |
| Valid Range | Not Applicable |
| Default Value | Not Applicable |
| Created in | This Key is user-created (not created by default). |
| Description | This key is used to allow the user to specify the log staging location. |
| Applies To | MySQL iDataAgents |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/Session/.properties |
| NetWare | Not applicable |
| Key | Session (Standard) |
| Value | nEnableSessionBlacklist (Optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 or 1 (1 - enable, 0 = disable) |
| Default Value | 0 |
| Created In | Any CommCell computer |
| Description | This key is used to block any rogue sessions from other CommCell Components |
| Applies To | All |
| Location | |||
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ | ||
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/NAS/.properties | ||
| Key | NAS (optional) | ||
| Value | sConvertToFull (optional) | ||
| Value Type (Windows only) | String Value | ||
| Valid Range | y, Y, n, N | ||
| Default Value | N | ||
| Created in | The MediaAgent computer in which the NAS NDMP iDataAgent is installed. | ||
| Description | If set to "y" or "Y", then if no more
incrementals are allowed, the backup will automatically be converted to a
FULL rather than failing. If set to "n" or "N", then if no more incrementals are allowed, the backup will fail.
You may find additional information in Backup - NAS NDMP - Backup Considerations - Hitachi and NetApp Clients - Incremental Backups. |
||
| Applies To | Hitachi NAS NDMP iDataAgent NetApp NAS NDMP iDataAgent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/NAS/.properties |
| NetWare | Not Applicable |
| Key | NAS (optional) |
| Value | OnDemandLocalFilePath (optional) |
| Value Type (Windows only) | String Value |
| Valid Range | Full path of the Content File. |
| Default Value | None |
| Created in | The MediaAgent computer(s) used for NAS NDMP data protection operations. |
| Description | Allows On Demand NAS backups to use the Content File on the MediaAgent. Specify the full path of the Content File. |
| Applies To | NetApp NDMP iDataAgent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | WinFSDataMigrator (standard) |
| Value | GXHSM_NAS_REMOVESPARSE_ON_RECALL |
| Value Type (Windows only) | String Value |
| Valid Range | Y or N |
| Default Value | N |
| Created in | Computers where File Archiver is installed |
| Description | When registry key GXHSM_FPOLICY_CREATESPARSE is set to Y, archiving FPolicy or NAS; data will create stubs that have a sparse attribute. Therefore when this key is set to 'N', recall process leave sparse attribute on sparse file. If it is set to 'Y' sparse attribute is removed on recall. |
| Applies To | FPolicy and Network File Share instances |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | NAS (optional) |
| Value | GXHSM_IGNORE_ALT_STREAM_RECALLS |
| Value Type (Windows only) | String Value |
| Valid Range | Y or N |
| Default Value | N |
| Created in | Computers where File System datamigrator runs |
| Description | Any modifications to alternate stream after stubbing is lost if this key is set to 'Y', so as to disallow alternate streams from triggering a recall. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | WinFSDataMigrator (standard) |
| Value | GXHSM_FPOLICY_REGISTER_FILERNAME |
| Value Type (Windows only) | String Value |
| Valid Range | default |
| Default Value | Default value short on Windows 2008 and Vista. Default value empty on all other OS. |
| Created in | Computers where File Archiver for Windows Agent runs. |
| Description | This key is used for FPolicy support on computers with Windows 2008. |
| Applies To | File Archiver for Windows Agent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | WinFSDataMigrator (standard) |
| Value | GXHSMRESTORE_NAS_SEC_ACL |
| Value Type (Windows only) | String Value |
| Valid Range | Y to restore security Access Control List. N to not restore security ACL |
| Default Value | Y |
| Created in | The computer in which the agent is installed |
| Description | This key is not created by default when
restoring Celerra and Network File Share. To restore ACL's security it has
to be created by the user and its value has to be set to Y. For FPolicy this key is created by default and its value is set to "N" by the GXHSMFPDM.dll process. In order to turn the key on the user has to set the value to Y. |
| Applies To | File Archiver for Windows |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/OracleAgent/.properties |
| NetWare | Not Applicable |
| Key | OracleAgent (standard) |
| Value | sLARGEPOOLSIZE (optional) |
| Value Type (Windows only) | STRING |
| Valid Range | NIL |
| Default Value | 16M |
| Created in | The computer in which the Oracle iDataAgent is installed. |
| Description | This client-side registry key is used to modify the large pool size for the auxiliary Database during Oracle tablerestore. Default value of this parameter is 16M and setting this registry key will override it. |
| Additional Information | You may find additional information in Restore Data - Oracle - Table Restores. |
| Applies to | Oracle and Oracle RAC iDataAgents |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/OracleAgent/.properties |
| NetWare | Not Applicable |
| Key | OracleAgent (standard) |
| Value | sSTREAMPOOLSIZE (optional) |
| Value Type (Windows only) | STRING |
| Valid Range | NIL |
| Default Value | 48M |
| Created in | The computer in which the Oracle iDataAgent is installed. |
| Description | This client-side registry key is used to specify the streams pool size parameter of the auxiliary instance during tablerestore. Default value if this registry key is not set is 48M |
| Additional Information | You may find additional information in Restore Data - Oracle - Table Restores. |
| Applies to | Oracle and Oracle RAC iDataAgents |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/OracleAgent/.properties |
| NetWare | Not Applicable |
| Key | OracleAgent (standard) |
| Value | sUNDORETENTIONSIZE (optional) |
| Value Type (Windows only) | STRING |
| Valid Range | NIL |
| Default Value | 1800 seconds |
| Created in | The computer in which the Oracle iDataAgent is installed. |
| Description | This key is used to specify the undo retention parameter in seconds for the auxiliary instance during tablerestore. Default value if this registry key is not set is 1800 seconds |
| Additional Information | You may find additional information in Restore Data - Oracle - Table Restores. |
| Applies to | Oracle and Oracle RAC iDataAgents |
| Location | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/.properties |
| Key | Base (standard) |
| Value |
sBindToInterface x
(optional) where x is the appropriate value |
| Value Type (Windows only) | Not Applicable |
| Valid Range | Host name or IP address of the interface to which all services should bind. |
| Default Value | Not Applicable |
| Created In | The computer in which the iDataAgent is installed. |
| Description | This key allows you to bind all services (e.g.,
Client Event Manager, Communications Service, etc.) to the specified
interface name or IP address. This is especially useful for dual-NIC setups
where you do not want these services exposed on the public interface. NOTES
|
| Applies To | Unix File System iDataAgents |
| Location | |||
| Windows | Not Applicable | ||
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/FileSystemAgent/.properties | ||
| NetWare | Not Applicable | ||
| Key | FileSystemAgent (standard) | ||
| Value | HLINK (optional) | ||
| Value Type (Windows only) | Not Applicable | ||
| Valid Range | y or Y (to enable hard link functionality) or any other value (to disable) | ||
| Default Value | y or Y | ||
| Created In | The computer in which the iDataAgent is installed. | ||
| Description | This key allows you to back up data contents
including hard links. If you are backing up hard links with this key set to
Y and the appropriate hard link updates
applied, ensure that there are no directories in your subclient content that
are named /_CVHardLink@-@-Files_/.
Otherwise, a backup of that content will not complete successfully. And if a
head hard link is removed from the subclient content between the scan and
backup phase, the backup job will go to pending. In such a case, you must
kill the job and start a new backup.
|
||
| Applies To | Unix File System iDataAgents |
| Location | |
| Windows | Not Applicable |
| Unix | /etc/CommVault/Galaxy/Instance<xxx>/FileSystemAgent/.properties |
| NetWare | Not Applicable |
| Key | FileSystemAgent (standard) |
| Value | EnableFSTypeCache (optional) |
| Value Type (Windows only) | Not Applicable |
| Valid Range | Y or N |
| Default Value | Y |
| Created In | The computer in which the iDataAgent is installed. |
| Description | This key allows you to disable
the internal cache and use the Unix operating system to fetch file
system information faster.
Please consider the following about this feature:
|
| Applies To | Unix File System iDataAgents |
| Location | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/FileSystemAgent/.properties |
| Key | FileSystemAgent (standard) |
| Value |
ignoreFSType :fs
name a:fs name b: where fs name a, fs name b, etc., identify the affected file systems |
| Value Type (Windows only) | Not Applicable |
| Valid Range | lofs (with ufs, zfs, vxfs for Solaris Global Zone), tmpfs, ctfs, proc, devfs |
| Default Value | Not Applicable |
| Created in | The computer in which the iDataAgent is installed. |
| Description | This registry key allows you to add and remove
file system types from zone backup operations for Unix File System
iDataAgents.
By default, the lofs, tmpfs, devfs, ctfs, and proc file systems will be skipped during backup. However, this registry key will allow you to determine which of these file systems will be backed up or skipped during backup. Also, the addition of the lofs file system as a skipped file system has an impact on the Solaris Global Zone with regard to filesystem submount points that might previously had been expected to be backed up (e.g., if the root of a zone is an lofs file system and it has the ufs, zfs, or vxfs submount file system). These submount file systems will be skipped during backup unless they are added to the subclient content. To use this key, simply include after ignoreFSType and using the correct format a value to identify the file system(s) you will skip during backup. Use the following format for the key value: :fs name a:fs name b:...:fs name n: The value must start and end with ":". Each file system name must be separated by ":". All file systems will be backed up (see first Note below) if the value is set to "::". For example: ignoreFSType :lofs:tmpfs: (In this example, the command will skip backing up the lofs and tmpfs file systems.) NOTES
|
| Applies To | Unix File System iDataAgents |
| Location | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/iDataAgent/.properties |
| Key | iDataAgent (standard) |
| Value |
OptimizeRunLengths x
where x is an appropriate value that determines whether or not to create genuine holes in potential or actual sparse files during a restore and, if such creation is desired, the minimum byte length threshold boundary for hole creation. |
| Value Type (Windows only) | Not Applicable |
| Valid Range | Integer greater than or equal to -1 |
| Default Value | Not Applicable |
| Created in | The computer in which the iDataAgent is installed. |
| Description | This key allows you to determine whether to
restore genuine holes in potential or actual sparse files flat or intact
based on size considerations. Note that such restores without this key are
"flat" by default.
NOTES
During a backup, a backup hole scanner scans the data being sent for large areas of zeros, and it replaces each such area with a PL_HOLE tag header. Each area of zeros may or may not in fact represent sparse file holes; nevertheless, the PL_HOLE tag header is applied in every case. When restoring data, use this key with value -1 or no value (or simply do not use this key) if you want to restore "flat" the data represented by each PL_HOLE tag header. To restore the data represented by the PL_HOLE tag headers as genuine holes, use this key with the appropriate positive integer value to ensure restoring tag headers of a particular byte length. Tag headers that are longer than the length that you specify using this value will be restored as holes; on the other hand, tag headers that are shorter than the length that you specify will be restored flat. For example, if you specify “OptimizeRunLenghts 3”, PL_HOLE tag headers with a length of 4 bytes, 5 bytes, etc. will be restored as holes, while tag headers with a length of 2 bytes, 1 byte, etc. will be restored flat. |
| Applies To | AIX, FreeBSD, HP-UX, IRIX, Linux, Solaris, and Tru64 File System iDataAgents |
| Location | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/iDataAgent/.properties |
| Key | iDataAgent (standard) |
| Value |
sUFSRESTORE x
(optional) where x is an appropriate value |
| Value Type (Windows only) | Not Applicable |
| Valid Range | y or Y (to enable ufsrestore) or any other value (to disable ufsrestore) |
| Default Value | y (ufsrestore enabled) |
| Created in | The computer in which the iDataAgent is installed. |
| Description | This key allows you to enable (value y or Y) or disable (any other value) the use of ufsrestore. If ufsrestore is disabled at restore time, clRestore will leave file <destinationFileName>.ufsdump on disk for the manual use of ufsrestore. |
| Applies To | Solaris File System iDataAgent |
| Location | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/FileSystemAgent/.properties |
| Key | FileSystemAgent (standard) |
| Value | sUNLINKTOREPLACE |
| Value Type (Windows only) | Not Applicable |
| Valid Range | yes |
| Default Value | no |
| Created in | The computer in which the iDataAgent is installed. |
| Description | This key allows the restore to overwrite open
files that are in use by first deleting them and then restoring them. Use this key AT YOUR OWN RISK. Be sure to review Unconditionally Overwrite Root Directories on Live Systems before considering enabling this option. |
| Applies To | Linux File System iDataAgent |
| Location | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/FileSystemAgent/.properties |
| Key | FileSystemAgent (standard) |
| Value |
sClusteredFSFilter
x (optional) where x is an appropriate value |
| Value Type (Windows only) | Not Applicable |
| Valid Range | Y (to enable the key) or N (to disable the key) |
| Default Value | Not Applicable |
| Created in | The computer in which the iDataAgent is installed. |
| Description | This key, along with its associated sClusteredFSTypes registry key, allows you to filter file systems for backup. In essence, the keys allow you to control whether clustered (shared) file systems and non-clustered file systems will be backed up during a Data Protection operation from a physical or virtual node. If you are running a backup from a physical node, and if you want to prevent backing up clustered file systems (and therefore just want to back up non-clustered file systems), set this key to Y. If you are running a backup from a virtual node, and if you want to back up only clustered file systems (and therefore do not want to back up non-clustered file systems), set this key to Y and set the sClusteredFSTypes registry key to the value(s) representing the clustered file system(s) to be backed up. Be sure to separate each value with a comma. |
| Applies To | AIX and Linux File System iDataAgents that support the VERITAS Cluster File System (VxCFS) |
| Location | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/FileSystemAgent/.properties |
| Key | FileSystemAgent (standard) |
| Value |
sClusteredFSTypes
x (optional) where x is an appropriate value |
| Value Type (Windows only) | Not Applicable |
| Valid Range | vxfs (VERITAS Cluster File System) |
| Default Value | Not Applicable |
| Created in | The computer in which the iDataAgent is installed. |
| Description | This key, along with its associated sClusteredFSFilter registry key, allows you to filter file systems for backup. In essence, the keys allow you to control whether clustered (shared) file systems and non-clustered file systems will be backed up during a Data Protection operation from a physical or virtual node. If you are running a backup from a physical node, and if you want to prevent backing up clustered file systems (and therefore just want to back up non-clustered file systems), set the sClusteredFSFilter key to Y. If you are running a backup from a virtual node, and if you want to back up only clustered file systems (and therefore do not want to back up non-clustered file systems), set the sClusteredFSFilter key to Y and set this key to the value(s) representing the clustered file system(s) to be backed up. Be sure to separate each value with a comma. |
| Applies To | AIX and Linux File System iDataAgents that support the VERITAS Cluster File System (VxCFS) |
| Location | |||
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\LotusNotesDMAgent | ||
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx> /LotusNotesDMAgent/.properties | ||
| NetWare | Not Applicable | ||
| Key | LotusNotesDMAgent (standard) | ||
| Value | sDOCUMENTTYPEFILTERLIST (optional) | ||
| Value Type (Windows only) | String | ||
| Valid Range | Any string value where each
element represents a document type. Multiple document types must be separated using a semicolon. For example: Memo;Phone;Appointment;Task |
||
| Default Value | Not Applicable | ||
| Created in | User-created on the client hosting the Domino Server. | ||
| Description |
This key enables the Domino Mailbox Archiver to exclude documents based on
their types. Various document types can be set via this key, acting as a
type filter.
|
||
| Applies To | Domino Mailbox Archiver Agent |
| Location | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/UnixFsDataMigrator/.properties |
| Key | UnixFsDataMigrator (standard) |
| Value | dSTUB_CACHE_ROOT (optional) |
| Value Type | String |
| Valid Range | Not Applicable |
| Default Value | Not Applicable |
| Created in | The computer in which the agent is installed. |
| Description | This key allows you to specify location of the root folder for the File Archiver stub cache (see nUSE_STUB_CACHE). By default, the stub cache will be created under /opt/galaxy/StubCache. |
| Applies To | File Archiver for Unix |
| Location | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/UnixDataMigrator/.properties |
| Key | UnixFsDataMigrator (standard) |
| Value | nUSE_STUB_CACHE (standard) |
| Value Type | String |
| Valid Range | Y to preserve stubs in cache and re-stub them after recall; or N to disable re-stubbing of files after recall. |
| Default Value | Y |
| Created in | The computer in which the agent is installed. |
| Description | When set to Y,
this key allows a file to be re-stubbed after recall by preserving it in
cache memory if the current archive file exists and no changes were made to
the recalled file. During a subsequent migration, if the files to be
migrated have not been modified since their last recall, the migration is
completed by just moving the stubs back from the cache to replace the files.
As such, no date transfer happens and no space is taken on tape/magnetic
media again. Current default behavior is to enable re-stubbing of files
after recall. NOTES
|
| Applies To | File Archiver for Unix |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\WinFSDataMigrator\ |
| Key | Drives (standard) |
| Value | <name of the drive/volume> (standard) |
| Value Type | String Value |
| Valid Range | The letter of the drive or volume to be monitored, followed by a colon and a backslash (e.g., "E:\"). |
| Default Value | None |
| Created in | The computer in which the agent is installed. |
| Description | This key enables the specified drive or volume
to be monitored for stub recovery. Note that this key:
|
| Applies To | File Archiver for Windows |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance<xxx>/EventManager/.properties |
| Key | EventManager (standard) |
| Value | nDMRSendFileStatus (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 0 to turn off Job Manager updates on stub recall; or 1 to send Job Manager updates at the end of each stub recall. |
| Default Value | When the key is not present, the default behavior is the same as that of value 0. Once the key is created, it should be set to either 0 or 1. |
| Created in | User-created in the computer in which the agent is installed. |
| Description | This key controls the frequency at which stub
recovery job statistics are sent to Job Manager for updating Recovery Job
History views and reports. Creating this key with a value of
0 turns off stub recall reporting. Setting the key to 1 enables stub
recall history update at an interval based on the value of the registry key
nDMRSIDLETIMEOUT.
If the nDMRSIDLETIMEOUT key does not exist,
the default time out is 20 minutes (1200 seconds) after the stub recall job
completes. This key is useful for increasing the efficiency of system resources in cases where there are frequent stub recalls and there is no need to update the Job History immediately after each stub recall. After creating this key or modifying its value, restart all services for the change to take effect. |
| Applies To | Domino Mailbox Archiver File Archiver for Windows File Archiver for Unix |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | WinFSDataMigrator (standard) |
| Value | GXHSMSERVICEKEEPTIMES (optional) |
| Value Type | String Value |
| Valid Range | Y to preserve the original file access time and modified time during stub recovery operations; or N to not preserve those times during stub recovery. |
| Default Value | Y |
| Created in | User-created in the computer in which the agent is installed. |
| Description | This key preserves the original file access
time and modified time for files during stub recovery operations. It can be
used in conjunction with the
GXHSMSTUBKEEPTIMES registry key to preserve these times during
archive operations
as well. After adding (or removing) the value for this key, restart the GXHSM services for the change to take effect. NOTES
|
| Applies To | File Archiver for Windows |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | WinFSDataMigrator (standard) |
| Value | GXHSM_PRESERVE_ACCESSTIME_ONMIGRTNS (optional) |
| Value Type | String Value |
| Valid Range | Y to preserve the original file access time and modified time during migrations; or N to not preserve those times during migrations. |
| Default Value | Y |
| Created in | User-created in the computer in which the agent is installed. |
| Description | By default, this key preserves the original
file access time and modified time for files during migrations. You can
set this key to stop preserving these times. After adding (or removing) the value for this key, restart the GXHSM services for the change to take effect. |
| Applies To | File Archiver for Windows |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | WinFSDataMigrator (standard) |
| Value | GXHS_PRESERVE_ACCESSTIME_ONRECALLS (optional) |
| Value Type | String Value |
| Valid Range | Y to preserve the original file access time and modified time during recalls; or N to not preserve those times during recalls. |
| Default Value | Y |
| Created in | User-created in the computer in which the agent is installed. |
| Description | By default, this key preserves the original
file access time and modified time for files during recalls. You can set
this key to stop preserving these times. After adding (or removing) the value for this key, restart the GXHSM services for the change to take effect. To enable the functionality of this key, the value of GXHSM_PRESERVE_ACCESSTIME_ONMIGRTNS should be set to N. |
| Applies To | Local File System and Network File Share instances |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | WinFSDataMigrator (standard) |
| Value | GXHSMSTUBKEEPTIMES (optional) |
| Value Type | String Value |
| Valid Range | Y to preserve the original file access time and modified time during archive operations; or N to not preserve those times during archiving. |
| Default Value | Y |
| Created in | User-created in the computer in which the client component is installed. |
| Description | This key preserves the original file access
time and modified time for files during archive operations. It can be used
in conjunction with the
GXHSMSERVICEKEEPTIMES
registry key to preserve these times during stub recovery operations as well. After adding (or removing) the value for this key, restart the GXHSM services for the change to take effect. NOTES
|
| Applies To | File Archiver for Windows |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | WinFSDataMigrator (standard) |
| Value | GXHSMNOPOPUP (standard) |
| Value Type | String Value |
| Valid Range | Y to disable the pop-up; or N to enable the pop-up |
| Default Value | Y |
| Created in | Created in the computer in which the agent is installed, when the GXHSM service is started. |
| Description | This key enables/disables a pop-up message displayed for stub recoveries confirming that the recovery operation completed, and showing the path of the file that was recovered. |
| Applies To | File Archiver for Windows |
| Location | HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\GXHSMNAS\ |
| Key | Parameters |
| Value |
GXHSM_DISABLE_ARCHIVE_FILE_RECALL_AND_RESTORE |
| Value Type | String Value |
| Valid Range | Y |
| Default Value | NA |
| Created in | Created in the computer in which File Share Archiver Client is installed. |
| Description | This registry key disables stub recalls at the driver level and allows
service to send custom popup messages. This key should be used with a
service level key
GXHSM_DISABLE_ARCHIVE_FILE_RECALL_AND_RESTORE_MESSAGE. The services must be restarted. |
| Applies To | File Archiver for Windows |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instancexxx\ |
| Key | WinFSDataMigrator (standard) |
| Value |
GXHSM_DISABLE_ARCHIVE_FILE_RECALL_AND_RESTORE_MESSAGE |
| Value Type | String Value |
| Valid Range | Customized message |
| Default Value | NA |
| Created in | Created in the computer in which File Share Archiver Client is installed. |
| Description | This is a service level key used in conjunction
with the driver level key
GXHSM_DISABLE_ARCHIVE_FILE_RECALL_AND_RESTORE. It allows
for customizing the popup message when
GXHSM_DISABLE_ARCHIVE_FILE_RECALL_AND_RESTORE is used to disallow
the recall. The services must be restarted. |
| Applies To | File Archiver for Windows |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instancexxx\ |
| Key | WinFSDataMigrator (standard) |
| Value |
GXHSM_MAX_DISPLAY_TIME_FOR_DISABLERECALLRESTORE_MESSAGE |
| Value Type | String Value |
| Valid Range | Time in seconds |
| Default Value | NA |
| Created in | Created in the computer in which File Share Archiver Client is installed. |
| Description | The key is used in conjuction with GXHSM_DISABLE_ARCHIVE_FILE_RECALL_AND_RESTORE_MESSAGE as it allows the user to set a desired popup message display time. |
| Applies To | File Archiver for Windows |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Unix | Not applicable |
| NetWare | Not applicable |
| Key | MSExchangeDMAgent (standard) |
| Value | nApplyRulesForArchivingCand (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 1 or 0, where: 1 = The Archiving Rules will be applied to Archive List candidates when the Archiving Rules are enabled (i.e., the Disable All Rules option is not selected). 0 = The Archiving Rules will never be applied to Archive List candidates regardless of whether the Archiving Rules are enabled. |
| Default Value | When this key is not present, or when the value is set to 0, then Archiving Rules will never be applied to Archive List candidates regardless of whether the Archiving Rules are enabled. |
| Created in | User-created in the computer in which the agent is installed. |
| Description | This key allows you to apply Archiving Rules to Archive List candidates. NOTES
|
| Applies To | Exchange Mailbox Archiver |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\WinFSDataMigrator |
| Key | EVMGRC_REMOTE_PORT_OVERRIDE |
| Value | Should be set to the override port number. |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Larger than 1 |
| Default Value | None |
| Created in | User-created in the computer in which the File Share Archiver client driver is installed. |
| Description | The user has the option to override the stub
file port number by using the registry key
EVMGRC_REMOTE_PORT_OVERRIDE. When this registry key is set, it overrides all other logic including the port number set by the EVMGRC_REMOTE_PORTregistry key and the stub file port number. This key is not created by default, and when the key does not exist, the File Share Archiver client uses the stub content to determine port number. If the stub file is from a previous release, the EVMGRC_REMOTE_PORT registry key value will determine the port number. |
| Applies To | File Share Archiver Client |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\WinFSDataMigrator |
| Key | EVMGRC_REMOTE_PORT |
| Value | Should be set to the override port number. |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Larger than 1 |
| Default Value | None |
| Created in | User-created in the computer in which the File Share Archiver client driver is installed. |
| Description | This value is used when recalling 7.0 stub files which do not contain a port number value in the stub meta data and the EVMGRC_REMOTE_PORT_OVERRIDE registry key does not exist. |
| Applies To | File Share Archiver Client |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | EventManager (standard) |
| Value | nRETRY_RECALL_TIMEOUT (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Number in seconds |
| Default Value | When key is not present, the default is 300 seconds. |
| Created in | User-created in the computer where the agent is installed. |
| Description | This registry key allows you to specify the time of duration for a recall attempt. Once this time expires, the recall attempt will stop. This key works hand-in-hand with the nRETRY_RECALL_DELAY registry key, and these keys are especially useful if the CommServe goes down. |
| Applies To | File Archiver for Windows Agent - Local Archiving |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | EventManager (standard) |
| Value | nRETRY_RECALL_DELAY (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Number in seconds |
| Default Value | When key is not present, the default is 60 seconds. |
| Created in | User-created in the computer where the agent is installed. |
| Description | This registry key allows you to specify the delay time for a recall attempt. Once this time expires, the recall attempt will resume. This key works hand-in-hand with the nRETRY_RECALL_TIMEOUT registry key, and these keys are especially useful if the CommServe goes down. |
| Applies To | File Archiver for Windows Agent - Local Archiving |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | EventManager (standard) |
| Value | nRETRY_RECALL_MAX_RETRY_COUNT (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Number in seconds |
| Default Value | When the key is not present, the default is 300 seconds. |
| Created in | User-created in the computer where the agent is installed. |
| Description | This registry key allows you to specify the maximum number of recall attempts. In case the value of the key is set to 0 then the retry will continue until time out is reached, which is set by nRETRY_RECALL_TIMEOUT registry key. |
| Applies To | File Archiver for Windows Agent - Local Archiving |
| Location | HKLM\SOFTWARE\CommVault Systems\Common\ |
| Key | AddInGui (standard) |
| Value | nGuiUpdateCheck (optional) |
| Value Type (Windows only) | DWORD |
| Valid Range | 0 - The software will not automatically
download Java updates from the CommCell Console. 1 - The software will automatically download Java updates from the CommCell Console. |
| Default Value | When key is not present, the software will not look for Java updates from the CommCell Console. |
| Created in | User-created in the computer where the Outlook Add-In or Lotus Notes Client Add-In is installed. |
| Description | This registry key allows the software to automatically check for and download any available Java updates from the CommCell Console at a random interval between 12:00AM and 6:00AM. If you would like to specify a specific time-of-day to check for and download Java updates, you can use the dJavaUpdateTimeHour and dJavaUpdateTimeMin registry keys instead. |
| Applies To | Outlook Add-In and Lotus Notes Client Add-In |
| Location | HKLM\SOFTWARE\CommVault Systems\Common\ |
| Key | AddInGui (standard) |
| Value | dJavaUpdateTimeHour (optional) |
| Value Type (Windows only) | DWORD |
| Valid Range | 0 - 23 where the value represents the hour of day at which the software will download Java updates. |
| Default Value | When key is not present, the software will not automatically download Java updates from the CommCell Console. |
| Created in | User-created in the computer where the Outlook Add-In or Lotus Notes Client Add-In is installed. |
| Description | This registry key allows you to specify the
hour of day at which the software will download Java updates. When created,
this key overrides the
nGuiUpdateCheck registry key if it already exists. This functionality can be further refined to specify a minute of the hour by creating the dJavaUpdateTimeMin registry key. |
| Applies To | Outlook Add-In and Lotus Notes Client Add-In |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Common |
| Key | AddInGui (optional) |
| Value | nSearchRangeDays (optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Number in days. |
| Default Value | When this key is not present, the default number of days is 30. |
| Created in | User-created in the computer in which the agent is installed. |
| Description | This registry key allows you to specify the default number of days to search for protected messages. |
| Applies To | Exchange Mailbox Archiver Note that this registry key is supported only for Find and Search operations launched directly from Outlook. If the Find and Search operations are launched from a web browser, the default number of days is used. |
| Location | HKLM\SOFTWARE\CommVault Systems\Common\ |
| Key | AddInGui (standard) |
| Value | dJavaUpdateTimeMin (optional) |
| Value Type (Windows only) | DWORD |
| Valid Range | 0 - 59 where the value represent the minute of the hour at which the software will download Java updates. |
| Default Value | When key is not present, the software will not automatically download Java updates from the CommCell Console. |
| Created in | User-created in the computer where the Outlook Add-In or Lotus Notes Client Add-In is installed. |
| Description | This registry key allows you to specify the minute of the hour configured with the dJavaUpdateTimeHour at which the software will download Java updates. When created, this key overrides the nGuiUpdateCheck registry key if it already exists. |
| Applies To | Outlook Add-In and Lotus Notes Client Add-In |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVaultSystems\Galaxy\Instance001\ WinFSDataMigrator |
| Key | AliasMappedPath (Has to be created) |
| Value | "FILER_PATH" |
| Value Type (Windows only) | String Value |
| Valid Range | "filerpath\VDM internal name\" |
| Default Value | Not Applicable |
| Created in | Agent Machine |
| Description | This registry key is needed to migrate VDM
data. To use VDM the following steps are required: 1. Create a REG_SZ
subkey under AliasMappedPath with the same name as the vdm, and prefix it
with \\ 2. Set the value of this subkey equal to the name, and append \root_vdm_ 3. Perform following command: 4. In the output of the above command, you'll see an ID field. Append the
value of the subkey with the value in the ID field. Note that the subclient content must have the VDM path and not the filer
path. |
| Applies To | File Archiver for Windows |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | MSExchangeDMAgent |
| Value | createpstspecificfolder |
| Value Type (Windows only) | DWORD |
| Valid Range | 1, 0 or nonexistant |
| Default Value | When the key is not present, PST stubs will be copied into the root level of the folder specified as the stub destination folder. |
| Created in | User-created in the computer in which the agent is installed. |
| Description |
If the value is set to 0 - stubs will be copied/moved into the destination
folder maintaining the internal folder structure of the PST If the value is set to 1 - stubs will be copied/moved into the destination folder maintaining the internal folder structure of the PST, they will also be separated into unique folders for each PST imported If the values will be non existent - stubs will be copied/moved into the root of the destination folder with no folder structure maintained. |
| Applies To | Exchange Mailbox Archiver |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVaultSystems\Galaxy\Instancexxx\SAP |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance001/OracleSapAgent/.properties |
| NetWare | Not Applicable |
| Key | SAP |
| Value | sNOOFFLINEFORCE |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Y or N |
| Default Value | N |
| Created in | The Client computer in which the iDataAgent is installed. |
| Description | This key may be created to disable forceful shutdown of databases during offline backups from the CommCell Console. |
| Applies To | SAP for Oracle iDataAgent |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | MSSharepoint (optional) |
| Value | nMixedModeOverrideVersion |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 2003 - backs up
SharePoint 2003 data 2007 - backs up SharePoint 2007 data |
| Default Value | N/A |
| Created in | SharePoint Server 2003 or 2007 Computer |
| Description | By default, if this Registry key does not
exist, SharePoint 2007 data will be backed up.
If set to 2003, SharePoint 2003 data will be backed up. If set to 2007, SharePoint 2007 data will be backed up. |
| Applies To | SharePoint Database iDataAgent |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\MSSharepointDocAgent |
| Key | bEnableRestart (optional) |
| Value | N/A |
| Value Type (Windows only) | DWORD Value |
| Valid Range | N/A |
| Default Value | N/A |
| Created in | SharePoint Server 2007 Computer or SharePoint WSS v3.0 |
| Description | When this key is created and set to 1, the backup will restart and continue from the last folder that was backed up. Set to 1 to enable this feature. NOTE: This key cannot be used with dwDisableAutoDiscovery. |
| Applies To | SharePoint Server Computer |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\SharepointDM |
| Key | bEnableRestart (optional) |
| Value | N/A |
| Value Type (Windows only) | DWORD Value |
| Valid Range | N/A |
| Default Value | N/A |
| Created in | SharePoint Server 2007 Computer or SharePoint WSS v3.0 |
| Description | When this key is created and set to 1, the archive will restart and continue from the last folder that was archived. Set to 1 to enable this feature. NOTE: This key cannot be used with dwDisableAutoDiscovery. |
| Applies To | SharePoint Archiver Computer |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\MSSharepointDocAgent |
| Key | dwDisableAutoDiscovery (optional) |
| Value | N/A |
| Value Type (Windows only) | DWORD Value |
| Valid Range | N/A |
| Default Value | N/A |
| Created in | SharePoint Server 2007 Computer or SharePoint WSS v3.0 |
| Description | When this key is created, the auto-discovery of sites for user-created subclients will be disabled. NOTE: This key cannot be used with bEnableRestart. |
| Applies To | SharePoint Server Computer |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\SharePointDM |
| Key | dwDisableAutoDiscovery (optional) |
| Value | N/A |
| Value Type (Windows only) | DWORD Value |
| Valid Range | N/A |
| Default Value | N/A |
| Created in | SharePoint Server 2007 Computer or SharePoint WSS v3.0 |
| Description | When this key is created, the auto-discovery of sites for user-created subclients will be disabled. NOTE: This key cannot be used with bEnableRestart. |
| Applies To | SharePoint Archiver Computer |
| Location | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\ |
| Key | SharePointDM (optional) |
| Value | nRecallTimeout |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Any number of minutes. |
| Default Value | N/A |
| Created in | SharePoint Server 2003 or 2007 Computer |
| Description | By default, or if this Registry key does not exist, the amount of time allocated for recalling data is 5 minutes. |
| Applies To | SharePoint Archiver Agent |
| Location | HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\MSSQLAgent |
| Key | Client (Standard) |
| Value | nLogThreshHoldValue (Optional) |
| Value Type (Windows only) | DWORD Value |
| Valid Range |
0 = Disabled 1 - max integer = This integer specifies the number of transaction log backups that will be taken before a minor event is issued to remind users to run a full backup. |
| Default Value | None. |
| Created in | Client computer. |
| Description | By default, 24 log backups are run and then a full backup is taken. Specify a number with the registry key if you want to run a different number of log backups other than the default. After the number of transaction log backups is taken, a minor event is issued to remind users to run a full backup. The event can be viewed with the Event Viewer. This is useful since log backups are typically scheduled, but scheduling full backups may be inadvertently missed. Full backups also reduce the chance of data loss if log backups become corrupted. |
| Applies To | Client computer. |
| Location | HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\CVRepSvc(Instance<xxx>) |
| Key | CVRepSvc (standard) |
| Value | PipelineBufferSizeInKiloBytes (standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | 64 - 256, in increments of 32 (KB) |
| Default Value | 64 |
| Created in | The Client computers in which CDR is installed; the key must have the same value on both the source computer(s) and destination computer(s). |
| Description | Allows you to increase the size of the
pipeline buffer for a commensurate increase in replication performance.
However, if the value of this key is set too high, when performing a SmartSync, or
Copyback to a destination computer with low kernel memory,
or in a 'Fan-In' configuration, the operation may fail because the system
lacks sufficient buffer space or because a queue was full. When the value of this key is changed, Replication Services must be stopped and restarted on both the source and destination computers. When Services are restarted, any Smart Sync will be converted to a Full Sync. |
| Applies To | ContinuousDataReplicator |
| Location | HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\CVRepSvc(Instance<xxx>) |
| Key | CVRepSvc (standard) |
| Value | MaxConnectionAttempts (standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Number>=1 |
| Default Value | 30 |
| Created in | The Client computer in which CDR is installed, which is used as a source for data replication. |
| Description | The number of attempts a source computer will
make to connect to the pipeline, when trying to re-establish contact with
the destination computer. When the value of this key is changed, Replication Services must be stopped and restarted on the source computer. |
| Applies To | ContinuousDataReplicator |
| Location | HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\CVRepSvc(Instance<xxx>) |
| Key | CVRepSvc (standard) |
| Value | nIncrementalCache (standard) |
| Value Type (Windows only) | DWORD Value |
| Valid Range | Integer |
| Default Value | 50 (MB) |
| Created in | The Client computers in which CDR is installed -- the source or destination computer(s). |
| Description | The minimum size, in MB, of the COW cache used
by QSnap during the SmartSync Scan phase on a source computer, or for Recovery Points on
a destination computer. For computers with sufficient space, this should be
increased to at least 100 MB. Changes to this registry key take effect immediately. |
| Applies To | ContinuousDataReplicator |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance |
| Key | MediaAgent (standard) |
| Value | nSuspendSDR (optional) |
| Value Type (Windows only) | DWORD |
| Valid Range | Integer |
| Default Value | 1 |
| Created in | The source MediaAgent computer used for the MediaAgent Replication solution. |
| Description | Allows replication of data between the source
MediaAgent and destination MediaAgent to be temporarily suspended. Set a value of "1" to suspend replication. Set a value of "0", or remove this key, to enable replication. |
| Applies To | The MediaAgent Replication solution. For more information, see MediaAgent Replication. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\MediaAgent |
| Key | MediaAgent (standard) |
| Value | SDRPairStartIntervalMins |
| Value Type (Windows only) | DWORD |
| Valid Range | Integer |
| Default Value | 0 |
| Created in | The source MediaAgent computer used for the MediaAgent Replication solution. |
| Description | Controls the interval (in minutes) at which SDR Pairs should be kicked off. |
| Applies To | The MediaAgent Replication solution. For more information, see MediaAgent Replication. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\instance<xxx> |
| Unix | Not Applicable |
| NetWare | Not Applicable |
| Key | File Replication (standard) |
| Value | nDoNotReplicateACLs |
| Value Type (Windows only) | DWORD |
| Valid Range | 0=ACLs will be replicated 1=ACLs will not be replicated |
| Default Value | 0 |
| Created in | The source computer where ContinuousDataReplicator, Remote Backup, or Workstation Backup Agent is installed. |
| Description | This registry key enables you to optionally disable the replication of the security stream of files. This stream includes user and group access control list (ACL) settings for file access. If this registry key is not present, behavior is the same as if it were set to 0; ACLs will be replicated. |
| Applies To | ContinuousDataReplicator, Remote Backup, and Workstation Backup Agent. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\instance<xxx> |
| Unix | Not Applicable |
| NetWare | Not Applicable |
| Key | File Replication (standard) |
| Value | nUseVSSSoftwareProvider |
| Value Type (Windows only) | DWORD |
| Valid Range | Integer |
| Default Value | Not Applicable |
| Created in | The destination computer where ContinuousDataReplicator is installed. |
| Description | This registry key enables you to override the
hardware VSS provider and use Microsoft VSS provider for creating snapshots
on the destination computer. Set a value of "1" to override the hardware VSS provider and use Microsoft VSS provider for snapshot creation. Set a value of "0", or remove this key, to use the hardware VSS provider (as and if applicable). Following an upgrade of ContinuousDataReplicator to the current release, you will need to re-add the nUseVSSSoftwareProvider registry key on the destination computer even if this registry key was added to the previous release. |
| Applies To | ContinuousDataReplicator |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\GalaxyInstallerFlags |
| Unix | /etc/CommVaultRegistry/ |
| NetWare | Not Applicable |
| Key | GalaxyInstallerFlags (standard) |
| Value | nOverridePreferredIPFamily (optional) |
| Value Type (Windows only) | DWORD |
| Valid Range | 0 - FAMILY_ANY (allows both IPv4 or IPv6
support) 1 - FAMILY_IPV4 (allows IPv4 support) 2 - FAMILY_IPV6 (allows IPv6 support) (Not available for Unix computers.) |
| Default Value | 1 |
| Created in | The computer on which the software component is installed |
| Description | This key allows you to install software
components on a CommCell computer in an IPv6 environment. The key must
be manually created on each computer within the CommCell prior to installing any software components.
When created, an option to select IPv6 support will be offered during the
software installation. Note that this key only provides IPv6 support for the duration of the software installation. To further operate CommCell components in an IPv6 environment, the nPreferredIPFamily registry key must be configured on each computer within the CommCell after the software has been installed. |
| Applies To | All client computers in the CommCell |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\Session |
| Unix | /etc/CommVaultRegistry/Galaxy/Instance/Session/.properties |
| NetWare | Not Applicable |
| Key | Session (standard) |
| Value | nPreferredIPFamily (standard) |
| Value Type (Windows only) | DWORD |
| Valid Range | 0 - FAMILY_ANY (allows both IPv4 or IPv6
support) 1 - FAMILY_IPV4 (allows IPv4 support) 2 - FAMILY_IPV6 (allows IPv6 support) |
| Default Value | 0 |
| Created in | The computer on which the software component is installed |
| Description | This key allows you to operate software
components on a CommCell computer in an IPv6 environment. This key must be
configured on each computer within the CommCell after the software has been
installed. Note that this key does not provide IPv6 support for the installation of CommCell components. The nOverridePreferredIPFamily must first be created on each computer within the CommCell prior to installing any software components. Once the software has been installed throughout the CommCell, the nPreferredIPFamily can then be configured on each computer in the CommCell to provide further functionality in the IPv6 environment. |
| Applies To | All client computers in the CommCell |
| Location | |||
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\ | ||
| Unix | Not Applicable | ||
| NetWare | Not Applicable | ||
| Key | Instance### (standard) | ||
| Value | nForceApplyDBUpdates (optional) | ||
| Value Type (Windows only) | DWORD | ||
| Valid Range | 0 - Disabled 1 - Enabled |
||
| Default Value | None | ||
| Created in | User-Created in CommServe | ||
| Description | When this key is defined and the value is set
to 1, database updates will be installed without stopping software services.
This is applicable for:
| ||
| Applies To | All Database platforms: CommServe, CommNet Server, SRM Server, CommCell Explorer, and Content Indexing Engine. |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE |
| Key | GalaxyInstallerFlags (standard) |
| Value | szRepSetPolicyName (Optional) |
| Value Type (Windows only) | REG_SZ Value |
| Valid Range | Name of the Replication Policy to create Replication Sets for this agent. |
| Default Value | None |
| Created in | Client computer where Workstation Backup agent is installed |
| Description | Before installing Workstation Backup using standalone package, create this key to specify replication policy name. (Optional) |
| Applies To | Workstation Backup Agent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE \SOFTWARE |
| Unix | Not Applicable |
| NetWare | Not Applicable |
| Key | GalaxyInstallerFlags |
| Value | szCommServeIPHostName |
| Value Type (Windows only) | REG_SZ |
| Valid Range | Fully qualified domain name of the CommServe computer. |
| Default Value | None |
| Created in | CommCell clients installed with Workstation Backup Agent. |
| Description | Before installing Workstation Backup Agent using standalone package, create this key to specify the fully qualified host name of the CommServe computer. |
| Applies To | Workstation Backup Agent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE |
| Key | GalaxyInstallerFlags (standard) |
| Value | multiszFirewallHosts (Optional) |
| Value Type (Windows only) | REG_MULTI_SZ Value |
| Valid Range |
Fully qualified domain name, IP address, or wild card representation of the CommCell computers on the other side of the firewall.
See Firewall Consideration -
One-Way Firewalls
or Two-Way
Firewalls for syntax. For example: aquila.company.com perseus.company.com 192.168.189.176 |
| Default Value | None |
| Created in | Client computer where Workstation Backup agent is installed |
| Description | Before installing Workstation Backup using standalone package, create this key to specify host name of CommCell computers on the other side of the firewall. (Optional) |
| Applies To | Workstation Backup Agent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE |
| Key | GalaxyInstallerFlags (standard) |
| Value | multiszFirewallPeers (Required only if the multiszFirewallHosts registry key is specified.) |
| Value Type (Windows only) | REG_MULTI_SZ Value |
| Valid Range |
Firewall peers. See Firewall Consideration -
One-Way Firewalls
or Two-Way
Firewalls for syntax. For example (one-way firewall): computer1.company.com @@PASSIVE@@ computer2.company.com computer2.company.com 8400 189.27.271.11 189.27.271.11 8400 |
| Default Value | None |
| Created in | Client computer where Workstation Backup agent is installed |
| Description | Before installing Workstation Backup using standalone package, create this key to specify the firewall peers. (This is required only if the multiszFirewallHosts registry key is specified.) |
| Applies To | Workstation Backup Agent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE |
| Key | GalaxyInstallerFlags (standard) |
| Value | multiszFirewallPorts (Optional) |
| Value Type (Windows only) | REG_MULTI_SZ Value |
| Valid Range |
List of ports that are open for CommCell communications through the firewall.
See Firewall Consideration -
One-Way Firewalls
or Two-Way
Firewalls for syntax. For example: 8600-8619 8650-8659 8800 |
| Default Value | None |
| Created in | Client computer where Workstation Backup agent is installed |
| Description | Before installing Workstation Backup using standalone package, create this key to specify the ports that are open for CommCell communications across the firewall. (Optional) |
| Applies To | Workstation Backup Agent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE |
| Key | GalaxyInstallerFlags (standard) |
| Value | nKEEP_ALIVE (Optional) |
| Value Type (Windows only) | DWORD |
| Valid Range | Integer (in Seconds) |
| Default Value | None |
| Created in | Client computer where Workstation Backup agent is installed |
| Description | Before installing Workstation Backup using standalone package, create this key to specify firewall keep alive interval. (Required if multiszFirewallHosts or multiszFirewallPorts registry key is specified.) |
| Applies To | Workstation Backup Agent |
| Location | |
| Windows | HKEY_LOCAL_MACHINE\SOFTWARE |
| Key | GalaxyInstallerFlags (standard) |
| Value | nTUNNEL_INIT_INTERVAL (Optional) |
| Value Type (Windows only) | DWORD |
| Valid Range | 1 - 60 (in Seconds) |
| Default Value | None |
| Created in | Client computer where Workstation Backup agent is installed |
| Description | Before installing Workstation Backup using standalone package, create this key to specify firewall tunnel initialization interval. (Required if multiszFirewallHosts or multiszFirewallPorts registry key is specified.) |
| Applies To | Workstation Backup Agent |