Quick Start Guide and Deployment
Quick Start Guide and Deployment
Procedure
1. On the computer where you plan to install the server package, open the Windows Registry Editor.
2. In the Registry Editor window, expand to the HKEY_LOCAL_MACHINE\SOFTWARE\ folder.
3. Right-click the SOFTWARE parent registry key and click New > Key.
4. Type the following name for the new key: GalaxyInstallerFlags.
5. Right-click the GalaxyInstallerFlags key, click New > String Value, and type szUserSQLInstanceName.
6. Double-click the szUserSQLInstanceName key, and in the Value data box, type the name of the SQL instance that you want to use, and click OK.
When you run the installation program, the server package is installed on the instance that you specified.
Postinstallation Tasks
The following sections describe the tasks that you must perform to complete the Microsoft SQL Server installation:
Apply latest SQL Server updates
Install the latest cumulative updates and service packs provided by Microsoft. As a best practice, keep the SQL Server software up-to-date.
Tune the SQL Server memory usage
The maximum memory used by the SQL Server should be 50% of the physical memory available in the computer.
Use the following steps to tune the SQL Server memory usage for Commvault:
1. On the CommServe computer, open the Microsoft SQL Server Management Studio.
2. Right-click the Server_Instance, and then click Properties.
3. From the Server Properties dialog box, on the left pane, select the Memory page.
4. In the Maximum server memory (in MB) box, specify 50% of the physical memory available in the computer.
5. Click OK.
Postinstallation Tasks
The following sections describe the tasks that you must perform to complete the Microsoft SQL Server installation:
Apply latest SQL Server updates
Install the latest cumulative updates and service packs provided by Microsoft. As a best practice, keep the SQL Server software up-to-date.
Tune the SQL Server memory usage
The maximum memory used by the SQL Server should be 50% of the physical memory available in the computer.
Use the following steps to tune the SQL Server memory usage for Commvault:
1. On the CommServe computer, open the Microsoft SQL Server Management Studio.
2. Right-click the Server_Instance, and then click Properties.
3. From the Server Properties dialog box, on the left pane, select the Memory page.
4. In the Maximum server memory (in MB) box, specify 50% of the physical memory available in the computer.
5. Click OK.
If you plan to perform VSS enabled backups on the CommServe computer, we recommend that you do not install SQL Server on the system drive. VSS
restores might cause system state restore issues.
Destination folder for the CommServe database
By default, the database files are installed in C:\Program Files\CommVault\ContentStore. The drive must have at least 1 GB of free space.
You can change the destination folder, but the folder cannot reside on the following types of drives:
Mapped network drive
FAT drive (as it does not allow temporary sparse files to be generated when creating the database snapshot, which is required for data verification)
Compressed drive
Destination folder for disaster recovery files
Determine the location where you want to store the disaster recovery files. The destination folder can be a local path or a network path. If you decide to use a
network path, you must have a user account with sufficient privileges to access the network.
Software cache
5/6/2017 Commvault Systems Page 51 of 587
The CommServe cache stores the updates, service packs, and packages released by the software provider, which you can install on client computers from the
CommCell Console.
By default, the CommServe cache directory is stored in C:\Program Files\CommVault\ContentStore\SoftwareCache. The drive must have at least 5 GB of free space.
You can change the default location of the CommServe cache.
CommServe name
The following default names are provided by the installation wizard, but you can provide different names:
The default CommServe Client Name is the local (NetBIOS) name of the computer where the CommServe package will be installed.
The default CommServe Host Name is the fully qualified domain name of the computer where the CommServe package will be installed.
If the CommServe computer has multiple network interface cards, the first network interface bound to the network must be used in the CommServe installation.
Windows firewall exclusion list
If the computer has Windows Firewall turned on, you can add the Commvault programs and services to the Windows Firewall exclusion list during the installation.
We recommend this configuration which enables CommCell operations across the firewall.
CommServe database (new or existing)
By default, the installation wizard creates a new CommServe database.
If you are reinstalling the CommServe package, you can use the CommServe database dump file that was created during a disaster recovery backup. This is useful if
you need to:
Rebuild your CommServe computer as part of a disaster recovery scenario.
Move the CommServe database to another computer as part of a hardware refresh process.
If the new computer uses different IP settings than the old CommServe computer, contact your software provider to request a new CommServe license
configured with the new IP address.
If you reinstall the CommServe package with other server packages, you can also submit the database dump files for the Web Server (shown as DM2) and Workflow
Engine.
Commvault ID
The Commvault ID is the email address and password associated with your Cloud Services account.
During installation, the CommCell administrator account is configured to use the email address and password of your Cloud Services account. By default, the
installation program automatically defines the user name of the CommCell administrator account to be admin.
If you do not have a Cloud Services account, you need an email address and a password to create a new account. The password must meet the following strength
requirements:
a minimum of eight characters
one uppercase letter
one lowercase letter
one number
one special character
After the installation, you can use the account credentials to access the CommCell Console, Web Console, and Admin Console.
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
2. Run Setup.exe from the installation package.
The installation wizard opens.
3. On the welcome page, select the I Agree check box and proceed to the next page.
4. On the Choose the Installation Type page, click Install packages on this computer and proceed to the next page.
5. On the Select Packages page, select the CommServe check box, and proceed to the next page.
6. Follow the instructions in the installation wizard.
7. If you want to use an existing CommServe database, complete the following steps on the Database Install Option page:
a. Click Use Existing Database, select the CommServ check box, and then proceed to the next page.
Note: If you are installing other server packages with the CommServe software, such as the Web Server, and you want to use an existing database, select the check
box that corresponds to the database.
b. On the Database Dump Location page, specify the path to the CommServe database dump file (and to any other database that you selected).
The dump files are located in your Disaster Recovery (DR) folder, along with other DR backup files.
c. Continue to follow the installation wizard.
8. If you need assistance on the Commvault ID page, refer to the following instructions:
If you have a Cloud Services account, click Use existing account and then type the email address and password associated with your account.
If you do not have a Cloud Services account, click Create a new account and then specify the account details as described in Preinstallation Checklist for the
CommServe (refer to the Commvault ID description).
Continue to follow the installation wizard.
Note: To help you troubleshoot errors that occur before the installation summary page, check the %allusersprofile%\Commvault Systems\Galaxy\LogFiles\Install.log. If the error occurs
after the summary page, check the installation logs in the Software_Installation_Directory\Log Files directory.
What to Do Next
Review the tasks that you must perform after the installation in Postinstallation Tasks for the CommServe .
What to Do Next
Review the postinstallation tasks that you might have to perform to complete the installation:
Add Commvault to the Windows Firewall Exclusion List
If you did not add the Commvault programs and services to the Windows Firewall exclusion list during the installation, you can add them later by using a batch file.
For more information, see Configuring Windows Firewall to Allow CommCell Communication .
Complete Firewall Configurations
If you configured firewall settings during the installation, you must complete additional firewall configurations from the CommCell Console. For more information,
see Firewall: Overview .
What to Do Next
Review the postinstallation tasks that you might have to perform to complete the installation:
Add Commvault to the Windows Firewall Exclusion List
If you did not add the Commvault programs and services to the Windows Firewall exclusion list during the installation, you can add them later by using a batch file. For
more information, see Configuring Windows Firewall to Allow CommCell Communication .
Complete Firewall Configurations
If the CommCell Console connects to the CommServe computer through a firewall, you must configure third-party port mapping (TPPM). For instructions, see
Configuring Access to the CommCell Console Using TPPM .
Related Topics
Opening the CommCell Console
What to Do Next
Review the postinstallation tasks that you might have to perform to complete the installation:
Add Commvault to the Windows Firewall Exclusion List
If you did not add the Commvault programs and services to the Windows Firewall exclusion list during the installation, you can add them later by using a batch file.
For more information, see Configuring Windows Firewall to Allow CommCell Communication .
Complete Firewall Configurations
If you configured firewall settings during the installation, you must complete additional firewall configurations from the CommCell Console. For more information,
see Firewall: Overview .
Assign the necessary permissions for users that will perform compliance search operations. For more information, see Configuration - Compliance Officer .
We recommend scheduling regular backups of the DM2 database on the Web Server used for Compliance Search. See Backing Up the Web Server DM2 Database .
What to Do Next
Review the postinstallation tasks that you might have to perform to complete the installation:
Add Commvault to the Windows Firewall Exclusion List
If you did not add the Commvault programs and services to the Windows Firewall exclusion list during the installation, you can add them later by using a batch file.
For more information, see Configuring Windows Firewall to Allow CommCell Communication .
Complete Firewall Configurations
If you configured firewall settings during the installation, you must complete additional firewall configurations from the CommCell Console. For more information,
see Firewall: Overview .
Configure your settings and preferences on the ContentStore Mail Server dashboard. For more information, see Setting Up the ContentStore Mail Server .
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
2. Run Setup.exe from the installation package.
The installation wizard opens.
3. On the welcome page, select the I Agree check box and proceed to the next page.
4. On the Choose the Installation Type page, click Install packages on this computer and proceed to the next page.
5. On the Select Packages page, select the Metrics Reporting check box, and proceed to the next page.
6. Follow the instructions in the installation wizard.
Tip: To help you troubleshoot errors that occur before the installation summary page, check the %allusersprofile%\Commvault Systems\Galaxy\LogFiles\Install.log. If the error
occurs after the summary page, check the installation logs in the Software_Installation_Directory\Log Files directory.
What to Do Next
If you installed a new CommServe package together with the Metrics Reporting package, review the tasks that you must perform after the CommServe installation in
Postinstallation Tasks for the CommServe .
If you installed both the Metrics Reporting package and the CommServe package on a separate computer from the backup CommServe computers, then you must
request a Zero (0) Terabyte License from your Account Representative for that stand-alone CommServe computer with the Metrics Reporting package.
If you installed the Metrics Reporting package to run Metrics reports, get access to reports and configure data collection. For more information, refer to the high-level
process steps described in Getting Started with Metrics Reports .
If you installed the Metrics Reporting package to monitor client computer group backup quotas across multiple CommCell environments, indicate which client
computer groups you want to monitor. For more information, see Activating the Metrics Reporting Server for Client Computer Group Backup Quota .
What to Do Next
Review the postinstallation tasks that you might have to perform to complete the installation:
Add Commvault to the Windows Firewall Exclusion List
If you did not add the Commvault programs and services to the Windows Firewall exclusion list during the installation, you can add them later by using a batch file.
For more information, see Configuring Windows Firewall to Allow CommCell Communication .
Complete Firewall Configurations
If you configured firewall settings during the installation, you must complete additional firewall configurations from the CommCell Console. For more information,
see Firewall: Overview .
Secure access to the Search Engine node and the content indexing data. See Securing Access to the Search Engine and Content Indexing Data .
Configure the Search Engine and enable content indexing. For more information, see Configuration - Search Engine .
What to Do Next
Review the postinstallation tasks that you might have to perform to complete the installation:
Add Commvault to the Windows Firewall Exclusion List
If you did not add the Commvault programs and services to the Windows Firewall exclusion list during the installation, you can add them later by using a batch file.
For more information, see Configuring Windows Firewall to Allow CommCell Communication .
Complete Firewall Configurations
If you configured firewall settings during the installation, you must complete additional firewall configurations from the CommCell Console. For more information,
see Firewall: Overview .
If you want to set up web access for end-users, refer to Post-Installation Configurations for Web Server and Web Console to enable operations from the Web Console.
Related Topics
Accessing the Web Console
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
2. Run Setup.exe from the installation package.
The installation wizard opens.
3. On the welcome page, select the I Agree check box and proceed to the next page.
4. On the Choose the Installation Type page, click Install packages on this computer and proceed to the next page.
5. On the Select Packages page, select the Web Server check box, and proceed to the next page.
6. Follow the instructions in the installation wizard.
Tip: To help you troubleshoot errors that occur before the installation summary page, check the %allusersprofile%\Commvault Systems\Galaxy\LogFiles\Install.log. If the error
occurs after the summary page, check the installation logs in the Software_Installation_Directory\Log Files directory.
What to Do Next
Review the postinstallation tasks that you might have to perform to complete the installation:
Add Commvault to the Windows Firewall Exclusion List
If you did not add the Commvault programs and services to the Windows Firewall exclusion list during the installation, you can add them later by using a batch file.
For more information, see Configuring Windows Firewall to Allow CommCell Communication .
Complete Firewall Configurations
If you configured firewall settings during the installation, you must complete additional firewall configurations from the CommCell Console. For more information,
see Firewall: Overview .
If you want to set up web access for end-users, refer to Post-Installation Configurations for Web Server and Web Console to enable operations from the Web Console.
If you installed a Web Server for Compliance Search, we recommend that you schedule regular backups of the DM2 database on the Web Server. See Backing Up the
Web Server DM2 Database .
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
2. Run Setup.exe from the installation package.
The installation wizard opens.
3. On the welcome page, select the I Agree check box and proceed to the next page.
4. On the Choose the Installation Type page, click Install packages on this computer and proceed to the next page.
5. On the Select Packages page, select the Workflow Engine check box, and proceed to the next page.
6. Follow the instructions in the installation wizard.
Tip: To help you troubleshoot errors that occur before the installation summary page, check the %allusersprofile%\Commvault Systems\Galaxy\LogFiles\Install.log. If the error
occurs after the summary page, check the installation logs in the Software_Installation_Directory\Log Files directory.
What to Do Next
Review the postinstallation tasks that you might have to perform to complete the installation:
Add Commvault to the Windows Firewall Exclusion List
If you did not add the Commvault programs and services to the Windows Firewall exclusion list during the installation, you can add them later by using a batch file.
For more information, see Configuring Windows Firewall to Allow CommCell Communication .
Complete Firewall Configurations
If you configured firewall settings during the installation, you must complete additional firewall configurations from the CommCell Console. For more information,
see Firewall: Overview .
If you want to set up additional instances of the Workflow Engine on the same computer, see Setting Up Multiple Instances of the Workflow Engine .
Refer to Workflow - Getting Started - Create a Workflow to get started with workflows.
Procedure
1. Log on to the computer as root.
2. Run the following command from the installation package or mount point:
./cvpkgadd
To run the installation as a SUDO user with root privileges, use the following command:
./sudo cvpkgadd
3. On the Install Task dialog, select Install packages on this machine and click Next.
4. On the Package Selection dialog, select 1-Touch Server and click Next.
Follow the instructions in the installation wizard.
5. When you reach the Configure the Client dialog, select Yes to configure and register the client with the CommServe computer. Then, click Next and continue to follow
the instructions in the installation wizard.
Important:
For 1-Touch Server installation on Solaris computers, you must configure a remote cache for Solaris packages in the /jumpstart_directory/files directory. For more
information on setting up a remote cache, see Setting Up a Remote Cache .
For 1-Touch for Solaris 11, after installing the 1-Touch Server package, you must configure a remote cache for Solaris packages in the /rpool/CommVaultRecovery directory.
What to Do Next
If you configured firewall settings during the installation, you must complete additional firewall configurations from the CommCell Console. For more information, see
Firewall - Getting Started - Overview .
Configure the 1-Touch Server:
For AIX, see Configuration - 1-Touch for AIX .
For Solaris, see Configuration - 1-Touch for Solaris .
If you install the CommCell Console and Web Console on the same computer, the URL will not require a port number. The CommCell Console will use the same
port used by the Web Console (port 80 by default).
If there is a firewall between the client computer and the CommServe computer, you also need to record the name of the CommServe client, as seen in the
CommCell Browser (the name is case-sensitive). The installation program requires this information for all firewall setups, except for environments where
only the CommServe can connect to the client.
5/6/2017 Commvault Systems Page 68 of 587
5/6/2017 Commvault Systems Page 69 of 587
Preinstallation Checklist for the CommCell Console on UNIX
The CommCell Console is a graphical user interface through which you can control and manage your CommCell environment. For more information, see CommCell Console
- Basic .
By default, the CommCell Console is installed as part of the CommServe installation. However, you can install additional consoles on other computers.
Use this preinstallation checklist to prepare the computer where the CommCell Console will be installed and to gather all of the information you will need during the
installation.
Verify System Requirements
Verify that the computer where you will install the CommCell Console satisfies the minimum requirements. For more information, see System Requirements - CommCell
Console .
Verify License Requirements
The CommCell Console does not require a license.
Determine the Installation Location
Based on your environment, install the CommCell Console on an appropriate computer.
Environment Where to install the software
Non-Clustered On a computer that can communicate with the CommServe computer using TCP/IP.
Clustered On the physical nodes of the cluster which can communicate with the CommServe computer using
TCP/IP.
If you install the CommCell Console and Web Console on the same computer, the URL will not require a port number. The CommCell Console will use the same
port used by the Web Console (port 80 by default).
If you plan to perform VSS enabled backups on the Web Server computer, we recommend that you do not install SQL Server on the system drive. VSS
restores might cause system state restore issues.
Destination folder for the Web Server database
By default, the database files are installed in C:\Program Files\CommVault\ContentStore. The drive must have at least 1 GB of free space.
You can change the destination folder, but the folder cannot reside on the following types of drives:
Mapped network drive
FAT drive (as it does not allow temporary sparse files to be generated when creating the database snapshot, which is required for data verification)
Compressed drive
Configure Proxy Service (IIS)
If the Internet Information Services (IIS) is not enabled on the computer, you can enable IIS from the installation wizard. This configuration is useful if you forget to
enable IIS before the Web Server installation.
What To Do Next
Review the tasks that you must perform after the installation in Postinstallation Tasks for the MediaAgent .
Procedure
Log on to the Docker host as root and then enter the following command on a container:
docker run -d
-v $CVDIR/CommvaultLogs:/var/log/commvault/Log_Files \
-v $CVDIR/.gxsetup:/var/log/.gxsetup \
-v $CVDIR/CommvaultRegistry/:/etc/CommVaultRegistry \
-v $CVDIR/libraryPath/:/opt/libraryPath \
-v $CVDIR/IndexCache/:/opt/commvault/MediaAgent/IndexCache \
-v $CVDIR/jobResults/:/opt/commvault/iDataAgent/jobResults \
-v $CVDIR/certificates:/opt/commvault/Base/certificates \
--net host \
--add-host mycommserve.mydomain.com:172.xx.xx.xxx \
commvaultrepo/mediaagent:SP6a \
-csclientname mycommserve \
-cshost mycommserve.mydomain.com \
-mountpath "/opt/libraryPath" \
-commcelluser myusername \
-commcellpassword mypassword \
-cvdport 8600 \
-clienthost 172.xx.xx.xxx \
-clientname docker123
The following table displays the command options that require user input.
Command Options Description
--add-host The fully qualified domain name and IP address of the CommServe computer, separated by a colon (:).
-csclientname The client name of the CommServe computer.
-cshost The fully qualified domain name or IP address of the CommServe computer.
-mountpath The path to a storage volume to be used by MediaAgent libraries.
-commcelluser The user name of a CommCell user account that has sufficient permissions to perform Commvault installations.
-commcellpassword The password associated with the CommCell user that you specified.
-cvdport Port number between 1024 and 65000 to be used by the Commvault instance.
-clienthost The fully qualified domain name or IP address of the Docker host.
-clientname The name of the Docker host.
What To Do Next
Review the tasks that you must perform after the installation in Postinstallation Tasks for the MediaAgent .
On Windows
Configure Cluster Group Clients
If you installed agents in a cluster environment, you must configure a cluster group client, and if applicable, failover settings. For more information, see:
Microsoft Clusters
Non-Microsoft Clusters
Quorum Disk
Scale-Out File Server
HP Scalable NAS/PolyServe Clusters
Add Commvault to the Windows Firewall Exclusion List
If you did not add the Commvault programs and services to the Windows Firewall exclusion list during the installation, you can add them later by using a batch file.
For more information, see Configuring Windows Firewall to Allow CommCell Communication .
Complete Firewall Configurations
If you configured firewall settings during the installation, you must complete additional firewall configurations from the CommCell Console. For more information,
see Firewall: Overview .
Enable Application-Aware Installs
You can configure the Commvault software to automatically detect the installed client applications and then install the corresponding Commvault packages when
you:
Plan to add additional applications after you install the Commvault software
Plan to refresh the hardware
Have managed service provider configuration
For information on how to enable this feature, see Enabling Application-Aware Installations .
Please enter the name of the host running the ACSLS daemon. ACSLS Server host name:
4. Enter the name of the host where the ACSLS server is installed, and then press Enter.
The system copies the necessary files and creates the required configuration. A message appears:
A menu appears.
5. Enter the number that corresponds with the Exit.
Use the commvault list command to check if the SSI service is running on the Solaris computer. For details, see Controlling Services on Unix .
Configure Storage Devices
You must configure the MediaAgent to communicate with the storage devices that are attached to the computer.
Depending on the type of storage devices that are attached to the MediaAgent computer, refer to one of the following topics:
Disk Library
Cloud Storage
Tape Library
Create Storage Policies
You must create a storage policy to define where and how to store your data during backup jobs. For instructions, see Storage Policy - Getting Started .
Additional Configurations
If you want to eliminate duplicate blocks of data during backups, you can create a storage policy with deduplication. For instructions, see Creating a Storage Policy
with Deduplication .
If you want to change the Index Directory location, see Index: Moving the Index Directory .
For additional features and configurations, refer to the Media Management documentation.
Procedure
1. From the CommCell Browser, right-click CommServe and click Properties.
2. In the CommCell Properties dialog box, click the Additional Settings tab and click Add.
3. In the Add Additional Settings dialog box, add the nAllowDuplicateHostName additional setting with the following properties:
Property Value
Name nAllowDuplicateHostName
Category CommServe
Type INTEGER
Value 1
For instructions on adding the additional setting from the CommCell Console, see Add or Modify an Additional Setting .
Procedure
1. From the directory where the installation package is stored, go to the DownloadPackageLocation_WinX64/Common/OEM/1/install_images folder. Note that
DownloadPackageLocation is the location you specified during the creation of the installation package.
If the installation package also has a DownloadPackageLocation_Win32 folder, wait until the end of the procedure for instructions.
2. Update the following images with your own icons and logos:
Image File Required Specifications Usage
EdgeMonitor.ico Dimensions: 32 x 32 pixels, Bit depth: 32 Icon to be used by the Edge Monitor tool for Laptop Backup.
OEMIcon.ico Dimensions: 48 x 48 pixels, Bit depth: 32 Icon to be used by the Commvault software in general. This icon may be the same
as the Edge Monitor icon.
OEMImage.bmp Dimensions: 125 x 29, Bit depth: 24 Image to be used by the installation wizard.
OEMImage.png Dimensions: 125 x 29, Bit depth: 32 Image to be used by the installation wizard.
OEMLogoImage.bmp Dimensions: 474 x 106, Bit depth: 24 Logo to be used by the installation wizard.
OEMLogoImage.png Dimensions: 474 x 106, Bit depth: 32 Logo to be used by the installation wizard.
ProcessManager.ico Dimensions: 256 x 256, Bit depth: 32 Icon to be used by the Process Manager application.
3. Open the OEMInfo.xml file with an appropriate editor, and then update one or more of the XML parameters listed in the following table:
Parameter Description
CompanyName The name of your company.
ProductName The name of your company product.
The product name is also used as the name of the installation wizard. This is the name you will see on the welcome
page of the wizard.
SoftwareName The name of the software to be installed. The software name may be the same as the product name.
EditionName The edition name for your software.
DestinationCompanyFolder The name of the Company folder.
The Company folder is part of the installation directory where the software installed. By default, the software is
installed in the C:\Program Files\Company\Software directory.
DestinationSoftwareFolder The name of the Software folder.
The Software folder is part of the installation directory where the software installed. This is the subfolder of the
Company folder.
SQLInstanceName Name to be used by the SQL Server instance that is created during the CommServe installation.
4. Save and close the OEMInfo.xml file.
5. If the installation package also has a DownloadPackageLocation_Win32 folder, copy the files that you recently updated to the
DownloadPackageLocation_Win32/Common/OEM/1/install_images folder.
Result
Future installations from the installation package will use the new branding settings.
Procedure
1. On the computer where you plan to run the installation program, open the Windows Registry Editor window and expand to the HKEY_LOCAL_MACHINE\SOFTWARE\
folder.
2. Right-click the SOFTWARE parent registry key and click New > Key.
3. Type the following name for the new key: GalaxyInstallerFlags.
4. Right-click the GalaxyInstallerFlags key, click New > DWORD value, and type bShowLanguageDialog.
5. Double-click the bShowLanguageDialog key, modify the value in Value data to 1, and click OK.
When you run the installation program, you can select the language you need.
Procedure
Use one of the following methods to enable 32-bit installations:
Preferred Method: Using the CommCell Console (Remote Installation)
During a remote installation, on the Enter Additional Install Options page of the installation wizard, select the Install 32-bit instead of default 64-bit packages
(Windows X64 only) - This will protect 32-bit applications only check box.
Tip: If the computer already has other Commvault software installed (64-bit agents), you must install the 32-bit agents on a new Commvault instance. To install in a new
instance, select the Install new Instance (if required) check box.
For instructions on remote installations, see Installing Commvault Remotely Using the CommCell Console .
Alternative Method: Using the Installation Package (Local Installation)
Before you run the installation package, you must configure a registry key on the 64-bit computer:
1. Open the Windows Registry Editor and go to the following directory:
HKEY_LOCAL_MACHINE\SOFTWARE\
2. Right-click SOFTWARE and click New > Key and name the new key as GalaxyInstallerFlags.
3. Right-click GalaxyInstallerFlags and click New > DWORD (32-bit) Value.
4. Right-click the new value, click Rename, and then type bAllow32BitInstallOn64Bit as the new value.
5. Double-click the DWORD key, set the Value Data to 1, and click OK.
6. Close the Registry Editor.
After the registry key is created, you can install 32-bit agents by running the installation package. For instructions, see Installing Commvault Locally on Windows Computers
Using the Installation Package .
General
If the 64-bit computer where you plan to install 32-bit agents has other Commvault software installed, you must install the 32-bit agents on a new Commvault instance. You
can have 32-bit and 64-bit agents running on the same computer, but they must be installed on separate instances.
For more information, see Enabling Multi-Instance Installations .
Tip: You can easily install 32-bit agents on a new instance from the CommCell Console. During the remote installation, you can select the options to install 32-bit agents and
to install in a new instance.
Exchange Agents
If you want to install both 32-bit and 64-bit Exchange agents on a 64-bit computer, use the following approach:
1. Install the 64-bit agent.
2. Install the 32-bit agent on a separate instance.
The new instance contains the 32-bit MAPI-based Exchange agents. You can use the 32-bit MAPI-based Exchange Agent along with 64-bit Exchange agents.
If you plan to install 32-bit MAPI-based Agents, you must satisfy the following requirements:
You must have the 32-bit version of Microsoft Outlook 2007or later installed on the computer where the agent will be installed.
If you plan to install the OWA Proxy Enabler on a separate instance to support the functionality for 32-bit Exchange agents, the client name that you specify during the
installation must be the same as the client hosting the 64-bit instance.
Backup
Active Directory
DB2
DB2 DPF
DB2 pureScale
Documentum
Exchange Database
Exchange Mailbox (Classic)
Exchange Public Folder
Google Mail and Google Drive
GPFS
Hadoop
IBM i File System
IBM Notes Database
IBM Notes Document
Image Level
Informix
Macintosh File System
Microsoft SharePoint Server
Microsoft SQL Server
Microsoft Windows File
Systems
MySQL
NAS
NFS
OES File System
OpenVMS File System
Oracle
Oracle RAC
PostgreSQL
Salesforce
SAP for MaxDB
SAP for Oracle
SAP HANA
Sybase
Unix File Systems
Archive
Domino Mailbox Archiver
Exchange Compliance Archiver
Exchange Mailbox
Exchange Mailbox Archiver
Exchange Public Folder
Archiver
OnePass for Celerra
OnePass for Exchange Mailbox
(Classic)
OnePass for Hitachi HNAS
(BlueArc)
OnePass for NetApp
OnePass for Network Shares
OnePass for Unix
OnePass for Windows
If you need to back up the client data at some point, you can reconfigure the client from the CommCell Console. For more information, see Reconfiguring Components .
General Requirements
The computer where you plan to install multiple instances must have at least one Commvault instance already installed.
Each instance must be installed on a different installation directory. During the installation, the installation program automatically defines the directory.
For example, on a Windows computer, if Instance001 is installed on C:\Program Files\CommVault\ContentStore, then Instance002 is automatically installed on C:\Program
Files\CommVault\ContentStore2.
Each instance must have a unique set of static TCP port numbers. During the installation, the installation program automatically assigns the port numbers.
If you want to change the ports used by an existing instance, see Changing Port Numbers .
If you plan to install multiple MediaAgent instances on a computer, and you want to use a port other than 8400 for the MediaAgent Communications Service
(GxCVD), clients from older Commvault versions might not be able to communicate through that port. Therefore, make sure that the port is accessible by the
clients that use the MediaAgent.
The VSS Provider software, which includes the VSS Provider and/or VSS Hardware Provider packages, cannot be installed on multiple instances. If the VSS Provider is
already installed, and you need to install an agent that requires the VSS Provider software, make sure that the VSS packages are not selected for installation.
New instances can point to the same CommServe computer or to a different CommServe computer.
To point to a different CommServe computer, you can use the same client name and host name that you specified on the existing instance.
To point to the same CommServe computer, you must provide a unique client name.
On UNIX, Linux, and Macintosh computers, the installation of additional instances changes the permissions of the entire /etc/CommVaultRegistry directory and its sub-
directories. Therefore, non-root users must be members of the same user group that is used for installations. The group permissions must have the default value '7'.
CommServe
You can install multiple instances of the CommServe software on cluster group servers. Review the following information for installations on cluster environments:
The instance with the CommServe software cannot be used for subsequent installations. If you install additional Commvault software on the cluster server, the
software is automatically installed on a new instance.
For all cluster group servers that use the same instance, only one set of binaries and one set of services are used, except for the GxClusterPlugin service.
MediaAgent
Multiple MediaAgent instances that share libraries with each other must be part of the same CommCell. To be in separate CommCells, the MediaAgents cannot share any
libraries.
Exchange Agents
For the Exchange Public Folder Archiver Agent, you must provide a different OWA alias during the installation for each instance that you install.
Procedure
Use one of the following methods to enable multi-instance installations on a computer:
Preferred Method: Using the CommCell Console (Remote Installation)
During a remote installation, on the Enter Additional Install Options page of the installation wizard, select the Install new Instance (if required) check box to install a
new instance.
For instructions on remote installations, see Installing Commvault Remotely Using the CommCell Console .
Important:
Remote installations are not supported for server packages, such as the CommServe, Web Server, and Workflow Engine.
Subsequent installations on the new instance are not supported from the CommCell Console. You must run the installation package to install the software on the
instance you want.
Alternative Method: Using the Installation Package (Local Installation)
On Windows computers:
1. Before you run the installation package, create the bAllowMultiInstances registry key to enable the multi-instancing feature on a Windows computer:
a. Open the Windows Registry Editor and go to the following directory:
HKEY_LOCAL_MACHINE\SOFTWARE\
b. Right-click SOFTWARE and click New > Key. Name the new key as GalaxyInstallerFlags.
c. Right-click GalaxyInstallerFlags and click New > DWORD. Name the new value as bAllowMultiInstances.
d. Double-click bAllowMultiInstances, set the Value data to 1, and click OK.
e. Close the Registry Editor.
2. Install a new instance.
During a local installation, on the Install Instance Selection page of the installation wizard, select Create a new instance.
For instructions on local installations, see Installing Commvault Locally on Windows Computers Using the Installation Package .
On UNIX computers:
During a local installation, make sure to select the following options:
On the Install Task dialog, select Install packages on this machine.
On the Instance Page dialog, select Create new instance.
For instructions on local installations, see Installing Commvault Locally on UNIX, Linux, and Macintosh Computers Using the Installation Package .
Note: Do not use unattended installations to create new instances or on a computer that has multiple instances.
What to Do Next
Overlapping contents can result in data loss.
Ensure that there is no overlapping subclient content across instances before you start to perform backups for the following agents:
Exchange Database
Informix
Oracle
SharePoint Server
Sybase
Backup
Active Directory
DB2
DB2 DPF On UNIX computers, you cannot use DB2 Agents installed on different instances to protect the data of a given DB2
version. For example, if DB2 version 8 is installed on a given computer, you cannot protect the data with a DB2 Agent
installed on Instance 001, and protect some of the data with a DB2 Agent installed on Instance002. However, if you
have DB2 version 8 and DB2 version 9 installed on the same UNIX computer, you can protect the data from DB2
version 8 using the agent from Instance001, and use the agent installed on Instance002 to protect the data from DB2
version 9.
DB2 pureScale Same as DB2 DPF.
Documentum
Exchange Database Before you start backup operations, ensure that there is no overlapping subclient content across instances. If subclient
content overlaps, there is the potential risk of data loss.
Exchange Mailbox (Classic) Before you start backup operations, ensure that there is no overlapping subclient content across instances. If subclient
content overlaps, there is the potential risk of data loss.
Exchange Public Folder Before you start backup operations, ensure that there is no overlapping subclient content across instances. If subclient
content overlaps, there is the potential risk of data loss.
Google Mail and Google Drive
GPFS
Hadoop
IBM i File System
IBM Notes Database
IBM Notes Document
Image Level
Informix Before you start backup operations, ensure that there is no overlapping subclient content across instances. If subclient
content overlaps, there is the potential risk of data loss.
Macintosh File System
Microsoft SharePoint Server Before you start backup operations, ensure that there is no overlapping subclient content across instances. If subclient
content overlaps, there is the potential risk of data loss.
Microsoft SQL Server
Microsoft Windows File IntelliSnap backups are not supported on a client with multiple instances.
Systems Block-level backups are not supported on a client with multiple instances.
MySQL
NAS
NFS
OES File System
OpenVMS File System
Oracle Supported: UNIX computers
Unsupported: Windows computers, IntelliSnap backups on a client with multiple instances.
Oracle RAC
PostgreSQL
Salesforce
SAP for MaxDB
SAP for Oracle
SAP HANA
Sybase Before you start backup operations, ensure that there is no overlapping subclient content across instances. If subclient
content overlaps, there is the potential risk of data loss.
Unix File Systems IntelliSnap backups are not supported on a client with multiple instances.
Block-level backups are not supported on a client with multiple instances.
Archive
Domino Mailbox Archiver
Exchange Compliance Archiver
Exchange Mailbox
Exchange Mailbox Archiver Multiple instances are supported if the agent uses the proxy fanning configuration.
The OWA Proxy Enabler also supports the installation of multiple instances, except if it is installed through a Group
Policy Objects (GPO) by using the Microsoft Windows Installer (MSI) package.
5/6/2017 Commvault Systems Page 102 of 587
Exchange Public Folder
Archiver
OnePass for Celerra
OnePass for Exchange Mailbox
(Classic)
OnePass for Hitachi HNAS The File Share Archiver Client supports the installation of multiple instances, except if it is installed through a GPO
(BlueArc) using the MSI package.
OnePass for NetApp
OnePass for Network Shares
OnePass for Unix
OnePass for Windows
Oracle Archiving
Replication
ContinuousDataReplicator
Virtualization
Amazon
Citrix Xen
Docker
FusionCompute
KVM
Microsoft Azure
Microsoft Hyper-V IntelliSnap backups are not supported on a client with multiple instances.
Nutanix AHV
OpenStack
Oracle VM
oVirt
Red Hat Enterprise
Virtualization
VMware IntelliSnap backups are not supported on a client with multiple instances.
Laptop
Laptop Backup (Linux) IntelliSnap backups are not supported on a client with multiple instances.
Laptop Backup (Macintosh)
Laptop Backup (Windows) IntelliSnap backups are not supported on a client with multiple instances.
Procedure
1. Log on to the client computer as root.
2. Open the /etc/sudoers configuration file in editable mode by using the following command:
visudo
To remove the password prompt during the computer login, specify NOPASSWD: ALL as follows:
sudouser ALL=(ALL) NOPASSWD: ALL
If you want users to only run Commvault commands as root users, enter the following:
## Allow users to install and run Commvault commands
Cmnd_Alias DVDINSTALLCMDS =/DVD_Mount_Location/cvpkgadd
Cmnd_Alias DVDUNINSTALLCMDS =/usr/bin/cvpkgrm
Procedure
1. From the CommCell Browser, right-click CommServe and click Properties.
2. In the CommCell Properties dialog box, click the Additional Settings tab and click Add.
3. In the Add Additional Settings dialog box, add the nAllowDuplicateHostName additional setting with the following properties:
Property Value
Name nAllowDuplicateHostName
Category CommServe
Type INTEGER
Value 1
For instructions on adding the additional setting from the CommCell Console, see Add or Modify an Additional Setting .
Procedure
1. Create the OEMInfo.xml file and enter the following content in the XML:
<OEMInformation>
<OEMInfo Id="1">
<BRAND_OI_ID>1</BRAND_OI_ID>
<BRAND_OI_NAME>Commvault</BRAND_OI_NAME>
<BRAND_OEM>CommvaultEdition</BRAND_OEM>
<BRAND_PRODUCT>Commvault</BRAND_PRODUCT>
<BRAND_VENDOR>Commvault Systems, Inc.</BRAND_VENDOR>
<BRAND_SUPPORT_URL>http://www.commvault.com/support</BRAND_SUPPORT_URL>
<BRAND_SUPPORT_EMAIL>[email protected]</BRAND_SUPPORT_EMAIL>
<BRAND_SUPPORT_PHONE>US/CANADA (Toll Free) (877) 780-3077; INTERNATIONAL (732) 571-2160</BRAND_SUPPORT_PHONE>
<BRAND_SUBSYSTEMS>*</BRAND_SUBSYSTEMS>
<BRAND_PLATFORMS>*</BRAND_PLATFORMS>
<BRAND_INSSUBDIR>commvault</BRAND_INSSUBDIR>
<BRAND_SSCRIPT>commvault</BRAND_SSCRIPT>
<BRAND_GALGROUP>commvault</BRAND_GALGROUP>
</OEMInfo>
</OEMInformation>
Note: Do not close the editor yet as you need to update the XML parameters.
2. Update the necessary XML parameters listed in the following table.
Parameter Description
BRAND_OI_NAME The name of the software to be installed. The software name may be the same as the product name.
BRAND_OEM The edition name for your software.
BRAND_PRODUCT The name of your company product.
The product name is also used as the name of the installation wizard. This is the name you will see on the welcome
page of the wizard.
BRAND_VENDOR The name of your company.
BRAND_SUPPORT_URL The URL to the customer support page of your company website.
BRAND_SUPPORT_EMAIL The email address for general support inquiries.
BRAND_SUPPORT_PHONE The phone number for general support inquiries. You can specify more than one phone number. For example,
phone numbers for domestic and international calls.
BRAND_INSSUBDIR The name of the subdirectory where the software must be installed.
The Commvault software is installed in a subdirectory under the opt directory. For example, /opt/subdirname.
BRAND_SSCRIPT The name for a UNIX command to check and manage Commvault processes.
BRAND_GALGROUP The name of the UNIX group name that you want to use during the installation.
3. Save and close the OEMInfo.xml file.
4. Copy the XML file to the appropriate location based on type of installation method that you plan to use:
If you plan to install the software locally by using the installation package, copy the file to the root directory of the package. In this directory, you will also find other
scripts, such as cvpkgadd and detect.
If you plan to install the software remotely by using the CommCell Console, copy the file to the CommServe computer, and then place the file in the following UNIX
folder within the CommServe cache path: CommServe_cache_directory\CVMedia\11.0.0\Unix.
For example, if the CommServe cache is located in the installation directory, then copy the fie to software_installation_directory\SoftwareCache\CVMedia\11.0.0\Unix.
Result
Future installations from the package will use the new brand name.
Note: During client upgrades, the installation program will use the default branding information, except for the XML parameters BRAND_INSSUBDIR, BRAND_SSCRIPT, and
BRAND_GALGROUP, which retain the value that was set during the client installation.
Procedure
1. From the Apple menu, click System Preferences .
2. In the System Preferences window, click Users & Groups.
3. To make changes to the user and group settings, click the lock icon to unlock it, then enter the administrator credentials.
4. Below the list of users, click the + button to add a user group.
5. In the new user dialog box, complete the following steps:
a. From the New Account list, select Group.
b. In the Full Name box, enter the name of the user group.
c. Click Create Group.
6. To save the changes you made, click the lock icon again.
Prerequisites
At a minimum, the following 32-bit libraries must be installed on the 64-bit Linux computer:
C and C++ runtime libraries, such as libc6-i386 and lib32stdc++6, or equivalents
Compression libraries, such as lib32z1 or equivalent
Access control lists libraries, such as libacl.i386 or equivalent
Procedure
Use one of the following methods to enable 32-bit installations:
Preferred Method: Using the CommCell Console (Remote Installation)
During a remote installation, on the UNIX Advanced Options page of the installation wizard, select the Install 32-bit instead of default 64-bit packages (Linux_x86_64
only) - This will protect 32-bit applications only check box.
For instructions on remote installations, see Installing Commvault Remotely Using the CommCell Console .
Alternative Method: Using the Installation Package (Local Installation)
Before you run the installation package, create a lock file on the 64-bit computer by running the following command:
touch /tmp/cvpkgadd_unlock_32
After the file is created, you can install 32-bit agents by running the installation package. For instructions, see Installing Commvault Locally on UNIX, Linux, and Macintosh
Computers Using the Installation Package .
Prerequisites
The non-root user must have read and write permissions to the /tmp/locks directory.
Supported Agents
The following table lists the agents that are available when you install as a non-root user, along with some important considerations.
Note: If you are installing a custom package, the package displays all of its available agents. However, only the agents listed in the following table are supported for
installation.
Agents Considerations
File System Agent The following features are not supported:
Optimized scans
OnePass
ContinuousDataReplicator
IntelliSnap backups
Oracle Agent The agent supports traditional data backups, log backups, and restores, including restores to disk that were performed by the
same user who installed Commvault.
Table-level restores and IntelliSnap backups are not supported.
For third-party command-line and on-demand backup or restore jobs, the user must pass the CVREG=RegistryPath in the RMAN
script. For example:
run {
allocate channel ch1 type 'sbt_tape'
PARMS="SBT_LIBRARY=/home/oracle/opt/commvault/Base/libobk.so,ENV=(CVREG=/home/oracle/CommVaultRegistry/)";
backup database;
}
exit;
DB2 Agent The agent supports traditional data backups, log backups, and restores, including restores to disk that were performed by the
same user that installed Commvault.
IntelliSnap backups are not supported.
Before running Db2_config.sh and db2util.sh, you must set the CVREG environment variable to the registry path. If the environment
variable is not set, run the galaxy_vm command to get the registry path:
. ~/opt/commvault/galaxy_vm
The command must be run by the same user who installed Commvault.
Use the following commands every time you need to start the DB2 application:
db2set DB2ENVLIST='CVREG'
db2stop
export CVREG="/home/db2inst1/CommVaultRegistry"
db2start
Postinstallation Tasks
Review the following information after the installation, and ensure that you follow any necessary postinstallation task.
Review Files and Folders Created During Installation
The installation program uses the home directory of the non-root user for the following items:
Installation binaries are stored in the ~/opt directory.
In a traditional installation performed by the root user, the program stores the binaries in the /opt directory.
Log files are stored in the ~/log directory. Users must have write permissions to access the directory.
In a traditional installation performed by the root user, the program stores the log files in the /var/log directory.
The registry is created in the ~/CommVaultRegistry directory.
In a traditional installation performed by the root user, the program uses the/etc/CommVaultRegistry directory.
Restart Commvault Services
Commvault services do not start automatically during a reboot. You must start the services manually by running the following command from the
Software_Installation_Path/Base directory:
./commvault start
If the PATH environment variable in the $HOME/.bash_profile or the $HOME/.profile files is exported to the Software_Installation_Path/Base directory, you can run the following
5/6/2017 Commvault Systems Page 111 of 587
command from any directory.
commvault start
Install Updates
Updates must be installed by the same user who installed the Commvault software.
When a non-root user installs updates, the installation program checks whether the CVREG environment variable is already set in the registry path. If it is not set, run the
galaxy_vm command to get the registry path, as shown below:
. ~/opt/commvault/galaxy_vm
If you need to back up the client data at some point, you can reconfigure the client from the CommCell Console. For more information, see Reconfiguring Components .
General Requirements
The computer where you plan to install multiple instances must have at least one Commvault instance already installed.
Each instance must be installed on a different installation directory. During the installation, the installation program automatically defines the directory.
For example, on a Windows computer, if Instance001 is installed on C:\Program Files\CommVault\ContentStore, then Instance002 is automatically installed on C:\Program
Files\CommVault\ContentStore2.
Each instance must have a unique set of static TCP port numbers. During the installation, the installation program automatically assigns the port numbers.
If you want to change the ports used by an existing instance, see Changing Port Numbers .
If you plan to install multiple MediaAgent instances on a computer, and you want to use a port other than 8400 for the MediaAgent Communications Service
(GxCVD), clients from older Commvault versions might not be able to communicate through that port. Therefore, make sure that the port is accessible by the
clients that use the MediaAgent.
The VSS Provider software, which includes the VSS Provider and/or VSS Hardware Provider packages, cannot be installed on multiple instances. If the VSS Provider is
already installed, and you need to install an agent that requires the VSS Provider software, make sure that the VSS packages are not selected for installation.
New instances can point to the same CommServe computer or to a different CommServe computer.
To point to a different CommServe computer, you can use the same client name and host name that you specified on the existing instance.
To point to the same CommServe computer, you must provide a unique client name.
On UNIX, Linux, and Macintosh computers, the installation of additional instances changes the permissions of the entire /etc/CommVaultRegistry directory and its sub-
directories. Therefore, non-root users must be members of the same user group that is used for installations. The group permissions must have the default value '7'.
CommServe
You can install multiple instances of the CommServe software on cluster group servers. Review the following information for installations on cluster environments:
The instance with the CommServe software cannot be used for subsequent installations. If you install additional Commvault software on the cluster server, the
software is automatically installed on a new instance.
For all cluster group servers that use the same instance, only one set of binaries and one set of services are used, except for the GxClusterPlugin service.
MediaAgent
Multiple MediaAgent instances that share libraries with each other must be part of the same CommCell. To be in separate CommCells, the MediaAgents cannot share any
libraries.
Exchange Agents
For the Exchange Public Folder Archiver Agent, you must provide a different OWA alias during the installation for each instance that you install.
Procedure
Use one of the following methods to enable multi-instance installations on a computer:
Preferred Method: Using the CommCell Console (Remote Installation)
During a remote installation, on the Enter Additional Install Options page of the installation wizard, select the Install new Instance (if required) check box to install a
new instance.
For instructions on remote installations, see Installing Commvault Remotely Using the CommCell Console .
Important:
Remote installations are not supported for server packages, such as the CommServe, Web Server, and Workflow Engine.
Subsequent installations on the new instance are not supported from the CommCell Console. You must run the installation package to install the software on the
instance you want.
Alternative Method: Using the Installation Package (Local Installation)
On Windows computers:
1. Before you run the installation package, create the bAllowMultiInstances registry key to enable the multi-instancing feature on a Windows computer:
a. Open the Windows Registry Editor and go to the following directory:
HKEY_LOCAL_MACHINE\SOFTWARE\
b. Right-click SOFTWARE and click New > Key. Name the new key as GalaxyInstallerFlags.
c. Right-click GalaxyInstallerFlags and click New > DWORD. Name the new value as bAllowMultiInstances.
d. Double-click bAllowMultiInstances, set the Value data to 1, and click OK.
e. Close the Registry Editor.
2. Install a new instance.
During a local installation, on the Install Instance Selection page of the installation wizard, select Create a new instance.
For instructions on local installations, see Installing Commvault Locally on Windows Computers Using the Installation Package .
On UNIX computers:
During a local installation, make sure to select the following options:
On the Install Task dialog, select Install packages on this machine.
On the Instance Page dialog, select Create new instance.
For instructions on local installations, see Installing Commvault Locally on UNIX, Linux, and Macintosh Computers Using the Installation Package .
Note: Do not use unattended installations to create new instances or on a computer that has multiple instances.
What to Do Next
Overlapping contents can result in data loss.
Ensure that there is no overlapping subclient content across instances before you start to perform backups for the following agents:
Exchange Database
Informix
Oracle
SharePoint Server
Sybase
Backup
Active Directory
DB2
DB2 DPF On UNIX computers, you cannot use DB2 Agents installed on different instances to protect the data of a given DB2
version. For example, if DB2 version 8 is installed on a given computer, you cannot protect the data with a DB2 Agent
installed on Instance 001, and protect some of the data with a DB2 Agent installed on Instance002. However, if you
have DB2 version 8 and DB2 version 9 installed on the same UNIX computer, you can protect the data from DB2
version 8 using the agent from Instance001, and use the agent installed on Instance002 to protect the data from DB2
version 9.
DB2 pureScale Same as DB2 DPF.
Documentum
Exchange Database Before you start backup operations, ensure that there is no overlapping subclient content across instances. If subclient
content overlaps, there is the potential risk of data loss.
Exchange Mailbox (Classic) Before you start backup operations, ensure that there is no overlapping subclient content across instances. If subclient
content overlaps, there is the potential risk of data loss.
Exchange Public Folder Before you start backup operations, ensure that there is no overlapping subclient content across instances. If subclient
content overlaps, there is the potential risk of data loss.
Google Mail and Google Drive
GPFS
Hadoop
IBM i File System
IBM Notes Database
IBM Notes Document
Image Level
Informix Before you start backup operations, ensure that there is no overlapping subclient content across instances. If subclient
content overlaps, there is the potential risk of data loss.
Macintosh File System
Microsoft SharePoint Server Before you start backup operations, ensure that there is no overlapping subclient content across instances. If subclient
content overlaps, there is the potential risk of data loss.
Microsoft SQL Server
Microsoft Windows File IntelliSnap backups are not supported on a client with multiple instances.
Systems Block-level backups are not supported on a client with multiple instances.
MySQL
NAS
NFS
OES File System
OpenVMS File System
Oracle Supported: UNIX computers
Unsupported: Windows computers, IntelliSnap backups on a client with multiple instances.
Oracle RAC
PostgreSQL
Salesforce
SAP for MaxDB
SAP for Oracle
SAP HANA
Sybase Before you start backup operations, ensure that there is no overlapping subclient content across instances. If subclient
content overlaps, there is the potential risk of data loss.
Unix File Systems IntelliSnap backups are not supported on a client with multiple instances.
Block-level backups are not supported on a client with multiple instances.
Archive
Domino Mailbox Archiver
Exchange Compliance Archiver
Exchange Mailbox
Exchange Mailbox Archiver Multiple instances are supported if the agent uses the proxy fanning configuration.
The OWA Proxy Enabler also supports the installation of multiple instances, except if it is installed through a Group
Policy Objects (GPO) by using the Microsoft Windows Installer (MSI) package.
5/6/2017 Commvault Systems Page 118 of 587
Exchange Public Folder
Archiver
OnePass for Celerra
OnePass for Exchange Mailbox
(Classic)
OnePass for Hitachi HNAS The File Share Archiver Client supports the installation of multiple instances, except if it is installed through a GPO
(BlueArc) using the MSI package.
OnePass for NetApp
OnePass for Network Shares
OnePass for Unix
OnePass for Windows
Oracle Archiving
Replication
ContinuousDataReplicator
Virtualization
Amazon
Citrix Xen
Docker
FusionCompute
KVM
Microsoft Azure
Microsoft Hyper-V IntelliSnap backups are not supported on a client with multiple instances.
Nutanix AHV
OpenStack
Oracle VM
oVirt
Red Hat Enterprise
Virtualization
VMware IntelliSnap backups are not supported on a client with multiple instances.
Laptop
Laptop Backup (Linux) IntelliSnap backups are not supported on a client with multiple instances.
Laptop Backup (Macintosh)
Laptop Backup (Windows) IntelliSnap backups are not supported on a client with multiple instances.
File System
ContinuousDataReplicator
Driver for File Archiver
File Share Archiver Client
File System
VSS Provider (see MediaAgent )
Virtualization
Virtual Server
Database
DB2
Documentum
Informix
MySQL
Oracle
PostgreSQL
SQL Server
SAP for Oracle
SAP for MAXDB
Sybase
Applications
Active Directory
Domino Mailbox Archiver
Exchange Database
Exchange Mailbox
Exchange Public Folder
Exchange Offline Mining Tool
Exchange Compliance Archiver
Exchange Public Folder Archiver
Notes Database
Notes Document
OWA Proxy Enabler
SharePoint
File System
ContinuousDataReplicator
File System
OES File System
SAP ArchiveLink
Virtualization
Virtual Server
Database
DB2
Documentum
Informix
MySQL
Oracle
PostgreSQL
SAP for Oracle
SAP for MAXDB
SAP for HANA
Sybase
Applications
Domino Mailbox Archiver
Notes Database
Notes Document
*On Macintosh computers, only the File System Agent is supported.
Operating System Domain Controller Non-Domain Domain Controller & Non-Domain Controller & Notes
Controller ADAM/LDS ADAM/LDS
Windows 2003 Domain Admin N/A Domain Admin and ADAM ADAM Admin -
Admin
Windows 2008 Domain Admin Local Admin Domain Admin and LDS Admin LDS Admin and Local Admin Supports Offline DB
mounting
Where:
Domain Admin is a user that belongs to Domain Administrator group for that domain
ADAM Admin is a user that belongs to the Roles\Administrator group (container) of the configuration partition for that ADAM instance.
LDS Admin is a user that belongs to the Roles\Administrator group (container) of the configuration partition for that LDS instance.
Local Admin is a user that belongs to the Local Administrators group.
Notes: If a user with all the required permissions does not exist, you must create one and assign the necessary permissions.
Gather Installation Data
Refer to the items in this section to gather the information that you will need during the installation. Record the information before you begin installing the software, so
you can refer to it during the installation.
You can install the Active Directory Agent using either the CommCell Console or the installation package created by the Download Manager. Any item that applies to
only one of these installation methods is noted.
Commvault package to install
Install the Active Directory package, which is listed under the Application category.
If the File System Agent is not installed on the computer, the File System Core and File System packages are automatically installed with the package you
selected. The File System Agent will not consume any license.
To gather the required information for the File System Agent, refer to the Gather Installation Data section in the Preinstallation Checklist for the
Windows File System Agent .
Client computer details
If the File System Agent, or another package, is already installed on the computer, you are not required to gather all the computer details again. The level of detail
depends on how the package you selected is installed:
For installations using the CommCell Console, the installation program requests only the name of the client computer.
For installations using the installation package, the installation program reads the details from the previous installation.
You must restart the Oracle database application after installing the Documentum Agent on Oracle database.
If the File System Agent is not installed on the computer, the File System Core and File System packages are automatically installed with the package you
selected. The File System Agent will not consume any license.
To gather the required information for the File System Agent, refer to the Gather Installation Data section in the Preinstallation Checklist for the
Windows File System Agent .
Client computer details
If the File System Agent, or another package, is already installed on the computer, you are not required to gather all the computer details again. The level of detail
depends on how the package you selected is installed:
For installations using the CommCell Console, the installation program requests only the name of the client computer.
For installations using the installation package, the installation program reads the details from the previous installation.
Make sure that you install the agent on a different computer than where you installed the CommServe host. Backup operations might fail if you install both the
agent and the CommServe host on the same computer.
In both a clustered and non-clustered environment, you can install the agent using either of the following locations:
On-host: The package is installed directly onto the Exchange server. Use this location if your hardware resources are limited. However, an on-host location places a
high load on the server's memory and processor.
Off-host: The package is installed on a separate computer that is in the same domain as the Exchange server. Use this location to relieve memory and resource
processing load from the Exchange server.
If you use a clustered environment, you must install the agent either on the physical nodes of the cluster where the Exchange server is installed, or on a
separate physical node that is connected to the server.
Make sure that you install the agent on a different computer than where you installed the CommServe host. Backup operations might fail if you install both the
agent and the CommServe host on the same computer.
In both a clustered and non-clustered environment, you can install the agent using either of the following locations:
On-host: The package is installed directly onto the Exchange server. Use this location if your hardware resources are limited. However, an on-host location places a
high load on the server's memory and processor.
Off-host: The package is installed on a separate computer that is in the same domain as the Exchange server. Use this location to relieve memory and resource
processing load from the Exchange server.
If you use a clustered environment, you must install the agent either on the physical nodes of the cluster where the Exchange server is installed, or on a
separate physical node that is connected to the server.
Make sure that you install the agent on a different computer than where you installed the CommServe host. Backup operations might fail if you install both the
agent and the CommServe host on the same computer.
In both a clustered and non-clustered environment, you can install the agent using either of the following locations:
On-host: The package is installed directly onto the Exchange server. Use this location if your hardware resources are limited. However, an on-host location places a
high load on the server's memory and processor.
Off-host: The package is installed on a separate computer that is in the same domain as the Exchange server. Use this location to relieve memory and resource
processing load from the Exchange server.
If you use a clustered environment, you must install the agent either on the physical nodes of the cluster where the Exchange server is installed, or on a
separate physical node that is connected to the server.
If you are installing the File Share Archiver Client using the CommCell Console, the File System Core package is installed automatically.
If the client is separated from the CommServe computer by an HTTP proxy, collect the host name (or IP address) and the port number of the HTTP
proxy through which the CommServe computer can be reached.
Other Firewall Setups
The following firewall setups share the same preparation requirements as those listed under Client Connects to the CommServe Computer:
Two-way firewall, where the client and CommServe computer connect to each other.
Port-forwarding gateway, where the gateway forwards incoming connections on specific ports.
Use this preinstallation checklist to prepare the computer where the File System Agent will be installed and to gather all of the information you will need during the
installation.
Verify System Requirements
Verify that the computer where you will install the File System Agent satisfies the minimum requirements specified in System Requirements - Microsoft Windows File
System Agent .
If you plan to use the OnePass solution, review the requirements specified in System Requirements - OnePass for Windows .
Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the File System Agent. For more
information, see License Requirements - Windows File System Agent
If you plan to use the OnePass solution, review the license information in License Requirements - OnePass for Windows File System .
Remember: The File System Agent is a dependency for most agents. If required by an agent, the File System Agent is installed automatically without consuming any
license.
Determine the Installation Location
Based on your environment, install the File System Agent on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer that you want to back up.
Clustered On all physical nodes of the cluster.
Regardless of the installation method, the File System Core package is automatically included in the installation.
If there is a firewall between the client computer and the CommServe computer, you also need to record the name of the CommServe client, as seen in the
CommCell Browser (the name is case-sensitive). The installation program requires this information for all firewall setups, except for environments where
only the CommServe can connect to the client.
Client computer details
For installations using the CommCell Console:
Collect the host name (fully qualified domain name) of the computers on which you want to install the software. You also need an administrative account that
has access to all the computers. The account details are not required for existing clients.
For installations using the installation package:
By default, the installation program uses the local (NetBIOS) name of the computer to configure the client name in the CommServe database as well as the
display name in the CommCell Console. Optionally, you can use a different display name to represent the client. Do not include spaces in the name.
The installation program also uses the default network interface name (host name) of the computer to communicate with the CommServe computer. If the
computer has multiple network interfaces, select the interface name to use.
Windows Firewall for Computer Profiles
This information is only applicable to installations using the installation package.
If Windows Firewall is enabled for some profiles (PublicProfile, DomainProfile, and StandardProfile), decide whether you want to disable Windows Firewall for all
profiles.
Windows Firewall Exclusion List
If the computer has Windows Firewall turned on, you can add the Commvault programs and services to the Windows Firewall exclusion list during the installation.
We recommend this configuration which enables CommCell operations across the firewall.
Client groups
If you want the computer to share the same properties of a client group, and client groups are configured in your CommCell environment, select a client group to
use.
For more information on client groups, see Client Computer Groups .
Subclient policy
If you have subclient policies configured in your CommCell environment, select a policy to associate to the default subclient.
For more information on subclient policies, see Subclient Policies - Getting Started .
Storage policy
If you have storage policies configured in your CommCell environment, select a policy to associate to the default subclient.
If you plan to create a new storage policy for the agent to be installed, see Storage Policy - Getting Started for instructions.
Configure for laptop backup
If you configure the agent for laptop backup, access to the CommCell Console is not required, since backup operations can be performed from the Web Console. For
more information, see Overview - End-User Operations .
This configuration also triggers the installation of the Edge Monitor tool, so that end-users can view the backup job summary of their laptop computer. For more
information, see Edge Monitor .
By default, the installation program creates a shortcut to access the Edge Monitor tool. If you decide not to create the shortcut, the tool can be accessed from the
Installation_Directory/Base folder, by double-clicking Laptop2Taskbaricon.exe.
Use this preinstallation checklist to prepare the computer where the File System Agent will be installed and to gather all of the information you will need during the
installation.
Verify System Requirements
Verify that the computer where you will install the File System Agent satisfies the minimum requirements specified in the system requirements page for your operating
system:
System Requirements - AIX File System
System Requirements - FreeBSD File System
System Requirements - HP-UX File System
System Requirements - Linux File System
System Requirements - Solaris File System
System Requirements - Macintosh File System
If you plan to use the OnePass solution, review the following system requirements for your operating system:
System Requirements - OnePass for UNIX File Systems
System Requirements - OnePass for Macintosh File System
Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the File System Agent.
For more information, see:
License Requirements - UNIX File System Agent
License Requirements - Macintosh File System Agent
If you plan to use the OnePass solution, review the following license information:
License Requirements - OnePass for UNIX File Systems
License Requirements - OnePass for Macintosh File System
Remember: The File System Agent is a dependency for most agents. If required by an agent, the File System Agent is installed automatically without consuming any
license.
Determine the Installation Location
Based on your environment, install the File System Agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On the computer that you want to back up.
For Oracle Solaris computers, install the File System Agent on one of the following setups:
Solaris server
Computer hosting the global zone
Non-global zone
We recommend that you install the File System Agent on the global zone to protect static data on non-global zones. If the data is
dynamic or contains application data, you can install the File System Agent on the non-global zone.
Clustered On all physical nodes of the cluster.
Cluster installations are not supported on FreeBSD and Macintosh computers.
By default, regardless of the installation method, the File System Core package is automatically included in the installation.
For installations on Linux clients that will also serve as a proxy to an OpenVMS client or an IBM i client, also install the File System for OpenVMS package or the File
System for IBM i package respectively.
Installation directory
By default, the software binaries are installed in /opt/commvault.
You can change the directory to a different local directory or to an NFS share. If you decide to use an NFS share, make sure that it is always mounted and accessible
by the Commvault software.
Client computer details
For installations using the CommCell Console:
5/6/2017 Commvault Systems Page 140 of 587
Collect the host name (fully qualified domain name) of the computers on which you want to install the software. You also need an administrative account that
has access to all the computers. The account details are not required for existing clients.
For installations using the installation package:
By default, the installation program uses the local (NetBIOS) name of the computer to configure the client name in the CommServe database as well as the
display name in the CommCell Console. Optionally, you can use a different display name to represent the client. Do not include spaces in the name.
The installation program also uses the default network interface name (host name) of the computer to communicate with the CommServe computer. If the
computer has multiple network interfaces, select the interface name to use.
Log directory
By default, all Commvault logs are stored in /var/log/commvault/Log_Files.
You can change the directory, but it must be a local directory or an NFS share with at least 100 MB of free space.
UNIX group
We recommend that you assign a dedicated UNIX group for all Commvault processes. Users associated to that group are granted access rights over Commvault
configuration files, registry, and log files. If you do not assign a group, you must set access permissions for other users during the installation. Only the root group
has all access rights by default.
If you plan to install a database agent (for example, Oracle), assign the UNIX group that is used by the database application, and add the database users to the
group. The group grants access rights for both Commvault and database application processes.
Access Permissions for the UNIX group and other computer users
If you do not assign a dedicated UNIX group, you must set sufficient access permissions for other users (other than root users) during the installation. By default,
read and execute permissions are granted to other users during installations from the installation package, and read, write, and execute permissions during
installations from the CommCell Console.
If you do assign a dedicated UNIX group, you will be able to set the access permissions for the group. By default, read, write, and execute permissions are granted to
the UNIX group.
For installations on AIX computers and for 32-bit installations, grant read permissions for other users to ensure that services are started when the
installation completes.
System configuration files and number of streams on Macintosh
Gather the following details of your Macintosh computer:
Determine the number of streams that you will run at the same time to ensure that there are enough semaphores and shared memory configured in the
system.
For installations using the installation package:
Verify whether the /etc/sysctl.conf and /boot/loader.conf configuration files can be modified. The installation program makes changes to these files if not enough
shared memory and semaphores are available for Commvault processes.
CVD port for CommCell communication
By default, CVD uses port number 8400. If the port number is used by other applications, or if you plan to install a new Commvault instance, select a port number
that is between 1024 and 65000.
Configure for laptop or desktop backup
If you configure the agent for laptop backup, access to the CommCell Console is not required, since backup operations can be performed from the Web Console. For
more information, see Overview - End-User Operations .
This configuration also triggers the installation of the Edge Monitor tool, so that end-users can view the backup job summary of their laptop computer. For more
information, see Edge Monitor .
Firewall services
If there is a firewall between the client computer and the CommServe computer, gather the following information based on your firewall setup:
Client connects to the CommServe computer (One-Way Firewall)
Select an HTTP or HTTPS port number that can be used to open tunnel connections to the CommServe computer.
If the client is separated from the CommServe computer by an HTTP proxy, collect the host name (or IP address) and the port number of the HTTP proxy
through which the CommServe computer can be reached.
CommServe computer connects to the client (One-Way Firewall)
Select a local HTTP or HTTPS port number that can be used by the CommServe computer to open tunnel connections towards the client.
CommServe computer can be reached only through a Proxy
Collect the following information:
Client name of the Commvault proxy (name is case-sensitive).
HTTP or HTTPS tunnel port number on which the proxy expects connections.
If the CommServe computer is behind a port-forwarding gateway, collect the port number of the gateway instead.
Host name or IP address of the proxy through which the CommServe computer can be reached.
If the CommServe computer is behind a port-forwarding gateway, collect the host name or IP address of the gateway instead.
If the client is separated from the CommServe computer by an HTTP proxy, collect the host name (or IP address) and the port number of the HTTP
proxy through which the CommServe computer can be reached.
Other Firewall Setups
The following firewall setups share the same preparation requirements as those listed under Client Connects to the CommServe Computer:
Two-way firewall, where the client and CommServe computer connect to each other.
Port-forwarding gateway, where the gateway forwards incoming connections on specific ports.
CommServe host name
Record the host name of the CommServe computer (fully qualified domain name or IP address.) The CommServe host name cannot include spaces or any of the
following characters:
\|`~!@#$%^&*()+=<>/?,[]{}:;'"
If there is a firewall between the client computer and the CommServe computer, you also need to record the name of the CommServe client, as seen in the
CommCell Browser (the name is case-sensitive). The installation program requires this information for all firewall setups, except for environments where
5/6/2017 Commvault Systems Page 141 of 587
only the CommServe can connect to the client.
Client certificates
This information is only applicable to installations using the installation package.
If the CommCell environment is in "lockdown" mode, create a temporary certificate to authenticate the client installation. For more information, see Create a
Temporary Certificate for Client Installation .
Note that installations using the CommCell Console are not supported when the CommCell is in "lockdown" mode.
Client groups
If you want the computer to share the same properties of a client group, and client groups are configured in your CommCell environment, select a client group to
use.
For more information on client groups, see Client Computer Groups .
Subclient policy
If you have subclient policies configured in your CommCell environment, select a policy to associate to the default subclient.
For more information on subclient policies, see Subclient Policies - Getting Started .
Storage policy
If you have storage policies configured in your CommCell environment, select a policy to associate to the default subclient.
If you plan to create a new storage policy for the agent to be installed, see Storage Policy - Getting Started for instructions.
If the File System Agent is not installed on the computer, the File System Core and File System packages are automatically installed with the package you
selected. The File System Agent will not consume any license.
To gather the required information for the File System Agent, refer to the Gather Installation Data section in the Preinstallation Checklist for the
Windows File System Agent .
Client computer details
If the File System Agent, or another package, is already installed on the computer, you are not required to gather all the computer details again. The level of detail
depends on how the package you selected is installed:
For installations using the CommCell Console, the installation program requests only the name of the client computer.
For installations using the installation package, the installation program reads the details from the previous installation.
If the File System Agent is not installed on the computer, the File System Core and File System packages are automatically installed with the package you
selected. The File System Agent will not consume any license.
To gather the required information for the File System Agent, refer to the Gather Installation Data section in the Preinstallation Checklist for the
Windows File System Agent .
Client computer details
If the File System Agent, or another package, is already installed on the computer, you are not required to gather all the computer details again. The level of detail
depends on how the package you selected is installed:
For installations using the CommCell Console, the installation program requests only the name of the client computer.
For installations using the installation package, the installation program reads the details from the previous installation.
ObjectStore Settings
You must provide the user name, password for the ObjectStore account, and the host name of the Web Server.
UNIX Group and access permissions
If you did not assign a UNIX group during the installation of the File System agent, make sure to do the following during the installation:
Assign the UNIX group that is used by the database application
Include the database users into the group
You will be able to set the access permissions for the group. By default, read/write/execute permissions are granted to the UNIX group.
Tomcat Web Service port number
By default, the Tomcat Web Service uses port number 8080. If the port number is used by other applications, you must select another port number.
Tomcat Web Service URL
The installation program provides the default URL for the Tomcat web service. You can provide a different URL.
On the SharePoint farm, install the software on the Application Server that hosts the Central Administration site.
Commvault services account, also known as the SharePoint Administrator account, is used to run the SharePoint backup operation.
Restart the Commvault services account to update service account information after assigning permissions, else it will use old information in the cache.
Use the same user account to run the SQL agent and the SQL server account.
Commvault user should be a sysadmin user on the SQL server where the configuration database resides.
You can run CVSPCompatibilityCheck tool to ensure that all the above mentioned permissions are set properly. For more information, see KB article SP0001 .
We do not support ADFS account to be used as a service account for Commvault SharePoint Agent.
User Accounts
When configuring a virtualization client, you must provide user credentials as noted in the following list:
For Amazon, define policies for user permissions as described in Amazon Web Services User Permissions for Backups and Restores .
For Citrix Xen, collect credentials for the root user or a user account having the Pool Administrator (Pool Admin) role.
For FusionCompute, obtain administrator user credentials for the Virtual Resource Manager (VRM).
For Microsoft Azure, see Setting Up an Application and Tenant for Azure Resource Manager or Setting Up a Microsoft Azure Management Certificate for Azure
Classic for credential requirements.
For Microsoft Hyper-V, the user account credentials that are used to access the Hyper-V server or cluster for your virtualization instance must be part of the
following administrator groups on the Hyper-V host:
Hyper-V Administrators group
For Windows Hyper-V Server 2008 R2, Local Administrators group
For a Hyper-V cluster, the user account must have full Cluster Permissions (Read and Full Control).
For Nutanix AHV, collect credentials for a user that has Prism administrator privileges for the Nutanix cluster.
For OpenStack, collect credentials for a user account with administrative privileges for the keystone node.
For Oracle VM, collect administrator user credentials for Oracle VM Manager.
For Red Hat Virtualization, collect credentials for a user account with administrative privileges on the RHEV Manager.
For each VMware vCenter, collect user credentials with appropriate permissions as described in Configuration of User Accounts for VMware .
Deployment Planning
Before installing the Virtual Server Agent, review deployment options for your virtualization platform to understand how to optimize operations for your environment.
Deployment - Virtual Server Agent for Amazon
Deployment Planning for Citrix Xen
Deployment for FusionCompute
Deployment for Microsoft Azure
Deployment Planning for Microsoft Hyper-V
Deployment for Nutanix AHV
Deployment for OpenStack
Deployment for Oracle VM
Deployment Planning for Red Hat Virtualization
Deployment Planning for VMware
Gather Installation Data
Refer to the items in this section to gather the information that you will need during the installation. Record the information before you begin installing the software, so
that you can refer to it during the installation.
You can install the Virtual Server Agent by using either the CommCell Console or the installation package created by the Download Manager. Any item that applies to
only one of these installation methods is noted.
Commvault package to install
Install the Virtual Server package, which is listed under the Virtualization category.
The VSS Provider package is installed as part of the Virtual Server Agent installation. (This package is not required for Citrix Xen.)
If the File System Agent is not installed on the computer, the File System Core and File System packages are automatically installed with the package
you selected. The File System Agent will not consume any license.
To gather the required information for the File System Agent, refer to the Gather Installation Data section in the Preinstallation Checklist for the
Windows File System Agent .
Client computer installations
If the File System Agent, or another package, is already installed on the computer, you are not required to gather all the computer details again. The level of detail
depends on how the package you selected is installed:
For installations using the CommCell Console, the installation program requests only the name of the client computer.
For installations using the installation package, the installation program reads the details from the previous installation.
User Accounts
When configuring a virtualization client, you must provide user credentials as noted in the following list:
For Docker, obtain administrator user credentials for the host where Docker is installed.
For FusionCompute, obtain administrator user credentials for the Virtual Resource Manager (VRM).
For Nutanix AHV, collect credentials for a user that has Prism administrator privileges for the Nutanix cluster.
For OpenStack, collect credentials for a user account with administrative privileges for the keystone node.
For Red Hat Virtualization, collect credentials for a user account with administrative privileges on the RHEV Manager.
Deployment Planning
Before installing the Virtual Server Agent, review deployment options for your virtualization platform to understand how to optimize operations for your environment.
Deployment for Docker
Deployment for FusionCompute
Deployment for Nutanix AHV
Deployment for OpenStack
Deployment Planning for Red Hat Virtualization
Gather Installation Data
Refer to the items in this section to gather the information that you will need during the installation. Record the information before you begin installing the software, so
that you can refer to it during the installation.
You can install the Virtual Server Agent by using either the CommCell Console or the installation package created by the Download Manager. Any item that applies to
only one of these installation methods is noted.
Commvault package to install
For installations using the CommCell Console, install the Virtual Server package, which is listed under the Virtualization category.
For installations using the installation package, install the VirtualServer package.
If the File System Agent is not installed on the computer, the File System Core and File System packages are automatically installed with the package you
selected. The File System Agent will not consume any license.
To gather the required information for the File System Agent, refer to the Gather Installation Data section in the Preinstallation Checklist for the UNIX,
Linux, and Macintosh File System Agent .
Client computer installations
5/6/2017 Commvault Systems Page 170 of 587
If the File System Agent, or another package, is already installed on the computer, you are not required to gather all the computer details again. The level of detail
depends on how the package you selected is installed:
For installations using the CommCell Console, the installation program requests only the name of the client computer.
For installations using the installation package, the installation program reads the details from the previous installation.
What To Do Next
Review the tasks that you must perform after the installation in Postinstallation Tasks for Clients .
Refer to the Getting Started page of each agent that you installed to perform the required agent configurations.
Windows
Configure Cluster Group Clients
If you installed agents in a cluster environment, you must configure a cluster group client, and if applicable, failover settings. For more information, see:
Microsoft Clusters
Non-Microsoft Clusters
Quorum Disk
Scale-Out File Server
HP Scalable NAS/PolyServe Clusters
Add Commvault to the Windows Firewall Exclusion List
If you did not add the Commvault programs and services to the Windows Firewall exclusion list during the installation, you can add them later by using a batch file.
For more information, see Configuring Windows Firewall to Allow CommCell Communication .
Complete Firewall Configurations
If you configured firewall settings during the installation, you must complete additional firewall configurations from the CommCell Console. For more information,
see Firewall: Overview .
Enable Application-Aware Installs
You can configure the Commvault software to automatically detect the installed client applications and then install the corresponding Commvault packages when
you:
Plan to add additional applications after you install the Commvault software
Plan to refresh the hardware
Have managed service provider configuration
For information on how to enable this feature, see Enabling Application-Aware Installations .
Procedure
1. At the command prompt, go to the /usr/bin directory and run the following command:
cvpkgchg
2. Select the type of operation that you want to perform and follow the prompts.
To change the UNIX group that you assigned for Commvault files, type 1 and press Enter.
To change access permissions, type 2 and press Enter.
Note: If snapshots are mounted within the Commvault installation directory, you might receive the following error:
You can ignore the error and continue running the script.
If you installed additional agents, and you want the new installation files to have the same access permissions as the existing Commvault files, type 3 to fix the
permissions and press Enter.
3. To apply your changes, restart the Commvault services.
Informix Agent
Platforms Folders Created Files Created Other Changes
Solaris None Create file under $INFORMIXDR/GalaxyRelinkInfo Create a link to ibsad001_64.so under
/usr/lib/sparcv9
MediaAgent
Platforms Folders Created Files Created Other Changes
AIX None None Creating and setting up the tape drive device
mappings () in / dev / rmt / [xyz]
Linux None None Creating and setting up the tape drive device
mappings () in / dev / rmt / [xyz]
Solaris None None Creating and setting up the tape drive device
mappings () in / dev / rmt / [xyz]
Sybase Agent
Platforms Folders Created Files Created Other Changes
AIX None None Create a link to libSybGalaxy.so under
$SYBASELIBPATH
HP-UX None None Create a link to libSybGalaxy.so under
$SYBASELIBPATH
Linux None None Create a link to libSybGalaxy.so under
$SYBASELIBPATH
Solaris None None Create a link to libSybGalaxy.so under
$SYBASELIBPATH
Other Agents
Other Agents do not create files/folders outside the software installation directory, such as the following:
Documentum
MySQL
Oracle
PostgreSQL
SAP Oracle
SAP MaxDB
After the command is ran, the main.cmd file is created with the same ownership as that of Commvault processes.
Procedure
1. From the command prompt, go to the /usr/bin directory and run the following command:
cvpkgchg
What to Do Next
Review the postinstallation tasks that you might have to perform to complete the installation:
Add Commvault to the Windows Firewall Exclusion List
If you did not add the Commvault programs and services to the Windows Firewall exclusion list during the installation, you can add them later by using a batch file.
For more information, see Configuring Windows Firewall to Allow CommCell Communication .
Complete Firewall Configurations
If you configured firewall settings during the installation, you must complete additional firewall configurations from the CommCell Console. For more information,
see Firewall: Overview .
Refer to the following sections to get started with the tool that you installed:
CommServe Failover
Configure the CommServe Failover on the production and standby CommServe hosts. For more information, see Building a Standby CommServe Host for Disaster
Recovery .
CommServe SNMP Enabler
Configure the Windows SNMP Service to set up SNMP email alerts. For more information, see Setting Up Alerts and Notifications (SNMP Traps) .
External Data Connector
The EDC tool is for those users that cannot use the EDC Cloud solution. For more information, see the If You Cannot Use the Cloud section in External Data
Connector - Overview .
b. Open the /etc/ssh/sshd_config file and add the following line at the end of the file:
Ciphers 3des-cbc
If you already have other ciphers declared, add 3des-cbc at the end of the list after a comma (,).
c. Run the following command to start SSH:
svcadm enable ssh
If you have a Macintosh computer running Mac OS X v10.11.x, you must also set the cipher as follows:
a. Run the following command to stop SSH:
launchctl stop com.openssh.sshd
b. Open the /etc/ssh/sshd_config file and add the following line at the end of the file:
Ciphers 3des-cbc
If you already have other ciphers declared, add 3des-cbc at the end of the list after a comma (',').
c. Run the following command to start SSH:
launchctl start com.openssh.sshd
For Windows computers, the following ports must be opened temporarily during the remote installation:
Port 135 for DCOM (Distributed Component Object Model).
Port 139 for NetBIOS Session Service (if you are using legacy Windows computers, such as Windows NT or earlier versions).
Port 445 for SMB (Server Message Block) file sharing.
Your Windows Management Instrumentation (WMI) port. For instructions on setting up a fixed port for WMI, see Setting Up a Fixed Port for WMI on the Microsoft
website.
Important: If Windows Firewall is enabled on the computer, the following ports must be open in Windows Firewall:
5/6/2017 Commvault Systems Page 187 of 587
Port 135 for DCOM-In (COM + Network Access).
Port 445 for SMB.
WMI port.
If you choose not to open ports 135, 139, 445, and WMI port on your network, you can set up a remote cache in the network where the client computer
resides.
Important: After you install the software and configure firewall settings on the client, the only port that should remain open is the firewall tunnel port
(8403 by default).
Procedure
1. Open the CommCell Console.
For instructions, see Opening the CommCell Console .
2. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Install Software.
The Install Wizard opens.
3. Follow the instructions in the installation wizard.
Notes:
If you are installing on a clustered environment, install the software on all the physical nodes of the cluster.
If you need guidance on installing the software on computers that are part of a directory service, see Selecting Computers from a Directory Service .
If you need guidance on configuring firewall settings, see Firewall Configuration During Installation .
4. On the Summary page, choose whether to save the installation as a script:
To run the installation job, click Finish.
Based on your selections, the job runs immediately, or the job is scheduled to run at the time you configured.
When the installation job starts, you can track the progress of the job from the Job Controller window (CommCell Console ribbon > Home tab > Job
Controller).
If the installation job goes beyond two hours, the job will stop running. To increase the timeout duration, see Configuring the Timeout Interval for
Installations Using the CommCell Console .
What to Do Next?
1. Review the tasks that you must perform after the installation:
For the server packages that you installed, go to Other Server Packages , select the package, and on the installation procedure, see the What to Do Next section.
For MediaAgents, see Postinstallation Tasks for the MediaAgent .
For agents, see Postinstallation Tasks for Clients , and then refer to the Getting Started page of each agent that you installed to perform the required agent
configurations.
For tools, see the What to Do Next section in Installing Commvault Tools .
2. Optional: if you are a user with administrative rights in the CommCell environment, you can generate a report that summarizes all the installation jobs that ran in the
CommCell Console.
a. From the CommCell Console ribbon, click the Reports tab and then click Summary.
b. In the Report Selection dialog box, on the General tab, click Administrative Jobs > Install/Upgrade/Remove/Repair Software, and then click Run.
For more information on the report, see Administrative Job Summary Report .
Procedure
1. Log on to the computer where you saved the script.
2. At the command line, go to the Installation_Directory_Path/Base directory and run the following command to log on to the CommServe database:
qlogin -cs commserve_host_name -u user_name
Procedure
Choose whether you want to install the software on all the computers of a directory service, or on selected computers.
On Selected Computers
1. On the Select how to discover the computers for installing the software page, click Manually select computers and then click Next.
2. On the Enter the host names of the computers page, based on the operating system you selected, click Import From Active Directory (Windows) or Import from
Directory Service (UNIX).
The Enter Active Directory Server Information dialog box (Windows) or Service Enter Directory Service Server Information dialog box (UNIX) is displayed.
3. In the directory service dialog box, complete the following steps:
a. From the Select Directory Service list, select the type of directory service (for example, Windows Active Directory).
b. Based on the type of directory service, specify the required directory details, such as the domain name and user credentials. For guidance on the information
that you must provide, see Add Active Directory Server .
c. Click OK.
4. On the Discovered Computers dialog box, select the computers where you want to install the software and click Add.
The computers you selected are displayed on the Enter the host names of the computers page.
5. If you need to add computers from a different directory service, click Import From Active Directory (Windows) or Import from Directory Service (UNIX), and repeat
step 3 and 4. Otherwise, click Next to continue.
6. On the Enter Account Information page, specify the administrative user credentials to access the computers you selected, and click Next.
7. Continue to follow the instructions in the installation wizard.
On All Computers
1. On the Select how to discover the computers for installing the software page, click Automatically discover computers and then click Next.
2. Based on the operating system you selected, on the Active Directory Server Configuration page (Windows) or Directory Service Server Configuration page (UNIX),
click Add.
3. In the Add Active Directory Server dialog box, complete the following steps:
a. From the Select Directory Service list, select the type of directory service (for example, Windows Active Directory).
b. Based on the type of directory service, specify the required directory details, such as the domain name and user credentials. For guidance on the information
that you must provide, see Add Active Directory Server .
c. Click OK.
4. If you need to add computers from a different directory service, click Add and repeat step 3. Otherwise, click Next to continue.
5. On the Enter Account Information page, the Reuse Active Directory credentials check box is automatically selected.
If you do not want to reuse the Active Directory credentials, or if you have computers in Open LDAP, clear the check box and specify the administrative user
credentials to access the computers.
6. Continue to follow the instructions in the installation wizard.
Related Topics
Installing Commvault Remotely Using the CommCell Console
Procedure
Use the following steps to enable installations from the CommCell Console (remote installations) for computers in a PowerBroker environment.
Step 1: Verify permissions for the PowerBroker profile.
The PowerBroker profile must have the following permissions:
Permission to run any command from the following locations:
/tmp directory
Commvault installation directory
Permission to execute the following command:
chmod a+x /tmp/cvpkgseed
Procedure
1. From the CommCell Browser, right-click the CommServe node and then click Properties.
2. In the CommCell Properties dialog box, on the Additional Settings tab, click Add.
3. In the Add Additional Settings on Windows Client dialog box, complete the following steps:
a. In the Name box, type nPushInstallTimeoutInMin.
The Category and Type details are automatically populated.
b. In the Value box, type the time out interval in minutes.
c. Click OK.
4. Click OK to close the CommCell Properties dialog box.
Related Topics
Installing Commvault Remotely Using the CommCell Console
Procedure
Add the additional setting on the client as shown in the following table.
For instructions on how to add additional settings from the CommCell Console, see Add or Modify an Additional Setting .
Property Value
Name nEnableAutoDetectApp
Category iDataAgent
Type Integer
Value 1 - to have the software automatically check for applications that have been installed.
2 - to have the software automatically check for applications that have been installed and then install the Commvault software packages
for each application. For example, if the Commvault software detects the Oracle application, the workflow installs the Oracle Agent on
the client.
Result
If you set the additional setting to 1, the CommCell Console displays the third-party applications that are installed on the clients and client group members with a Product
Status as uninstalled, because the Commvault software packages for the applications are not installed on the client and client group members.
If you set the additional setting to 2, the software:
Installs the Commvault package for the third-party application if it does not exist on the client.
Configures the client on the CommServe computer.
Registers the client with the CommServe computer with the Product Status as 'Auto Detect'.
The following table shows the packages that the workflow installs:
Application Commvault package
Active Directory Active Directory
DB2 DB2
Microsoft Exchange Database Exchange Database
Microsoft SQL Server SQL Server
MySQL MySQL
Oracle Oracle
PostgreSQL PostgreSQL
Sybase Sybase
What to Do Next
1. If you set the additional setting to 1, after the Commvault software detects the third-party applications, schedule a predefined workflow that installs the Commvault
software packages for each third-party application. For more information, see Running the Installing Automatically Discovered Applications Workflow .
2. You can configure cluster Data Agents, for example, Oracle RAC or Exchange DAG by creating pseudo-clients.
Procedure
1. From the CommCell Browser, go to Workflows.
2. Right-click InstallAutoDiscoveredApps and then click All Tasks > Execute.
The InstallAutoDiscoveredApps dialog box appears.
3. Decide which clients to install the software on:
To install the detected software on all clients in a client group, from the ClientGroup list, select the client group.
To install the detected software on a specific client, from the ClientGroup list, select the client.
4. On the Job Initiation tab, specify whether to run the workflow now or if it will be scheduled.
Best Practice: Select Schedule.
For information on configuring a workflow backup schedule, see Schedule Workflows .
5. Click OK.
You can track the progress of the workflow job from the Job Controller. For instructions on using the Job Controller, see Getting Started with the Job Controller .
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
In a cluster environment, log on to the physical node of the cluster as an Administrator or as a member of the Administrator group on that computer.
2. Run Setup.exe from the installation package.
The installation wizard opens.
3. On the welcome page, select the I Agree check box and proceed to the next page.
4. On the Choose the Installation Type page, click Install packages on this computer and proceed to the next page.
If the Install Option page is displayed, an agent or another Commvault software is already installed on the computer. To install additional software, click Add Packages.
5. On the Select Packages page, select the appropriate category (on the left side) and the package name (on the right side), and then proceed to the next page.
6. Follow the instructions in the installation wizard.
Notes:
If you are installing the software in a cluster environment, repeat the installation procedure for each physical node on the cluster.
To help you troubleshoot errors that occur before the installation summary page, check the %allusersprofile%\Commvault Systems\Galaxy\LogFiles\Install.log. If the error occurs
after the summary page, check the installation logs in the Software_Installation_Directory\Log Files directory.
What to Do Next
Review the tasks that you must perform after the installation:
For MediaAgents, see Postinstallation Tasks for the MediaAgent .
For agents, see Postinstallation Tasks for Clients , and then refer to the Getting Started page of each agent that you installed to perform the required agent
configurations.
For tools, see the What to Do Next section in Installing Commvault Tools .
Procedure
1. Log on to the computer as root.
In a cluster environment, log on to a physical node of the cluster as root.
Note: If the computer does not have a root user defined, you can install some UNIX agents by using a non-root user. However, only a few agents are supported. For
more information, see Installation of UNIX Agents by a Non-Root User .
2. Run the following command from the installation package or mount point:
./cvpkgadd
To run the installation as a SUDO user with root privileges, use the following command:
sudo ./cvpkgadd
What to Do Next
Review the tasks that you must perform after the installation:
For CommCell Console installations, see the What to Do Next section in Installing the CommCell Console .
For MediaAgents, see Postinstallation Tasks for the MediaAgent .
For agents, see Postinstallation Tasks for Clients , and then refer to the Getting Started page of each agent that you installed to perform the required agent
configurations.
For tools, see the What to Do Next section in Installing Commvault Tools .
Procedure
1. Create the base package.
The base package contains the File System Agent, which establishes connections between the client computer and the CommServe database.
To create the package for Windows and Macintosh computers, see Creating a Base Package Using the Cloud Services Website .
To create the package for UNIX computers, you can use the steps for Creating a Laptop Backup Installation Package for UNIX . During the package creation, when
you reach the On the Laptop & Desktop Backup dialog, make sure to select No.
2. Install the base package on all computers.
Use one of the following methods to install the base package:
Method 1: Configure a third-party software to install the package silently on all computers.
For installations on Windows computers, configure the third-party software to run the following command:
PackageName.exe /s /install /silent
For installations on UNIX computers, configure the third-party software to locate the package and then run the following command:
./silent_install -p default
For installations on Macintosh computers, configure the third-party software to run the following command:
sudo installer -pkg package_location -target /
Method 2: Distribute the package to your end-users in one of the following ways:
Copy the package to a network share.
Upload the package to the Download Center. For instructions, see Adding a Package to Download Center .
End-users can start the installation by double-clicking the executable file (.exe or .dmg). For UNIX computers, use the installation command provided in Method 1.
3. Add roles to your clients.
Roles are the Commvault agents that you want to install and the configurations that you want to apply to your clients.
After the base package is installed, install the required agents from the CommCell Console. For instructions, see Installing Commvault Remotely Using the CommCell
Console .
Process Flow
The custom package deployment involves the following tasks:
1. Create a custom package.
Use the following table to decide the type of custom package that you want to create:
Package Task
Custom package for laptop computers (Laptop Package) Creating a Laptop Backup Installation Package for Windows or Macintosh
Creating a Laptop Backup Installation Package for UNIX
General custom package Preferred Method:
Creating a Custom Package Using the Cloud Services Website (Windows and Macintosh only)
Alternative Method:
Creating a Custom Package for Windows Computers
Creating a Custom Package for UNIX, Linux, and Macintosh Computers *
UNIX native package Creating a Custom Package for UNIX, Linux, and Macintosh Computers *
Custom package for Active Directory Group Policy Setting Up Packages for Active Directory GPO Installations
Objects (GPO)
*Includes the steps for general and native packages.
2. Install the custom package.
Use the following table to select the appropriate installation task based on the custom package that you created:
Package Task
Custom package for laptop computers (Laptop Package) Installing the Laptop Package for Windows
Installing the Laptop Package for UNIX
Installing the Laptop Package for Macintosh
General custom package Interactive installations:
Installing the Custom Package on Windows Computers
Installing the Custom Package on UNIX, Linux, and Macintosh Computers
Unattended (silent) installations:
Installing the Custom Package on Windows Computers Using the Answer File
Installing the Custom Package on UNIX, Linux, and Macintosh Computers Using the Answer File
Installing the Custom Package Using a Third-Party Software
Windows self-extracting executable Installing a Windows Custom Package Configured as a Self-Extracting Executable File
UNIX native package Installing UNIX Native Packages
Procedure
1. Log on to the Cloud Services website and open the Custom Install Package Creation form on the Forms page.
For instructions on obtaining a user account for the Cloud Services site, see Getting Access to the Cloud Services Website .
2. On the CS Information page, do either of the following:
In the Select a previously used CS Client Name box, select the name of the CommServe computer that you used earlier from the list to create the base package.
In the Or enter a new CS Client Name box, enter the name of the CommServe computer. The name that you enter is case-sensitive and must match the
CommServe name in the CommCell Console.
3. Click Next.
4. On the form, fill in the following information:
In the CS Client Name (case sensitive) box, verify that you have the same name that you entered in the Or enter a new CS Client Name box.
In the CS Hostname box, enter the host name of the CommServe. You can also use an IP address instead of the host name.
Optional: The proxy computer communicates with laptops that are outside the network. If you are using a proxy, select the Use Proxy check box to create a proxy
package.
In the Service Pack box, select the service pack version that you will use to create the package.
Choose one of the following options:
Do not require any end user interaction: Select this option if you want the end-users to install the package directly without the necessity of selecting more
options. You can also select this option if you want to install the package using a third-party software.
Require end users to enter their credentials during installation: Select this option if you want to display the user authentication prompt during the package
installation. If you plan to configure clients to register with the CommServe computer automatically, do not select this check box because you will need to
specify the user authentication credentials later in the package creation.
Do not require any end user interaction and follow multiple CommCell routing rules: Select this option if you have more than one CommServe computer
running in your CommCell environment and you want to configure clients to register with their respective CommServe computer automatically without the
necessity of selecting more options.
5. Click Next.
6. Optional: If you selected the Use Proxy check box, fill in the following information:
In the Proxy Client Name (case sensitive) box, enter the name of the proxy computer. The name that you enter must match with the name of the proxy computer
in the CommServe.
In the Proxy Hostname box, enter the host name of the proxy computer. You can also use an IP address instead of the host name.
In the Port Number box, enter the port number. This port will be used for incoming connections to the proxy computer, when a firewall is configured.
In the HTTP Proxy Hostname (if required) box, enter the host name of the HTTP proxy server.
In the HTTP Proxy Port box, type the port to be used by the HTTP proxy server. By default, the port is 443.
7. Optional: If you selected the Do not require any end user interaction check box, fill in the following information:
In the Username box, enter the user name that the end-user must provide during the silent installation of the package.
In the Password box, enter the password that the end-user must provide during the silent installation of the package.
Note: Skip this step if user authentication is not enabled on the CommServe computer for installing agents. For more information, see Enabling User Authentication for
Installing Agents on the CommCell .
8. On the summary page, click Edit Advanced Options, and then click OK.
9. On the Advanced Options page, fill in the following information:
a. In the Client Group box, enter the name of the client group under which the client must be added.
b. In the Windows Subclient Policy box, you can use the default or assign a new subclient policy.
c. In the Mac Subclient Policy box, you can use the default or assign a new subclient policy.
d. Optional: Select the Allow users to enter an install directory check box, so that the end-users can create an install directory except for the silent installs. This
option is applicable only for Windows laptops.
e. Make sure that you do not select the Do not create laptop shortcuts or apps check box.
f. Optional: To install the Commvault VPN Access software on a Windows x64 client, select the Include VPN Client check box. The software enables the client to use
the Commvault firewall framework to establish a VPN tunnel.
g. Clear the Configure Laptop Client check box, and then click Next.
h. Click OK on the summary screen after verifying the information.
Click OK to create the packages.
10. Verify the confirmation email.
You will receive an email confirming the package creation request. Subsequently, you will receive another email with links to the following downloadable packages:
32 bit proxy (if the Use Proxy option was selected)
64 bit proxy (if the Use Proxy option was selected)
32 bit Windows
64 bit Windows
macOS Dmg
macOS Pkg
Notes:
The proxy package consists of the File System Core package which can be installed interactively. However, you cannot perform a silent install of the proxy
5/6/2017 Commvault Systems Page 203 of 587
package.
You can perform a silent install of the macOS Pkg package. However, the macOS Dmg package supports only interactive installations. If your Macintosh laptop
uses a proxy computer, then the proxy package is Windows-based.
11. Using the link provided, download the packages.
What to Do Next
Install the base package on computers that you want to protect. For more information, see Installing Commvault on All Computers Across Your Organization.
Procedure
1. Log on to a Windows computer as an Administrator or as a member of the Administrator group on that computer.
2. Run Setup.exe from the installation package.
The installation wizard opens.
3. On the welcome page, select the I Agree check box and proceed to the next page.
4. On the Choose the Installation Type page, click Create a custom package to install on a different computer and proceed to the next page.
5. On the Select Windows Processor Type page, select the type of Windows processor that your computers support, and then proceed to the next page.
6. On the Custom Package Install Type page, select one of the following options and proceed to the next page:
Option Description
New Installations Use this option in the following scenarios:
You plan to install the Commvault software on new clients.
You plan to perform a hardware refresh.
The Download Manager downloads all the required installation files and service pack updates. For Commvault packages that
need the SQL Server software, the Download Manager will retrieve Microsoft SQL Server 2014 Standard.
Upgrades Use this option if you plan to upgrade clients from previous Commvault versions. For example, upgrades from Version 10 to
Version 11.
For Commvault packages that use the SQL Server software, the Download Manager will retrieve Microsoft SQL Server 2012
Enterprise. This SQL version is needed to upgrade clients that have SQL Server 2008 Enterprise (or earlier versions).
Service Pack Installations Use this option if you plan to install service pack updates or additional agents on an existing client.
Note: If you plan to install Commvault packages that need the Microsoft SQL Server (such as the CommServe), select New
Installations.
7. Follow the instructions in the installation wizard.
If you need information on which custom package option to select, see Decide which custom package options to set .
Remember: If you decide to save your selections during the package creation, consider the following guidelines:
If Commvault is not installed on your computer, the Base Client software is installed to establish communications with the CommServe computer. You must provide
the CommServe host name as well as your computer details.
If you want to create an interactive custom package, configure the package to display the necessary options to the user, and record the option names so that you
can notify users to better prepare them for the installation.
What to Do Next?
Distribute the custom package by using one of the following methods:
Copy the package to a network share that is accessible by users
Upload the package to the Download Center
For instructions, see Adding a Package to Download Center .
Procedure
1. Log on to a UNIX computer as root.
Note: If the computer does not have a root user defined, you can create a custom package by using a non-root user. However, only a few agents are supported. For
more information, see Installation of UNIX Agents by a Non-Root User .
2. Run the following command from the installation package or mount point:
./cvpkgadd
To run the installation as a SUDO user with root privileges, use the following command:
sudo ./cvpkgadd
What to Do Next?
1. Distribute the custom package using one of the following methods:
Copy the package to a network share that is accessible by users
Upload the package to the Download Center
For instructions, see Adding a Package to Download Center .
2. Notify users the type of package that you created (for example, general and RPM packages).
RPM package AIX PPC Make sure to select all the necessary agents that you need during the RPM
Linux x86, x64, PPC64, and s390 package creation. Installing additional agents on existing clients is not
supported.
The RPM Package Manager and the RPM Build Package must be installed on
the computer. Run the following command to verify that the RPM Build
Package is installed:
rpm -qa | grep -i rpm
If you plan to create the package on a Linux computer that is configured to
resolve library symbols (a configuration called prelinking), you must run the
following command to disable prelinking:
/usr/sbin/prelink ?av ?mR
If you want to create the package as a non-root user, the administrator must
grant you permissions to access the native package directory (/opt) during the
package creation. To grant permissions, the administrator must run the
following commands:
User setfacl ?m u::non_root_user_name:rwx /opt
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
2. Go to the location where you stored the custom package, and then find and double-click the Setup.exe file.
For example, suppose you have a Windows x64 computer and the name of the package is CustomPackageName. The Setup.exe file is under the
CustomPackageName\CustomPackageName_WinX64 folder.
3. Follow the instructions in the installation wizard.
Note: If the custom package was configured to install the software in decoupled mode, you do not have to provide the CommServe computer details during the
installation. In a decoupled installation, the client does not establish connections with the CommServe computer. At the end of the installation, you will receive a
message indicating that the installation is not complete until you register the client with the CommServe.
Postinstallation Tasks
If the client was not registered during the installation, use the RegisterMe tab in the Process Manager application to register the client. For instructions, see Registering the
Client Using the Process Manager .
If the RegisterMe tab is unavailable, the CommServe name was not defined during the custom package creation. In such a case, you can register the client by using the
CommCell Console or through the command-line interface. If you do not have access to the console, a user with administrative rights in the CommCell must perform the
registration for you.
Registering the Client Using the CommCell Console
Registering the Client Using the Command Line
Related Topics
Installing the Custom Package on Windows Computers Using the Answer File
Procedure
1. Log on to the computer as root.
Note: If the computer does not have a root user defined, you can install some UNIX agents by using a non-root user. However, only a few agents are supported. For
more information, see Installation of UNIX Agents by a Non-Root User .
2. Go to the location where you stored the custom package.
Suppose the custom package is located in the /opt/UnixCustomPackage directory. The package files are located in the /opt/UnixCustomPackage/pkg subdirectory.
If the package is in a .tar file (for example, /opt/UnixCustomPackage/tar), extract the contents using the "GNU" TAR utility.
3. To install the package, run the following command:
./cvpkgadd
Note: If the custom package was configured to install the software in decoupled mode, you do not have to provide the CommServe computer details during the
installation. In a decoupled installation, the client does not establish connections with the CommServe computer. At the end of the installation, you will receive a
message indicating that the installation is not complete until you register the client with the CommServe.
Postinstallation Tasks
If the client was not registered during the installation, use one of the following methods to register the client:
Registering the Client Using the CommCell Console
If you do not have access to the console, a user with administrative rights in the CommCell must perform the registration for you.
Registering the Client Using the Command Line
Registering the Client Using the Process Manager (only for Macintosh computers)
Related Topics
Installing the Custom Package on UNIX, Linux, and Macintosh Computers Using the Answer File
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
2. At the command line, go to the location where you stored the custom package and find the Setup.exe file.
If the package consists of only the answer file, find the Setup.exe file from a separate installation package.
3. To install the package in silent mode, run the following command:
start /wait Setup.exe /silent /play install.xml
Note: If the answer file is in a different location, update the command by replacing install.xml with the path to your answer file.
You can monitor the installation from the install.log file in the %allusersprofile%\Commvault Systems\Galaxy\LogFiles folder.
Postinstallation Tasks
Register the client by using the RegisterMe tab in the Process Manager application. For instructions, see Registering the Client Using the Process Manager .
If the RegisterMe tab is unavailable, the CommServe name was not defined during the custom package creation. In such a case, you can register the client by using the
CommCell Console or through the command-line interface. If you do not have access to the console, a user with administrative rights in the CommCell must perform the
registration for you.
Registering the Client Using the CommCell Console
Registering the Client Using the Command Line
Related Topics
Installing the Custom Package Using a Third-Party Software
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
2. At the command line, go to the location where you stored the custom package and find the pkg subdirectory.
3. To install the package in silent mode, run the following command:
./silent_install -p default
If the answer file is in a different location, update the command by replacing default with the path to your .xml file.
During the installation, messages related to the installation progress are displayed on the command-line interface.
Postinstallation Tasks
Register the client using one of the following methods:
Registering the Client Using the CommCell Console
If you do not have access to the console, a user with administrative rights in the CommCell must perform the registration for you.
Registering the Client Using the Command Line
Registering the Client Using the Process Manager (only for Macintosh computers)
Related Topics
Installing the Custom Package Using a Third-Party Software
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
2. Go to the location where you stored the custom package.
The custom package is an executable file. For example, CustomPackageName.exe.
3. Use one of the following installation methods:
To install the package interactively, double-click the executable file to start the installation.
To install the package silently, run the following command:
CustomPackageName.exe /s /install /silent
Tip: If the package fails to extract the software and displays an error stating that the program "could not read the source SFX", move the package to the root of C: drive
and retry the installation. The software extraction could fail if the package was in a directory that had non-English characters.
Postinstallation Tasks
If the client was not registered during the installation, use the RegisterMe tab in the Process Manager application to register the client. For instructions, see Registering the
Client Using the Process Manager .
If the RegisterMe tab is unavailable, the CommServe name was not defined during the custom package creation. In such a case, you can register the client by using the
CommCell Console or through the command-line interface. If you do not have access to the console, a user with administrative rights in the CommCell must perform the
registration for you.
Registering the Client Using the CommCell Console
Registering the Client Using the Command Line
Procedure
1. Specify the installation command in the third-party software.
For Windows custom packages:
If the package is a self-extracting executable file, configure the third-party software to run the file.
If the package is a folder that includes the answer file, configure the third-party software to run the installation command described in Installing the Custom
Package on Windows Computers Using the Answer File .
For UNIX custom packages, configure the third-party software to run the installation command described in Installing the Custom Package on UNIX, Linux, and
Macintosh Computers Using the Answer File .
2. If the package was configured to install the software in decoupled mode, you must register the clients. Choose one of the following approaches:
If you want the third-party software to perform the registration, specify the SIMCallWrapper command as a post-installation command. The SIMCallWrapper command
is described in Registering the Client Using the Command Line .
The command must be run the from the Software_Installation_Directory\Base directory. Software_Installation_Directory is the directory where the Commvault software will
be installed.
If you want users to register their clients, ask them to use one of the following methods:
Registering the Client Using the CommCell Console
Registering the Client Using the Command Line
Registering the Client Using the Process Manager
Related Topics
Setting Up Packages for Active Directory GPO Installations (Windows only)
Procedure
1. Log on to the computer as root.
2. Go to the location where you stored the custom package.
3. To install the native package, you must access the appropriate subdirectory. Each type of native package has its own subdirectory.
Suppose the custom package is located in the /opt/UnixCustomPackage directory. Use the following list to locate the appropriate subdirectory and to run the installation
command:
For the APT package, go to /opt/UnixCustomPackage/apt and run the .deb file. For example:
dpkg -i custom-linux-4811_11.0.0-BUILD52_all.deb
For the HP-UX package, go to the root directory and run the following command:
swinstall -s /opt/UnixCustomPackage/sd-ux ?x mount_all_filesystems=false \*
For the RPM package (for AIX or Linux computers), go to /opt/UnixCustomPackage/rpm and run the .rpm file. For example:
rpm -i custom-Linux.Instance001.CVGxBase_CVGxBase0-11.0.0-80.70.0.538250.70.501574.el6.centos.x86_64.rpm
For the Solaris package, go to /opt/UnixCustomPackage/sol and run the .pkg file. For example:
pkgadd -i custom-solaris-10042.pkg
Note: If you receive a message that the installation is not complete until you register the client with the CommServe, the custom package was configured to install the
software in decoupled mode. In a decoupled installation, the client does not establish connections with the CommServe computer. Therefore, you must register the
client to complete the installation.
Postinstallation Tasks
If the client was not registered during the installation, use one of the following methods to register the client:
Registering the Client Using the CommCell Console
If you do not have access to the console, a user with administrative rights in the CommCell must perform the registration for you.
Registering the Client Using the Command Line
Related Topics
If you plan to update clients where you installed the RPM package, you need to recreate the package using the latest installation media. For more information, see Installing
the Service Pack on RPM Package Clients .
Procedure
1. Create a custom package with the agents that you need and configure the package as a self-extracting executable.
For instructions, see Creating a Custom Package for Windows Computers .
During the package creation, on the Custom Package Options page, make sure to select the following options:
Create self-extracting executable
Save user answers in the custom package
Create a de-coupled installation package
2. Copy the self-extracting executable file to a network share folder that is accessible by the Active Directory computer as well as all the computers in the domain.
3. Log on to the Active Directory computer as the domain administrator.
4. Verify that you can access the network share folder where you saved the self-extracting executable file.
If you cannot access the folder, check the share permissions.
5. Configure a Group Policy Object to remotely install the custom package on the clients in the domain.
a. Open the Group Policy Management administrative tool. If the tool is not installed, you can install it by using the Windows Server Manager.
b. Create a GPO. For instructions, go to the Microsoft TechNet Web site.
c. Link the GPO that you created to your domain.
From the Group Policy Management console tree, right-click the domain, click Link an Existing GPO and select the GPO.
d. Configure the GPO to use the self-extracting executable file. Switch the GPO into edit mode (as described in the Microsoft TechNet Web site) and perform the
following steps:
i. From the tree in the Group Policy Object Editor window, expand the Computer Configuration > Windows Settings node and then click Scripts
(Startup/Shutdown).
The right pane of the window displays the startup and shutdown scripts.
ii. Right-click the Startup script and then click Properties.
iii. In the Startup Properties dialog box, click Add.
The Add a Script window appears.
iv. In the Script Name box, specify the path to the self-extracting executable file, and on the Script Parameters box, type /s /install /silent, and then click OK.
v. Click OK to close the Startup Properties dialog box.
vi. Expand the Administrative Templates > System node (under Computer Configuration), and click Scripts.
The right pane of the window displays system settings.
vii. Right-click the Run startup scripts asynchronously setting and then click Properties.
viii. In the Run startup scripts asynchronously Properties dialog box, select Enabled and click OK.
Results
After you configure the Active Directory GPO, the custom package is automatically installed when the client computer is restarted.
Supported Agents
The package created from the Solaris IPS Packager includes the following UNIX agents:
File System
Oracle
Sybase
Procedure
Use the following steps to create an publish an IPS package:
Step 1: Packaging the Software
1. Log on as root to the client computer acting as the image source.
2. If the installation package that was created using the Download Manager was copied to a DVD, use the following command to mount the DVD:
Run the following command from the installation package or mount point:
./cvpkgmake
where:
PathToRepository is the path to the repository where the IPS package resides.
PublisherName is the publisher's name for the package (for example, Commvault).
where PackageName is the name of the IPS package. Rectify any error that you find in the command output.
2. Navigate to the File System or HTTP repository that you selected during the IPS package creation to verify that the package is available.
The following figure is an example of a package in an HTTP repository.
Procedure
Run the following command to install the package:
pkg install -g <PathToPackage> <PackageName>
where:
PathToPackage is the path to the repository where the package resides. If the repository is HTTP based, the path is the web address of the repository.
PackageName is the name of the IPS package.
Note: If the package is in an HTTP repository, you can also install the package from the repository Web page. Access the repository and then click the Install link next to the
IPS package to start the installation using the Package Manager.
What to Do Next
Refer to the Getting Started page of each agent that you installed to perform the required agent configurations.
Process Flow
Unattended installations involve the following tasks:
1. Create a custom package.
During the package creation, you must save (record) your selections to generate the answer file.
Creating a Custom Package for Windows Computers
Creating a Custom Package for UNIX, Linux, and Macintosh Computers
2. Run unattended installations by using the answer file.
Installing the Custom Package on Windows Computers Using the Answer File
Installing the Custom Package on UNIX, Linux, and Macintosh Computers Using the Answer File
If you want to configure a third-party software to install the custom package across multiple computers, see Installing the Custom Package Using a Third-Party Software
.
Process Flow
1. Set Up Computers at the Factory
The administrator, or a designated user, must preinstall the software on the computers, and then distribute the computers.
2. Register the Clients
Upon receipt, the user can perform the registration with the CommServe computer.
Procedure
Follow the steps that correspond to the operating system of the computers where you want to preinstall the software.
On Windows
1. Create the custom package by using the installation package that was downloaded from the Download Manager. For instructions, see Creating a Custom Package for
Windows Computers .
During the custom package creation, consider the following requirements:
To configure the package for decoupled installations, you must select the Create a de-coupled installation package check box on the Custom Package Options
page. Make sure to clear the Launch RegisterMe at the end of install check box.
For the custom package to install the software with minimal user interaction, you must provide all the necessary information during the package creation.
2. Copy the custom package to a network share that is accessible by all the Windows computers where you want to preinstall the software.
3. Install the custom package silently on each computer by running the installation command specified in Installing the Custom Package on Windows Computers Using the
Answer File .
Tip: You can configure a script or a third-party application to run the installation command on all the necessary computers.
On UNIX
1. Create the custom package by using the installation package that was downloaded from the Download Manager. For instructions, see Creating a Custom Package for
UNIX, Linux, and Macintosh Computers .
During the custom package creation, consider the following requirements:
To configure the package for decoupled installations, you must record your selections and leave the CommServe information prompts blank.
For the custom package to install the software with minimal user interaction, you must provide all the necessary information during the package creation.
2. Copy the custom package to a network share that is accessible by all the UNIX computers where you want to preinstall the software.
3. Install the custom package silently on each computer by running the installation command specified in Installing the Custom Package on UNIX, Linux, and Macintosh
Computers Using the Answer File .
Tip: You can configure a script or a third-party application to run the installation command on all the necessary computers.
What to Do Next
Distribute the computers to the respective users.
Procedure
Choose one of the following methods to register each of the computers that you received.
Method 1: Register Using the CommCell Console
1. From the CommCell Console ribbon, on the Tools tab, click New Client. Under the File System section, and based on the computer's operating system, click Windows
or UNIX and Linux.
The New Windows Client (or New UNIX Client) dialog box is displayed.
2. On the Configure Client page, perform the following steps:
a. In the Host Name box, enter the fully qualified domain of the computer.
b. Select the Fetch the configuration information from the client that is already installed in decoupled mode check box.
By default, the Connect to a client and get its configuration option is selected
c. In the CVD port on client box, enter the CVD port that was provided during the installation. If the port was not requested during the installation, then it uses the
default port number (8400).
d. Click Next.
3. On the Optional Data page, if you want to display the client with a different name in the CommCell Browser, select the Overrides the Client name check box, and in
the Client Name box, enter a new name for the client. Click Next to continue.
4. On the Summary page, review the information you provided, and then click Finish.
When the registration process finishes, the client is listed under the Client Computers node of the CommCell Browser.
Notes:
InstanceNNN is the format of the instance number. If no other Commvault instance is installed on the computer, specify Instance001.
XML_file_location is the directory path where you want to save the output of the SIMCallWrapper command. For example, on Windows, C:\temp\output.xml, and on UNIX,
/temp/output.xml.
If user authentication for installing agents is enabled on the CommCell environment, you must add the -user and -password parameters to specify your user
credentials.
When the registration process finishes, the client is listed under the Client Computers node of the CommCell Browser.
Procedure
1. Start the Download Manager application, select where to extract the installation files, and then click Extract.
The installation wizard opens.
2. On the welcome page, select the I Agree check box and proceed to the next page.
3. On the Choose the Installation Type page, click Install packages on this computer and proceed to the next page.
If the Install Option page is displayed, an agent or another Commvault software is already installed on the computer. To install additional software, click Add Packages.
4. On the Select Packages page, select the appropriate category (on the left side) and the package name (on the right side), and then proceed to the next page.
5. Follow the instructions in the installation wizard.
Notes:
If you are installing the software in a cluster environment, repeat the installation procedure for each physical node on the cluster.
To help you troubleshoot errors that occur before the installation summary page, check the %allusersprofile%\CommVault Systems\Galaxy\LogFiles\Install.log. If the error occurs
after the summary page, check the installation logs in the Software_Installation_Directory\Log Files directory.
Procedure
1. Start the Download Manager application, select where to extract the installation files, and then click Extract.
The installation wizard opens.
2. On the welcome page, select the I Agree check box and proceed to the next page.
3. On the Choose the Installation Type page, click Download packages to install on a different computer and proceed to the next page.
4. On the Select Operating System Type page, select the type of Windows processor that your computers support, and then proceed to the next page.
5. On the Custom Package Install Type page, select one of the following options and proceed to the next page:
Option Description
New Installations Use this option in the following scenarios:
You plan to install the Commvault software on new clients.
You plan to perform a hardware refresh.
The Download Manager downloads all the required installation files and service pack updates. For Commvault packages that
need the SQL Server software, the Download Manager will retrieve Microsoft SQL Server 2014 Standard.
Upgrades Use this option if you plan to upgrade clients from previous Commvault versions. For example, upgrades from Version 10 to
Version 11.
For Commvault packages that use the SQL Server software, the Download Manager will retrieve Microsoft SQL Server 2012
Enterprise. This SQL version is needed to upgrade clients that have SQL Server 2008 Enterprise (or earlier versions).
Service Pack Installations Use this option if you plan to install service pack updates or additional agents on an existing client.
Note: If you plan to install Commvault packages that need the Microsoft SQL Server (such as the CommServe), select New
Installations.
6. On the Select Package Option page, click Select Packages and proceed to the next page.
7. On the Download Location page, specify the directory where you want to create the custom package, and then proceed to the next page.
8. On the Select Packages page, select the Commvault software that you want to include in the custom package, and then proceed to the next page.
9. On the Custom Package Options page, select the options required by your custom package and proceed to the next page.
Remember: If you decide to save your selections during the package creation, consider the following guidelines:
If Commvault is not installed on your computer, the Base Client software is installed to establish communications with the CommServe computer. You must provide
the CommServe host name as well as your computer details.
If you want to create an interactive custom package, configure the package to display the necessary options to the user, and record the option names so that you
can notify users to better prepare them for the installation.
When you proceed to the next page, a status page is displayed showing the current operation and a progress bar.
10. On the Install Status page, click Finish.
What to Do Next
Distribute the custom package by using one of the following methods:
Copy the package to a network share that is accessible by users
Upload the package to the Download Center
For instructions, see Adding a Package to Download Center .
Installation Methods
The following table indicates the Commvault software that you can install with each installation method:
Method Supported Commvault Software
Installations Using the CommCell You can install most Commvault packages, except for the following packages:
Console CommServe
(Remote Installations) 1-Touch Server
CommServe SNMP Enabler
Metrics Reporting Server
Web Server
Workflow Engine
Note: ContinousDataReplicator installations are not supported on SuSE 10.x.
Installations Using the Installation Local Installations
Package All Commvault packages are supported.
Custom Package
All Commvault packages are supported.
Unattended Installations
All Commvault packages are supported, except for the CommServe.
Installations Using the Download You can only install Windows-based Commvault packages or create custom packages for Windows computers.
Manager
Installation Configurations
The following table indicates the Commvault software that is supported for the following installation configurations:
Configuration Supported Commvault Software Considerations
Installing agents in restore-only mode Supported by most agents, except for the following packages: IBM Notes Database and IBM Notes Document
(Restore-only agents) Active Directory can be installed as restore-only agents only on
ContinuousDataReplicator Windows computers.
Documentum
Macintosh and OES
Sybase
Installing Commvault in decoupled mode Supported by most Commvault packages, except for the following Oracle supports decoupled installations only on
packages: UNIX computers.
Active Directory
ContinuousDataReplicator
Macintosh and OES
SAP Hana
SharePoint Server Agent
There are other configurations that you can perform during the installation. To review their support information, see:
32-Bit Installation Support on 64-bit Windows Computers
Multi-Instance Support
CAUTION: If you delete the client icon after uninstalling all the agents, the backed up data is irretrievably lost.
Important Considerations
If the CommServe is upgraded after you uninstalled agents from your client, you must use the same Commvault version as the CommServe to reinstall the agents.
If you deconfigured an agent or a client, but you did not uninstall the software, you can reconfigure the agent or client. For more information, see Reconfiguring
Components .
If the client did not communicate with the CommServe computer during the uninstallation, you must deconfigure the client from the CommCell Console before you can
reinstall the software. For more information, see Releasing a License (Deconfiguration).
When you upgrade the CommServe software, any deconfigured client from up to two prior versions is automatically upgraded with the CommServe. Therefore, if you
want to reinstall agents on deconfigured clients, you must use the same Commvault version as the CommServe.
During the reinstallation of an agent, the schedules that were disabled when the agent was uninstalled are enabled. However, if a change (such as an upgrade) is made
to a deconfigured agent before the reinstallation, the schedules must be reconfigured after the reinstallation.
Selecting a new storage policy does not impact the ability to restore the data that was previously backed up. When you select a new policy, the first backup will be
converted to a full backup.
Configure the Commvault software to automatically detect the installed client applications and then install the corresponding Commvault packages. For information on
how to enable this feature, see Enabling Application-Aware Installations .
Related Topics
Installation Methods
Procedure
The following sections describe the tasks that the administrator must perform based on the user responsible for the reinstallation.
Laptop Owner
If you want the laptop owner to reinstall the package, send a notification to all laptop owners including the following instructions:
1. Retrieve the laptop package from the administrator or from the Download Center.
2. Install the laptop package on the new laptop.
3. Register the new laptop.
Detailed instructions for the steps above can be found in the following topics:
Installing the Laptop Package - Laptop Backup for Windows
Installing the Laptop Package - Laptop Backup for Linux
Installing the Laptop Package - Laptop Backup for Macintosh
CommCell Administrator
If you, the administrator, want to reinstall the package, use the following steps:
1. Determine if you want to take over old laptop clients automatically
By default, when you reinstall the package on a new laptop that has the name of an existing (old) laptop client, both clients are displayed in the Web Console. The old
laptop is renamed to include the name of the user that performed the reinstallation. For example, laptopName_AdminUser.
If you want to take over or replace the old laptop clients with the new laptops automatically after reinstalling the package, configure the dForceClientOverride additional
setting.
a. From the CommCell Browser, right-click the CommServe node and click Properties.
b. In the CommCell Properties dialog box, click the Additional Settings tab and then click Add.
c. In the Add Additional Settings on Windows Client dialog box, complete the following steps:
i. In the Name box, type dForceClientOverride.
The Category and Type details fill automatically.
ii. In the Value box, type 1.
iii. Click OK.
d. Click OK to close the properties dialog box.
2. Include the laptop administrator account details in the install.xml file of the laptop package
To include the account details, you must determine whether client authentication is enabled in your CommCell environment.
If enabled, access the xml file and provide the user account and password of the laptop administrator, or a user with CommCell level administrative management
privileges.
If disabled, access the xml file and provide only the user account of the laptop administrator, or a user with CommCell level administrative management privileges.
In the xml file, locate the ClientAuthentication element as shown below:
<ClientAuthentication><userAccountToLogin userName="admin" domain="" password=""/></ClientAuthentication>
3. Install the package using the method that better suits your environment
For example, if you used the multi-CommCell routing feature or a third-party software to deploy the laptop package the first time, you might want to use the same
method.
4. Delete any older laptop client using the CommCell Console
From the CommCell Browser, right-click the laptop client that you want to delete and then click All Tasks > Delete.
If the Delete option is not available, then you must deconfigure the client. Right-click the laptop client and then click All Tasks > Release License for Client.
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click New Client. Under the File System section, and based on the computer's operating system, click Windows
or UNIX and Linux.
The New Windows Client (or New UNIX Client) dialog box is displayed.
2. On the Configure Client page, perform the following steps:
a. In the Host Name box, enter the fully qualified domain of the computer where you installed the Commvault software.
b. Select the Fetch the configuration information from the client that is already installed in decoupled mode check box.
By default, the Connect to a client and get its configuration option is selected
c. In the CVD port on client box, enter the CVD port that was provided during the installation. If the port was not requested during the installation, then it uses the
default port number (8400).
d. Click Next.
3. On the Optional Data page, if you want to display the client with a different name in the CommCell Browser, select the Overrides the Client name check box, and in
the Client Name box, enter a new name for the client. Click Next to continue.
4. On the Summary page, review the information you provided, and then click Finish.
Once the registration process finishes, the client is listed under the Client Computers node of the CommCell Browser.
Note: When you run the commands, make sure to notice the dot space before the /opt directory.
Procedure
On the computer where you installed Commvault, open the command line prompt and do the following:
On Windows Computers
Go to the Installation_Directory_Path/Base directory and run the following command after substituting the parameter values:
SIMCallWrapper.exe -OpType 1000 -CSHost CommServe_hostname -clientname client_name -output XML_file_location
The following table describes all of the parameters supported by the command. The required parameters have a Required tag in the description. Other parameters are
optional.
Parameter Description of Parameter Values
-opType 1000 Required. Name of the operation type to register the client to the CommServe computer.
-clientName Required. Name of the computer that you want to register.
-output Required. Directory path where you want to save the output XML file. For example:
On Windows, C:\temp\output.xml
On UNIX, /tmp/output.xml
The SIMCallWrapper command saves the success or error messages in XML format.
-instance CommCell instance on which the command runs. For example, Instance001.
-user User name of your CommCell user account. If the user is part of a domain, specify the user name as 'domain\user'.
Notes:
If you installed a laptop package, this parameter is required. You must specify the user name of your Web Console account.
If user authentication for installing agents is enabled on the CommCell environment, this parameter is required.
-password Password for the user account provided. This parameter is required if you used the -user parameter.
-CSName Name of the CommServe computer.
-CSHost Required. Host name of the CommServe computer.
-clientHostName Host name of the computer that you want to register.
-clientGroup Name of the client group that you want to associate with the computer.
-subclientPolicy Name of the subclient policy that you want to associate with the computer.
-storagePolicy Name of the storage policy that you want to associate with the computer.
-overwriteClientInfo Overwrites the computer's client name and host name that were provided during the installation with the ones you provide in the SIMCallWrapper
command.
Valid values are ON and OFF.
-regPath Name of the alternative registry path.
-instanceFor1Touch Name of the instance for 1-Touch.
-restartServices Restarts Commvault services on the client.
Use this parameter if you installed the Commvault software from a custom package that did not include CommServe details in its configuration.
Procedure
Based on the computer's operating system, perform the following registration steps:
On Windows Computers
When the Process Manager is automatically opened after the package installation, the application displays the Register Me tab. If you manually opened the application,
click the Register Me tab.
On the Register Me tab, provide the following details:
a. In the Computer Name box, enter the name of the computer on which you installed the package.
The computer name might be already provided.
b. In the User Name and Password boxes, enter your CommCell user credentials.
If you installed a laptop package, enter your Web Console credentials.
c. Click Register Me.
On Macintosh Computers
1. On the Introduction page of the Process Manager application, click Continue to start the laptop registration.
2. On the Configuration page, provide the following details:
a. Enter the name of the laptop in the Computer Name box. The computer name might be already provided.
b. Enter the CommServe host name in the CommServe box. The CommServe name might be already provided.
c. Enter your Web Console user credentials in the User Name and Password boxes.
d. Click Continue.
3. On the Summary page, review the information and then click Register.
The Process Manager prompts for your laptop password to proceed with the registration. Enter the password and then click OK.
4. Click Close to exit the laptop registration.
Procedure
Create the workflow using the steps in Creating a Business Logic Workflow .
During the workflow creation, locate the General tab in the Workflow Properties pane, and then specify the following properties:
In the Value column of the Message Name property, type CVInstallManager_ClientSetup.
Note: CVInstallManager_ClientSetup is the name of the XML request that manages client registrations. To review the XML attributes that are defined in the request, see
Sample XML Request.
In the Value column of the Module property, select CVD.
Tip: Commvault provides predefined business logic workflows for client registrations. If you need help creating the business logic workflow, you can use the predefined
workflows as a reference model. For more information, see Predefined Business Logic Workflows for Client Registrations .
Process Flow
To enable multi-CommCell routing for clients, you must perform the following configuration steps:
1. Set up a Master CommServe
One of the CommServe computers must be set as the master CommServe to maintain the information about all the available CommServe computers as well as the
clients that will be installed in your environment.
For instructions, see Setting Up a Master CommServe for Multi-CommCell Routing .
2. Create a laptop package from the Cloud Services website
The laptop package must be configured to support multi-CommCell routing. The package includes the File System Agent software.
For instructions, see Creating a Laptop Backup Installation Package .
3. Configure registration rules for clients
Registration rules consists of CommCell properties that you want to assign to clients, such as CommServe hostname and storage policy.
When your end-users install the laptop package on their clients, the package uses the registration rules that you configured.
For instructions, see Configuring Client Registration Rules for Multi-CommCell Routing .
4. Distribute the laptop package
Make the package available to your end-users. You can also use a third-party software to install the package on a group of clients.
When the package is installed on a client, the client will register with its respective CommServe computer automatically.
Procedure
1. Log on to CommServe computer that you want to set up as the master CommServe.
2. From the CommCell Browser, right-click the CommServe node, and then click All Tasks > CommCell Registration.
The CommCell Registration dialog box appears.
3. Click Add.
The Register Remote CommCell dialog box appears.
4. Add the details of one of the CommServe computers by specifying the following information:
a. In the User Name box, type the name of a user account that has administrative privileges on the CommServe computer.
b. In the Password box, type the password associated with the user account.
c. In the CommCell Host Name box, type the host name of the CommServe computer.
d. If the CommServe computer can only be accessed through a proxy, select the Select CommServe client located across a firewall check box and specify the proxy
name.
e. Click OK.
A confirmation prompt appears indicating that the operation was successful. Click OK to close the prompt.
5. Click Add to register the remaining CommServe computers.
After you add all of the CommServe computers to the master CommServe, you can see the registered computers listed under the Registered CommCells section.
6. Click OK.
What to Do Next
1. Create the laptop package from the Cloud Services website. For instructions, see Creating a Laptop Backup Installation Package .
2. Configure Client Registration Rules for Multi-CommCell Routing .
Procedure
1. On the computer where the Workflow Engine is installed (preferably on the master CommServe computer), create a text file with the client registration rules. Use the
following format to define each rule:
wildcard, CommServe_hostname, storage_policy, client_group, subclient_policy
Notes:
For wildcards, you must specify a period ('.') before an asterisk ('*').
If you do not plan to associate clients with a storage policy, client group, or subclient policy, specify double quotes ("") for blank entries.
Examples:
In the following rule, every client name that starts with AUS is associated with the Pacific CommServe computer and with the Australia client group.
AUS.*,Pacific.company.domain.com,"",Australia,""
In the following rule, every client name that ends in 12 is associated with the ABC CommServe computer, with CG client group, and with SP storage policy.
.*12,ABC.company.domain.com,"",CG,SP
2. Optional: By default, the clients that do not meet your registration rules are registered with the master CommServe computer. If you do not want these clients to be
registered with the master CommServe computer, use the following steps to disable the registration or to register the clients with another CommServe computer.
a. On the master CommServe computer, open the Microsoft SQL Server Management Studio.
b. Run the following SQL query on the CommServ database:
update app_registerclient
set targetCCId =1
where name = 'CV_Default'
To disable the registration for the clients, targetCCId must be 1. If you want to register the clients with a CommServe computer other than the master CommServe,
retrieve the appropriate CommServe ID from the app_commcell table.
3. Obtain the workflows required for multi-CommCell routing and get them ready in your CommCell environment.
a. Download the following workflows from Commvault Store:
AutoRegisterClientSavePatterns
AutoRegisterClient
Note: You must have an account to access Commvault Store. If you do not have an account, see Getting Access to the Cloud Services Website .
b. Import the workflows to the master CommServe, and then deploy the workflows. For instructions, see Importing a Workflow and Deploying a Workflow .
4. Save the client registration rules in the master CommServe database by running the AutoRegisterClientSavePatterns workflow.
a. Open the CommCell Console and connect to the master CommServe.
b. From the CommCell Browser, go to Workflows.
c. Right-click AutoRegisterClientSavePatterns and then click All Tasks > Execute.
d. In the AutoRegisterClientSavePatterns Options dialog box, in the patternFilePath box, specify the path to the text file where you defined the client registration
rules, and then click OK.
You can track the progress of the workflow job from the Job Controller.
What to Do Next
Distribute the laptop package to your end-users or use a third-party software to install the package on a group of clients.
When the package is installed on a client, the AutoRegisterClient workflow runs automatically and registers the client with its respective CommServe computer.
Related Topics
System Messages, Event Strings and Error Codes
Additional Options
The following table describes additional operations that you can perform with the reports feature:
Option Description Related topics
Saving the Report Output You can save the report output to a specified location.
1. In the CommCell Console, select the Reports tab, and then on the ribbon, click the button for the
report that you want to save.
The Report Selection dialog box appears.
2. Configure the report as needed.
3. Select the Output tab, and then from the Output Format section, select a file format.
4. Select Output To, and then enter the location to which you want to save the report.
To save the report to your local computer, select Use Local Drive On, and then in the Report
Copy Location box, enter a location.
To save the report to a shared network drive, select Use Network Share, and then in the
Report Copy Location box, enter a location.
To upload the report to an FTP site, select FTP Upload, and then click Settings to enter the
FTP location and your credentials.
You can use the default FTP location configured for the CommCell, or you can enter a
different FTP location and credentials.
5. From the Choose Locale list, select the language in which you want the report to appear.
6. At the bottom of the Report Selection dialog box, click Run.
The report opens in the file format that you specified and a copy of the report is saved to the
location that you entered.
Saving a Report as a Template You can save the report settings as a template in the CommCell Console, and then run the report at
any time.
1. In the CommCell Console, select the Reports tab, and then on the ribbon, click the button for the
report that you want to make into a template.
The Report Selection dialog box appears.
2. Configure the report as needed.
3. At the bottom of the Report Selection dialog box, click Save As.
The Save As dialog box appears.
4. Select Save a Report, and then enter a name for the template in the box.
5. Click OK.
The report template appears in the CommCell Browser under Reports > My Reports.
Generating a Report from a You can generate a report from a template at any time.
Template 1. From the CommCell Browser, expand Reports > My Reports, and then click General.
The General tab appears in the CommCell Console.
2. In the General tab, right-click the name of the report that you want to generate, and then select
Run Immediately.
The report opens in the format that is specified in the template.
Setting a Report Alert This option allows users or user groups to get an automatic notification when a report is created. Refer to Alerts .
Follow the steps given below to set up the criteria to raise notifications/alerts:
1. In the CommCell Console, select the Reports tab, and then on the ribbon, click the button for the
report that you want to set alerts for.
The Report Selection dialog box appears.
2. Configure the report as needed
3. At the bottom of the Report Selection dialog box, click Schedule.
The Schedule Details dialog box appears.
4. Configure the schedule as needed.
5. Select the Notification tab, and then click Add Alert.
6. From the Add Alert Wizard dialog box, select the types of notifications that you want to send,
and then click Next.
7. Add recipients to the selected list.
To add a recipient that is a user in the CommCell, from the Available list, select a user, and
then click Add.
To add a recipient that is not a user in the CommCell, in the Email to Recipients box, type an
e-mail address.
8. Click Next, and then click Finish.
9. Click OK.
Saving a Report as a Script The Command Line Interface allows you to generate reports from the command line. The commands Refer to Command Line
can be executed from the command line or can be integrated into scripts. You can generate Interface .
command line scripts for specific operations in the CommCell Console by using the Save As Script
option.
To create an XML script that generates a report:
1. From the CommCell Browser, expand Reports > My Reports, and then click General.
The General tab appears in the CommCell Console.
2. In the General tab, right-click the name of the report that you want to save as a script, and then
select Edit.
The Saved Reports dialog box appears.
3. Select the Job Initiation tab, and then click Save As Script
The Save As Script dialog box appears.
4. Enter the appropriate settings to generate a script file.
a. From the Client list, select the name of the client where you want to save the script.
b. In the Path box, enter the file path where you want to save the script, and then enter a name
for the script file at the end of the path.
Ensure that the name of the file contains the .xml extension
c. Click OK to create the script.
A message appears that says that the script saved successfully
d. Click OK.
The Save As Script and the Saved Reports dialog boxes close.
5/6/2017 Commvault Systems Page 244 of 587
5/6/2017 Commvault Systems Page 245 of 587
Repairing Installations
You can repair Commvault installations on any computer where the Commvault software is installed. You can run the repair operation remotely by using the CommCell
Console.
Repair operations must be performed to solve the following issues:
Registry corruption
If one or more Commvault registries are deleted, the repair operation recreates the missing registries while preserving the existing ones.
Service corruption
If a Commvault service is deleted or incorrectly configured, the repair operation reconfigures the service.
Installation file corruption
If an installation file or binary is missing or corrupted, the repair operation recreates the file in its original state.
In addition, you can perform the repair operation even when you cannot reach the computer because of CVD service problems. This repair feature is currently supported
only for Windows clients.
Procedure
1. From the CommCell Browser, expand Client Computers, right-click the Client, and click All Tasks > Add/Remove Software > Repair Software.
2. In the Repair Software Options dialog box, select the Enter system credentials check box and specify a user account that has administrative privileges on the client.
3. Click OK.
Tip: When the job starts, you can track the progress of the job from the Job Controller window (CommCell Console ribbon > Home tab > Job Controller).
What are the installation scenarios in which the installer may prompt for a reboot?
Third-party applications are installed for some Commvault packages.
The following table displays the third-party applications that might require a reboot for a specific Commvault package.
Note: Step 1 applies only to V9 to V11 upgrades. V9 users have to manually generate the Preupgrade Readiness Report before requesting an upgrade.
Prerequisites
V9 Service pack 14 or later must be installed on the CommServe computer.
The CommServe computer must be registered with the Cloud Services website.
If you have a Cloud Services account, the CommServe is already registered. If not registered, see Registering a Version 9 CommServe Computer .
Tip: After the registration, if you do not receive the confirmation email within one hour, see No E-mail Received after CommCell Registration or Upgrade Check . If the
issue persists, send an email to [email protected].
For the preupgrade checks to run successfully, the CommServe computer must have access to the https://edc.commvault.com/downloads/SQLScripts/ website.
If the CommServe computer has no Internet connectivity, use a client computer with Internet access as a gateway. To configure a client as the Internet gateway, see
Using an Internet Gateway Computer for Metrics Reporting .
If the CommServe computer is behind a firewall, open access to port 443 for https://edc.commvault.com/downloads/SQLScripts/ .
Procedure
1. Generate the report.
a. From the CommCell Console toolbar, click Control Panel.
b. In the Control Panel window, double-click Diagnostics and Usage.
c. In the Diagnostics and Usage dialog box, select the CommCell Diagnostics and Usage check box, and then select the Upgrade Readiness check box to collect
information for the Preupgrade Readiness Report.
d. Click Run Now to generate the Preupgrade Readiness Report. The report becomes available in the Cloud Services Web site.
2. Access the report.
a. In your Web browser, go to https://cloud.commvault.com/webconsole/survey/reports/monitoringform.jsp .
b. Log on to the Cloud Services site by using the credentials provided in the registration email.
c. On the Reports page, locate the CommCell Name column and click the name of your CommServe computer.
The report's dashboard page is displayed.
d. At the top of the dashboard page, click the Reports tab.
e. Under the Cloud section, click Pre Upgrade Readiness.
The Preupgrade Readiness Report is displayed.
The report includes the status of each preupgrade check so that you can identify and then address any issues that might cause the upgrade to fail. For example,
some of the preupgrade check results included in the report are:
Clients that are older than two releases
Clients with duplicate names or hostnames
What to Do Next
Request an Upgrade
For V9 Users
Preferred Method: Submit a form through the Cloud Services website
You can submit an upgrade request form, along with the CommServe database, through the Cloud Services website. If your CommServe computer is in a lock down
environment with no Internet access, you can copy the database to a computer with Internet connectivity to submit the request for upgrade.
Alternative Method: Test the upgrade by using the Database Upgrade tool
If you have issues submitting the request through the cloud, you can use the Database Upgrade tool to test the CommServe upgrade to detect possible issues during
the upgrade process.
This method is useful if your business does not allow you to submit the CommServe database due to strict security policies.
Note: If none of the alternative methods works for you, contact Customer Support for assistance.
Procedure
1. Send your request for upgrade.
a. In your Web browser, go to https://cloud.commvault.com/webconsole/survey/reports/monitoringform.jsp and log on to the website using your credentials.
b. On the CommCells tab of the Reports page, locate the CommCell Name column and click the name of your CommServe computer.
The report's dashboard page is displayed.
c. At the upper right of the dashboard page, click Request Upgrade to V11.
Tip: If the Request Upgrade to V11 option is not available, send an email to [email protected] to add the Operational Intelligence Foundation Package
(OIFP) SKU to your CommServe database. To review other solutions, see Upgrades - FAQ .
d. In the Request Upgrade to V11 dialog box, select the Request Type, enter the necessary information, and then click Yes.
Refer to the following table for more information on the Request Type that you should select:
Request Type Description
Access latest Release Media Kit for Evaluation Use this option to request access to download the V11 media from the Maintenance Advantage website. The
media must be used for evaluation purposes only.
When you are ready to perform the upgrade, resubmit the upgrade request by using one of the other request
types.
Partner assisted upgrade Use this option if a certified partner is assisting you with the upgrade. Make sure to include the email address of
the certified partner in the Commvault/Partner Contact Email box.
Professional Services assisted upgrade Use this option if Professional Services is assisting you with the upgrade. Make sure to include the email
addresses of the Professional Services personnel in the Commvault/Partner Contact Email box.
If you want to receive a quote for the assisted upgrade, make sure to add a note in the Comments section asking
that someone calls you to scope your needs. The message will be sent to the Professional Services team for a
follow-up.
Self-upgrade with Support Contact Use this option if you plan to perform the upgrade on your own. If necessary, include the email addresses of the
sales or partner contact in the Commvault/Partner Contact Email box.
2. Verify the confirmation email.
A confirmation email is sent to you within a few minutes of the upgrade request. The email will look similar to this sample email .
If you do not receive a confirmation email, send an email to [email protected].
3. Confirm the receipt of the Preupgrade Readiness Report. If you received an upgrade approval email, go to Step 5.
The report is sent in an email within 24 hours of the upgrade request. The email will look similar to this sample email .
If you do not receive the report, send an email to [email protected].
4. Analyze and fix the issues identified in the Preupgrade Readiness Report.
The report provides the necessary corrective actions for each of the preupgrade checks that failed. To see the most common errors and their respective workarounds,
see Troubleshooting Errors Found During a Request an Upgrade or Test Upgrade .
After the issues are fixed, resubmit your upgrade request as follows:
a. On the Cloud Services website, return to the report's dashboard page.
b. At the upper right of the dashboard page, next to the failure message, click Retry.
c. If the preupgrade checks fail again, you will receive an updated report in an email. Repeat Step 4.
5. Confirm the receipt of the upgrade approval email.
If the CommServe database passes all the preupgrade checks, you will receive an email indicating that your upgrade was approved. The email will look similar to this
sample email .
Important: You have 30 days to upgrade the CommServe computer. If you do not upgrade within 30 days, you must repeat the request for upgrade operation again.
5/6/2017 Commvault Systems Page 251 of 587
What to Do Next
1. Review the service-level agreement (SLA) information.
The upgrade approval email also includes the current SLA value for a specified number of days (for example, 83% for the last 7 days). We recommend that you check
whether the jobs in your CommCell meet the SLA value displayed in the report.
2. Start the CommServe Upgrade process.
Procedure
1. In your Web browser, go to https://cloud.commvault.com/upgraderequest/ .
2. Enter the information requested in the Request Upgrade to V11 form and click Check Upgrade Eligibility.
Tip: The CommCell ID can be found in the License Administration dialog box of the CommCell Console's Control Panel.
If your CommCell is not eligible, follow the instructions provided by the form.
If your CommCell is eligible, the form will request additional information, such as the type of request and the location of the CommServe database dump file.
Refer to the following table for more information on the Request Type that you should select:
Request Type Description
Access latest Release Media Kit for Evaluation Use this option to request access to download the V11 media from the Maintenance Advantage website. The
media must be used for evaluation purposes only.
When you are ready to perform the upgrade, resubmit the upgrade request by using one of the other request
types.
Partner assisted upgrade Use this option if a certified partner is assisting you with the upgrade. Make sure to include the email address of
the certified partner in the Commvault/Partner Contact Email box.
Professional Services assisted upgrade Use this option if Professional Services is assisting you with the upgrade. Make sure to include the email
addresses of the Professional Services personnel in the Commvault/Partner Contact Email box.
If you want to receive a quote for the assisted upgrade, make sure to add a note in the Comments section asking
that someone calls you to scope your needs. The message will be sent to the Professional Services team for a
follow-up.
Self-upgrade with Support Contact Use this option if you plan to perform the upgrade on your own. If necessary, include the email addresses of the
sales or partner contact in the Commvault/Partner Contact Email box.
3. Verify the confirmation email.
A confirmation email is sent to you within a few minutes of the upgrade request. The email will look similar to this sample email .
If you do not receive a confirmation email, send an email to [email protected].
4. Confirm the receipt of the Preupgrade Readiness Report. If you received an upgrade approval email, go to Step 6.
The report is sent as an email within 24 hours of the upgrade request. The email will look similar to this sample email .
If you do not receive the report, send an email to [email protected].
5. Analyze and fix the issues identified in the Preupgrade Readiness Report.
The report provides the necessary corrective actions for each of the preupgrade checks that failed. To see the most common errors and their respective workarounds,
see Troubleshooting Errors Found During a Request an Upgrade or Test Upgrade .
After the issues are fixed, perform another DR backup and repeat the previous steps to resubmit the upgrade form.
6. Confirm the receipt of the upgrade approval email.
If the CommServe database passes all the preupgrade checks, you will receive an email indicating that your upgrade is approved. The email includes the authentication
code along with the instructions to apply the code to your database. The email will look similar to this sample email .
Important: You have 30 days to upgrade the CommServe computer. If you do not upgrade within 30 days, you must repeat the request for upgrade operation again.
What to Do Next
1. Review the service-level agreement (SLA) information.
The upgrade approval email also included the current SLA value for a specified number of days (for example, 83% for the last 7 days). We recommend that you check
whether the jobs in your CommCell meet the SLA value displayed in the report.
2. Start the CommServe Upgrade process.
Procedure
1. Set up the standby CommServe.
Install the V11 CommServe software on the designated computer. For instructions, see Installing the CommServe Software .
2. Perform a disaster recovery (DR) backup on the production CommServe.
a. From the CommCell Browser, right-click the CommServe and click All Tasks > Disaster Recovery Backup.
b. In the Disaster Recovery Options dialog box, click OK.
c. After the job finishes, go to the DR backup folder and copy the dump file to the computer on which you plan to set up the standby CommServe.
Tip: The DR backup folder is specified in the DR Backup Settings dialog box, which you can access from the CommCell Console's Control Panel. The dump file is
located under a folder name SET_nnn. Use the folder with the highest nnn number.
3. Restore the database dump file on the standby CommServe by using the CommServe Recovery Assistant tool.
a. On the standby CommServe, open the command prompt and go to the Software_Installation_Path\Base directory.
b. Run the following command to restore the database dump file:
CSRecoveryAssistant.exe -operation staging -restoreonly -dbdumplocation "Database_Dump_Folder"
What to Do Next
CommServe Upgrade
Standard Upgrade
The standard upgrade procedure includes popular scenarios and configurations, such as cluster and non-cluster environments. This procedure is used by most CommCell
environments.
For more information, see Standard CommServe Upgrade .
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
CommServe Cache
If you have a UNIX share configured as the CommServe cache directory, clients will be automatically configured to point to the cache directory located on the
CommServe computer.
A UNIX share can no longer be configured as the CommServe cache.
If the CommServe is configured with the Get Updates From Share option, clients will be automatically configured to point to the CommServe cache directory.
Deconfigured Clients
Deconfigured clients from previous versions (up to two versions old) are automatically upgraded during the CommServe upgrade.
If you want to reinstall Commvault on a deconfigured client, you must install the same software version as the CommServe.
Free Space Requirements
The free space available on the CommServe computer must be at least three times the size of the current CommServe database.
After the upgrade, the size of the database might increase, decrease, or remain the same.
Library Server Configured in your CommCell Environment
If you are sharing a library and its drives between multiple CommCells, then you must first upgrade the CommCell, which is hosting the library server MediaAgent.
Microsoft SQL Server Software
The current Commvault version uses Microsoft SQL Server 2014 Standard Edition, but continues to support the Microsoft SQL Server 2012 Enterprise Edition.
Refer to the following table to determine your course of action based on your current SQL Server version.
Your SQL Server Version Action Required? Information
Microsoft SQL Server 2012 No The Commvault software does not upgrade the SQL Server version and continues to use Microsoft
SQL Server 2012.
If you want to upgrade to Microsoft SQL Server 2014 Standard Edition, you can do so after the
CommServe upgrade.
Microsoft SQL Server 2008 or 2008 R2 Yes Determine which of the following scenarios apply to your CommServe configuration:
If the CommServe is in a cluster environment, you must manually upgrade to Microsoft SQL
Server 2012 SP2.
For instructions, see Upgrading Older SQL Server Versions to Microsoft SQL Server 2012
Enterprise Edition .
If the CommServe is in a non-cluster environment, the following Microsoft SQL Server versions
are automatically upgraded to Microsoft SQL Server 2012 SP2:
Microsoft SQL Server 2008 Editions
Microsoft SQL Server 2008 R2 Editions with SP2
Important: Microsoft SQL Server 2008 R2 Editions must have SP2 installed for a successful SQL
upgrade.
Microsoft SQL Server 2008 Express No The Commvault software automatically upgrades the version to Microsoft SQL Server 2014
Express.
SafeNet Certificates Configured in the Installation Directory
If you created SafeNet certificates in the software installation directory, move all certificates to a new location. For more information on the data encryption using
SafeNet, see Configuring Data Encryption to Use Third-Party Software (SafeNet) .
Version 8 Clients Running Windows Server 2000
If you have V8 clients running the Windows Server 2000 operating system, you must upgrade the clients to Commvault Version 9 before the CommServe upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Clients with Products That Are Not Backward Compatible
If you have any of the following products installed on your clients, you must upgrade them as soon as the CommServe is upgraded:
Web Console
Web Server
Workflow Engine
CommCell with Client Certificate Authentication
If your CommCell is in lock-down mode, authentication of client certificates is enforced during client upgrades and installations.
Before you upgrade the clients in your CommCell environment, we recommend that you disable the client certificate authentication feature. After all clients are
upgraded, you can enable the feature again.
To enable or disable client certificate authentication, see Enable Client Certificate Authentication on the CommServe .
CommServe Cache Status
During the upgrade, the latest updates and service packs are downloaded to the CommServe cache directory. Updates from previous versions are cleared from the
CommServe cache.
If new updates become available after the upgrade, you can download the latest service pack. For download instructions, see Installing the Service Pack Remotely Using
the CommCell Console .
Email Server Configuration
If you configured an email server to send CommCell alerts, log files, and reports, the email address of the sender is not retained after the upgrade.
You can specify the sender's email address from the CommCell Console. For instructions, see Configuring an Internal Mail Server .
HTTP Proxy Server for Internet Connections
If you configured an HTTP proxy server to send logs, download software, or manage Metrics Reporting communications, your settings in V11 might change based on
the following conditions:
5/6/2017 Commvault Systems Page 258 of 587
If you used an HTTP proxy to download software, but not to send logs, then the send log and Metrics Reporting connections will be reconfigured to use the same
HTTP proxy connection.
If you used an HTTP proxy to send logs, the download software and Metrics Reporting connections will be reconfigured to use the same HTTP proxy connection.
Java Runtime Environment Version
During the upgrade, the Java software is updated to the Java version supported by the V11 Commvault software. To learn about the supported version, see the Java
Runtime Environment (JRE) section in System Requirements .
Microsoft SQL Server Software
If you want to use Microsoft SQL Server 2014 Standard Edition instead of Microsoft SQL Server 2012, see Upgrading Microsoft SQL Server 2012 Enterprise to Microsoft
SQL Server 2014 Standard Edition .
Recall Operations for OnePass for Exchange Mailbox (Classic)
If you have V10 clients configured with OnePass for Exchange Mailbox (Classic), you must upgrade them as soon as the CommServe is upgraded. If you do not plan to
upgrade the clients immediately but you want to continue to perform recall operations, make sure that your V10 clients have service pack 10 installed (with all of the
hotfixes).
Web Administration Settings for the CommCell Console
If the CommCell Console was configured as a web application in the previous Commvault version, you must reconfigure the web administration settings for the
CommCell Console to work as a web application. For more information, see Web Administration for CommCell Console .
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
CommServe Cache
If you have a UNIX share configured as the CommServe cache directory, clients will be automatically configured to point to the cache directory located on the
CommServe computer.
A UNIX share can no longer be configured as the CommServe cache.
If the CommServe is configured with the Get Updates From Share option, clients will be automatically configured to point to the CommServe cache directory.
CommServe Express Version License Change
If you have the CommServe Express version, token-based licenses will be converted to traditional licenses during the upgrade. If you are not using all of the tokens that
you purchased, the remaining tokens will be divided amongst the traditional licenses based on the current consumption ratio.
Deconfigured Clients
Deconfigured clients from previous versions (up to two versions old) are automatically upgraded during the CommServe upgrade.
If you want to reinstall Commvault on a deconfigured client, you must install the same software version as the CommServe.
Index Cache Sharing is Deprecated
Index Cache sharing arrangements (Index Cache Using Network Share and Index Cache Server) are not supported in V11. Before upgrading your CommServe, you must
remove all index-sharing configurations. Appropriate indexes should be placed onto local (internal) drives in each MediaAgent that formerly used a shared
arrangement. For more information, see Moving the Index Directory .
In V11, the Secondary Index Server feature is provided as a replacement for index cache sharing.
Free Space Requirements
The free space available on the CommServe computer must be at least three times the size of the current CommServe database.
After the upgrade, the size of the database might increase, decrease, or remain the same.
Microsoft SQL Server Software
The current Commvault version uses Microsoft SQL Server 2014 Standard Edition, but continues to support the Microsoft SQL Server 2012 Enterprise Edition.
Refer to the following table to determine your course of action based on your current SQL Server version.
Your SQL Server Version Action Required? Information
Microsoft SQL Server 2012 No The Commvault software does not upgrade the SQL Server version and continues to use Microsoft
SQL Server 2012.
If you want to upgrade to Microsoft SQL Server 2014 Standard Edition, you can do so after the
CommServe upgrade.
Microsoft SQL Server 2008 or 2008 R2 Yes Determine which of the following scenarios apply to your CommServe configuration:
If the CommServe is in a cluster environment, you must manually upgrade to Microsoft SQL
Server 2012 SP2.
For instructions, see Upgrading Older SQL Server Versions to Microsoft SQL Server 2012
Enterprise Edition .
If the CommServe is in a non-cluster environment, the following Microsoft SQL Server versions
are automatically upgraded to Microsoft SQL Server 2012 SP2:
Microsoft SQL Server 2008 Editions
Microsoft SQL Server 2008 R2 Editions with SP2
Important: Microsoft SQL Server 2008 R2 Editions must have SP2 installed for a successful SQL
upgrade.
Microsoft SQL Server 2008 Express No The Commvault software automatically upgrades the version to Microsoft SQL Server 2014
Express.
Version 8 Clients Running Windows Server 2000
If you have V8 clients running the Windows Server 2000 operating system, you must uninstall the V8 software before the CommServe upgrade.
If you want to continue protecting the data on the Windows Server 2000 client, you will need to install the V9 software after the CommServe upgrade.
Windows Server 2003 Edition is Deprecated
The CommServe software is no longer supported on computers running Windows Server 2003 editions. You must upgrade the Windows Server operating system to a
supported version. For more information, see System Requirements .
Note: If you plan to move the CommServe database to a new hardware as part of the upgrade, see CommServe Hardware Refresh.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Capacity License Over-Usage Status for Virtualization Users
After the CommServe upgrade, the capacity usage might increase for Virtualization users. However, the capacity will return to its original usage status after the next full
Virtual Server backup. If you do not want to wait for the next full backup, you can reset the capacity usage. For instructions, see Addressing Over-Capacity Situations .
Clients with Products That Are Not Backward Compatible
If you have any of the following products installed on your clients, you must upgrade them as soon as the CommServe is upgraded:
Web Console
Web Server
Workflow Engine
Clients Running Windows Server 2000
If you uninstalled the V8 software from Windows Server 2000 clients before the CommServe upgrade, then install the V9 software on those clients where you want to
keep protecting the data. For instructions, see Installing Version 9 Windows Server 2000 Clients on a Version 11 CommCell Environment .
CommCell with Client Certificate Authentication
If your CommCell is in lock-down mode, authentication of client certificates is enforced during client upgrades and installations.
Before you upgrade the clients in your CommCell environment, we recommend that you disable the client certificate authentication feature. After all clients are
5/6/2017 Commvault Systems Page 260 of 587
upgraded, you can enable the feature again.
To enable or disable client certificate authentication, see Enable Client Certificate Authentication on the CommServe .
CommServe Cache Status
During the upgrade, the latest updates and service packs are downloaded to the CommServe cache directory. Updates from previous versions are cleared from the
CommServe cache.
If new updates become available after the upgrade, you can download the latest service pack. For download instructions, see Installing the Service Pack Remotely Using
the CommCell Console .
Email Server Configuration
If you configured an email server to send CommCell alerts, log files, and reports, the email address of the sender is not retained after the upgrade.
You can specify the sender's email address from the CommCell Console. For instructions, see Configuring an Internal Mail Server .
HTTP Proxy Server for Internet Connections
If you configured an HTTP proxy server to send logs, download software, or manage Metrics Reporting communications, your settings in V11 might change based on
the following conditions:
If you used an HTTP proxy to download software, but not to send logs, then the send log and Metrics Reporting connections will be reconfigured to use the same
HTTP proxy connection.
If you used an HTTP proxy to send logs, the download software and Metrics Reporting connections will be reconfigured to use the same HTTP proxy connection.
Java Runtime Environment Version
During the upgrade, the Java software is updated to the Java version supported by the V11 Commvault software. To learn about the supported version, see the Java
Runtime Environment (JRE) section in System Requirements .
Microsoft SQL Server Software
If you want to use Microsoft SQL Server 2014 Standard Edition instead of Microsoft SQL Server 2012, see Upgrading Microsoft SQL Server 2012 Enterprise to Microsoft
SQL Server 2014 Standard Edition .
Network Ports
If you used the Database Upgrade tool to upgrade the CommServe, the port numbers used by the Web Console and CommCell Console are changed to the new default
port numbers that are used in the current Commvault version:
By default, Web Console uses port number 80.
By default, CommCell Console uses port number 81.
Make sure that the new port numbers are not used by any other application.
New Mobile Applications
If you are using the CommVault Access application, it has been replaced by the new application CommVault Edge.
Use the following steps to guide your transition to the new application:
1. Upgrade the Web Server.
The application will not work if the Web Server is from a previous version.
2. Download CommVault Edge.
The CommVault Access application will not work after the upgrade.
Secondary Index Server
If you were using index cache sharing, the Secondary Index Server feature may provide useful functionality. For more information, see Transitioning from a Shared
Cache .
Web Administration Settings for the CommCell Console
If the CommCell Console was configured as a web application in the previous Commvault version, you must reconfigure the web administration settings for the
CommCell Console to work as a web application. For more information, see Web Administration for CommCell Console .
In Commvault V11, configuring the CommServe software and the Microsoft SQL Server on separate computers is no longer supported.
Procedure
1. Stop all services and disable all activities on the CommServe computer.
To stop all services:
a. Log on to the CommServe computer.
b. Click Start and click All Programs > Commvault > Process Manager.
c. On the Services tab, stop all activities.
To disable all activities:
a. From the CommCell Browser, right-click the CommServe node and then click Properties.
b. In the CommCell Properties dialog box, click the Activity Control tab and clear the Enable All Job Activity check box.
c. Click OK.
2. Move the CommServe database dump file from the Microsoft SQL Server computer to the CommServe computer.
3. Restore the dump file on the Microsoft SQL Server of the CommServe computer.
4. Update the SQL Server account settings.
On the CommServe computer, use the following steps to update some registry values to point back to the CommServe computer:
a. Open the Windows Registry Editor and go to the following directory:
HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance<xxx>\Database
b. Update the values of the following registry keys:
sCONNECTION set it to <CommServe computer>_commserv
sDOMAIN set it to <CommServe computer>
sINSTANCE set it to <CommServe computer>\Commvault
5. Change the DSN settings.
On the CommServe computer, modify the DSN settings for the CommServe database to point to the CommServe computer.
a. On the Windows Control Panel window, click Administrative Tools > Data Sources (ODBC).
b. On the System DSN tab, select <CommServe computer>_commserv and then click Configure.
The Microsoft SQL Server DSB Configuration wizard opens.
c. On the first page, edit the following values:
In the Name box, update the value to <CommServe computer>_commserv.
In the Server box, update the value to <CommServe computer>\Commvault.
d. On the second page, do the following:
Select the With SQL Server authentication using a login ID and password entered by the user option.
Select the Connect to SQL Server to obtain default settings for the additional configuration options check box and enter the user credentials of the sa
user.
e. On the third and fourth page, do not make any changes.
f. On the fifth page, click Test Data Source.
The result should be TEST COMPLETED SUCCESSFULLY!.
g. Click OK.
6. Start all the services and enable all the activities on the CommServe computer.
To start all services:
a. Log on to the CommServe computer.
b. Click Start and click All Programs > Commvault > Process Manager.
c. On the Services tab, start all activities.
To enable all activities:
a. From the CommCell Browser, right-click the CommServe node and click Properties.
b. In the CommCell Properties dialog box, click the Activity Control tab and click the Enable All Job Activity check box.
c. Click OK.
7. Enable disaster recovery (DR) backups.
a. From the CommCell Browser, right-click the CommServe node and click View > Schedules.
b. In the Schedules window, right-click the DR Backup Full schedule and click Enable.
8. Disable automated scripts for installing updates.
If you have automated scripts to install software updates, you can disable them because you can install updates from the CommCell Console. For more information, see
Configuring Automatic Service Pack Installations .
What to Do Next
Continue with Plan the CommServe Upgrade . However, if you are ready to perform the upgrade, see Upgrading the CommServe Software .
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
In a cluster environment, log on to the active physical node of the cluster as an Administrator or as a member of the Administrator group on that computer.
2. Run Setup.exe from the installation package.
The installation wizard opens.
3. On the welcome page, select the I Agree check box and proceed to the next page.
Note: If there is more than one Commvault instance on the computer, the Instance Selection page is displayed. Select the instance where the CommServe is installed.
4. On the Confirm Upgrade page, read the upgrade notice and proceed to the next page to start the upgrade process.
Note: During the upgrade, the CommServe computer also undergoes a database maintenance check, which results in the overall improvement of the CommServe
performance.
5. On the upgrade completion page, click Finish.
Notes:
If the CommServe is in a cluster environment, repeat the upgrade procedure for each cluster node where the software is installed.
To help you troubleshoot errors that occur during the upgrade process, check the DatabaseUpgrade.log and install.log in the Software_Installation_Directory\Log Files directory.
What to Do Next
Review the tasks that you must perform after the upgrade in Postupgrade Tasks for the CommServe .
Review postupgrade considerations, which include recommendations, notes, and other important information.
For V10 to V11
For V9 to V11
If you plan to use the same network details, do not connect the new computer to the network. The computer can be connected later in the process, after
shutting down the old CommServe computer.
Procedure
1. Disable CommCell activities.
a. From the CommCell Browser, right-click the CommServe node and then click Properties.
b. On the Activity Control tab, clear all the check boxes, except the Enable All Job Activity check box, and then click OK.
This ensures that no new jobs are performed, except for disaster recovery operations, VM provisioning jobs, and workflow jobs. These jobs do not affect the
hardware refresh.
2. From the Job Controller, kill all jobs that are in progress, or wait for the jobs to complete.
3. Install the latest Commvault Service Pack. For instructions, see Service Pack Installation .
4. If a MediaAgent is installed on the CommServe computer and you have a disk library with a local mount path, copy the mount path to a location accessible to the new
CommServe computer.
For example, if you have a disk library configured with a local mount path in C:\disklib01, copy the entire folder including its contents and subfolders.
Based on your Commvault version, read the instructions to move mount paths. For V10, see Moving Mount Paths . For V9, use the following steps:
a. From the current mount path location, copy the CV_MAGNETIC folder to the new mount path location.
b. From the Tools menu in the CommCell Console, click Control Panel, and from the Control Panel window, double-click Library & Drive Configuration.
c. In the Library & Drive Configuration window, right-click the mount path that you want to move and click Properties.
d. In the Mount Path Properties dialog box, enter the new path, and then click OK to save the information.
5. If you have a deduplication database (DDB), perform one of the following steps:
If the MediaAgent hosting the DDB is installed in the CommServe, copy the DDB content (CV_SIDB folder and icl_label.txt file) to an accessible location. This location
should be accessible to the new CommServe computer.
If the DDB resides on a separate MediaAgent, no action is required.
6. Index Cache Sharing is not supported in this release. If a shared Index Cache used by a set of MediaAgents is hosted in the old CommServe computer, copy the
IndexCache directory to an accessible location so that it can be placed onto a local drive on each MediaAgent in the set.
To identify the current location of the directory, navigate to one of the MediaAgents where the shared Index Cache is configured, and follow these steps:
a. From the CommCell Browser, navigate to Storage Resources > MediaAgents.
b. Right-click the MediaAgent and then click Properties.
c. In the MediaAgent Properties dialog box, click the Catalog tab.
The Index Cache Directory box displays the UNC path of the Index Cache. For example, \\CommSevePCName\e$\IndexCache.
d. Click OK.
7. Run a CommServe Disaster Recovery Backup.
a. From the CommCell Browser, right-click the CommServe node and then click All Tasks > Disaster Recovery Backup.
b. On the Disaster Recovery Options dialog box, click OK to run the backup.
The Disaster Recovery backup job may enter the Waiting state after the Backup to Disk phase is complete. This can happen if the DR storage policy is
associated to the same MediaAgent where you stopped the services. As a result, the DR backup job is not able to transfer the data to the offline
MediaAgent.
In this situation, you can stop the DR backup job after the Backup to Disk phase is complete. However, before you stop the job, verify that the Backup to
Disk phase is complete:
a. From the Job Controller window, double-click the job.
b. To view the status of the different phases in the job, click the Attempts tab on the Job Details dialog box.
8. Copy the CommServe Disaster Recovery backup files (set_XXX folder) to an accessible location.
Disaster Recovery backup files are saved to the location specified in the DR Backup Settings dialog box that is available from the Control Panel. Make sure to
obtain the latest DR set from this location.
9. Using the Microsoft Internet Information Services (IIS), make a note of the port numbers used by the Consoles.
What to Do Next
Setting Up the CommServe Database in the New Hardware
Procedure
Choose the method that better accommodates your requirements.
If you plan to set up an exact replica of the old CommServe computer, add the new computer to the same domain as the old computer.
To submit the dump file, perform the following steps during the installation:
a. On the Database Install Option page, click Use Existing Database and select the CommServe check box.
If you had other server packages installed on the CommServe computer (for example, Workflow Engine and Web Server), select the check boxes associated
with them.
b. On the Database Dump Location page, specify the location of the CommServe database dump file (and of any other database that you selected).
The dump files are located with your Disaster Recovery backup files. For example, the default name for the CommServe dump file is commserv.dmp.
Remember: After you provide the dump files, the installation program upgrades the CommServe database (and any other database that you provided)
silently.
4. To match the ports used by the Consoles on the old CommServe computer, open IIS Server Manager to modify the default IIS port.
The port numbers should match the information collected during the Preparing the Old CommServe Computer for Shutdown procedure.
5. If a deduplication database (DDB) was configured in the old CommCell environment, perform one of the following steps:
If the DDB was hosted in the CommServe computer, then copy the DDB content (CV_SIDB folder and icl_label.txt file) to the same drive and folder in the new
computer.
If the DDB was hosted on a separate MediaAgent computer, no action is required.
6. To verify that your CommServe database was successfully moved to the new computer, verify that services are running and then open the CommCell Console.
The console should display the CommServe computer and the associated clients in the CommCell Browser.
7. If the MediaAgent was installed in the old CommServe computer, complete the following steps:
a. If you have a tape library, the library should already be plugged into the new hardware. Make sure to reconfigure the library from the CommCell Console.
See Configuring Devices for step-by-step instructions.
b. If you have a disk library, copy the local mount path folder to the same drive as it was on the old CommServe.
c. Install the MediaAgent software in the new CommServe computer using the steps described in MediaAgent Installation .
8. Index Cache Sharing is not supported in this release. If a shared Index Cache used by a set of MediaAgents was hosted on the old CommServe computer, that
5/6/2017 Commvault Systems Page 270 of 587
arrangement must be transitioned from a shared index cache to a local index cache. In the shutdown procedure for this hardware refresh, you copied the contents
of the Index Cache to a directory you can access. Transitioning from a Shared Cache provides procedures for moving to a local cache. Use the copy of the Index
Cache that you created during the shutdown when performing your chosen transition procedure.
9. Enable CommCell activities.
a. From the CommCell Browser, right-click the CommServe node, and click Properties.
b. On the Activity Control tab, enable all the activities that you cleared when the CommServe database was on the old hardware, and click OK.
Note: If the DDB activity was disabled before DR restore, re-enabling the DDB activity after the DR restore automatically starts the DDB resynchronization
process.
10. Perform a test backup. Refer to the Agent-appropriate documentation for instructions on how to run backups.
Alternative Method: Install the CommServe Software, then Restore and Upgrade the Database Using the Recovery Assistant
Tool
1. Log on to the new computer and ensure that the network details (computer name and IP settings) are properly set.
2. Copy the Disaster Recovery backup files to the local drive.
The disaster recovery backup files were saved during the Preparing the Old CommServe Computer for Shutdown procedure.
3. Install the CommServe software on the new computer. For the installation instructions, see Installing the CommServe Software .
Important:
During the installation, on the Client Computer Information page, make sure that you provide the name of the old CommServe computer.
If you need to retrieve data from a tape or disk library, do not install the MediaAgent when you install the CommServe software. You will be able to properly
retrieve data from a tape or disk library when you get to step 11.
4. Restore the CommServe database by using the CommServe Recovery Assistant tool. For step-by-step instructions, see Recovering the CommServe Database .
Remember: During the restore process, the tool upgrades CommServe database silently.
5. Shut down the old CommServe computer using the following sequence:
a. Stop all Commvault services.
b. Shut down the computer.
c. Unplug the network cables.
d. If you have a tape library attached to the CommServe, unplug the library from the CommServe computer and plug it in to the new hardware.
If you plan to reuse this computer, complete the following tasks before you activate the computer in the network:
Uninstall Commvault software.
Change the computer name and IP settings to different values.
6. Configure the host name of the old CommServe computer to point to the IP address of the new computer.
Important: Verify that all client computers point to the host name of the old CommServe computer (not to the IP address).
7. Optional: If you want to update the clients and MediaAgents with the name of the new CommServe computer, see Changing the CommServe Host Name on a Client .
8. To match the ports used by the Consoles on the old CommServe computer, open IIS Server Manager to modify the default IIS port.
The port numbers should match the information collected during the Preparing the Old CommServe Computer for Shutdown procedure.
9. If a deduplication database (DDB) was configured in the old CommCell environment, perform one of the following steps:
If the DDB was hosted in the CommServe computer, then copy the DDB content (CV_SIDB folder and icl_label.txt file) to the same drive and folder in the new
computer.
If the DDB was hosted on a separate MediaAgent computer, no action is required.
10. To verify that your CommServe database was successfully moved to the new computer, verify that services are running and then open the CommCell Console.
The console should display the CommServe computer and the associated clients in the CommCell Browser.
11. If the MediaAgent was installed in the old CommServe computer, complete the following steps:
a. If you have a tape library, the library should already be plugged into the new hardware. Make sure to reconfigure the library from the CommCell Console.
See Configuring Devices for step-by-step instructions.
b. If you have a disk library, copy the local mount path folder to the same drive as it was on the old CommServe.
c. Install the MediaAgent software in the new CommServe computer using the steps described in MediaAgent Installation .
12. Index Cache Sharing is not supported in this release. If a shared Index Cache used by a set of MediaAgents was hosted on the old CommServe computer, that
arrangement must be transitioned from a shared index cache to a local index cache. In the shutdown procedure for this hardware refresh, you copied the contents
of the Index Cache to a directory you can access. Transitioning from a Shared Cache provides procedures for moving to a local cache. Use the copy of the Index
Cache that you created during the shutdown when performing your chosen transition procedure.
13. Enable CommCell activities.
a. From the CommCell Browser, right-click the CommServe node, and click Properties.
b. On the Activity Control tab, enable all the activities that you cleared when the CommServe database was on the old hardware, and click OK.
Note: If the DDB activity was disabled before DR restore, re-enabling the DDB activity after the DR restore automatically starts the DDB resynchronization
process.
14. Perform a test backup and restore. Refer to the Agent-appropriate documentation for instructions on how to run backups.
d. Click OK.
Step 3: Configure an Additional Setting to Send Update Status to the CommServe
a. Log on to the CommCell Console.
b. In the CommCell Browser, right click the <CommServe> computer, and then click Properties.
c. Click the Additional Settings tab, and then click Add.
d. In the Add Additional Settings on Windows Client dialog box, do the following:
i. In the Name box, type bSendUpdateStatusToCS .
ii. In the Category box, type registry.
iii. From the Type list, select INTEGER.
iv. In the Value box, type 1.
v. Click OK.
e. Click OK to close the CommCell Properties dialog box.
f. Restart the CommCell services using the Process Manager. For instructions, see Restarting a Service .
Procedure
1. Stop the mirroring between the production and standby CommServe databases.
To stop the database mirroring, remove the mirroring configuration as follows:
a. On the production CommServe computer, open the Microsoft SQL Server Management Studio.
b. From the Object Explorer pane, go to Server_Instance > Databases > CommServ.
c. Right-click the CommServ database and click Tasks > Mirror.
d. In the Database Properties - CommServ dialog box, click Remove Mirroring. The Database Properties pop up window opens.
e. Click Yes to confirm that you want to remove mirroring from the database.
f. In the Database Properties - CommServ dialog box, the Status box should display that the database is not configured for mirroring.
Click OK to close the dialog box.
2. Upgrade the production CommServe computer.
For instructions, see Upgrading the CommServe Software .
3. Upgrade the standby CommServe computer.
a. Uninstall the old version of the Commvault software. See the Uninstallation topic in the respective version of Commvault documentation.
b. Install Microsoft SQL Server 2012 Enterprise.
For instructions, you can use the installation steps in Pre-Installing the Microsoft SQL Server Software , but remember that you must obtain the software from
Microsoft.
c. Add the szUserSQLInstanceName registry key to specify the SQL instance that was created during the SQL Server 2012 installation.
For instructions, see Configuring an Existing SQL Instance for Server Packages .
d. Install the current version of the Commvault software.
For more information, see Installing the CommServe Software .
4. Set up the production CommServe computer for database mirroring.
To prepare for database mirroring, you have to back up the CommServe database and transaction logs, and then copy the backup files to the standby CommServe
computer.
Perform the following tasks using the SQL Management Studio software. For instructions, consult the Microsoft manual.
Set CommServe Database in Full Recovery Mode
Backup Full Database Using SQL Server Management Studio
Backup Transaction Logs of CommServe Database
Copy Backup Files to Standby CommServe
5. Set up the standby CommServe computer for data mirroring.
a. Stop the Commvault services.
If services are running on both the production and standby CommServe computers, the two CommServe databases will try to communicate with the clients
simultaneously.
b. Restore the database and transaction logs of the production CommServe computer to the standby CommServe computer using the SQL Management Studio
software
For instructions, consult the Microsoft manual.
6. Re-establish database mirroring. For instructions, consult the Microsoft manual.
Procedure
1. Disable the backup and restore schedules:
a. From the CommCell Browser, right-click the CommServe node and click View > Schedules.
b. In the Schedules tab, right-click the schedule you created for backup transaction logs and then click Disable.
c. Similarly, right-click the schedule you created for restoring transaction logs and then click Disable.
2. Upgrade the Production CommServe computer.
For instructions, see Upgrading the CommServe Software .
3. Upgrade the Disaster Recovery computer:
The Disaster Recovery computer has two Commvault instances installed. One instance has the CommServe database (in standby mode), and the other instance has the
SQL Server Agent installed.
Upgrade the instance containing the Standby CommServe database:
a. Uninstall the old version of the Commvault software. See the Uninstalling Components topic in the respective version of Commvault Documentation.
b. Install the current version of the Commvault software. For more information, see CommServe Installation .
c. Stop the Commvault services.
Upgrade the instance containing the SQL Server agent.
Tip: Upgrade the SQL Server agent using the CommCell Console of the production CommServe computer. For more information, see Upgrading Commvault
Remotely Using the CommCell Console .
4. Prepare the Production CommServe database for recovery:
a. Set the CommServe database to full recovery mode. See SQL Server documentation for instructions on changing the database to full recovery mode.
b. Perform a full backup of the CommServe database using SQL Server Agent. For more information, see Backing Up SQL Databases .
c. Restore the CommServe database to the standby CommServe. For more information, see Recovery Types and Undo Path - Stand By .
Tip: Use a fast access disk as the Undo File Path.
5. Enable the backup and restore schedules in the Production CommServe computer:
a. From the CommCell Browser, right-click the CommServe node and then click View > Schedules.
b. In the Schedules tab, right-click the schedule you created for backup transaction logs and then click Enable.
c. Similarly, right-click the schedule you created for restoring transaction logs and then click Enable.
Procedure
1. Upgrade the Production CommServe computer.
For instructions on the upgrade process, see Upgrading the CommServe Software .
2. Upgrade the Disaster Recovery computer.
The Disaster Recovery computer has two Commvault instances installed. One instance has the CommServe database in standby mode, and the other has the SQL
Server Agent and the CommServe Failover package.
Upgrade the instance containing the SQL Server Agent and the CommServe Failover package.
We recommend that you upgrade the SQL Server Agent and the CommServe Failover package using the CommCell Console from the production CommServe
computer. For more information, see Upgrading Commvault Remotely Using the CommCell Console .
Upgrade the instance containing the Standby CommServe computer.
From the command line, go to the folder where Commvault installation package is located, and run the following upgrade command (which uses the option to skip
the database upgrade):
Standard Upgrade
The standard upgrade procedure includes popular scenarios and configurations, such as MediaAgents configured with deduplication databases as well as MediaAgents in
cluster environments. For more information, see Standard MediaAgent Upgrade .
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Analytics Engine
If you deconfigured the Analytics Engine on a MediaAgent, then you must upgrade the MediaAgent locally by using the installation package. If you upgrade the
MediaAgent remotely by using the CommCell Console, the upgrade will fail.
Backup, Auxiliary Copy, and Data Aging
For backups, auxiliary copy, and data aging operations to work, the MediaAgent that hosts the deduplication database (DDB MediaAgent) and the MediaAgent that is
associated with the library (Data Mover MediaAgent) must have the same Commvault version.
For example, if you plan to upgrade the DDB MediaAgent, you must also upgrade the Data Mover MediaAgent.
Deduplication
If partitioned deduplication database (DDB) is configured, all MediaAgents associated with the partitions and the data path MediaAgent must be of same software
version.
You can move DDB only to a MediaAgent with the same or newer software versions. Moving DDB to a MediaAgent with an older software version is prevented.
When upgrading MediaAgents that hosts the deduplication database (DDB) to v11, it is not required to upgrade the DDB because the older version DDB is
supported on v11 MediaAgent.
If data verification job was run to Reclaim idle space on Mount Paths with no drill hole capability in v10, then you must upgrade to v11 Service Pack 5 or higher.
Deduplication to Tape (Silo Storage)
For silo jobs to work, the data path MediaAgent associated with the source copy of a silo copy must have the same version as the CommServe computer.
Disk Library Configured in the Installation Directory
If you created a disk library in the installation directory, change the mount path location and move all the library files to a new mount path. For instructions, see Moving
Mount Paths .
Restore Operation with Older MediaAgents
You can perform restore operations on a client that is one version higher than the associated MediaAgent.
Tape Libraries
If you have tapes mounted on the libraries attached to your MediaAgents, you must unmount the tapes from the drives for a successful upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Deduplication
If you disabled the Optimize Concurrent LAN Backups option on a UNIX client, the first backup will be a full backup, resulting in a lower deduplication ratio and a
large data transfer rate. A full backup is required due to deduplication enhancements on UNIX clients.
If you disabled data compression for backups from database agents (such as DB2 or Oracle agents), after the upgrade of those database clients, you can enable
compression to achieve a good deduplication ratio.
Library and Drive Configuration
The Library and Drive Configuration tool is renamed and will appear as Expert Storage Configuration.
For more details, see Expert Storage Configuration - Overview .
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Backup, Auxiliary Copy, and Data Aging
For backups, auxiliary copy, and data aging operations to work, the MediaAgent that hosts the deduplication database (DDB MediaAgent) and the MediaAgent that is
associated with the library (Data Mover MediaAgent) must have the same Commvault version.
For example, if you plan to upgrade the DDB MediaAgent, you must also upgrade the Data Mover MediaAgent.
Deduplication
If a partitioned deduplication database (DDB) is configured, all MediaAgents associated with the partitions and the data path MediaAgent must be of same software
version.
If you plan to change the location of the DDB, you must first upgrade the MediaAgent hosting the deduplication database.
You can move DDB only to a MediaAgent with same or higher software version. Moving the DDB to a MediaAgent with older software version is not supported.
When upgrading MediaAgents that hosts the deduplication database (DDB) to v11, it is not required to upgrade the DDB because the older version DDB is
supported on v11 MediaAgent.
Disk Library Configured in the Installation Directory
If you created a disk library in the installation directory, change the mount path location and move all the library files to a new mount path. For instructions, see Moving
Mount Paths .
MediaAgents for Browse and Restore Operations in the Web Console
If you perform browse and restore operations in the Web Console, you must upgrade all the MediaAgents that are used by the Web Console. Otherwise, browse and
restore operations will not work properly. For example, the browse operation might not display deleted items.
Tape Libraries
If you have tapes mounted on the libraries attached to your MediaAgents, you must unmount the tapes from the drives for a successful upgrade.
Deduplication to Tape (Silo Storage)
For silo jobs to work, the data path MediaAgent associated with the source copy of a silo copy must have the same version as the CommServe computer.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Clients Configured with Client Side Deduplication
You must upgrade clients that are configured with Client Side Deduplication so that you can associate the clients with the partitioned DDB storage policy for backups.
If you do not plan to upgrade the clients, disable the Client Side Deduplication option from the Client Computer Properties dialog box, or use a storage policy without
a partitioned DDB.
Deduplication
If you disabled the Optimize Concurrent LAN Backups option on a UNIX client, the first backup will be a full backup, resulting in a lower deduplication ratio and a
large data transfer rate. A full backup is required due to deduplication enhancements on UNIX clients.
After a MediaAgent upgrade, the Enable Managed Disk Space for Disk Library option is not enabled for new deduplicated storage policies. If a deduplication policy
has this option enabled, and you need to update the policy properties, you will be asked to disable the option. For more information, see Thresholds for Managed
Disk Space .
If you disabled data compression for backups from database agents (such as DB2 or Oracle agents), after the upgrade of those database clients, you can enable
compression to achieve a good deduplication ratio.
Disk Space for Index Directory and Index Retention Criteria
The Index Directory requires at least 5% of your total storage space. Ensure that you have sufficient disk space for the Index Directory.
The default value for the index retention criteria is 15 days in the current Commvault version. Previously, the retention criteria was 35 days. If you configured a
different retention value, the value you configured is retained through the upgrade.
Because the Index Directory needs more space in this release, you need to set Retain index for n days to a value that will keep your Index Directory from running
out of space. To update the value, open the MediaAgent Properties dialog box in the CommCell Console and click the Catalog tab.
First Incremental Backup Requires More Time Due to Indexing Changes
The first incremental backup for a subclient will require additional time to complete because the MediaAgent has to convert the index of that subclient to a V11 format.
Libraries with I/E Port
If you used the nUseImpExpBitForImport additional setting to prevent exported media in I/E ports to be imported back to the library after a reset, you must enable the
option in the library properties.
For instructions, see Prevent Import of Exported Media after Resetting a Library .
Library and Drive Configuration
The Library and Drive Configuration tool is renamed and will appear as Expert Storage Configuration.
For more details, see Expert Storage Configuration - Overview .
Supported combinations for V9 Clients (for Backups) or V9 Source MediaAgent (for Auxiliary Copy)
Clients or Source MediaAgent Data Path MediaAgents DDB MediaAgents Is Supported
V9 V9 V9 Yes
V9 V9 V10 No
V9 V9 V11 No
V9 V10 V9 No
V9 V10 V10 Yes
V9 V10 V11 No
V9 V11 V9 No
V9 V11 V10 No
V9* V11 V11 Yes
* - If the DDB has multiple partitions, then only MediaAgent-side deduplication is supported. For a single partition DDB, the V9 client can perform the client
deduplication.
Supported combinations for V10 Clients (for Backups) or V11 Source MediaAgent (for Auxiliary Copy)
Clients or Source MediaAgent Data Path MediaAgents DDB MediaAgents Is Supported
V10 V9 V9 No
V10 V9 V10 No
V10 V9 V11 No
V10 V10 V9 No
V10 V10 V10 Yes
V10 V10 V11 No
V10 V11 V9 No
V10 V11 V10 No
V10 V11 V11 Yes
Supported combinations for V11 Clients (for Backups) or V11 Source MediaAgent (for Auxiliary Copy)
Clients or Source MediaAgent Data Path MediaAgents DDB MediaAgents Is Supported
V11 V9 V9 No
V11 V9 V10 No
V11 V9 V11 No
V11 V10 V9 No
V11 V10 V10 No
V11 V10 V11 No
V11 V11 V9 No
V11 V11 V10 No
V11 V11 V11 Yes
What to Do Next
Review postupgrade considerations, which include recommendations, notes, and other important information.
For V10 to V11
For V9 to V11
Note: Review general client considerations, such as cluster postupgrade notes. For more information, see the postupgrade considerations for clients (V10 to V11 | V9 to
V11 ).
Server
CommCell Console (V10 to V11 | V9 to V11 )
Compliance Search (V10 to V11 | V9 to V11 )
Metrics Reporting Server (V10 to V11 )
Search Engine (V10 to V11 | V9 to V11 )
Web Console (V10 to V11 | V9 to V11 )
Web Server (V10 to V11 | V9 to V11 )
File System
Data Classification for UNIX (V9 to V11 )
IBM i (V10 to V11 )
Macintosh File System (V10 to V11 )
OnePass for UNIX File System (V10 to V11 | V9 to V11 )
OnePass for Windows File System (V10 to V11 | V9 to V11 )
OpenVMS (V10 to V11 )
5/6/2017 Commvault Systems Page 289 of 587
UNIX File System (V10 to V11 | V9 to V11 )
Windows File System (V10 to V11 | V9 to V11 )
1-Touch for UNIX (V10 to V11 | V9 to V11 )
Virtualization
Virtual Server for Amazon (V10 to V11 )
Virtual Server for Citrix Xen (V10 to V11 )
Virtual Server for Microsoft Azure (V10 to V11 )
Virtual Server for Microsoft Hyper-V (V10 to V11 | V9 to V11 )
Virtual Server for VMware (V10 to V11 | V9 to V11 )
Database
DB2 (V10 to V11 | V9 to V11 )
Documentum (V10 to V11 | V9 to V11 )
MySQL (V10 to V11 )
Oracle (V10 to V11 | V9 to V11 )
Oracle RAC (V10 to V11 )
SAP HANA (V10 to V11 )
SAP for Oracle (V10 to V11 | V9 to V11 )
SAP MaxDB (V10 to V11 | V9 to V11 )
Applications
Exchange Server (V10 to V11 | V9 to V11 )
IBM Notes (V10 to V11 | V9 to V11 )
SharePoint Server (V9 to V11 )
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Browse from Backup Set Level Not Supported on Older Clients
If you decide not to upgrade a client, remember that if you modify the content of the default backup set, browse operations will not work from the backup set level.
To perform browse operations from the backup set level, you must upgrade the client. Otherwise, you can only browse from the subclient level.
Microsoft .NET Framework and Microsoft Visual C++
Some Commvault products use Microsoft .Net Framework and Visual C++. These third-party applications are also upgraded to meet the new Commvault version
requirements. During the upgrade, the services for the third-party applications are temporarily stopped.
If you have critical applications using the Microsoft .Net Framework and Visual C++, you should plan the upgrade accordingly. If needed, you can manually upgrade the
Microsoft applications before you start the Commvault upgrade.
User Groups on Macintosh Computers
If you are required to create a user group with permissions to upgrade the software, see Creating User Groups to Install or Upgrade Commvault on a Macintosh
Computer .
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Clients in a Cluster Environment
Read the following table and determine which considerations apply to your cluster environment:
Consideration Description
Cluster plug-in resource for Microsoft Clusters If a node lost its active or passive status, the cluster plug-in resource might be removed after the upgrade. Use the
following steps to recreate the cluster plug-in resource:
1. From the CommCell Browser, expand Client Computers, right-click the Cluster_Group_Client, and then click
Properties.
2. In the Client Computer Properties dialog box, click Advanced.
3. In the Advanced Client Properties dialog box, click the Cluster Group Configuration tab and then click the
Force Sync configuration on remote nodes check box to force the cluster configuration on the remote clients.
4. Click OK.
Cluster resource configuration You must configure the cluster resources after upgrading the following cluster environments:
Non-Microsoft Clusters
HP Scalable NAS/PolyServe Clusters
Failover Operations If a MediaAgent or other agent software fails to be upgraded on the active node of a Microsoft, Veritas, or HP
Scalable NAS/PolyServe Cluster, failover operations cannot be initiated.
Deduplication for Compressed Database Backups
If you disabled data compression for backups from database agents (such as DB2 or Oracle agents), after the upgrade of those database clients, you can enable
compression to achieve a good deduplication ratio.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade.
Java Runtime Environment (JRE) Requirements
Review the JRE requirements specified in System Requirements .
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
CommCell Console Shortcut Icons
If you have created or copied shortcuts for the CommCell Console on your desktop or Start menu, you should delete them and re-copy the new shortcut that was
created during the upgrade.
Web Administration Settings for the CommCell Console
If the CommCell Console was configured as a web application in the previous Commvault version, you must reconfigure the web administration settings for the
CommCell Console to work as a web application. For more information, see Web Administration for CommCell Console .
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Must Upgrade Web Server to Upgrade Compliance Search
In order to upgrade Compliance Search, you must also upgrade the Web Server used for Compliance Search.
New Features are Only Available for Review Sets Created in Version 11
One of the new features in the latest version of Compliance Search is the ability to perform keyword and faceted searches of data in review sets. However, this
functionality is only available for review sets that were created in V11. Although you can still view and recall data from the review sets that were created in a previous
version of Compliance Search, data in these review sets will not be searchable from within the review set.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Upgrading Review Sets
After you upgrade the Compliance Search and Web Server software, your existing review sets must be processed before you can edit them in V11. This processing is
handled automatically by the CommServe software. The duration of processing depends on the number of items in each review set. Before a review set has finished
being processed, you cannot view the data in the review set After processing, you may add or edit items in the upgraded review set, but new Compliance Search
features, such as the ability to search data within a review set, will only be available for review sets created in V11 Compliance Search.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Stop the DB2 Services on UNIX Clients before You Start the Upgrade
You must stop the DB2 services before you upgrade the Commvault software so that the DB2 log manager process uses the new Commvault VENDOR library.
This will prevent the following error from occurring during an online full backup job.
SQL2428N The BACKUP did not complete because one or more of the requested log files could not be retrieved
Assign the Deployment Permissions to the Agent
Determine the install type that you want to use and then assign the appropriate permissions. For information, see Deployment Permissions .
Postupgrade Considerations
In a Windows configuration, you must restart the DB2 services after the upgrade.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Services Restart After Upgrade
After upgrading the Windows client, restart the Oracle services. If services are not restarted, backup jobs will remain in pending state.
Preupgrade Considerations
Consider the following recommendations, prerequisites, and other important information before the upgrade.
Exchange Database Agent
Index Cache
In V11, an index cache is created. Make sure that you account for the index cache configuration and that you have enough space to accommodate the index cache.
Exchange Mailbox Archiver Agent
Deprecated Agent
This agent has been deprecated. You must deconfigure this agent before you upgrade the client. For more information, see the deprecation notice for the Exchange
Mailbox Archiver Agent .
Exchange Mailbox (Classic) Agent
Outlook Add-In Stub Recall
In version 11, the stub format has changed. In order to use these stubs, you must either install the latest updates for the version of the Outlook Add-In that is currently
installed on the client or upgrade to the version 11 Outlook Add-In.
Postupgrade Considerations
Consider the following recommendations, prerequisites, and other important information after the upgrade.
Exchange Compliance Archiver Agent
First Backup job
The first backup job after the upgrade creates a new index regardless of when the last one was created.
Exchange Database Agent
First Backup Job
The first backup job after the upgrade is converted to Full.
Exchange Mailbox (Classic) Agent
Append Option
The Append option in the When message exists area of the Restore Options for All Selected Items (General) dialog box is no longer available.
Outlook Add-In Stub Recall
After the Outlook Add-In is upgraded, you can continue to recall stubs that were created by the older Exchange Mailbox (Classic) Agent.
Configure the sEnableEmailPreviewV2 Additional Setting
To set up message reply and forwarding, after the Exchange Mailbox Agent is upgraded, you must set the sEnableEmailPreviewV2 additional setting to True. For
instructions, see Setting Up Message Reply .
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Notes Database Agent
Index Cache
In V11, an index cache is created. Make sure that you account for the index cache configuration and that you have enough space to accommodate the index cache.
Domino Mailbox Archiver Agent
Domino Server Shut Down
Shut down the Domino Server before the upgrade.
Find and Recover Not Supported
Find and Recover feature for IBM Notes Client Add-in is not supported after upgrading the CommServe to V11.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Notes Database Agent
First Backup Job
The first backup job after the upgrade is converted to Full.
Transaction Log Backup
You must perform a full backup operation on a subclient before starting a transaction log backup.
Notes Document Agent
Backup Jobs
After the upgrade, the backup jobs run incremental backups.
Domino Mailbox Archiver Agent
Domino Server Reboot
If .NET Framework is upgraded, reboot the client machine after the upgrade.
Backup Jobs
After the upgrade, the backup jobs run incremental backups in backup mode. In archive mode, the backup jobs continue to run in archive mode.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
The Instance Informix version must be updated in the CommCell Console
Verify that the Informix version for the instances (Instance Properties dialog box, General tab, INFORMIX Version) is the latest version. If it is not the latest version,
run a backup from the CommCell Console and make sure that the backup is successful.
Postupgrade Considerations
There is no additional information to consider after the upgrade.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Commvault Icons on Yosemite Clients
The icons for Commvault application have changed in V11. If you have a Macintosh client with the Yosemite version, the icons might not get updated immediately after
the upgrade. To resolve this problem, you might need to reset the Icon Services cache on the client. For more information, refer to the Apple documentation.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Use The Standard Upgrade Process
If your Private Metrics Reporting Server is already installed, along with an instance of the CommServe software, on a separate computer from your production
CommServe, then follow the standard upgrade process. For more information, see Upgrades .
If your Private Metrics Reporting Server is installed on your production CommServe, then follow the standard upgrade process for the CommServe. For more
information, see Upgrades .
Move the Private Metrics Reporting Server to a New Server
If you want to upgrade your Private Metrics Reporting Server, but you do not want to upgrade your CommServe software, then you must move the CVCloud database
to a different server, install the latest version of Metrics Reporting Server, and then upgrade the CVCloud database. For instructions, see Moving the Private Metrics
Reporting Server to a New Host .
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Create Backup Copies
Create backup copies for all snap backups before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Connect Windows 32-Bit Client to MySQL Server
Create additional setting sCommandMode on a Windows 32-bit client, and set its value as 1. This enables the client to create instance and run backups on the MySQL
server after upgrade.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Transition to OnePass
You must transition to OnePass for UNIX as described in Transitioning from a Version 10 Traditional Archiver Agent to Version 11 OnePass .
Upgrade on Solaris Clients
While upgrading on a Solaris platform, ensure that the cxfs mount points are not busy during upgrade. If the cxfs mount points are busy, it is recommended to reboot
the client computer.
If you do not wish to reboot the client computer, then follow these steps:
On the client computer, open the command prompt and type the following:
a. commvault stop
b. rem_drv cvfsf
c. unmounts fs
d. rem_drv cxhsm
e. commvault start
The newer driver will be loaded.
CXFS Upgrade Tool to Convert Old Stubs
Run the cxfs_upgrade tool located in the Base directory to upgrade the old cxfs stubs to the new stub format. Use the following command:
cxfs_upgrade -c cache_root -l log_file fs_dir
where:
cache_root is the location of the stub cache.
log_file is the location of the Commvault log file.
fs_dir is name of the volume for which you want to upgrade the stubs.
When you run an archive job, the cxfs_upgrade tool will run automatically.
Note: Stubs created by the previous version of the software will be recalled correctly even before cxfs_upgrade is run for the mount point. The cxfs_upgrade tool corrects
the size of the stubs.
Upgrade Not Supported for Red Hat Enterprise Linux AS 4.x
Upgrade is not supported for Red Hat Enterprise Linux AS 4.x version with 2.6.x kernel
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Delayed Stubbing Enabled After First Backup Job
After the first back job is run, delayed stubbing is automatically enabled on the client using the default value of three DR backups plus two days.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Transition to OnePass
You must transition to OnePass for Windows as described in Transitioning from a Version 10 Traditional Archiver Agent to Version 11 OnePass .
Requirements for the File Share Archiver Client package
If you have a standalone File Share Archiver Client installed in your environment, you must uninstall the package and then install the V11 File Share Archiver Client.
You can use the Microsoft Group Policy Object (GPO) feature to uninstall all the standalone File Share Archiver Clients. Create a batch file with the uninstallation
commands and then configure the GPO to run the batch file.
Based on the computer's operating system, the batch file must contain the following commands:
64-Bit Computers 32-Bit Computers
msiexec /x {AD432D13-3972-4403-942B-7F44EB16A2F6} /qn msiexec /x {EC3E0D47-45A5-4D4A-AF2A-9FF43CC9CBE2} /qn
msiexec /x {43EF52E0-FCDD-11DB-8C08-000D56A21C18} /qn msiexec /x {55012CC4-AFAB-11DA-829D-000D56A21C18} /qn
msiexec /x {43EF52E1-FCDD-11DB-8C08-000D56A21C18} /qn msiexec /x {55012CC5-AFAB-11DA-829D-000D56A21C18} /qn
The computer where the package is installed must establish connections with the CommServe computer. If the standalone File Share Archiver Client was installed in
decoupled mode, you must uninstall the package and then install the V11 File Share Archiver Client.
Before you upgrade the File Share Archiver Client, you must upgrade the CommServe, MediaAgent, and the proxy computer where the File System Agent is installed.
Proxy Computer Requirements for Fpolicy (OnePass for NetApp)
Your proxy computer must be Windows XP 64-bit or later. If the proxy computer runs on Windows XP 32-bit version or earlier, you cannot perform a recall operation
after the upgrade finishes.
Postupgrade Considerations
File Share Archiver Client installed with other packages
If the File Share Archiver Client is installed with other Commvault packages in decoupled mode, then after an upgrade, the packages continue to remain in decoupled mode.
Make sure that the computer where the package is installed establishes connections with the CommServe computer after the upgrade finishes.
Delayed Stubbing Enabled After First Backup Job
After the first back job is run, delayed stubbing is automatically enabled on the client using the default value of three DR backups plus two days.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Data Aging Requirements
If a backup piece has been manually deleted (or marked expired) in the Recovery Catalog, manually run the CROSSCHECK command and, if necessary, the DELETE
EXPIRED BACKUP command from RMAN before you run the data aging operation. This ensures that the CommServe database is properly synchronized with the
Recovery Catalog before before you run the data aging operation.
Restart Requirement for Oracle Services on Windows Clients
Oracle services must be restarted to prevent backup jobs from going into pending state. You must restart the services in the following scenarios:
The Oracle client was upgraded from the CommCell Console, and you did not use the option to restart the Oracle services (Restart Oracle/DB2 services (if
applicable) check box located on the Upgrade Software Options dialog box).
The Oracle client was upgraded locally by using the installation package.
Category Change for Additional Settings
In previous versions of the Commvault software, you can create an additional setting for Oracle that had CommServe as the Category in the Additional Settings dialog
box. After you upgrade, the software automatically pushes additional settings that were created at the CommServe level to all upgraded clients and any new clients that
you install after the upgrade. If you have an additional setting from the following list that you created before the upgrade, the software automatically pushes the
additional setting to new Oracle clients and changes the Category to Oracle Agent. For all new clients, create these additional setting at the client level with
OracleAgent as the Category:
sSKIPBACKUPBROWSE
sNOSBTLIBNAME
sIGNORE_RMAN_WARNINGLIST
sSNAPRESTORE
sRMANMAXOPENFILES
sDISABLE_ORA_USE_NEWBROWSE
nORATRACELEVEL
sRMANFILESPERSET
sSKIPLOGPAHSECFBACKUP
sORA_MERGE_INCREMENTAL_BACKUP_FORMAT
sORADISABLE_SWITCH_DATAFILE
IGNORE_IMPERSONATION
sIGNORERMANWARNINGS
sRMANOPTPERFFIX
sUSERMANSENDCMD
After the next browse, the software creates the additional settings on the client.
If you add a new additional setting to the CommServe after the first browse (which pushes the additional settings to the client), you must perform the following steps on
the client:
1. Go to CommvaultRegistry-> Commserv
2. Open the .properties file and add the sSyncOraRegKeysFromCommserv additional setting with a value of Y.
Note: If you need to remove any of the additional settings that are in the list and those additional settings have already been pushed to the client, you must remove
them from the CommServe and the clients.
Run the Check Readiness Report
You can use the Check Readiness report to verify that the client and MediaAgent are connected to the CommServe computer and that the database agents are properly
configured to run backup and restore jobs. For information on the report and how to run it, see Check Readiness for File System Clients and Database Clients -
Overview .
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Category Change for Additional Settings
In previous versions of the Commvault software, you can create an additional setting for Oracle that had CommServe as the Category in the Additional Settings dialog
box. After you upgrade, the software automatically pushes additional settings that were created at the CommServe level to all upgraded clients and any new clients that
you install after the upgrade. If you have an additional setting from the following list that you created before the upgrade, the software automatically pushes the
additional setting to new Oracle clients and changes the Category to Oracle Agent. For all new clients, create these additional setting at the client level with
OracleAgent as the Category:
sSKIPBACKUPBROWSE
sNOSBTLIBNAME
sIGNORE_RMAN_WARNINGLIST
sSNAPRESTORE
sRMANMAXOPENFILES
sDISABLE_ORA_USE_NEWBROWSE
nORATRACELEVEL
sRMANFILESPERSET
sSKIPLOGPAHSECFBACKUP
sORA_MERGE_INCREMENTAL_BACKUP_FORMAT
sORADISABLE_SWITCH_DATAFILE
IGNORE_IMPERSONATION
sIGNORERMANWARNINGS
sRMANOPTPERFFIX
sUSERMANSENDCMD
After the next browse, the software creates the additional settings on the client.
If you add a new additional setting to the CommServe after the first browse (which pushes the additional settings to the client), you must perform the following steps on
the client:
1. Go to CommvaultRegistry-> Commserv
2. Open the .properties file and add the sSyncOraRegKeysFromCommserv additional setting with a value of Y.
Note: If you need to remove any of the additional settings that are in the list and those additional settings have already been pushed to the client, you must remove
them from the CommServe and the clients.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
After you upgrade the client, refresh the instance properties. To refresh the SAP HANA instance, see Refreshing the SAP HANA Instance Properties After an Upgrade .
Discover the Tenant Databases for Multitenant Database Containers
Beginning in Service Pack 7, you can perform backup and restore operations on multitenant database containers from the CommCell Console.
After you upgrade the client to Service Pack 7, discover the tenant databases to ensure that your command line jobs do not fail. For information, see Manually Discovering
SAP HANA Databases .
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Category Change for Additional Settings
In previous versions of the Commvault software, you could create an additional setting that applied to clients by:
Adding an additional setting for a specific client from the CommCell Console
Adding an additional setting for a client group from the CommCell Console
Adding an entry in the registry key folder, for example HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance001\SAP.
If you added an additional setting for a specific client from the CommCell Console, the software automatically updates the additional settings that had SAP as the
Category to OracleSapAgent after the upgrade.
If you added additional settings for a client group from the CommCell Console, you must add the additional settings to the client group after the upgrade.
If you added the additional setting to the registry key folder, you must manually add the additional setting to the new location, for example,
HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance001\OracleSapAgent, after the upgrade.
Run the Check Readiness Report
You can use the Check Readiness report to verify that the client and MediaAgent are connected to the CommServe computer and that the database agents are properly
configured to run backup and restore jobs. For information on the report and how to run it, see Check Readiness for File System Clients and Database Clients -
Overview .
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Replace the new <install_location>\SapMaxDbAgent folder with the one prior to the upgrade.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
You Must Upgrade Search Engine Software on All Nodes of a Search Engine Cloud
For Search Engine Clouds, you must upgrade each Search Engine node to the latest version of the Search Engine software. In other words, you may not have Search
Engine clouds with mixed versions of the Search Engine software installed on the associated Search Engine nodes.
Postupgrade Considerations
There is no additional information to consider after the upgrade.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Transition to OnePass
You must transition to OnePass for UNIX as described in Transitioning from a Version 10 Traditional Archiver Agent to Version 11 OnePass .
Read Permissions for Other Users on AIX Computers
Before performing a remote upgrade on an AIX client computer, installed binaries should have read permissions for other users.
Use the following steps to add read permissions to other users:
1. Ensure that no jobs are running on any Commvault instance. You have to restart Commvault services for all instances to change the permissions.
2. On the command line, type the following command:
cvpkgchg
3. Type 2 and press Enter.
4. Select the type of permission that you want to assign to other users and press Enter.
5. Type Yes to change the permissions.
6. Restart Commvault services for all instances for the changes to take effect.
Wildcard Support for Subclient Content
If the CommServe is in the current version and the client is in the previous version, wildcard support for defining subclient content is limited to what is supported in the
previous version. For more information, refer documentation for the corresponding version.
Patch for Red Hat Enterprise Linux/CentOS 4.7 Clients
Download and install the patch from the following location on Red Hat Enterprise Linux/CentOS 4.7 clients prior to the upgrade.
https://rhn.redhat.com/errata/RHBA-2008-0650.html
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Virtualization Client Automatically Upgraded to V11 after a Proxy Upgrade
Ensure that all VSA proxies used by a virtualization client are upgraded at the same time, unless some of those proxies will only be used with a virtualization client for a
previous version.
After upgrading a VSA proxy to V11, a virtualization client that includes the proxy is automatically upgraded to V11.
If some proxies referred to by the virtualization client have not been upgraded, those proxies cannot be used for backup and restore operations in V11.
File level browse only displays V11 clients
In an environment that includes both V10 and V11 clients, only V11 clients are displayed when you perform a file-level browse.
V11 Required for VM Conversion
Conversion of virtual machines to Amazon is supported only in V11. To restore a virtual machine to Amazon , you must upgrade the Amazon virtualization client and at
least one proxy to V11.
No Backward Compatibility for VM Lifecycle Management
In a V11 CommCell environment, you cannot perform VM Lifecycle Management operations using a V9 or V10 Virtual Server agent. All Virtual Server agents must also be
upgraded to V11.
In addition, Web Console end users cannot create virtual machines using templates created using a V9 or V10 Virtual Server agent.
Reboot Required after Service Pack 4 Upgrade for Virtual Server Agent
The Virtual Server Agent upgrade for v11 Service Pack 4 includes .NET framework 4.5 for Windows machines. You must reboot VSA machines after .NET is installed.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Restores from Backups Using V11 Proxies
If a backup was performed using a V11 VSA proxy, you must select a V11 VSA proxy for the Proxy Client on the Restore Options for All Selected Items dialog box when
performing a restore operation.
Virtualization Client Automatically Upgraded to V11 after a Proxy Upgrade
Ensure that all VSA proxies used by a virtualization client are upgraded at the same time, unless some of those proxies will only be used with a virtualization client for a
previous version.
After upgrading a VSA proxy to V11, a virtualization client that includes the proxy is automatically upgraded to V11.
If some proxies referred to by the virtualization client have not been upgraded, those proxies cannot be used for backup and restore operations in V11.
File level browse only displays V11 clients
In an environment that includes both V10 and V11 clients, only V11 clients are displayed when you perform a file-level browse.
Reboot Required after Service Pack 4 Upgrade for Virtual Server Agent
The Virtual Server Agent upgrade for v11 Service Pack 4 includes .NET framework 4.5 for Windows machines. You must reboot VSA machines after .NET is installed.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Virtualization Client Automatically Upgraded to V11 after a Proxy Upgrade
Ensure that all VSA proxies used by a virtualization client are upgraded at the same time, unless some of those proxies will only be used with a virtualization client for a
previous version.
After upgrading a VSA proxy to V11, a virtualization client that includes the proxy is automatically upgraded to V11.
If some proxies referred to by the virtualization client have not been upgraded, those proxies cannot be used for backup and restore operations in V11.
File level browse only displays V11 clients
In an environment that includes both V10 and V11 clients, only V11 clients are displayed when you perform a file-level browse.
No Backward Compatibility for VM Lifecycle Management
In a V11 CommCell environment, you cannot perform VM Lifecycle Management operations using a V9 or V10 Virtual Server agent. All Virtual Server agents must also be
upgraded to V11.
In addition, Web Console end users cannot create virtual machines using templates created using a V9 or V10 Virtual Server agent.
Reboot Required after Service Pack 4 Upgrade for Virtual Server Agent
The Virtual Server Agent upgrade for v11 Service Pack 4 includes .NET framework 4.5 for Windows machines. You must reboot VSA machines after .NET is installed.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Restores from Backups Using V11 Proxies
If a backup was performed using a V11 VSA proxy, you must select a V11 VSA proxy for the Proxy Client on the Restore Options for All Selected Items dialog box when
performing a restore or Live Sync operation.
Virtualization Client Automatically Upgraded to V11 after a Proxy Upgrade
Ensure that all VSA proxies used by a virtualization client are upgraded at the same time, unless some of those proxies will only be used with a virtualization client for a
previous version.
After upgrading a VSA proxy to V11, a virtualization client that includes the proxy is automatically upgraded to V11.
If some proxies referred to by the virtualization client have not been upgraded, those proxies cannot be used for backup and restore operations in V11.
File level browse only displays V11 clients
In an environment that includes both V10 and V11 clients, only V11 clients are displayed when you perform a file-level browse.
Reboot Required after Service Pack 4 Upgrade for Virtual Server Agent
The Virtual Server Agent upgrade for v11 Service Pack 4 includes .NET framework 4.5 for Windows machines. You must reboot VSA machines after .NET is installed.
VSS Hardware Provider Requirement in V11 for IntelliSnap Windows 2008 R2
In V11 the Commvault VSS hardware provider is required for IntelliSnap backups. After a VSA proxy running Windows 2008 R2 is upgraded to V11, the VSS hardware
provider must be installed manually on the VSA proxy. If the VSS hardware provider is not installed, backups fail with the vsbkp.log message ?Commvault VSS Hardware
provider is required for running snap backup, but was not found on the host.?
Virtualize Me
After the CommServe system has been upgraded to V11, Virtualize Me jobs can run using a VSA proxy on V10 or V11.
No Backward Compatibility for VM Lifecycle Management
In a V11 CommCell environment, you cannot perform VM Lifecycle Management operations using a V9 or V10 Virtual Server agent. All Virtual Server agents must also be
upgraded to V11.
In addition, Web Console end users cannot create virtual machines using templates created using a V9 or V10 Virtual Server agent.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Restores from Backups Using V11 Proxies
If a backup was performed using a V11 VSA proxy, you must select a V11 VSA proxy for the Proxy Client on the Restore Options for All Selected Items dialog box when
performing a restore or Live Sync operation.
Virtualization Client Automatically Upgraded to V11 after a Proxy Upgrade
Ensure that all VSA proxies used by a virtualization client are upgraded at the same time, unless some of those proxies will only be used with a virtualization client for a
previous version.
After upgrading a VSA proxy to V11, a virtualization client that includes the proxy is automatically upgraded to V11.
If some proxies referred to by the virtualization client have not been upgraded, those proxies cannot be used for backup and restore operations in V11.
File level browse only displays V11 clients
In an environment that includes both V10 and V11 clients, only V11 clients are displayed when you perform a file-level browse.
Reboot Required after Service Pack 4 Upgrade for Virtual Server Agent
The Virtual Server Agent upgrade to v11 Service Pack 4 includes .NET framework 4.5 (for Windows machines) and the latest VDDK driver (for VMware). You must reboot
VSA machines after these components are installed.
VMDK Short Name Requirement for Backward Compatibility
By default, V11 uses short names for virtual machine disk (VMDK) files, while V9 or V10 used full names. After upgrading a Virtual Server Agent (VSA) proxy, MediaAgent,
or 3dfs server to V11, you must create the bUseIndexNameForVMDK additional setting to support backward compatibility:
Configure this setting on the 3dfs server or MediaAgent if the 3dfs server or MediaAgent is running V9 or V10 and the VSA proxy has been upgraded to V11.
Configure this setting on the VSA proxy and 3dfs server or MediaAgent if the VSA proxy is running V9 or V10 and the 3dfs server or MediaAgent has been upgraded
to V11.
If both the VSA proxy and the 3dfs server or MediaAgent are running V9 or V10, the additional setting is only required if you encounter issues with long VMDK names.
Live Browse of ext4 with 3dfs Server on MediaAgent Rather Than File Recovery Enabler for Linux
After upgrading a VSA proxy to V11, Live Browse operations on ext4 file systems will, by default, start 3dfs services on the MediaAgent that performed the backup rather
than on a File Recovery Enabler for Linux. This is different behavior than in V10, where a File Recovery Enabler would be used if one was configured.
Virtualize Me
After the CommServe system has been upgraded to V11, Virtualize Me jobs can run using a VSA proxy on V10 or V11.
For Virtualize Me operations where the target is VMware, the VSA proxy must be V11 or V10 Service Pack 12 or later.
No Backward Compatibility for VM Lifecycle Management
In a V11 CommCell environment, you cannot perform VM Lifecycle Management operations using a V9 or V10 Virtual Server agent. All Virtual Server agents must also be
upgraded to V11.
In addition, Web Console end users cannot create virtual machines using templates created using a V9 or V10 Virtual Server agent.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Tomcat Configuration Files and Certificates
If you configured the Web Console for secured connections (to use HTTPS instead of HTTP), save your Tomcat custom configuration files and certificates before the
upgrade.
Context Changes in the server.xml File
If you made changes to the <context> element in the server.xml file, save the file before the upgrade.
Web Console Is Not Backward Compatible
The Web Console must be upgraded as soon as the CommServe is upgraded.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Tomcat Configuration Files and Certificates
If you configured the Web Console for secured connections (to use HTTPS instead of HTTP) and you saved the Tomcat custom configuration files and certificates, do the
following:
Merge the existing Tomcat configuration files with your saved configuration files
Place the saved certificates in the software_installation_path/Apache directory
If you did not save the files and certificates before upgrading and you need to reconfigure HTTPS, see Configuring Secure Access .
Context Changes in the server.xml File
Merge the existing server.xml file with your saved server.xml file.
Change the Web Console URL Link in the CommCell Console
The link to the Web Console from the CommCell Console might need to be updated in the following scenarios:
The Web Console is installed on multiple computers and the link is not the computer where the Web Console was installed first.
Multiple Web Console computers are upgraded and the link is not the Web Console computer that was upgraded first.
For instructions on changing the Web Console URL link in the CommCell Console, see Linking to the Web Console from the CommCell Console .
MediaAgents for Browse and Restore Operations in the Web Console
After the Web Server and Web Console upgrade, if you perform browse and restore operations in the Web Console, you must upgrade all of the MediaAgents that are
used by the Web Console. Otherwise, browse and restore operations will not work properly.
No Backward Compatibility for VMware and Amazon Virtual Machine Templates
In the Virtual Machines application, you cannot create VMware or Amazon virtual machines using templates from a V9 or V10 Virtual Server agent. In a V11 CommCell
environment, users must create VMware or Amazon virtual machines using templates from V11 Virtual Server agents.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Web Server Is Not Backward Compatible
The Web Server must be upgraded as soon as the CommServe is upgraded.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
MediaAgents for Browse and Restore Operations in the Web Console
After the Web Server and Web Console upgrade, if you perform browse and restore operations in the Web Console, you must upgrade all of the MediaAgents that are
used by the Web Console. Otherwise, browse and restore operations will not work properly.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Enabling Block-Level Backups
By default, block-level backup options are not available on upgraded clients. If you have a large number of clients to be upgraded, contact Customer Support.
Note: If you have created a snapshot copy without enabling the spool copy in the previous version, you must enable spool copy after the upgrade finishes. For more
information, see Snapshot Copy and Enabling Spool Copy .
To enable block-level backups, use the following steps:
1. Make sure that there are no pending, suspended, or running jobs for the client computer.
2. Disable backups for the client computer. For more information on disabling jobs, see Enabling or Disabling CommCell Activities .
3. Upgrade the client computer to Indexing Version 2. For instructions, see Upgrading Client Indexing with the Upgrade to Indexing V2 Workflow .
4. Log out and log in to the CommCell Console.
5. Configure a separate backup set for block-level backups. For more information, see Creating a User-Defined Backup Set for the Windows File System Agent.
6. Configure a Windows File system subclient for performing block-level backups.
For instructions, see Configuring a Subclient for Block-Level Backups for the Windows File System Agent.
7. After half an hour of running the command on the client computer, enable backups for the client. For more information on disabling jobs, see Enabling or Disabling
CommCell Activities .
File System Core Package Retention Settings
In previous Commvault versions, the retention was 730 days for computers where you installed the standalone File System Core package. After the upgrade, the
retention is changed to 0 days. If the retention was set to a number other than 730, the upgrade process retains the retention settings for the subclient.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Backward Compatibility of 1-Touch Server on UNIX
1-Touch agents are not backward compatible and must be upgraded to the current version as soon as the CommServe is upgraded.
Solaris 1-Touch Boot Server Upgrade
While upgrading the Solaris 1-Touch boot server, follow these instructions if the JumpStart server version is Solaris 10.0 Update 8 or lower:
1. Uninstall the 1-Touch Agent.
2. Install the JumpStart server using a Solaris 10.0 Update 8 or higher DVD.
3. Upgrade Commvault software.
4. Install the 1-Touch Agent and give the new location of the JumpStart server.
5. From the CommCell Console, update the existing clients with the new location of the JumpStart server.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
1-Touch Restores
After the upgrade, we recommend to perform a new backup of the client. Once the data is backed up, you can proceed to perform an 1-Touch offline restore.
For more information on restoring data post-upgrade, see Restoring Data Post-Upgrade from a 1-Touch Computer .
1-Touch for Solaris
You must configure a remote cache for Solaris packages in the /jumpstart_directory/files directory. For more information, see Setting Up a Remote Cache .
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following important information after the upgrade:
Restoring Data from a 1-Touch Computer
After you upgrade the CommServe computer, we recommend that you upgrade the MediaAgent and Client. Run a new backup using the Version 11 1-Touch Live CD or
Virtualize Me.
However, if the recommendation does not work for you, refer to the following table and choose the scenario that applies to your environment.
Note: Restoring data is supported for upgrades from V10 to V11. If you upgraded from V9, you must run a full backup before you restore the data.
Scenarios Offline Interactive Recovery Offline Non-Interactive Recovery Virtualize Me
Only CommServe is upgraded If the MediaAgent is not upgraded, then Not supported Not supported
you cannot create a version 11 Live CD. In
that case, you can use version 10 Live CD
to restore the client. Contact your
software provider for more information.
If you perform the recovery using
Version 10 Live CD, all new features from
Version 11 will not be supported.
CommServe and MediaAgent are 1. Download the ISO file from the Cloud 1. Download the ISO file from the Cloud 1. Download the ISO file from the Cloud
upgraded Services website and create a new Services website and create a new Services website and create a new
Version 11 Live CD to boot the client Version 11 Live CD to boot the client Version 11 Live CD to boot the client
computer. For more information, see computer. For more information, see computer. For more information, see
Preparing for Recovery - 1-Touch for Preparing for Recovery - 1-Touch for Preparing for Recovery - 1-Touch for
Windows. Windows . Windows .
2. Start the Offline Interactive recovery 2. Start the Offline Non-Interactive 2. Start the recovery of the client.
of the client. recovery of the client.
CommServe, MediaAgent, and client are 1. Download the ISO file from the Cloud 1. Download the ISO file from the Cloud 1. Download the ISO file from the Cloud
upgraded Services website and create a new Services website and create a new Services website and create a new
Before running the first backup Version 11 Live CD to boot the client Version 11 Live CD to boot the client Version 11 Live CD to boot the client
computer. For more information, see computer. For more information, see computer. For more information, see
Preparing for Recovery - 1-Touch for Preparing for Recovery - 1-Touch for Preparing for Recovery - 1-Touch for
Windows . Windows . Windows .
2. Start the Offline Interactive recovery 2. Start the Offline Non-Interactive 2. Start the recovery of the client.
of the client. recovery of the client.
3. Reboot the client computer after the
3. Reboot the client computer after the 3. Reboot the client computer after the restore is completed successfully.
restore is completed successfully. restore is completed successfully.
4. Uninstall the Commvault software
4. Uninstall the Commvault software 4. Uninstall the Commvault software from the client.
from the client. from the client.
5. Logon to the CommCell Console and
5. Logon to the CommCell Console and 5. Logon to the CommCell Console and release the license of the client.
release the license of the client. release the license of the client. However, do not delete the client
However, do not delete the client However, do not delete the client from the CommCell.
from the CommCell. from the CommCell.
6. Install latest version of the
6. Install latest version of the 6. Install latest version of the Commvault software on the client.
Commvault software on the client. Commvault software on the client.
CommServe, MediaAgent, and client are All new features supported for Version All new features supported for Version All new features supported for Version
upgraded 11 will be available from the Commvault 11 will be available from the Commvault 11 will be available from the Commvault
After running the first backup software. software. software.
CommServe, MediaAgent, and client are 1. Download the ISO file from the Cloud 1. Download the ISO file from the Cloud 1. Download the ISO file from the Cloud
upgraded Services website and create a new Services website and create a new Services website and create a new
After running the first backup but Version 11 Live CD to boot the client Version 11 Live CD to boot the client Version 11 Live CD to boot the client
data has to be restored from an computer. For more information, see computer. For more information, see computer. For more information, see
older version backup Preparing for Recovery - 1-Touch for Preparing for Recovery - 1-Touch for Preparing for Recovery - 1-Touch for
Windows . Windows . Windows .
2. Start the Offline Interactive recovery 2. Start the Offline Non-Interactive 2. Start the recovery of the client.
of the client. recovery of the client.
3. Reboot the client computer after the
3. Reboot the client computer after the 3. Reboot the client computer after the restore is completed successfully.
restore is completed successfully. restore is completed successfully.
4. Uninstall the Commvault software
4. Uninstall the Commvault software 4. Uninstall the Commvault software from the client.
from the client. from the client.
5. Logon to the CommCell Console and
5. Logon to the CommCell Console and 5. Logon to the CommCell Console and release the license of the client.
5/6/2017 Commvault Systems Page 322 of 587
release the license of the client. release the license of the client. However, do not delete the client
However, do not delete the client However, do not delete the client from the CommCell.
from the CommCell. from the CommCell.
6. Install latest version of the
6. Install latest version of the 6. Install latest version of the Commvault software on the client.
Commvault software on the client. Commvault software on the client.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Browse from Backup Set Level Not Supported on Older Clients
If you decide not to upgrade a client, remember that if you modify the content of the default backup set, browse operations will not work from the backup set level.
To perform browse operations from the backup set level, you must upgrade the client. Otherwise, you can only browse from the subclient level.
Clients in a Cluster Environment
Cluster configurations have undergone major changes in V11. To upgrade your cluster group client (known as virtual server or virtual node in V9), you must upgrade all
the physical nodes that are part of the cluster group. Use the installation package to run the upgrade locally on each physical node.
When all the physical nodes are upgraded, the cluster group that is displayed in the CommCell Console will be updated to reflect the latest version.
Microsoft .NET Framework and Microsoft Visual C++
Some Commvault products use Microsoft .Net Framework and Visual C++. These third-party applications are also upgraded to meet the new Commvault version
requirements. During the upgrade, the services for the third-party applications are temporarily stopped.
If you have critical applications using the Microsoft .Net Framework and Visual C++, you should plan the upgrade accordingly. If needed, you can manually upgrade the
Microsoft applications before you start the Commvault upgrade.
User Groups on Macintosh Computers
If you are required to create a user group with permissions to upgrade the software, see Creating User Groups to Install or Upgrade Commvault on a Macintosh
Computer .
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Clients in a Cluster Environment
Read the following table and determine which considerations apply to your cluster environment:
Consideration Description
Run backup jobs on physical nodes Physical nodes are in a deconfigured state. This means that you cannot back up the data that resides on the
physical nodes.
If you want to run backup jobs, perform the following operations for each physical node:
Note: Your CommCell environment must have available licenses for the physical nodes. Contact your software
provider if you need additional licenses.
1. Release the license.
From the CommCell Browser, expand Client Computers, right-click the physical_node, click All Tasks > Release
License for Client/MediaAgent and follow the prompts.
2. Reconfigure the client.
From the CommCell Browser, expand Client Computers, right-click the physical_node, click All Tasks >
Reconfigure and follow the prompts.
Cluster plug-in resource for Microsoft Clusters If a node lost its active or passive status, the cluster plug-in resource might be removed after the upgrade. Use the
following steps to recreate the cluster plug-in resource:
1. From the CommCell Browser, expand Client Computers, right-click the Cluster_Group_Client, and then click
Properties.
2. In the Client Computer Properties dialog box, click Advanced.
3. In the Advanced Client Properties dialog box, click the Cluster Group Configuration tab and then click the
Force Sync configuration on remote nodes check box to force the cluster configuration on the remote clients.
4. Click OK.
Cluster resource configuration You must configure the cluster resources after upgrading the following cluster environments:
Non-Microsoft Clusters
HP Scalable NAS/PolyServe Clusters
Failover Operations If a MediaAgent or other agent software fails to be upgraded on the active node of a Microsoft, Veritas, or HP
Scalable NAS/PolyServe Cluster, failover operations cannot be initiated.
Commvault on a Decommissioned V9 Cluster If you uninstalled Commvault version 9 from a cluster client before or after the CommServe upgrade, you can
Client reinstall Commvault using the cluster client definitions stored in the CommServe database.
In version 11, cluster clients are referred to as "cluster group clients". Use the following steps to reinstall the
software on the cluster group client:
1. Install the required Commvault packages on each of the physical nodes.
Note: During the installation, you will be asked to provide the names of both the physical nodes and cluster
servers.
2. From the CommCell Browser pane of the CommCell Console, expand Client Computers, right click the
Cluster_Group_Client and click Properties.
3. In the Client Computer Properties dialog box, click Advanced.
4. In the Advanced Client Properties dialog box, click the Cluster Group Configuration tab and then select the
Force Sync configuration on remote nodes check box.
5/6/2017 Commvault Systems Page 324 of 587
5. Click OK.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Java Runtime Environment (JRE) Requirements
Review the JRE requirements specified in System Requirements .
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
CommCell Console Shortcut Icons
If you have created or copied shortcuts for the CommCell Console on your desktop or Start menu, you should delete them and re-copy the new shortcut that was
created during the upgrade.
Web Administration Settings for the CommCell Console
If the CommCell Console was configured as a web application in the previous Commvault version, you must reconfigure the web administration settings for the
CommCell Console to work as a web application. For more information, see Web Administration for CommCell Console .
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Version 9 Web Client is Now Web Server and Compliance Search
In V9, Compliance Search and Web Console were features included in the Web Client software. Since V10, Compliance Search has been a stand-alone software. During
the upgrade, your V9 Web Client software will be replaced with V11 Compliance Search and Web Console software.
New Features are Only Available for Review Sets Created in Version 11
One of the new features in the latest version of Compliance Search is the ability to perform keyword and faceted searches of data in review sets. However, this
functionality is only available for review sets that were created in V11. Although you can still view and recall data from the review sets that were created in a previous
version of Compliance Search, data in these review sets will not be searchable from within the review set.
Features from Version 9 Deprecated in Version 11
Some Compliance Search features that were available in V9 have been deprecated in V10 and V11. These feature are not available after an upgrade:
Lemmatization
Synonyms
Find Similar
Remove Duplicates
Recent Searches
ERM
Filters
Entity Search
Refinements by Keyword
Limited Language Support
Content Director Policy
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Upgrading Review Sets
After you upgrade the Compliance Search and Web Server software, your existing review sets must be processed before you can edit them in V11. This processing is
handled automatically by the CommServe software and should only take a few seconds to complete for each review set. However, before a review set has been
processed, the data in the review set will be read only. After processing, you may add or edit items in the upgraded review set, but new Compliance Search features,
such as the ability to search data within a review set, will only be available for review sets created in V11 Compliance Search.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
QSnap Support
If the CommServe is in the current version and the client is in the previous version, QSnap cannot be used as a snap engine for ContinuousDataReplicator on UNIX. LVM
will always be used as a snap engine.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Data Synchronization
Optimized Sync is not enabled by default after upgrade. To include the new or modified files which do not match the destination files, select Include files that do not
match with destination copy option. For step-by-step instructions, see Add a Replication Pair .
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Stop the DB2 Services on UNIX Clients before You Start the Upgrade
You must stop the DB2 services before you upgrade the Commvault software so that the DB2 log manager process uses the new Commvault VENDOR library.
This will prevent the following error from occurring during an online full backup job.
SQL2428N The BACKUP did not complete because one or more of the requested log files could not be retrieved
Restart Requirement for DB2 Services on Windows Clients
If you plan to upgrade the client from the CommCell Console, make sure to select the Restart Oracle/DB2 services (if applicable) check box located on the Upgrade
Software Options dialog box. If the DB2 services are running during the upgrade, Commvault stops the services, and then restarts the services after the upgrade.
Postupgrade Considerations
There is no additional information to consider after the upgrade.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Services Restart After Upgrade
After upgrading the Windows client, restart the Oracle services. If services are not restarted, backup jobs will remain in pending state.
Preupgrade Considerations
Consider the following recommendations, prerequisites, and other important information before the upgrade.
Exchange Database Agent
Index Cache
In V11, an index cache is created. Make sure that you account for the index cache configuration and that you have enough space to accommodate the index cache.
Exchange Mailbox Archiver Agent
Deprecated Agent
This agent has been deprecated. You must deconfigure this agent before you upgrade the client. For more information, see the deprecation notice for the Exchange
Mailbox Archiver Agent .
Exchange Mailbox (Classic) Agent
Outlook Add-In Stub Recall
In version 11, the stub format has changed. In order to use these stubs, you must either install the latest updates for the version of the Outlook Add-In that is currently
installed on the client or upgrade to the version 11 Outlook Add-In.
Outlook Add-In
Version 9 of Outlook Add-In is uninstalled automatically.
Settings that you configured in version 9 are carried forward to version 11.
Some features that are available in version 9 are no longer available in version 11. For more information, see Transitioning from Exchange Mailbox Archiver Agent to
OnePass for Exchange Mailbox (Classic) .
Postupgrade Considerations
Consider the following recommendations, prerequisites, and other important information after the upgrade.
Exchange Compliance Archiver Agent
First Backup job
The first backup job after the upgrade creates a new index regardless of when the last one was created.
Exchange Database Agent
First Backup Job
The first backup job after the upgrade is converted to Full.
Exchange 2013 and Exchange 2016
After you upgrade the agent, you must manually change the Exchange Version in the agent's Properties dialog box to the appropriate version (either Exchange 2013 or
Exchange 2016).
Exchange Mailbox (Classic) Agent
Append Option
The Append option in the When message exists area of the Restore Options for All Selected Items (General) dialog box is no longer available.
Outlook Add-In Stub Recall
After the Outlook Add-In is upgraded, you can continue to recall stubs that were created by the older Exchange Mailbox (Classic) Agent.
Configure the sEnableEmailPreviewV2 Additional Setting
To set up message reply and forwarding, after the Exchange Mailbox Agent is upgraded, you must set the sEnableEmailPreviewV2 additional setting to True. For
instructions, see Setting Up Message Reply .
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Notes Database Agent
Index Cache
In V11, an index cache is created. Make sure that you account for the index cache configuration and that you have enough space to accommodate the index cache.
Domino Mailbox Archiver Agent
Domino Server Shut Down
Shut down the Domino Server before the upgrade.
Client Access License (CAL) Replaces Traditional License
CAL is required for protected and archived mailboxes. License consumption depends on the number of mailboxes and data size.
Find and Recover Not Supported
Find and Recover feature for IBM Notes Client Add-in is not supported after upgrading the CommServe to V11.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Notes Database Agent
First Backup Job
The first backup job after the upgrade is converted to Full.
Transaction Log Backup
You must perform a full backup operation on a subclient before starting a transaction log backup.
Notes Document Agent
Low Deduplication Ration for First Few Backups
After the upgrade, the first few backups may display lower deduplication ratio. After running a few backup jobs, the deduplication ratio increases.
Backup Jobs
After the upgrade, the backup jobs run incremental backups.
Domino Mailbox Archiver Agent
Domino Server Reboot
If .NET Framework is upgraded, reboot the client machine after the upgrade.
Backup Jobs
After the upgrade, the backup jobs run incremental backups in backup mode. In archive mode, the backup jobs continue to run in archive mode.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
The Instance Informix version must be updated in the CommCell Console
Verify that the Informix version for the instances (Instance Properties dialog box, General tab, INFORMIX Version) is the latest version. If it is not the latest version,
run a backup from the CommCell Console and make sure that the backup is successful.
Postupgrade Considerations
There is no additional information to consider after the upgrade.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Connect Windows 32-Bit Client to MySQL Server
Create additional setting sCommandMode on a Windows 32-bit client, and set its value as 1. This enables the client to create instance and run backups on the MySQL
server after upgrade.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Transition to OnePass
You must transition to OnePass for UNIX as described in Transitioning from a V9 Traditional Archiver Agent to V11 OnePass .
Upgrade on Solaris Clients
While upgrading on a Solaris platform, ensure that the cxfs mount points are not busy during upgrade. If the cxfs mount points are busy, it is recommended to reboot
the client computer.
If you do not wish to reboot the client computer, then follow these steps:
On the client computer, open the command prompt and type the following:
a. commvault stop
b. rem_drv cvfsf
c. unmounts fs
d. rem_drv cxhsm
e. commvault start
The newer driver will be loaded.
CXFS Upgrade Tool to Convert Old Stubs
Run the cxfs_upgrade tool located in the Base directory to upgrade the old cxfs stubs to the new stub format. Use the following command:
cxfs_upgrade -c cache_root -l log_file fs_dir
where:
cache_root is the location of the stub cache.
log_file is the location of the Commvault log file.
fs_dir is name of the volume for which you want to upgrade the stubs.
When you run an archive job, the cxfs_upgrade tool will run automatically.
Note: Stubs created by the previous version of the software will be recalled correctly even before cxfs_upgrade is run for the mount point. The cxfs_upgrade tool corrects
the size of the stubs.
Upgrade Not Supported for Red Hat Enterprise Linux AS 4.x
Upgrade is not supported for Red Hat Enterprise Linux AS 4.x version with 2.6.x kernel
Postupgrade Considerations
There is no additional information to consider after the upgrade.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Transition to OnePass
You must transition to OnePass for Windows as described in Transitioning from a V9 Traditional Archiver Agent to V11 OnePass .
Requirements for the File Share Archiver Client package
If you have a standalone File Share Archiver Client installed in your environment, you must uninstall the package and then install the V11 File Share Archiver Client.
You can use the Microsoft Group Policy Object (GPO) feature to uninstall all the standalone File Share Archiver Clients. Create a batch file with the uninstallation
commands and then configure the GPO to run the batch file.
Based on the computer's operating system, the batch file must contain the following commands:
64-Bit Computers 32-Bit Computers
msiexec /x {AD432D13-3972-4403-942B-7F44EB16A2F6} /qn msiexec /x {EC3E0D47-45A5-4D4A-AF2A-9FF43CC9CBE2} /qn
msiexec /x {43EF52E0-FCDD-11DB-8C08-000D56A21C18} /qn msiexec /x {55012CC4-AFAB-11DA-829D-000D56A21C18} /qn
msiexec /x {43EF52E1-FCDD-11DB-8C08-000D56A21C18} /qn msiexec /x {55012CC5-AFAB-11DA-829D-000D56A21C18} /qn
The computer where the package is installed must establish connections with the CommServe computer. If the standalone File Share Archiver Client was installed in
decoupled mode, you must uninstall the package and then install the V11 File Share Archiver Client.
Before you upgrade the File Share Archiver Client, you must upgrade the CommServe, MediaAgent, and the proxy computer where the File System Agent is installed.
Proxy Computer Requirements for Fpolicy (OnePass for NetApp)
Your proxy computer must be Windows XP 64-bit or later. If the proxy computer runs on Windows XP 32-bit version or earlier, you cannot perform a recall operation
after the upgrade finishes.
Postupgrade Considerations
File Share Archiver Client installed with other packages
If the File Share Archiver Client is installed with other Commvault packages in decoupled mode, then after an upgrade, the packages continue to remain in decoupled mode.
Make sure that the computer where the package is installed establishes connections with the CommServe computer after the upgrade finishes.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Data Aging Requirements
We recommend that you manually run a CROSSCHECK and, if necessary, DELETE EXPIRED BACKUP from RMAN prior to running a data aging operation, in cases where
a backup piece has been manually deleted (or marked expired) in the Recovery Catalog. Otherwise, the CommServe database is not made aware of the change and it
would become out of sync with the Recovery Catalog. This manual task ensures that the CommServe database is properly synchronized with the Recovery Catalog
before data aging is run.
Restart Requirement for Oracle Services on Windows Clients
Oracle services must be restarted to prevent backup jobs from going into pending state. You must restart the services in the following scenarios:
The Oracle client was upgraded from the CommCell Console, and you did not use the option to restart the Oracle services.
The Oracle client was upgraded locally by using the installation package.
Table Restores
After upgrading the client and the MediaAgent to the current version, the table restore from Version 8 client backup fails. Use the following post-upgrade steps to
prevent table restore failures:
1. From the CommCell Browser, navigate to Client Computers.
2. Right-click the Client to be configured and then click Properties.
3. Click Advanced.
4. Click the Advanced Settings tab and then click Add.
5. In the Name field, type sDISABLE_ORA_USE_NEWBROWSE .
6. In the Value field, type Y.
7. Click OK to save the key.
8. Click OK.
Solaris Configuration
If you upgrade the Oracle Agent in a Solaris configuration and you use the SQLNET_EXPIRETIME parameter in sqlnet.ora, perform the following steps:
1. Shut down the Oracle database and listener.
2. Edit the sysliblist file in the $ORACLE_HOME/lib directory and add -lthread and -lpthread at the beginning of the file.
For example, -lthread -lpthread -lnsl -lsocket -lgen -ldl -lsched
3. Start the Oracle database and listener.
Category Change for Additional Settings
In previous versions of the Commvault software, you can create an additional setting for Oracle that had CommServe as the Category in the Additional Settings dialog
box. After you upgrade, the software automatically pushes additional settings that were created at the CommServe level to all upgraded clients and any new clients that
you install after the upgrade. If you have an additional setting from the following list that you created before the upgrade, the software automatically pushes the
additional setting to new Oracle clients and changes the Category to Oracle Agent. For all new clients, create these additional setting at the client level with
OracleAgent as the Category:
sSKIPBACKUPBROWSE
sNOSBTLIBNAME
sIGNORE_RMAN_WARNINGLIST
sSNAPRESTORE
sRMANMAXOPENFILES
sDISABLE_ORA_USE_NEWBROWSE
nORATRACELEVEL
sRMANFILESPERSET
sSKIPLOGPAHSECFBACKUP
sORA_MERGE_INCREMENTAL_BACKUP_FORMAT
sORADISABLE_SWITCH_DATAFILE
IGNORE_IMPERSONATION
sIGNORERMANWARNINGS
sRMANOPTPERFFIX
sUSERMANSENDCMD
After the next browse, the software creates the additional settings on the client.
If you add a new additional setting to the CommServe after the first browse (which pushes the additional settings to the client), you must perform the following steps on
the client:
1. Go to CommvaultRegistry-> Commserv
2. Open the .properties file and add the sSyncOraRegKeysFromCommserv additional setting with a value of Y.
Note: If you need to remove any of the additional settings that are in the list and those additional settings have already been pushed to the client, you must remove
them from the CommServe and the clients.
Jobs Converted to Full
If you configure the Table Browse option, or the IntelliSnap option on a subclient, and then perform an upgrade, the software automatically converts the next
immediate backup job to a full backup.
Run the Check Readiness Report
You can use the Check Readiness report to verify that the client and MediaAgent are connected to the CommServe computer and that the database agents are properly
configured to run backup and restore jobs. For information on the report and how to run it, see Check Readiness for File System Clients and Database Clients -
Overview .
5/6/2017 Commvault Systems Page 338 of 587
5/6/2017 Commvault Systems Page 339 of 587
Upgrade Considerations for the Oracle RAC Agent (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Category Change for Additional Settings
In previous versions of the Commvault software, you can create an additional setting for Oracle that had CommServe as the Category in the Additional Settings dialog
box. After you upgrade, the software automatically pushes additional settings that were created at the CommServe level to all upgraded clients and any new clients that
you install after the upgrade. If you have an additional setting from the following list that you created before the upgrade, the software automatically pushes the
additional setting to new Oracle clients and changes the Category to Oracle Agent. For all new clients, create these additional setting at the client level with
OracleAgent as the Category:
sSKIPBACKUPBROWSE
sNOSBTLIBNAME
sIGNORE_RMAN_WARNINGLIST
sSNAPRESTORE
sRMANMAXOPENFILES
sDISABLE_ORA_USE_NEWBROWSE
nORATRACELEVEL
sRMANFILESPERSET
sSKIPLOGPAHSECFBACKUP
sORA_MERGE_INCREMENTAL_BACKUP_FORMAT
sORADISABLE_SWITCH_DATAFILE
IGNORE_IMPERSONATION
sIGNORERMANWARNINGS
sRMANOPTPERFFIX
sUSERMANSENDCMD
After the next browse, the software creates the additional settings on the client.
If you add a new additional setting to the CommServe after the first browse (which pushes the additional settings to the client), you must perform the following steps on
the client:
1. Go to CommvaultRegistry-> Commserv
2. Open the .properties file and add the sSyncOraRegKeysFromCommserv additional setting with a value of Y.
Note: If you need to remove any of the additional settings that are in the list and those additional settings have already been pushed to the client, you must remove
them from the CommServe and the clients.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Restart Requirement for Oracle Services on Windows Clients with the SAP Oracle Agent
On Windows client computers, Oracle services must be restarted after the upgrade to load the Commvault Media Library for data protection. Therefore, plan the
upgrade accordingly.
Use the remote, local or unattended method to upgrade the SAP for Oracle clients. You must manually restart the Oracles services on the client.
Postupgrade Considerations
Category Change for Additional Settings
In previous versions of the Commvault software, you could create an additional setting that applied to clients by:
Adding an additional setting for a specific client from the CommCell Console
Adding an additional setting for a client group from the CommCell Console
Adding an entry in the registry key folder, for example HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance001\SAP.
If you added an additional setting for a specific client from the CommCell Console, the software automatically updates the additional settings that had SAP as the
Category to OracleSapAgent after the upgrade.
If you added additional settings for a client group from the CommCell Console, you must add the additional settings to the client group after the upgrade.
If you added the additional setting to the registry key folder, you must manually add the additional setting to the new location, for example,
HKEY_LOCAL_MACHINE\SOFTWARE\CommVault Systems\Galaxy\Instance001\OracleSapAgent, after the upgrade.
Run the Check Readiness Report
You can use the Check Readiness report to verify that the client and MediaAgent are connected to the CommServe computer and that the database agents are properly
configured to run backup and restore jobs. For information on the report and how to run it, see Check Readiness for File System Clients and Database Clients -
Overview .
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Replace the new <install_location>\SapMaxDbAgent folder with the one prior to the upgrade.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
The FAST Content Indexing Engine Has Been Replaced by the SOLR Search Engine
The FAST Content Indexing Engine used in previous releases was replaced by a new SOLR Search Engine in version 10. To upgrade a version 9 Content Indexing Engine
to the current Search Engine, you must:
1. Install one or more v11 Search Engines in your environment. See Installing the Search Engine .
2. Configure content indexing and re-associate the content indexing storage policies from your v9 Content Indexing Engines to the new Search Engines. See
Configuration - Search Engine .
New data will be content indexed by the new Search Engines, and your old data will be searchable from your FAST Content Indexing Engines until it has been pruned
according to your data aging rules.
3. Gradually re-pick your old content indexing jobs, which will be content indexed again by the new Search Engines. See Advanced Configuration - Search Engine .
4. After all of your data has been content indexed by the new Search Engine, you may uninstall your FAST Content Indexing Engines.
FAST Content Indexing Engines are Search-Only in V11
You may only search your data that was content indexed with a version 9 FAST Content Indexing Engine. No new data can be content indexed with a version 9 Content
Indexing Engine in version 11.
Enhancements are Not Available for Data Content Indexed with a FAST Content Indexing Engine
Search enhancements and new features might not be available when using data that was content indexed with a version 9 FAST Content Indexing Engine. All new
enhancements require a version 11 Search Engine to content index the data.
Content Indexing Filters
Prior to running a Content Indexing operation, you can set filters at the storage policy level to prevent specific type of files from being content indexed. In the previous
version of the Search Engine, filters were applied to both file system and email attachment data. After upgrading, filters created in setups using the FAST Search Engine
are still applied to both file system and email attachment data. However, filters created in setups with the current SOLR Search Engine installed are only applied to file
system data. Refer to Advanced Configuration - Search Engine for more information.
Usage Based Licensing
Search Engine licensing is now usage based. When you upgrade from the FAST Content Indexing Engine, your existing licenses will automatically convert to usage based
licenses. The upgraded license will have an available document count based on your pre-upgraded license.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Number of Content Indexed Documents
In the current release, details for content indexing jobs include the number of folders that were indexed as well as the number of documents. The number of folders
indexed is added to the total number of items indexed, so this number might be higher after you upgrade the Search Engine.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
SharePoint Site Collection Backupset
Due to the presence of the new Site Collection backupset in V11, consider these points after upgrading the SharePoint Server Agent:
Define the database subclient content again after upgrading.
Back up the sites using the Site Collection backupsets in V11.
Scheduled Incremental Backups
Incremental backups scheduled in V9 are converted to full backups after upgrading to V11.
Save As Script for Restore
Recreate the Save As Script for restoring SharePoint documents after upgrading the SharePoint Server Agent.
Browse V9 Data
To browse data backed up in V9, specify the End Time as a time before the completion of upgrade.
Backing Up a Remote SQL Database with the SQL Server Agent
After upgrading the software from V9 to V11, do not back up the remote SQL databases with the SharePoint Server Agent. Instead, back up the remote SQL databases
using the SQL Server Agent.
Configuring Subclient to Back Up Content Databases
After upgrading the software from V9 to V11, configure the existing subclients by selecting new content that you want to include in the subclient.
Restoring from V9 Client Backup
After upgrading the software from V9 to V11, restores from the V9 client backup fails. Install V9 SharePoint Agent as a second instance and perform the restore
operation from the V11 instance to the V9 instance as destination.
For more information, see Restoring from the Backup Copy of a Version 9 Client .
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Wildcard Support for Subclient Content
If the CommServe is in the current version and the client is in the previous version, wildcard support for defining subclient content is limited to what is supported in the
previous version. For more information, refer to the documentation for the corresponding version.
Patch for Red Hat Enterprise Linux/CentOS 4.7 Clients
Download and install the patch from the following location on Red Hat Enterprise Linux/CentOS 4.7 clients prior to the upgrade.
https://rhn.redhat.com/errata/RHBA-2008-0650.html
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Virtualization Client Automatically Upgraded to V11 after a Proxy Upgrade
Ensure that all VSA proxies used by a virtualization client are upgraded at the same time, unless some of those proxies will only be used with a virtualization client for a
previous version.
After upgrading a VSA proxy to V11, a virtualization client that includes the proxy is automatically upgraded to V11.
If some proxies referred to by the virtualization client have not been upgraded, those proxies cannot be used for backup and restore operations in V11.
VMDK Short Name Requirement for Backward Compatibility
By default, V11 uses short names for virtual machine disk (VMDK) files, while V9 or V10 used full names. After upgrading a Virtual Server Agent (VSA) proxy, MediaAgent,
or 3dfs server to V11, you must create the bUseIndexNameForVMDK additional setting to support backward compatibility:
Configure this setting on the 3dfs server or MediaAgent if the 3dfs server or MediaAgent is running V9 or V10 and the VSA proxy has been upgraded to V11.
Configure this setting on the VSA proxy and 3dfs server or MediaAgent if the VSA proxy is running V9 or V10 and the 3dfs server or MediaAgent has been upgraded
to V11.
If both the VSA proxy and the 3dfs server or MediaAgent are running V9 or V10, the additional setting is only required if you encounter issues with long VMDK names.
Virtualize Me
After the CommServe system has been upgraded to V11, Virtualize Me jobs can run using a VSA proxy on V10 or V11.
For Virtualize Me operations where the target is VMware, the VSA proxy must be V11 or V10 Service Pack 12 or later.
No Backward Compatibility for VM Lifecycle Management
In a V11 CommCell environment, you cannot perform VM Lifecycle Management operations using a V9 or V10 Virtual Server agent. All Virtual Server agents must also be
upgraded to V11.
In addition, Web Console end users cannot create virtual machines using templates created using a V9 or V10 Virtual Server agent.
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Virtualization Client Automatically Upgraded to V11 after a Proxy Upgrade
Ensure that all VSA proxies used by a virtualization client are upgraded at the same time, unless some of those proxies will only be used with a virtualization client for a
previous version.
After upgrading a VSA proxy to V11, a virtualization client that includes the proxy is automatically upgraded to V11.
If some proxies referred to by the virtualization client have not been upgraded, those proxies cannot be used for backup and restore operations in V11.
VSS Hardware Provider Requirement in V11 for IntelliSnap Windows 2008 R2
In V11 the Commvault VSS hardware provider is required for IntelliSnap backups. After a VSA proxy running Windows 2008 R2 is upgraded to V11, the VSS hardware
provider must be installed manually on the VSA proxy. If the VSS hardware provider is not installed, backups fail with the vsbkp.log message ?Commvault VSS Hardware
provider is required for running snap backup, but was not found on the host.?
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Tomcat Configuration Files and Certificates
If you configured the Web Console for secured connections (to use HTTPS instead of HTTP), save your Tomcat custom configuration files and certificates before the
upgrade.
Context Changes in the server.xml File
If you made changes to the <context> element in the server.xml file, save the file before the upgrade.
Web Client and CommServe on the Same Computer
If the Web Client is installed on the CommServe computer, it cannot be upgraded.
Perform the following steps before you upgrade the Web Client:
1. Uninstall the Web Client from the CommServe computer.
2. Install the Web Client (using Version 9 software) on a different client computer. For instructions, see Install the Web Client .
Note: For a successful upgrade, make sure the client that you choose does not have the Content Indexing Engine.
3. Upgrade the Web Server.
Web Console Is Not Backward Compatible
The Web Console must be upgraded as soon as the CommServe is upgraded.
Windows Server 2003 Editions is Deprecated
The Web Console is no longer supported on computers running Windows Server 2003 editions. To review the supported operating systems, see System Requirements
.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Tomcat Configuration Files and Certificates
If you configured the Web Console for secured connections (to use HTTPS instead of HTTP) and you saved the Tomcat custom configuration files and certificates, do the
following:
Replace the existing Tomcat configuration files with your saved configuration files
Place the saved certificates in the software_installation_path/Apache directory
If you did not save the files and certificates before upgrading and you need to reconfigure HTTPS, see Configuring Secured Access .
Context Changes in the server.xml File
Merge the existing server.xml file with your saved server.xml file.
Web Console URL Link in the CommCell Console
The link to the Web Console from the CommCell Console might need to be updated in the following scenarios:
The Web Console is installed on multiple computers and the link is not the computer where the Web Console was installed first.
Multiple Web Console computers are upgraded and the link is not the Web Console computer that was upgraded first.
For instructions on changing the Web Console URL link in the CommCell Console, see Linking to the Web Console from the CommCell Console .
MediaAgents for Browse and Restore Operations in the Web Console
After the Web Server and Web Console upgrade, if you perform browse and restore operations in the Web Console, you must upgrade all of the MediaAgents that are
used by the Web Console. Otherwise, browse and restore operations will not work properly.
No Backward Compatibility for VMware Virtual Machine Templates
In the Virtual Machines application, you cannot create VMware virtual machines using templates from a V9 or V10 Virtual Server agent. In a V11 CommCell environment,
users must create VMware virtual machines using templates from V11 Virtual Server agents.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Web Server Is Not Backward Compatible
The Web Server must be upgraded as soon as the CommServe is upgraded.
Windows Server 2003 Editions is Deprecated
The Web Server is no longer supported on computers running Windows Server 2003 editions. To review the supported operating systems, see System Requirements .
You must decommission the Web Server on the 32-bit computer and install a new Web Server on a 64-bit computer.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
MediaAgents for Browse and Restore Operations in the Web Console
After the Web Server and Web Console upgrade, if you perform browse and restore operations in the Web Console, you must upgrade all of the MediaAgents that are
used by the Web Console. Otherwise, browse and restore operations will not work properly.
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Number of Objects Backed Up Appears Higher on a Client with Older Version of the Software
If you upgrade the CommServe and the MediaAgent, but you decide to keep the client in the previous version, the backups that you run for the client will display a high
number of objects in the Job Details dialog box. This is because the parent folders of files that are not changed are also considered in the backup.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
Changes in the Phases of a Backup Job
To speed up backups, Commvault ends the backup job after the scan phase if no files are changed or added in the subclient. The backup and archive index phases are
not performed.
After the client upgrade, the option to speed up the backups is not enabled. To enable the option, you must create the SkipEmptyBackup key in the gxGlobalParam
table as described in the following steps:
1. From the CommCell Browser, right-click <CommServe> and point to Properties.
2. Click the Additional Settings tab.
3. Click Add.
4. In the Name box, type SkipEmptyBackup.
5. Select CommServDB.GXGlobalParam from the Category list.
6. Select INTEGER from the Type list.
7. In the Value box, type 1.
8. Click OK twice.
If you need to disable the key later, set its value to 0.
Out of Place Restores to Older Clients are not Supported
Backed up data from upgraded clients cannot be restored to clients from older Commvault versions.
Enabling Block-Level Backups
By default, block-level backup options are not available on upgraded clients. If you have a large number of clients to be upgraded, contact Customer Support.
Note: If you have created a snapshot copy without enabling the spool copy in the previous version, you must enable spool copy after the upgrade finishes. For more
information, see Snapshot Copy and Enabling Spool Copy .
To enable block-level backups, use the following steps:
1. Make sure that there are no pending, suspended, or running jobs for the client computer.
2. Disable backups for the client computer. For more information on disabling jobs, see Enabling or Disabling CommCell Activities .
3. Upgrade the client computer to Indexing Version 2. For instructions, see Upgrading Client Indexing with the Upgrade to Indexing V2 Workflow .
4. Log out and log in to the CommCell Console.
5. Configure a separate backup set for block-level backups. For more information, see Creating a User-Defined Backup Set for the Windows File System Agent.
6. Configure a Windows File system subclient for performing block-level backups.
For instructions, see Configuring a Subclient for Block-Level Backups for the Windows File System Agent.
7. After half an hour of running the command on the client computer, enable backups for the client. For more information on disabling jobs, see Enabling or Disabling
CommCell Activities .
Preupgrade Considerations
Consider the following recommendations, notes, and other important information before the upgrade:
Backward Compatibility of 1-Touch Server on UNIX
1-Touch agents are not backward compatible and must be upgraded to the current version as soon as the CommServe is upgraded.
Solaris 1-Touch Boot Server Upgrade
While upgrading the Solaris 1-Touch boot server, follow these instructions if the JumpStart server version is Solaris 10.0 Update 8 or lower:
1. Uninstall the 1-Touch Agent.
2. Install the JumpStart server using a Solaris 10.0 Update 8 or higher DVD.
3. Upgrade Commvault software.
4. Install the 1-Touch Agent and give the new location of the JumpStart server.
5. From the CommCell Console, update the existing clients with the new location of the JumpStart server.
Postupgrade Considerations
Consider the following recommendations, notes, and other important information after the upgrade:
1-Touch Restores
After the upgrade, we recommend to perform a new backup of the client. Once the data is backed up, you can proceed to perform an 1-Touch offline restore.
For more information on restoring data post-upgrade, see Restoring Data Post-Upgrade from a 1-Touch Computer .
Preupgrade Considerations
There is no additional information to consider before the upgrade.
Postupgrade Considerations
There is no additional information to consider after the upgrade.
What to Do Next
Verify that backup and restore operations run as expected for the clients that you upgraded. For more information, see Postupgrade Verification Tests for Backup and
Restore Operations .
Review the postupgrade considerations for the Commvault software that was upgraded in your clients. If you do not see your agent or product in the following list, it
means that it does not have any considerations to review.
Note: Review general client considerations, such as cluster postupgrade notes. For more information, see the postupgrade considerations for clients (V10 to V11 | V9
to V11 ).
Server
CommCell Console (V10 to V11 | V9 to V11 )
Compliance Search (V10 to V11 | V9 to V11 )
Search Engine (V10 to V11 | V9 to V11 )
Web Console (V10 to V11 | V9 to V11 )
Web Server (V10 to V11 | V9 to V11 )
File System
OnePass for Windows File System (V10 to V11 | V9 to V11 )
Windows File System (V10 to V11 | V9 to V11 )
1-Touch for Windows (V10 to V11 | V9 to V11 )
1-Touch for UNIX (V10 to V11 | V9 to V11 )
Virtualization
Virtual Server for Amazon (V10 to V11 )
Virtual Server for Citrix Xen (V10 to V11 )
Virtual Server for Microsoft Azure (V10 to V11 )
Virtual Server for Microsoft Hyper-V (V10 to V11 | V9 to V11 )
Virtual Server for VMware (V10 to V11 | V9 to V11 )
Database
Documentum (V10 to V11 | V9 to V11 )
Oracle (V10 to V11 | V9 to V11 )
Oracle RAC (V10 to V11 )
SAP HANA (V10 to V11 )
Applications
Exchange Server (V10 to V11 | V9 to V11 )
IBM Notes (V10 to V11 | V9 to V11 )
SharePoint Server (V9 to V11 )
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Upgrade Software.
2. In the Upgrade Software Options dialog box, expand Client Computers and select the clients that you want to upgrade.
Notes:
If you upgrade the software on a cluster environment, upgrade all the physical nodes of the cluster.
If you want to upgrade clients that belong to a specific group (such as a laptop client group), expand Client Computer Groups and select the group to be upgraded.
3. Refer to the following table to select the options that are applicable to your clients:
Client's Operating
Option System When to Use It?
Reboot Client Windows, UNIX, Linux If the Commvault software installed on the client requires a reboot after the upgrade, select this
option to ensure the successful completion of the upgrade process.
The Commvault software determines whether a reboot is required.
Restart Oracle/DB2 services (if Windows If the DB2, Documentum, Oracle, or SAP Oracle agents are installed on the client, select this option
applicable) to restart Oracle or DB2 services and to make sure that backup operations work properly.
The Commvault software determines whether a reboot is required.
4. Choose whether to save the installation as a script:
To run the upgrade job, click OK.
Based on your selections, the job runs immediately, or the job is scheduled to run at the time you configured.
When the upgrade job starts, you can track the progress of the job from the Job Controller window (CommCell Console ribbon > Home tab > Job
Controller).
If the upgrade job fails, see Upgrades - Troubleshooting to review common upgrade failures and their corresponding resolutions.
What to Do Next?
If you are a user with administrative rights in the CommCell, you can generate a report to review a summary of all the upgrade jobs that ran in the CommCell Console.
1. From the CommCell Console ribbon, click the Reports tab and then click Summary.
2. In the Report Selection dialog box (General tab), click Administrative Jobs > Install/Upgrade/Remove/Repair Software, and then click Run.
For more information on the report, see Administrative Job Summary Report .
Procedure
1. Log on to the computer where you saved the script.
2. At the command line, go to the Installation_Directory_Path/Base directory and run the following command to log on to the CommServe database:
qlogin -cs commserve_host_name -u user_name
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
In a cluster environment, log on to the physical node of the cluster as an Administrator or as a member of the Administrator group on that computer.
2. Run Setup.exe from the installation package.
The installation wizard opens.
3. On the welcome page, select the I Agree check box and proceed to the next page.
4. If you have multiple instances installed, the Install Instance Selection page is displayed. Select the instance that you want to upgrade, and proceed to the next page.
Remember: Instances operate independently of each other. Every instance has its own set of software binaries and services.
5. On the Confirm Upgrade page, proceed to the next page to start the upgrade process.
6. On the upgrade completion page, click Finish.
Notes:
If you are upgrading the software in a cluster environment, repeat the upgrade procedure for each physical node on the cluster.
To help you troubleshoot errors that occur during the upgrade, check the installation logs in the Software_Installation_Directory\Log Files directory.
Procedure
1. Log on to the computer as root.
In a cluster environment, log on to a physical node of the cluster as root.
2. Run the following command from the installation package or mount point:
./cvpkgadd
To run the installation as a SUDO user with root privileges, use the following command:
sudo ./cvpkgadd
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
2. From the command prompt, go to the location where the installation package resides, find the Setup.exe file, and run the following command:
The following table describes other parameters that you can add to the upgrade command (when applicable):
Parameter Name Description
/inst The Commvault instance that you want to upgrade, for example, Instance002. Use this parameter if the computer has more than one
instance.
Specify the parameter along with the instance number. For example: /inst Instance002.
/ForceReboot Reboots the computer, if required by the software.
The Commvault software determines whether a reboot is required to finish the upgrade process.
/CopyLog Copies the log files to a different location after the upgrade. By default, the log files are stored in the Software_Installation_Directory\Log
Files directory.
Specify the parameter along with the location where you want to copy the log files. For example: /CopyLog C:\Data\MyLogs.
Example: If you want to upgrade the software on Instance002, and enable the option to automatically reboot (if required) as well as to copy the log files to a custom log
folder, then use the following command:
Setup.exe /upgrade /silent /inst Instance002 /ForceReboot /CopyLog C:\Data\MyLogs
Notes:
If you are upgrading the software in a cluster environment, repeat the upgrade procedure for each physical node on the cluster.
To verify that the upgrade was successful, run the following command to retrieve the exit code:
echo %error level%
The following are valid exit code values: 0 (Successful), 1 (Failed), 2 (Cancelled), 3 (Needs Reboot), and 4 (Needs Log Off).
Procedure
1. Log on to the computer as root.
In a cluster environment, log on to a physical node of the cluster as root.
2. Run the following command from the installation package or mount point:
./silent_install -upgrade Instance_nnn
where Instance_nnn is the Commvault instance that you want to upgrade. For example, Instance002.
If the computer has only one instance, specify Instance001.
Notes:
If you are upgrading the software in a cluster environment, repeat the upgrade procedure for each physical node on the cluster.
To verify that the upgrade was successful, run the following command to retrieve the exit code:
echo $?
If the exit code is 0, the upgrade was successful. A value other than 0 means that there was a problem with the upgrade operation. For more information, refer to the
logs.
Procedure
1. Start the Download Manager application, select where to extract the installation files, and then click Extract.
The installation wizard opens.
2. On the welcome page, select the I Agree check box and proceed to the next page.
3. If you have multiple instances installed, the Install Instance Selection page is displayed. Select the instance that you want to upgrade and proceed to the next page.
Remember: Instances operate independently of each other. Every instance has its own set of software binaries and services.
4. On the Confirm Upgrade page, proceed to the next page to start the upgrade process.
5. On the upgrade completion page, click Finish.
Notes:
If you are upgrading the software in a cluster environment, repeat the upgrade procedure for each physical node on the cluster.
To help you troubleshoot errors that occur during the upgrade, check the installation logs in the Software_Installation_Directory\Log Files directory.
Server UNIX / Linux / UNIX / Linux / Upgrade using the Upgrade using the Windows Windows -
Macintosh - Local Macintosh - Silent CommCell Console Download Manager - Local Silent
CommServe
MediaAgent
CommCell Console
Web Console
Web Server
Backup UNIX / Linux / UNIX / Linux / Upgrade using the Upgrade using the Windows Windows -
Macintosh - Local Macintosh - Silent CommCell Console Download Manager - Local Silent
Active Directory
DB2
DB2 MultiNode
Documentum
Image Level *
Informix
Lotus Notes Database
Lotus Notes Document
Macintosh File System
Microsoft Exchange Database
Microsoft Exchange Mailbox
Microsoft Exchange Public
Folder
Microsoft SharePoint Server
Microsoft SQL Server
Microsoft Windows File Systems
MySQL
NAS
OES File System
Oracle
Oracle RAC
PostgreSQL
SAP for MAXDB
SAP for Oracle
Sybase
UNIX File Systems
Archive UNIX / Linux / UNIX / Linux / Upgrade using the Upgrade using the Windows Windows -
Macintosh - Local Macintosh - Silent CommCell Console Download Manager - Local Silent
Domino Mailbox Archiver
Exchange Compliance Archiver
Exchange Mailbox Archiver **
Exchange Public Folder Archiver
File Archiver for BlueArc **
File Archiver for Celerra **
File Archiver for NetApp **
File Archiver for UNIX **
1-Touch Server
* This product is deprecated in this release. However, you can upgrade the product to the current software version for data recovery operations only.
** This product is deprecated in this release. You must deconfigure this product before you upgrade the client. After you upgrade the client, you can perform data recovery
operations with this deconfigured product, but you cannot perform archiving jobs.
For more information, see End-of-Life, Deprecated and Extended Support - Products .
UPG0003: Upgrade may fail with Microsoft SQL Server installation error (Unable to locate log
file)
Symptom
You might receive the following error during the upgrade of a Commvault package that uses the Microsoft SQL Server software:
Setup failed to locate the log file associated with the silent install of MSSQL at location. <C:>\Program Files\Microsoft SQL Server\110\SetupBootstrap\Log\Summary.txt
Resolution
1. Click OK to close the error prompt. This will abort the upgrade program.
2. Reboot your computer.
3. Resume the upgrade by running Setup.exe. The upgrade program will automatically resume from the point it was aborted.
UPG0004: DB2 Online Backup Fails with SQL2428N error After Upgrading Commvault
Issue
The DB2 online backup fails.
Symptom
The following error message is received when an online backup is performed.
SQL2428N The BACKUP did not complete because one or more of the requested log files could not be retrieved
Resolution
The DB2 Services need to be restarted to clear the API information cached by the db2logmgr process. After the restart, retry the backup.
Cause
During the upgrade operation, the Windows installer verifies whether the profile directory is accessible while performing the MSI installation. The upgrade operation will fail
if the profile directory is not accessible.
Resolution
Make sure that the profile directory is accessible, and then start the upgrade operation.
For more information, refer to the Microsoft Knowledge Base article http://support.microsoft.com/kb/327763 .
After resolving the above issue, ensure that the client is registered in the CommCell Console.
Current installation has issues and cannot be upgraded Login into client computer
Run ./cvpkgrm and uninstall the current instance.
Make sure CommvaultRegistry is not available under /etc folder.
Install the software using the CommCell Console. For more information, see Installing
Commvault Software Remotely Using the CommCell Console .
After resolving the above issue, ensure that the client is registered in the CommCell Console.
You are unable to determine the problem and require a Delete the Commvault install directory.
cleanup Delete logs directory located at /var/log/ContentStore.
Remove the registry using the following command:
rm ?rf /etc/CommVaultRegistry
Cause
When the remote upgrade detects pending registry keys to be renamed as a result of a failed installation of a component.
Resolution
1. Click Finish.
2. If you know the component that could not be successfully installed, uninstall the component from the Add/Remove Programs from the Windows Control Panel.
3. If you do not know the component that could not be successfully installed, contact Customer Support.
Cause
One of the files within the Commvault installation directory may be open.
Resolution
1. Click OK to the error prompt. This will abort the upgrade program.
2. Navigate to the software installation directory and delete it.
3. Resume the upgrade by running the Setup.exe. The upgrade program will automatically resume from the point it was aborted.
In a cluster, upgrade failed to retrieve the instance name of the active node
Symptom
The upgrade fails with the following error message:
Failed to get instance name from active node.
Cause
A passive node upgrade is performed before upgrading the active node.
Resolution
1. Perform the upgrade on the active node first.
2. The upgrade program provides the option to automatically upgrade the passive nodes when the active node is upgraded. You can choose the option to automatically
upgrade the passive nodes or manually upgrade the passive nodes after upgrading the active node.
Cause
The upgrade program failed to rename the ORASBT.DLL file on the remote client.
Resolution
Manually rename or delete occurrences of ORASBT.DLL within the SYSTEM PATH environment variable and continue installation locally.
Resolution 1
Perform the following steps:
Click Reboot Now to restart the computer.
When the computer restarts, use the same user account to log on to the computer.
The upgrade program will automatically resume when you log back on.
Prompt 2
<Software> Setup has detected that a few security privileges were not set for the current user. These administrative privileges have been successfully granted. But in order that these administrative privileges take
5/6/2017 Commvault Systems Page 370 of 587
effect, a log-off is required.
Would you like Setup to log-off your computer now?
Resolution 2
Log off and then log back on using the same user account. The upgrade program will automatically resume.
The following rights are necessary for performing the upgrade:
Right to increase quotas
Right to act as part of the operating system
Right to replace a process level token
Prompt 3
<Software> Setup has detected that a few security privileges were not set for the current user. These administrative privileges have been successfully granted. But in order that these administrative privileges take
effect, a log-off is required. Setup also recommends (although not necessary) that you reboot this computer before continuing the installation.
Press the 'Log Off' or the 'Reboot Now' button to continue. <Software> Setup will resume automatically.
Resolution 3
If the option to log off is displayed with the Reboot Now option, the upgrade program may have assigned the necessary rights to your account to perform the upgrade,
and also found files that need to be replaced.
We recommend you to reboot the computer at this point. The upgrade program will automatically resume after the reboot.
Cause
You may see the error message when you reboot the system, after applying the Microsoft SQL Server Service Pack. The error is triggered because the SQL Server service
fails to start or is in the process of getting started.
Resolution
1. Once the SQL Server services are up and running, click Yes to continue.
2. If the SQL Server services fails to start, manually start the services and then click Yes to continue with the upgrade.
Cause
When the SQL Server Service Pack upgrade fails during the CommServe database upgrade.
Resolution
1. Click OK and exit the upgrade.
2. Resume the upgrade process.
Cause
The local security policy settings of the CommServe database does not comply with the Microsoft SQL Server upgrade.
The error may occur if the local security policy of the CommServe database has been changed to restrict the passwords to more than 8 characters only. (SQL server
upgrade uses internal password of 8 characters.)
Resolution
1. Click OK to exit the upgrade.
2. Change the Local Security settings to allow passwords of 8 characters or less.
3. Restart the upgrade software and continue with the upgrade.
Upgrade failed due to CommServe database files residing in the software installation path
Symptom
The upgrade fails with the following error message:
Setup determined that the CommServe Database path is located inside the <software install path>. Setup needs to delete the <software install path> as part of the Upgrade process. You must first move the
CommServe Database path using SQL Enterprise Manager before you can continue the Upgrade.
Cause
The CommServe database files are located in the Commvault installation directory.
Resolution
1. Click OK to the error prompt. This will abort the upgrade program.
2. Stop the services on the CommServe computer. (See Stopping a Service on Windows for step-by-step instructions.)
3. Open SQL Server Management Studio and detach the database using the following steps:
Right click the CommServe database.
Select All tasks and then select Detach Database.
4. Create a new directory in another location and copy the database files.
5. In SQL Server Management Studio attach the database to this new location using the following steps:
Right click the CommServe database.
Select All Tasks and then Attach Database.
Select sqladmin_cv as the owner of database.
6. Start the services. (See Starting a Service on Windows for step-by-step instructions.)
7. Resume the upgrade by running Setup.exe. The upgrade program will automatically resume from the point it was aborted.
Cause
Application window is open in the remote client computer.
Resolution
Close the application window and then re-run the upgrade (remotely or locally).
Upgrade Failed due to communication problems between the CommServe and remote client
Symptom
The upgrade fails with following error messages:
Error Message 1
Upgrade failed. No response during time out.
Error Message 2
Unable to verify connectivity with the CommServe.
Cause
There may be a communication failure between the CommServe and the client computer.
Resolution
Check your network to see if the client computer is accessible. For more information, refer to Client Connectivity .
Verify that the services are running in both the CommServe and the client computers.
Upgrade failed due to an open software file or folder on the remote client
Symptom
The upgrade fails with the following error message:
Failed to delete the ContentStore folder.
Cause
Application window is open in the remote client computer.
Resolution
If you do not remember the password of the 'sa' user, you can reset the password as follows:
1. Open the Microsoft SQL Server Management Studio.
2. In the Connect to Server dialog box, select Windows Authentication from the Authentication box to log on to the SQL Server using your Windows credentials.
3. From the Object Explorer pane, navigate to <Server Instance> and expand Security | Logins.
4. Right-click sa and then click Properties.
5. In the Login Properties - sa dialog box, specify a new password in the Password and Confirm password check boxes.
6. Click OK and close the Microsoft SQL Server Management Studio.
7. Resume the CommServe upgrade and specify the new password in the SQL User Password page of the wizard.
Cause
The error message may be displayed if there is insufficient disk space in the following locations:
The location hosting the Operating Systems? temp directory.
The location in which the Commvault installation directory is located.
Resolution
1. Click Cancel to abort the upgrade.
2. Make sure that you have sufficient disk space on the volumes in which the Operating Systems? temp directory resides and the software installation directory. Disk
space requirements are listed in System Requirements .
3. Re-run the upgrade.
Cause
Some programs or services such as IIS might be running in the background.
Resolution
1. Close all applications and disable any programs that run automatically, including antivirus, screen savers and system utilities. Some programs, including antivirus
software, may be running as a service. Stop and disable all non-essential services. You can re-enable them after the upgrade.
2. Click Retry.
After you click the Ignore button, then the upgrade fails again with the following error message:
Setup failed to install Visual C++ Runtime Libraries. Refer to CommvaultInstallerLog.txt for more information.
Cause
The upgrade program detects an earlier version of Microsoft VC++ Redistributables.
Resolution
Reboot the machine and resume the upgrade process.
Cause
Oracle services could not be automatically stopped by the upgrade program.
Resolution
Stop the Oracle services manually and continue the upgrade locally.
Cause
The software upgrade was performed using a mapped network drive, and the computer was rebooted during the upgrade process. Subsequently, after resuming the
upgrade, the mapped network drive was different than the drive that was used prior to the reboot.
Resolution
1. Remap the network drive to the drive letter originally used by the software upgrade program.
2. Resume the upgrade process.
Hotfix Installation
A hotfix is an update that is targeted at resolving a specific critical issue that might cause major disruptions to operations or potential loss of data.
Critical hotfixes are installed along with a service pack. If you already installed a service pack, and critical hotfixes are made available after the service pack release, then
you can install the hotfixes by installing the service pack again with any of the methods described in Run Manual Service Pack Installations . Make sure to consider the
following requirements:
To install using the CommCell Console, download the Commvault software to retrieve the latest hotfixes and then perform the installation.
To install using the installation package, create a new package from the Download Manager to retrieve the latest hotfixes.
You can also download and install the hotfixes manually. This is useful if you also want to install non-critical hotfixes. For instructions, see Installing Hotfixes .
Service Pack 7
New Features
Hotfixes
Contents
Release Notes
Service Pack 6
New Features
Hotfixes
Contents
Release Notes
Service Pack 5
New Features
Contents
Release Notes
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Install Service Pack and Hotfixes.
If you want to install the service pack on a CommServe computer configured in a cluster environment, right-click the CommServe node and then click All Tasks >
Add/Remove Software > Install Service Pack and Hotfixes.
2. In the Install Service Pack and Hotfixes Options dialog box, select the client computers that you want to update:
If you want to update specific clients, expand Client Computers and select the clients to be updated.
For example, if you want to update the CommServe computer, select the check box for the CommServe computer.
If you want to update all clients, select the Client Computers check box. Note that the CommServe computer and all MediaAgents are also selected.
If you want to update clients that are part of a client group, expand Client Computer Groups and select the client group to be updated.
For example, if you want to update all MediaAgents, select the Media Agents check box.
3. Determine whether you need to select some of the installation options provided in the dialog box. For information about the options, see Install Update Options
(General) .
4. On the Job Initiation tab, click Schedule and then click Configure.
5. In the Schedule Details dialog box, complete the following steps:
a. In the Schedule Name box, enter a name for the schedule. For example, Automatic Updates.
b. On the left pane of the dialog box, click Monthly, and then configure your schedule details. For example, if you want to run the installation every 4 months on the
20th day, do the following:
In the On Day box, type 20.
In the Every n Months box, under the Repeat area, type 4.
c. Click OK to close the Schedule Details dialog box.
6. In the Install Service Pack and Hotfixes Options dialog box, click OK.
The service pack installation will run at the time that you scheduled.
What to Do Next
If you installed the service pack on a clustered CommServe computer and the installation failed on some of the passive nodes, perform the following steps to retry the
installation on the passive nodes:
1. Configure the CommServe cache directory as a network share and create a shortcut to the directory on each passive node. This step is called mapping a network
folder.
2. For each passive node that failed, complete the following steps:
a. Log on to the passive node and go to CommServe_Cache_Directory\CVMedia\11.0.0\Windows.
b. Run Setup.exe to install the service pack.
Note: The passive nodes will reflect the new service pack version when the next failover operation occurs.
If you are a user with administrative rights in the CommCell environment, then you can generate a report that summarizes all the installation jobs that ran in the
CommCell Console.
a. From the CommCell Console ribbon, click the Reports tab and then click Summary.
b. In the Report Selection dialog box, on the General tab, click Administrative Jobs > Install/Upgrade/Remove/Repair Software, and then click Run.
For more information on the report, see Administrative Job Summary Report .
Related Tasks
Run Manual Service Pack Installations
Managing Service Packs
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Install Service Pack and Hotfixes.
If you want to install the service pack on a CommServe computer configured in a cluster environment, right-click the CommServe node and then click All Tasks >
Add/Remove Software > Install Service Pack and Hotfixes.
2. In the Install Service Pack and Hotfixes Options dialog box, select the client computers that you want to update:
If you want to update specific clients, expand Client Computers and select the clients to be updated.
For example, if you want to update the CommServe computer, select the check box for the CommServe computer.
If you want to update all clients, select the Client Computers check box. Note that the CommServe computer and all MediaAgents are also selected.
If you want to update clients that are part of a client group, expand Client Computer Groups and select the client group to be updated.
For example, if you want to update all MediaAgents, select the Media Agents check box.
3. Determine whether you need to select some of the installation options provided in the dialog box. For information about the options, see Install Update Options
(General) .
For example, if you install the service pack on a CommServe computer configured in a cluster environment, select the Auto Install passive nodes check box and specify
the necessary details.
4. Choose whether you want to run the installation or to save it as a script:
To run the installation immediately, click OK.
You can track the installation as follows:
If you install the service pack on the CommServe computer, you can track the installation progress in the notification area located in the taskbar. During the
installation, the CommCell Console is closed and the services are stopped.
If you install the service pack on MediaAgents and clients, you can track the installation progress from the Job Controller window.
Tip: If the installation job fails or finishes with errors, refer to the Troubleshooting page.
To save the installation as a script, complete the following steps:
a. Click Save as Script.
b. In the Save as Script dialog box, from the Client list, select the client computer where you want to save the script.
The client computer must be able to establish connections with the clients that you want to install the service pack on.
c. In the File Path box, specify the location where you want to save the script.
d. If the user who is logged onto the CommCell Console does not have sufficient privileges to perform the Save as Script operation, click Use a different user
account and enter the name and password of a user account with sufficient privileges.
e. Click OK.
The script is saved as an .xml file and a .bat file on the client you selected. If a file with the same name exists in the specified location, the .xml file is created with
a timestamp. The .bat file overwrites any existing .bat file.
To run the script from the command-line interface, see Running the Remote Service Pack Installation Script from the Command Line .
What to Do Next
To verify the status of the clients where you installed the service pack, access the installation job details as follows:
1. From the CommCell Browser, right-click the CommServe node and then click View > Admin Job History.
2. In the Admin Job History Filter dialog box, click OK.
3. In the Admin Job History window, double-click the latest Install Updates job.
4. In the Admin Job History Details for Job: nnnn dialog box, click the Client Status tab to review the installation results.
If you installed the service pack on the CommServe computer, some jobs in the Job Controller window of the CommCell Console might be in the pending state. No
action is required because the jobs will be automatically resumed.
If you installed the service pack on a clustered CommServe computer and the installation failed on some of the passive nodes, perform the following steps to retry the
installation on the passive nodes:
1. Configure the CommServe cache directory as a network share and create a shortcut to the directory on each passive node. This step is called mapping a network
folder.
2. For each passive node that failed, complete the following steps:
a. Log on to the passive node and go to CommServe_Cache_Directory\CVMedia\11.0.0\Windows.
b. Run Setup.exe to install the service pack.
Note: The passive nodes will reflect the new service pack version when the next failover operation occurs.
Related Tasks
Managing Service Packs
Procedure
1. Log on to the computer where you saved the script.
2. At the command line, go to the Installation_Directory_Path/Base directory and run the following command to log on to the CommServe database:
qlogin -cs commserve_host_name -u user_name
Procedure
1. On the CommServe computer, go to the Installation_Directory_Path/SoftwareCache directory.
2. Determine whether you have the SoftwareCache/CVUpdates/10.0.0/OS_Name folder structure (where OS_Name is the operating system for which you want to copy
the updates).
If the structure is present, continue with the next step.
If the structure is not present, create the CVUpdates, 10.0.0, and OS_Name folders.
The following are valid names for the OS_Name folder based on your operating system: aix-ppc, dwn-x86, fbsd-x86, fbsd-x8664, hp-ia64, linux-ppc64, linux-s390,
linux-x86, linux-x8664, sol-sparc, sol-x8664, Windows, WinX64.
3. From the location where you extracted the service pack software, copy the following content to the OS_Name folder:
The ServicePacks folder
All the files that are at the same level as the ServicePacks folder.
For example, if you copied the service pack software for Windows x64 computers, your SoftwareCache directory will look as follows:
5. To save the changes you made to the CommServe cache, you must perform a commit cache operation. For instructions, see Committing the CommServe Cache .
Result
You can install updates on your V10 clients by using the CommCell Console.
Procedure
1. From the CommCell Browser, right-click the CommServe computer, and then click Properties.
2. In the CommCell Properties dialog box, click the Additional Settings tab, and then click Add.
3. In the Add Additional Settings on Windows Client dialog box, do the following:
a. In the Name box, type nNoConnectionLimitsForPushUpdate .
b. In the Value box, type 1.
c. Click OK.
4. In the CommCell Properties dialog box, click OK.
Procedure
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
2. Run Setup.exe from the installation package.
The installation wizard opens.
3. On the welcome page, select the I Agree check box and proceed to the next page.
4. On the Choose the Installation Type page, click Select packages to install on this computer and proceed to the next page.
5. On the Install Option page, click Install Service Pack and proceed to the next page.
6. On the Service Pack Upgrade Confirmation page, proceed to the next page to start with the service pack installation.
7. If you are installing the service pack on a CommServe computer configured in a cluster environment, you must complete additional installer pages:
a. On the Passive Nodes Installations Options page, determine whether you want to install the service pack on passive nodes. The service pack is installed on the
active node first, and then on each passive node.
If you do not want to update the passive nodes at this time, clear the Also install/update passive nodes check box. After the active node is updated, continue
with Step 8.
If you choose to update the passive nodes, but you want to restart the passive nodes at a later time, clear the Reboot passive nodes if required check box.
b. On the Remote Install Account page, specify the domain administrator account which has access to all cluster nodes and proceed to the next page.
After the active node is updated, the Install/Update packages on passive nodes page appears.
c. On the Install/Update packages on passive nodes page, follow the installation progress for each passive node. If the installation fails on a node, the installer
provides the link to a log file where you can troubleshoot the problem.
8. On the completion page, click Finish.
What to Do Next
Verify the update status of the client where you installed the service pack. For instructions, see Viewing the Service Pack Details for One or More Clients .
If you installed the service pack on the CommServe computer, some jobs in the Job Controller window of the CommCell Console might be in the pending state. No
action is required because the jobs will be automatically resumed.
Related Tasks
Managing Service Packs
Procedure
1. Log on to the computer as root.
2. Run the following command from the installation package or mount point:
./cvpkgadd
To run the installation as a SUDO user with root privileges, use the following command:
sudo ./cvpkgadd
What to Do Next
Verify the update status of the client where you installed the service pack. For instructions, see Viewing the Service Pack Details for One or More Clients .
Related Tasks
Managing Service Packs
Procedure
1. Start the Download Manager application, select where to extract the installation files, and then click Extract.
The installation wizard opens.
2. On the welcome page, select the I Agree check box and proceed to the next page.
3. On the Choose the Installation Type page, click Select packages to install on this computer and proceed to the next page.
4. On the Install Option page, click Install Service Pack and proceed to the next page.
5. On the Service Pack Upgrade Confirmation page, proceed to the next page to start with the service pack installation.
6. If you are installing the service pack on a CommServe computer configured in a cluster environment, you must complete additional installer pages:
a. On the Passive Nodes Installations Options page, determine whether you want to install the service pack on passive nodes. The service pack is installed on the
active node first, and then on each passive node.
If you do not want to update the passive nodes at this time, clear the Also install/update passive nodes check box. After the active node is updated, continue
with Step 7.
If you choose to update the passive nodes, but you want to restart the passive nodes at a later time, clear the Reboot passive nodes if required check box.
b. On the Remote Install Account page, specify the domain administrator account which has access to all cluster nodes and proceed to the next page.
After the active node is updated, the Install/Update packages on passive nodes page appears.
c. On the Install/Update packages on passive nodes page, follow the installation progress for each passive node. If the installation fails on a node, the installer
provides the link to a log file where you can troubleshoot the problem.
7. On the completion page, click Finish.
What to Do Next
Verify the update status of the client where you installed the service pack. For instructions, see Viewing the Service Pack Details for One or More Clients .
If you installed the service pack on the CommServe computer, some jobs in the Job Controller window of the CommCell Console might be in the pending state. No
action is required because the jobs will be automatically resumed.
Related Tasks
Managing Service Packs
Procedure
1. Log on to the computer as root.
2. Go to the location where you stored the RPM package.
3. Run the following command:
rpm ?U package_name.rpm
What to Do Next
Verify the update status of the client where you installed the service pack. For instructions, see Viewing the Service Pack Details for One or More Clients .
Procedure
1. Perform one of the following operations to start the update process:
Restart the CommCell Console
Close and reopen the console. After you log on to the console, the CommCell Console Update Information dialog box appears.
Check for updates
From the CommCell Console ribbon, go to the Support tab and click Check for Updates. The CommCell Console Update Information dialog box appears.
2. In the CommCell Console Update Information dialog box, click Yes.
The CommCell Console proceeds to download the updates to the Software_Installation_Directory\GUICache directory.
3. In the Warning dialog box, click OK.
The service pack is installed on the CommCell Console. After the installation, the console will close and reopen automatically.
Result
The CommCell Console client is updated with the same software version as the CommServe computer.
Note: If the service pack installation failed on a client due to corrupt update files, go to the Software_Installation_Directory\GUICache directory, delete all of its contents, and
then retry the service pack installation using one of the methods.
Procedure
Choose whether you want to view the service pack details for a specific client or for multiple clients.
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Install Service Pack and Hotfixes.
2. In the Install Service Pack and Hotfixes Options dialog box, expand Client Computers and select the clients where you want to install the hotfixes.
3. Click OK.
You can track the progress of the job from the Job Controller window.
If you are installing a driver update and the computer does not reboot automatically, then the update install will fail.
Resolution 1
Make sure to select the Reboot Client check box in the Install Updates Options dialog box and then resubmit the job. This option ensures that the CommServe,
MediaAgent, or client computers automatically reboot after the updates are installed.
Symptom 2
The installation of an update on a client fails with the following error message:
Failed - Conflicting with hotfix or diagnostic updates. If you want conflicting hotfix or diagnostic update to uninstall automatically before installing new updates, please resubmit the job with 'Automatically Uninstall
Conflicting Hotfix or Diagnostic Update' checkbox selected.
If there are diagnostic updates conflicting with the new updates that you are installing, then the installation of the new update will fail.
Resolution 2
Make sure to select the Automatically Uninstall Conflicting Hotfix or Diagnostic Update check box in the Install Updates Options dialog box and then resubmit the job.
This option ensures that the existing conflicting diagnostic updates are uninstalled automatically from the computer before new updates are installed.
USP0002: Failed to Install Updates and Service Packs through the CommCell Console on a
Recently Upgraded Cluster Client
Symptom
In previous versions, you could install agents directly on the virtual node of the cluster. Starting with Commvault version 10, you must install agents on the physical nodes
of the cluster.
After you upgrade a cluster environment, if some agents were directly installed on virtual nodes, then you might not be able to successfully install updates and service
packs on the cluster client from the CommCell Console. The installation of updates on agents that were installed on virtual nodes will fail.
Resolution
Install the agents on the physical nodes of the cluster from the CommCell Console. After the agents are installed, retry to install the updates on the cluster client.
Additional Software
Certain software packages are not available for download from neither the CommCell Console nor Download Manager. For example, the 1-Touch software for Linux and
FreeBSD is available on a separate disc.
You can download additional software packages from the Cloud Services or Maintenance Advantage websites. To review the software available for download, see
Installation Media List . For the download instructions, see Downloading Installation Media .
Procedure
Use the following steps to create an installation package for Windows computers.
1. Start the Download Manager application, select where to extract the installation files, and then click Extract.
The installation wizard opens.
2. On the welcome page, select the I Agree check box and proceed to the next page.
3. On the Choose the Installation Type page, click Download packages to install on a different computer and proceed to the next page.
4. On the Select Operating System Type page, select the type of Windows processor that your computers support, and then proceed to the next page.
For example, if your computers only support 64-bit processors, select the Win64 check box and proceed to the next page.
5. On the Custom Package Install Type page, select one of the following options and proceed to the next page:
Option Description
New Installations Use this option in the following scenarios:
You plan to install the Commvault software on new clients.
You plan to perform a hardware refresh.
The Download Manager downloads all the required installation files and service pack updates. For Commvault packages that
need the SQL Server software, the Download Manager will retrieve Microsoft SQL Server 2014 Standard.
Upgrades Use this option if you plan to upgrade clients from previous Commvault versions. For example, upgrades from Version 10 to
Version 11.
For Commvault packages that use the SQL Server software, the Download Manager will retrieve Microsoft SQL Server 2012
Enterprise. This SQL version is needed to upgrade clients that have SQL Server 2008 Enterprise (or earlier versions).
Service Pack Installations Use this option if you plan to install service pack updates or additional agents on an existing client.
Note: If you plan to install Commvault packages that need the Microsoft SQL Server (such as the CommServe), select New
Installations.
6. On the Select Package Option page, select whether you want to download all packages or specific packages, and then proceed to the next page.
Notes:
If you plan to copy the software to the CommServe cache, you must download all packages. Specific packages cannot be copied to the cache.
If you want to download all packages, make sure to select the Include MS SQL Server check box. The Microsoft SQL Server is needed by the CommServe and other
server packages.
7. On the Download Location page, specify the location where you want to download the installation package, and then proceed to the next page.
Note: Make sure that the download location has enough disk space available to accommodate the software that you want to download. If the download location is not
the system C:\ drive, you must have at least 1 GB of free space on your system C:\ drive to accommodate cached download files.
8. Based on the option selected on the Select Package Option page, choose from one of the following steps:
If you chose to download all packages, a status page is displayed showing the current operation and a progress bar. If you cancel the download or if the internet
connectivity is lost, the application allows you to resume the unfinished download from the point of failure.
Continue with Step 11.
If you chose to download specific packages, continue with Step 9.
9. On the Select Packages page, select the Commvault software that you want to include in the installation package and then proceed to the next page.
10. On the Custom Package Options page, complete the following steps:
a. If you selected the CommServe, Metrics Reporting, Web Server, or the Workflow Engine, make sure that the Include MS SQL Server check box is selected.
b. If any of the agents you selected requires .NET Framework 4.0, make sure that the Include .NET Framework 4.0 Installer check box is selected.
c. Proceed to the next page.
A status page is displayed, showing the current operation and a progress bar. If you cancel the download or if the internet connectivity is lost, the application allows
you to resume the unfinished download from the point of failure.
11. On the Install Status page, click Finish.
Remember: As a best practice, keep the installation package up to date, or at the same service pack level as that of the CommServe computer.
What to Do Next
Make the package available for Windows client computers by using one of the following methods:
Procedure
Use the following steps to create an installation package for UNIX, Linux, and Macintosh computers.
1. On a Windows computer, start the Download Manager application, select where to extract the installation files, and then click Extract.
The installation wizard opens.
2. On the welcome page, select the I Agree check box and proceed to the next page.
3. On the Choose the Installation Type page, click Download packages to install on a different computer and proceed to the next page.
4. On the Select Operating System Type page, click Unix, select the type of operating system that your computers support, and then proceed to the next page.
You can select more than one operating system. For example, if you have Linux and Solaris computers that support 64-bit processors, select the Linux-x86-64 and
Solaris-x86-64 check boxes and proceed to the next page.
5. On the Download Location page, specify the location where you want to download the installation package, and then proceed to the next page.
Note: Make sure that the download location has enough disk space available to accommodate the software that you want to download. If the download location is not
the system C:\ drive, you must have at least 1 GB of free space on your system C:\ drive to accommodate cached download files.
6. On the TAR File Destination page, choose whether to create .tar files:
If you do not want to create a .tar file, proceed to the next page.
If you want to compress the installation package in a .tar file, select the Create a TAR file for UNIX packages check box, specify where to save the file, and then
proceed to the next page.
Both the .tar file and the uncompressed package will be available at the end of the package creation.
Note: When you copy the package to a Linux computer, the .tar file preserves the software file attributes and reduces the chances of dealing with file permission
issues.
When you proceed to the next page, a status page is displayed showing the current operation and a progress bar. If you cancel the download or if the internet
connectivity is lost, the application allows you to resume the unfinished download from the point of failure.
7. On the Install Status page, click Finish.
Remember: As a best practice, keep the installation package up to date, or at the same service pack level as that of the CommServe computer.
What to Do Next
Make the package available for UNIX, Linux, and Macintosh client computers by using one of the following methods:
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Download Software.
2. In the Download and Sync Cache Options dialog box, choose the option that satisfies your requirements:
If you want to download the latest service pack and hotfixes, click Latest Service Pack.
If you only want to download hotfixes for the service pack that is installed on your CommServe computer, click Latest Hotfixes for the installed service pack.
If you want to download a previous service pack version, click Service Pack and Hotfixes and select the version from the list. This list does not include versions that
are older than the one installed on the CommServe computer.
3. Click Advanced, and on the Operating Systems tab, select the operating system of the computers where you plan to install the software.
By default, the CommCell Console downloads Commvault software binaries for Windows x64 and for any other operating system that is present in the CommServe
cache.
4. Choose whether you want to run or schedule the download:
To perform the download immediately, click OK.
You can track the progress of the job from the Job Controller window.
To schedule the download, click the Job Initiation tab, and then click Schedule to run the job at a specific date and time. After the schedule is configured, click OK.
The job runs at the date and time you specified.
5. To verify that the CommServe cache directory was updated with the downloaded software, go to the CommCell Console ribbon, and on the Tools tab, click
Add/Remove Software > Software Cache Configuration.
In the Software Cache Configuration dialog box, the CommServe Cache Status for Media should display Valid.
What to Do Next
Send a notification to your users to indicate that the latest software can be installed from the CommCell Console.
Related Topics
Manage the CommServe Cache
Manage the Remote Cache
Procedure
1. From the CommCell Browser, right-click the CommServe node and click Properties.
2. In the CommCell Properties dialog box, click the Additional Settings tab and then click Add.
3. In the Add Additional Settings on Windows Client dialog box, do the following:
a. In the Name box, type ShowFtpDetails .
b. In the Value box, type 1.
c. Click OK.
4. In the CommCell Properties dialog box, click OK and then close the CommCell Console.
5. Open the CommCell Console, and from the Home tab on the CommCell Console ribbon, click Control Panel.
6. In the Control Panel window, under Maintenance, click Internet Options.
7. In the Internet Options dialog box, click the Download Software tab and update the FTP site information.
8. Click OK.
Procedure
1. From the CommCell Console ribbon, on the Home tab, click Control Panel.
2. In the Control Panel window, under Maintenance, click Internet Options.
3. In the Internet Options dialog box, click the Download Software tab, and based on your network requirements, click the appropriate protocol.
The next time you download the software, the download operation will use the protocol that you selected.
Procedure
1. From the CommCell Console ribbon, on the Home tab, click Control Panel.
2. In the Control Panel dialog box, click Internet Options.
3. On the Internet Gateway tab, click Use Client, and then in the Client list, select the name of the computer you want to use as a gateway.
Note: Only clients connected to the Internet appear in the list.
4. Click OK.
The next time you download the software, the download operation will use the gateway client that you configured.
Procedure
1. From the CommCell Browser, right-click the CommServe node and click Properties.
2. In the CommCell Properties dialog box, click the Additional Settings tab and then click Add.
3. In the Add Additional Settings on Windows Client dialog box, complete the following steps:
a. In the Name box, type IgnoreDeconfigClientsForPatchDownload .
b. In the Value box, type 1.
c. Click OK.
4. In the CommCell Properties dialog box, click OK.
The next time you download the software, the download operation will not retrieve the software for the operating system of the deconfigured clients.
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Software Cache Configuration.
2. In the Software Cache Configuration dialog box, in the Please Specify Cache Directory box, specify the new directory path for the CommServe cache.
Note: If the CommServe was installed in a clustered environment, make sure that the directory resides on a shared drive.
3. Click Commit Cache to notify the CommServe database about the new location.
When the commit operation finishes, a message is displayed indicating whether the operation succeed or not.
4. Click OK.
The next time you download the software from the CommCell Console, the software will be downloaded to the new location.
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Software Cache Configuration.
2. In the Software Cache Configuration dialog box, click Commit Cache.
When the commit operation finishes, a message is displayed indicating whether the operation succeed or not.
3. Click OK.
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Software Cache Configuration.
2. On the Software Cache Configuration dialog box, click Cache Details.
3. In the Cache Details dialog box, from the Updates for Release list, select the software version that you want to check.
The dialog box displays the service pack version of the software and additional updates that are available for each operating system.
4. Click OK to close the Cache Details dialog box.
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Software Cache Configuration.
2. In the Software Cache Configuration dialog box, click Delete Cache Contents.
3. In the Choose Contents to Delete from Cache dialog box, choose whether you want to delete packages and/or updates, and then click OK.
4. In the Software Cache Configuration dialog box, click OK to close the dialog box.
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Software Cache Configuration.
2. In the Software Cache Configuration dialog box, click the Remote Software Cache tab and then click Add.
3. In the Configure Remote Software Cache dialog box, complete the following steps:
a. From the Computer list, select the client where you want to configure the remote cache directory.
b. In the Please Specify Cache Directory box, the default location for the remote cache is provided. If you want to specify a different location, click Browse.
c. Click Add/Remove Clients to associate the clients and client groups with the remote cache.
d. In the Associate Clients/Client Groups to a Remote Software Cache dialog box, under the Available Clients/Client Groups list, select the clients and click
Include > to add them to the Selected Clients/Client Groups list, and then click OK.
The selected clients and client groups will retrieve the software from the remote cache.
e. Click OK to save your remote cache configuration.
4. In the Software Cache Configuration dialog box, click OK.
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Software Cache Configuration.
2. In the Software Cache Configuration dialog box, click the Remote Software Cache tab, select the remote cache you want to configure and then click Edit.
3. In the Modify Remote Software Cache Information dialog box, click Configure Packages to Sync.
4. In the Configure Packages to Sync dialog box, choose the configuration that you want to perform:
If you want to synchronize additional packages for specific operating systems, you can specify the packages as follows:
a. From the Select OS list, select the operating system.
b. From the adjacent list, select the packages.
c. Click + to specify more combinations of operating system and packages.
If you want to synchronize all packages and updates that reside in the CommServe cache, click All Packages.
5. Click OK to save your configuration changes.
6. Click OK to close the Modify Remote Software Cache Information dialog box.
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Download Software.
2. In the Download and Sync Cache Options dialog box, click the Options tab and select the following options:
In the Job Type area, click Sync.
In the remote cache area, select the remote cache that you want to synchronize with the CommServe cache.
3. Click OK.
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Software Cache Configuration.
2. In the Software Cache Configuration dialog box, click the Remote Software Cache tab, select the remote cache where you want to delete the contents, and then click
Edit.
3. In the Modify Remote Software Cache Information dialog box, click Delete Cache Contents.
4. In the Confirmation window, click OK.
5. In the Modify Remote Software Cache Information dialog box, click OK to close the dialog box.
Procedure
1. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Software Cache Configuration.
2. In the Software Cache Configuration dialog box, click the Remote Software Cache tab, select the remote cache and click Edit to delete the cache contents.
3. In the Modify Remote Software Cache Information dialog box, click Delete Cache Contents.
4. In the Confirmation window, click OK.
5. In the Modify Remote Software Cache Information dialog box, click OK to close the dialog box.
6. In the Software Cache Configuration dialog box, select the remote cache and click Delete.
7. In the Confirmation dialog box, click OK.
DVD07 1-Touch FreeBSD Live DVD, also called Live Boot Disc or Disc 7.
1-Touch-Windows-x86.iso 1-Touch DVD (.iso) for Windows 32-bit operating systems computers.
1-Touch-Windows-X64.iso 1-Touch DVD (.iso) for Windows 64-bit operating systems computers.
Commvault VPN 32-bit Software for Windows 32-bit operating system clients to enable the use of Commvault VPN services.
Commvault VPN 64-bit Software for Windows 64-bit operating system clients to enable the use of Commvault VPN services.
* In the Cloud Services website, the Download Manager application is available for download as V11 SPn Media Kit and Service Pack.
Download Media
You can download the necessary media from the Cloud Services or Maintenance Advantage Web sites. For instructions, see Downloading Installation Media .
Procedure
Choose the method that better accommodates your requirements.
Preferred Method: From Cloud Services
1. Go to the Download Center page on the Cloud Services Web site.
2. On the left side of the page, under the Category filter, click the version of the software media that you want to download. For example:
To locate all the available Download Manager applications for Version 11, click v11 ServicePack/Installer.
To locate all the available hotfixes for Version 11, click v11 Hotfix.
3. Click the Download button next to the software media that you want to download. For a list of available installation media, see Installation Media List .
For example, to download the latest Download Manager application, look for V11 SPn Media Kit and Service Pack which displays the latest service pack.
The software media is downloaded to the location that you specified.
If you downloaded the Download Manager, you will see the application executable file.
If you downloaded a software disc, you will see the .iso image of the disc.
Mount the .iso using an appropriate software (for example, MagicISO). Then, use the software media from the mount location.
Alternate Method: From Maintenance Advantage
1. Log on to the computer on which you want to download the software.
Remember: You must log on as the administrator.
2. Go to the Maintenance Advantage website.
3. In the Custom Login section, type your user account credentials and click Login.
4. From the top menu bar, click the Select Version menu and select the Commvault version.
5. Click the Downloads & Packages tab and then click the Electronic Software Distribution link.
The following image is for sample purposes:
6. On the Electronic Software Distribution page, click the Resumable Download Manager tab.
7. Select the software media that you want to download. For a list of available installation media, see Installation Media List .
For example, to download the latest Download Manager application, look for V11 Download Manager with the latest service pack.
8. At the bottom of the page, click Launch Download Manager and follow the prompts to download the software media.
Note: You might be prompted to install the Akamai NetSession Interface if you do not have it installed on your computer. The NetSession Interface is a download
manager used to reduce download time and increase quality.
The software media is downloaded to the location that you specified.
If you downloaded the Download Manager (also known as Bootstrapper Installer), you will see the application executable file.
If you downloaded a software disc, you will see the .iso image of the disc.
Mount the .iso using an appropriate software (for example, MagicISO). Then, use the software media from the mount location.
CAUTION: You can perform browse and restore operations while the client icon exists in the CommCell Browser. If you delete the icon, the backed up data is irretrievably
lost.
To remove the Commvault software completely from your organization, you must uninstall clients and MediaAgents first. The CommServe software is the last package to be
uninstalled.
General Considerations
Verify that Commvault services are running on the CommServe computer.
For the client where you plan to uninstall the software, verify that no jobs are in progress or scheduled to occur.
If the software was not installed in the default location, you must remove the installation directory after the uninstallation.
Search Engine
Before you uninstall the Search Engine, you must delete the Search Engine from the CommCell Console:
1. From the CommCell Browser, expand Storage Resources and click Search Engines.
2. Right-click the Search_Engine that you want to uninstall and click Delete.
3. Click Yes to confirm the operation.
You can proceed to uninstall the Search Engine from the client where it is installed.
Procedure
1. Use one of the following ways to access the uninstallation options:
To uninstall from a single client:
From the CommCell Browser, expand Client Computers, right-click the Client, and then click All Tasks > Add/Remove Software > Uninstall Software.
To uninstall from multiple clients:
a. From the CommCell Console ribbon, on the Tools tab, click Add/Remove Software > Uninstall Software.
b. In the Uninstall Software Options dialog box, select the clients from where you want to uninstall the software.
2. On the Uninstall Software tab of the Uninstall Software Options dialog box, complete the following steps :
a. Select the packages that you want to uninstall.
Important: If you select the File System Core, all Commvault packages will be uninstalled. Commvault packages are dependent on the File System Core.
b. If you want to perform the uninstallation even when the client is unreachable, select the Force Uninstall if remote client is unreachable check box.
The client information will be removed from the CommServe database, and the licenses used by the client will be released.
c. If you want to configure advanced options, such as controlling the running time of the job, click Advanced, and in the Advanced Options for Remove Software
dialog box, click Help for more information.
3. Choose whether you want to schedule the uninstallation job.
By default, the job is configured to run immediately. To schedule the job, complete the following steps:
a. On the Job Initiation tab, click Schedule and then click Configure.
b. In the Schedule Details dialog box, provide the schedule details and click OK.
4. Choose whether to save the installation as a script:
To run the uninstallation job, click OK.
Tip: When the job starts, you can track the progress of the job from the Job Controller window (CommCell Console ribbon > Home tab > Job Controller).
To save the installation as a script, complete the following steps:
a. Click Save as Script.
b. In the Save as Script dialog box, from the Client list, select the client computer where you want to save the script.
The client computer must be able to establish connections with the computers where you plan to uninstall the software.
c. In the File Path box, specify the location where you want to save the script.
d. If the user who is logged on the CommCell Console does not have sufficient privileges to perform the Save as Script operation, click Use a different user
account and enter the name and password of a user account with sufficient privileges.
e. Click OK.
The script is saved as an .xml file and .bat file on the client you selected. If a file with the same name exists in the specified location, the .xml file is created with a
timestamp. The .bat file overwrites any existing .bat file.
To run the script from the command-line interface, see Running the Remote Uninstallation Script from the Command Line .
Note: If you uninstalled all packages from a client, the client is displayed as unavailable in the CommCell Browser.
What to Do Next
If the CommServe could not connect to a client, and if you enabled the option to force the uninstallation job, you must uninstall the packages locally from the client to
complete the uninstallation process. Based on the client's operating system, select the appropriate procedure:
Uninstalling Commvault Locally from Windows Clients .
Uninstalling Commvault Locally from UNIX and Linux Clients .
Uninstalling Commvault Locally from a Macintosh Client .
You can continue to browse the client data and perform out-of-place restores. However, if you no longer need the client data, you can delete the client from the
CommCell Console. For instructions, see Deleting a Client Computer .
Procedure
1. Log on to the computer where you saved the script.
2. At the command line, go to the Installation_Directory_Path/Base directory and run the following command to log on to the CommServe:
qlogin -cs commserve_host_name -u user_name
Procedure
Choose whether you want to uninstall the software interactively or silently.
Interactive Uninstallation
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
2. Open the Control Panel, and based on your Windows operating system, find the option to uninstall programs.
For example, for Windows Server 2012 and Windows 7 computers, open the Control Panel, and under the Programs section, click Uninstall a program.
3. From the list of programs, click Commvault ContentStore and then click Uninstall.
The uninstallation wizard opens.
Note: If there are multiple instances installed on the client, the Instance selection page is displayed. Select the instance from where you want to uninstall the
software and then proceed to the next page.
4. On the Select Uninstallation Option page, choose how you want to uninstall packages:
To uninstall all packages, click Uninstall all packages in the instance and proceed to the next page.
To uninstall specific packages, do the following:
a. Click Uninstall only selected packages and proceed to the next page.
b. On the Select Packages to Uninstall page, select the packages that you want to uninstall and proceed to the next page.
Important: If you select the File System Core, all Commvault packages will be uninstalled. Commvault packages are dependent on the File System Core.
5. On the Uninstall Summary page, review the information and then proceed to the next page.
Note: If the client cannot communicate with the CommServe computer, the program allows you to proceed with the uninstallation without contacting the
CommServe computer. This operation is called decoupled uninstallation. After the uninstallation, you must deconfigure the client.
6. On the Uninstallation Status page, click Finish.
If you uninstalled all packages, the client is displayed as unavailable in the CommCell Browser pane of the CommCell Console.
Tip: If the uninstallation failed with a registry-related error, see the KB article INS0017: Uninstallation Error: Setup failed to retrieve registry info article to
troubleshoot the error.
Unattended Uninstallation
1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
2. At the command line, go to the location where you stored the installation package and locate the Setup.exe file.
3. Determine which packages you want to uninstall:
To uninstall all package, run the following command:
Setup.exe /uninstall /silent /instance InstanceNNN
Notes:
InstanceNNN is the name of the instance from where you want to uninstall the software. If you only have one instance installed on the client, then specify
Instance001.
ID_list represents the ID of the packages that you want to uninstall (use a comma to separate each ID).
To view the IDs of the packages that are installed on the client, open the Registry Editor and expand the
HKEY_LOCAL_MACHINE\SOFTWARE\CommVaultSystems\Galaxy\InstanceNNN\InstalledPackages folder. You'll find subfolders with ID numbers as their names. Click on one
of the folders, and on the right pane you'll find the package name associated with the ID.
What to Do Next
If the client did not communicate with the CommServe computer, you must deconfigure the client from the CommCell Console.
Deconfiguring the client is the process of releasing the licenses used by the client. For instructions, see Releasing a License (Deconfiguration) .
If you uninstalled the DB2 agent and you cannot connect to the DB2 production database, see the KB article INS0020: Failed to Connect to the DB2 Production Database
to troubleshoot the error.
You can continue to browse the client data and perform out-of-place restores. However, if you no longer need the client data, you can delete the client from the
CommCell Console. For instructions, see Deleting a Client Computer .
Procedure
1. Log on to the computer as root.
2. At the command line, run the following command:
cvpkgrm
If there are multiple instances installed on the client, select the instance from where you want to uninstall the software and press Enter.
3. On the Welcome to Uninstaller dialog, click Next.
4. On the Uninstall Selection dialog, choose how you want to uninstall packages:
To uninstall all packages, select Remove all the packages and click Next.
Tip: If the client cannot communicate with the CommServe computer, select Remove all packages locally. Commvault will be removed from the client without
contacting the CommServe computer. This operation is called decoupled uninstallation. After the uninstallation, you must deconfigure the client.
To uninstall specific packages, do the following:
a. Select Select packages to remove and click Next.
b. On the Package Selection page, select the packages that you want to uninstall and then click Next.
Important: If you select the File System Core, all Commvault packages will be uninstalled. Commvault packages are dependent on the File System Core.
5. On the Summary dialog, review the information and then click Next.
6. On the Uninstall Status dialog, click Finish.
If you uninstalled all packages, the client is displayed as unavailable in the CommCell Browser pane of the CommCell Console.
What to Do Next
If the client did not communicate with the CommServe computer, you must deconfigure the client from the CommCell Console.
Deconfiguring the client is the process of releasing the licenses used by the client. For instructions, see Releasing a License (Deconfiguration) .
You can continue to browse the client data and perform out-of-place restores. However, if you no longer need the client data, you can delete the client from the
CommCell Console. For instructions, see Deleting a Client Computer .
Procedure
1. Log on to the computer with an administrator account.
2. Go to the Applications directory, press and hold the Control key while you click the Process Manager, and then click Move to Trash.
If you have multiple instances installed on the client, the Multiple Backup Applications detected dialog box prompts you to select the instance from where you want
to uninstall the software. After making your selection, click OK.
3. In the Name and Password boxes, type the user name and password of the administrator account, and then click OK.
4. In the Successful dialog box, click OK.
After the packages are uninstalled, the client is displayed as unavailable in the CommCell Browser pane of the CommCell Console.
What to Do Next
You can continue to restore the client data or use the client as a restore destination. However, if you no longer need the client data, you can delete the client from the
CommCell Console. For instructions, see Deleting a Client Computer .
Make sure that the client where the native package is installed can establish connections with the CommServe computer. If the client has connectivity problems, the
uninstallation will fail.
Procedure
1. Log on to the computer as root.
2. At the command line, use the appropriate command to uninstall the native package:
For APT packages:
dpkg -e package_name.deb
After the packages are uninstalled, the client is displayed as unavailable in the CommCell Browser pane of the CommCell Console.
What to Do Next
You can continue to browse the client data and perform out-of-place restores. However, if you no longer need the client data, you can delete the client from the CommCell
Console. For instructions, see Deleting a Client Computer .
Procedure
1. Log on to the Outlook Add-In computer as local Administrator or as a member of the Administrators group on that computer.
2. Open the Control Panel, and based on your Windows operating system, find the option to uninstall programs.
For example, for Windows Server 2012 and Windows 7 computers, open the Control Panel, and under the Programs section, click Uninstall a program.
3. From the list of programs, click OutlookAddInClient and then click Uninstall.
The uninstallation wizard opens.
4. To uninstall the application, click Remove and then click Yes to confirm the uninstallation.
The Outlook Add-In is successfully uninstalled.
Procedure
1. Log on to the computer as root.
2. At the command line, go to the installation directory. For example, /opt/simpana.
3. Set and export the AUTHENTICATED_THIS_SESSION variable by running the following commands:
AUTHENTICATED_THIS_SESSION=yes
export AUTHENTICATED_THIS_SESSION
What to Do Next
1. Deconfigure the client from the CommCell Console.
Deconfiguring the client is the process of releasing the licenses used by the client. For instructions, see Releasing a License (Deconfiguration) .
2. Delete the client from the CommCell Console. For instructions, see Deleting a Client Computer .
Procedure
1. From the CommCell Browser, go to Workflows.
2. Right-click Uninstall Third-Party Software and then click All Tasks > Execute.
3. In the Uninstall Third-Party Options dialog box, complete the following steps:
a. From the Run workflow on list, select the workflow engine.
b. In the Software to be Uninstalled box, the third-party software that was installed by Commvault is listed by default. You can enter the name of other software that
you want to uninstall.
Important: When you enter the software name in the box, make sure that the name matches with the name displayed in the Windows Control Panel.
c. In the Recipients box, enter the email address of the users that you want to notify. If multiple email IDs are specified, make sure that the emails are separated with
a semicolon (;).
d. In the Parallel Execution Count box, enter the number of clients that you want to run in parallel. By default, the workflow uninstalls the software from one client at
the time.
e. Click OK.
You can track the progress of the workflow job from the Job Controller.
Once the workflow job finishes, an email is sent with the operation results to the email address that you specified in the workflow.
Procedure
1. Disassociate agents from the cluster group client.
a. From the CommCell Browser, expand Client Computers.
b. Right-click the Cluster_Group_Client and then click Properties.
c. In the Client Computer Properties dialog box, click Advanced.
d. In the Advanced Client Properties dialog box, click the Cluster Group Configuration tab.
e. On the Agents sub tab, from the Selected list, select the agents that you want to disassociate and click < Remove.
2. If the cluster group client does not use any agent from a physical node, and if you no longer need the node, you can disassociate the physical node from the cluster
group client.
a. On the Cluster Group Configuration tab, click the Nodes sub tab.
b. From the Selected list, select the physical nodes that you want to disassociate and click < Remove.
3. Save the changes made to the cluster group client.
a. In the Advanced Client Properties dialog box, click OK.
b. Click OK to close the Client Computer Properties dialog box.
4. If you disassociated physical nodes from the cluster group client, uninstall Commvault from the physical nodes using one of the following methods:
Uninstalling Commvault Remotely Using the CommCell Console
Uninstalling Commvault Locally from Windows Clients
Uninstalling Commvault Locally from UNIX and Linux Clients
5. If you disassociated all physical nodes from the cluster group client, deconfigure the cluster group client, which becomes an inactive client.
To deconfigure the client, see Releasing a License (Deconfiguration) .
Procedure
1. Log on to the CommServe computer as an Administrator or as a member of the Administrator group on that computer.
2. Open the Control Panel, and under the Programs section, click Uninstall a program.
3. From the list of programs, click Commvault ContentStore and then click Uninstall.
The uninstallation wizard opens.
4. On the Select Uninstallation Option page, click Uninstall all packages in the instance and proceed to the next page.
5. On the Uninstall Summary page, review the information and proceed to the next page.
6. On the Uninstallation Status page, click Finish.
The CommServe software is successfully uninstalled.
Best Practice
Use the latest version of the operating system software listed in the Operating System table. Commvault software fully supports the latest version of an operating system
until the Microsoft Extended Support End Date. Newer versions of Commvault software might not install on operating systems for which Microsoft support has ended. For
information about the Microsoft support lifecycle, go to the Microsoft Support website, Microsoft Support Lifecycle.
Operating System
Windows
Microsoft Windows Server 2016 Editions
See Considerations for Microsoft Windows Server 2016 for more information.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
For information on supported cluster types, see Clustering - Support .
Processor
All Windows-compatible processors supported
Hardware Specifications
The hardware requirements for CommServe installed on either physical or virtual machines is explained in Hardware Specifications for CommServe.
Notes:
The software installation requires 10 GB of disk space on the operating system drive. This space is used for temporary files copied during the installation or upgrade of
the CommServe and Microsoft SQL Server software.
For hard drive requirements details of other components (such as the MediaAgent ), see the corresponding system requirements pages.
Database Engine
The Microsoft SQL Server application that is installed on the computer must be dedicated to support the software and cannot be shared by other applications.
Microsoft SQL Server 2014 Standard Edition is automatically installed during the installation of the CommServe software. Later SQL Server service packs and updates must
be installed manually. For more information on scalability (such as CPU, socket, and memory limits), performance, and other features supported by the standard edition,
refer to the Microsoft documentation.
Microsoft SQL Server 2012 Enterprise Edition with Service Pack 2 (SP2) and Cumulative Update 4 (CU4) is also supported. If you plan to use SQL Server 2012, review
important recommendations listed in Considerations for SQL Server 2012 .
Recommended SQL Server Settings
The database instance used by the software requires specific SQL server settings. Using the SQL Management Studio, verify the SQL properties listed below.
SQL Memory Size
Access the server properties and navigate to the Memory page. The maximum server memory should be 50% of the physical memory available in the computer on which
the software is installed.
Server Collation
Run the sp_helpsort system stored procedure, and verify that the server default collation has the following properties:
Character Set is 1252/ISO (default)
Sort Order is Dictionary order, and case is Insensitive
Unicode Collation includes General Unicode, case Insensitive, width Insensitive
Temp Database Properties
Navigate to the tempdb database (under the Databases | System Databases node), and access its properties to verify the following:
The tempdb database has at least 100 MB of disk space. Depending on the components that you decide to install later, additional space may needed.
Click the Files page to check the autogrowth properties of the database files. The Enable Autogrowth option must be selected, and the file growth should be set to
10%.
Note: To preallocate tempdb space or disable the autogrowth option in an Enterprise environment, allocate atleast 30GB space for tempdb. Monitor and track the usage of
tempdb periodically to ensure that the tempdb usage is less than 20GB. If the tempdb size is nearing 20GB, contact the software vendor to investigate the reason for
tempdb growth.
Service Accounts
For Service Accounts, use the same Local System account for each service and enable auto-start for SQL services.
On clustered environments, use an account with administrator privileges (such as, a member of the Administrator local group of the computer or domain).
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Best Practice
Use the latest version of the operating system software listed in the Operating System table. Commvault software fully supports the latest version of an operating system
until the vendor ends support. Newer versions of Commvault software might not install on operating systems for which vendor support has ended. For information about
the Microsoft support lifecycle, go to the Microsoft Support website, Microsoft Support Lifecycle. For support lifecycle information for other operating systems, contact the
appropriate software vendor.
Windows 8
Microsoft Windows Client 8.1* All Windows-compatible processors supported
See Considerations for Microsoft Windows Server 2012, 2012 R2, and Windows 8 for
more information.
*Tape Libraries/Drives are not supported.
Windows 7
Microsoft Windows 7 Editions* All Windows-compatible processors supported
*Tape Libraries/Drives are not supported.
Windows 2008
Microsoft Windows Server 2008 R2 Editions* All Windows-compatible processors supported
*Core Editions are not supported.
Windows 10
Microsoft Windows 10* All Windows-compatible processors supported
*Tape Libraries/Drives are not supported.
Windows 2016
Microsoft Windows Server 2016 Editions All Windows-compatible processors supported
*See Considerations for Microsoft Windows Server 2016 for more information.
Hardware Specifications
The hardware requirements for MediaAgent installed on either physical or virtual machines is explained in Hardware Specifications for MediaAgent .
Notes:
The software installation requires 20 GB of disk space on the operating system drive. This space is used for temporary files copied during the installation or upgrade of
the MediaAgent software.
10 GB for the MediaAgent software and log file growth.
Optimal performance will be realized with solid-state drive (SSD) technology for your local index cache disk. This is particularly important in cases of:
NAS filers running NDMP backups
Backing up large file servers
Any situation where performance is critical
Ports If you have a firewall setup, make sure that port 20000 is open for connections within the network.
Best Practice
Use the latest version of the operating system software listed in the Operating System table. Commvault software fully supports the latest version of an operating system
until the Microsoft Extended Support End Date. Newer versions of Commvault software might not install on operating systems for which Microsoft support has ended. For
information about the Microsoft support lifecycle, go to the Microsoft Support website, Microsoft Support Lifecycle.
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions
Microsoft Windows Server 2012 R2 Editions
Windows Server 2008
Microsoft Windows Server 2008 R2 x64 Editions
Windows Server 2016
Microsoft Windows Server 2016 Editions
Processor
All Windows-compatible processors supported
Additional Software
If you use an Exchange agent, install Microsoft Outlook x64 Editions to support Exchange email recovery.
If you use the Domino Mailbox Archiver, install Notes Client Release 8 or higher to support Domino email recovery.
Cluster Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems. For information on supported cluster types, see Clustering
- Support .
Database Engine
Microsoft SQL Server 2014 Standard Edition is automatically installed during the installation of the Web Server software. If you have Microsoft SQL Server 2012 Enterprise
Edition already installed in your environment, the Web Server will use the existing SQL Server.
For more information, see Database Engine under System Requirements - CommServe .
Miscellaneous
File System iDataAgent - For System Requirements specific to the File System iDataAgent, refer to System Requirements - Microsoft Windows File System iDataAgent .
For successful web restore of NAS data and Domino emails, install a 32-bit File System proxy instance on a 64-bit machine.
IIS
Microsoft Internet Information Services (IIS) must be installed on the system drive of the Web Server. Do not install IIS on a non-system drive.
The following IIS versions are supported:
Microsoft Internet Information Services (IIS) Manager version 8.0 or 8.5 (on Windows 2012 only)
Microsoft Internet Information Services (IIS) Manager version 7.5
Microsoft Internet Information Services (IIS) Manager version 7.0 (on Windows 2008 only)
All components of Microsoft Internet Information Services (IIS) Manager version 7.0 should be installed on Windows 2008
Outlook Add-In and ContentStore Email Viewer
The following requirements must be met to use Web Server with the Outlook Add-In and Outlook Add-In with ContentStore Email Viewer:
Use a dedicated Web Server when you deploy Outlook Add-In with ContentStore Email Viewer on more than 400 mailboxes.
Microsoft Outlook with the latest service pack. Also, to take advantage of Web Server capabilities from the Outlook Add-In, make sure that the latest service pack for
Microsoft Outlook is installed on the client where Outlook Add-In is installed.
Microsoft Outlook 2007 or later, or IBM Notes. NOTE: The 32-bit applications on a 64-bit server will require a second 32-bit File System agent. For x64, use Microsoft
Outlook 2010 or later.
Microsoft Outlook must be installed on the MediaAgent computer to perform content indexing of Exchange and IBM Notes data.
Upgrade all Exchange clients and Outlook Add-In users to Commvault version 11.
.NET Framework
5/6/2017 Commvault Systems Page 442 of 587
Both .NET Framework 3.5 and 4.0 are required and are automatically installed.
Note:
For .NET Framework 4.0, install both the Extended and Client Profile while installing the Web Server.
For .NET Framework 3.5, if the server is Windows 2012 or higher, the role is only enabled during installation if the machine has an internet connection. If there is no
internet connection, you must manually enable the role.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Windows Server 2012
Microsoft Windows Server 2012 x64 Editions
Microsoft Windows Server 2012 R2 x64 Editions
Windows Server 2008
Microsoft Windows Server 2008 x64 Editions
Hard Drive
500 GB of local disk space recommended
Memory
16 GB RAM minimum required
Processor
All Windows-compatible processors supported
Additional Requirements
Internet Information Services (IIS) must be enabled on the computer on which you plan to install the Admin Console.
Windows Vista
Microsoft Windows Vista 32-bit and x64 Editions All Windows-compatible processors supported
Windows XP
Microsoft Windows XP Professional 32-bit Editions with a minimum of Service Pack 3 All Windows-compatible processors supported
Windows 10
Microsoft Windows 10 Editions All Windows-compatible processors supported
Hard Drive
65 MB free disk space
763 MB of temp space required for install or upgrade (where the temp folder resides)
Display
The minimum resolution required to properly display the CommCell Console is 1280x1024.
The graphical icons in the CommCell Console cannot be displayed in VGA mode. This affects the appearance of the toolbar and the CommCell tree in the CommCell
Browser. Also, some table of contents is not displayed correctly.
Miscellaneous
The CommCell Console supports Internet Protocol version 6 (IPv6). See IPv6 Requirements for more information.
Service Pack Versions
The CommCell Console and the CommServe computer must have the same service pack version.
Java Runtime Environment (JRE)
The software supports Java 8 Update 65 (JRE 1.8.0_65) or later versions.
If a supported version of Java is not installed on the computer, you will be prompted to install Java 8 update 65.
5/6/2017 Commvault Systems Page 445 of 587
Note that on Windows Vista and Windows Server 2008 computers, these components will be automatically installed if not already installed on the computer.
Most UNIX operating systems use OpenJDK (an open source Java software). However, if you plan to launch the CommCell Console as a web-based application, we
recommend that you install Oracle Java and point the following directories to the Java program:
usr/bin/java
usr/bin/javaws
SELinux
If you have SELinux enabled on the client computer, create the SELinux policy module as a root user before performing a backup. The SELinux Development package must
be installed on the client.
To create an SELinux policy module, perform the following steps as user "root":
1. Create the following files in the /usr/share/selinux/devel directory:
File Name Content of the File
<directory>/<file_name>.te The content of the file should be as follows:
where: policy_module(<name>,<version>)
<directory> is /usr/share/selinux/devel ##############################
<file_name> is the name of the UNIX file, created to save the policy module statement. where:
It is a good idea to use the same name for policy module and the file. <name> is the name of the policy module. You can give any unique name to the policy
For example: When you are creating a policy module for backup_IDA application, you module, such as a process or application name.
can use the following file name: backup_IDA.te <version> is the version of the policy module. It can be any number, such as 1.0.0.
For Example: While creating a policy module for the backup_IDA application, you can
use the following content.
policy_module(backup_IDA,1.0.0)
<directory>/<file_name>.fc The content of the file should be as follows:
where: Note that the following list of files is not exhaustive. If the process fails to launch,
<directory> is /usr/share/selinux/devel check /var/log/messages. Also, if required, add it to the following list of files.
<file_name> is the name of the UNIX file, created to save the policy module statement. /opt/<software installation directory>/Base/libCTreeWrapper.so --
It is a good idea to use the same name for policy module and the file. gen_context(system_u:object_r:texrel_shlib_t,s0)
For example: When you are creating a policy module for backup_IDA application, you /opt/<software installation directory>/Base/libCVMAGuiImplgso --
can use the following file name: backup_IDA.fc gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libdb2locale.so.1 --
gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libdb2osse.so.1 --
gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libDb2Sbt.so --
gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libdb2trcapi.so.1 --
gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libDrDatabase.so --
gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libIndexing.so --
gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libSnooper.so --
gen_context(system_u:object_r:texrel_shlib_t,s0)
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
The CommCell Console as a Remote Web-Based Application is supported on any operating system running a supported Java-enabled web browser.
Supported Web Browsers
Apple Safari version 8.0 and later
Google Chrome version 40.0 and later
Microsoft Edge
Microsoft Internet Explorer (IE) version 10 and later
Mozilla Firefox version 36.0 and later
Display
The minimum resolution required to properly display the CommCell Console is 1280x1024.
The graphical icons in the CommCell Console cannot be displayed in VGA mode. This affects the appearance of the toolbar and the CommCell tree in the CommCell
Browser. Also, some table of contents is not displayed correctly.
Miscellaneous
The CommCell Console supports Internet Protocol version 6 (IPv6). See IPv6 Requirements for more information.
Java Runtime Environment (JRE)
The software supports Java 8 Update 65 (JRE 1.8.0_65) or later versions.
Important: Oracle has discovered an issue with some versions of their Java software. This issue prevents the CommCell Console from starting when it is accessed as a web-
based application. To avoid this issue, do not install Java 8 Update 72, 74, 77, 91, 92, or 102 (versions 1.8.0_72, 1.8.0_74, 1.8.0_77, 1.8.0_91, 1.8.0_92, and 1.8.0_102). You can
install Java version 1.8.0_101 and all subsequent CPU (Critical Patch Update) versions.
If a supported version of Java is not installed on the computer, you will be prompted to install Java 8 update 65.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Best Practice
Use the latest version of the operating system software listed in the Operating System table. Commvault software fully supports the latest version of an operating system
until the Microsoft Extended Support End Date. Newer versions of Commvault software might not install on operating systems for which Microsoft support has ended. For
information about the Microsoft support lifecycle, go to the Microsoft Support website, Microsoft Support Lifecycle.
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions
Microsoft Windows Server 2012 R2 Editions
Windows Server 2008
Microsoft Windows Server 2008 R2 Editions*
*Core Editions are not supported.
Hard Drive
2 GB of local disk space for the Web Console software and log file growth. 4 GB recommended
1 GB of temp space on the drive on where the temp folder resides
Processor
All Windows-compatible processors supported
Supported Web Browsers
Apple Safari version 8.0 and later
Google Chrome version 40.0 and later
Microsoft Edge
Microsoft Internet Explorer (IE) version 10 and later
Mozilla Firefox version 36.0 and later
Miscellaneous
The following is automatically installed during the installation of this software if it is not already installed:
Apache Tomcat Server
File System iDataAgent - For System Requirements specific to the File System iDataAgent, refer to System Requirements - Microsoft Windows File System iDataAgent .
For successful web restore of NAS data and Domino emails, install a 32-bit File System proxy instance on a 64-bit machine.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions
Microsoft Windows Server 2012 R2 Editions
Windows Server 2008
Microsoft Windows Server 2008 32-bit and x64 Editions*
Microsoft Windows Server 2008 R2 Editions*
*Core Editions are not supported.
Hard Drive
1 GB minimum of hard disk space for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
Miscellaneous
Services
It is recommended that your Active Directory server has DNS services configured.
The File System Agent is installed automatically during the installation of this software component (if it is not installed already). To review the system requirements of the
File System Agent, see System Requirements - Microsoft Windows File System Agent .
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
Hard Drive
Windows
1 GB minimum disk space is required for software installation.
256 MB is required for the job result directory.
256 MB is required for the log directory.
Linux
2 GB minimum disk space is required for software installation.
256 MB is required for the job result directory.
256 MB is required for the log directory.
AIX
3 GB minimum disk space is required for software installation.
256 MB is required for the job results directory
256 MB is required for the log directory
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
libstdc++.so
On Linux, if you have installed libstdc++.so.6, make sure to install the compat-stdlibc++ rpm containing libstdc++.so.5 also.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Hard Drive
See System Requirements - DB2 iDataAgent
Solaris Zones/Containers Support
For a comprehensive list of supported components, see Unix Virtualization .
AIX LPAR/WPAR Support
Data protection on Logical Partitioning (LPAR) and Workload Partitioning (WPAR) is supported.
Miscellaneous
SELinux
If you have SELinux enabled on the client computer, create the SELinux policy module as a root user before performing a backup. The SELinux Development package must
be installed on the client.
To create an SELinux policy module, perform the following steps as user "root":
1. Create the following files in the /usr/share/selinux/devel directory:
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Windows 2008
Microsoft Windows Server 2008 32-bit and x64 Editions* All Windows-compatible processors supported
*Core Editions are not supported.
Hard Drive
1GB of minimum disk space is required for installing the software.
256MB of free disk space is required for job result directory.
256MB of free disk space is required for log directory.
Supported Databases
Oracle
Oracle 10g R2 (10.2.x)
Oracle 11g R1
Oracle 11g R2
DB2
DB2 9.5 Universal Database
DB2 9.7 Universal Database
SQL
Microsoft SQL Server 2005 Editions up to the latest Service Pack
Microsoft SQL Server 2008 Editions up to the latest Service Pack
Microsoft SQL Server 2008 R2 Editions up to the latest Service Pack
Microsoft SQL Server 2012 Editions*
*See Considerations for SQL Server 2012 .
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Microsoft Windows Server 2008 32-bit and x64 Editions* All Windows-compatible processors supported
*Core Editions are not supported.
Windows Vista
Microsoft Windows Vista 32-bit and x64 Editions All Windows-compatible processors supported
Windows XP
Microsoft Windows XP Professional Edition 32-bit with a minimum of Service Pack 3 All Windows-compatible processors supported
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
Hard Drive
Image Level on UNIX
1 GB minimum disk space for software installation.
10 GB of free disk space is required for job result directory.
1 GB of free disk space is required for log directory.
Image Level on Windows
1 GB minimum disk space for software installation.
10 GB of free disk space is required for job result directory.
500 MB of free disk space is required for log directory.
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
The Unix File System snapshots cannot be backed up by non-CXBF backup jobs. The Unix QSnap® (cxbf) driver does not support volumes created by Solaris
Volume Manager.
On AIX clients, Data Blocks Only backups are supported for full backups only.
The Image Level iDataAgent on Unix can perform a File Level Restore only when the OS of the Client computer and the MediaAgent are the same.
For a complete listing of applications supported for each operating system, see Image Level - Application Support .
For Windows, when volumes are backed up using the Image Level agent, sharing attributes for volumes and folders are not retained.
For Windows, file-level restores require the MediaAgent Index Cache to reside on an NTFS partition. In the case of a MediaAgent whose Index Cache resides on
a FAT partition, use volume-level restores.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Windows 2008
Microsoft Windows Server 2008 x64 Editions
*Core Editions are not supported.
Windows 2008
Microsoft Windows Server 2008 x64 Editions
*Core Editions are not supported.
Windows 2008
Microsoft Windows Server 2008 x64 Editions
Informix 11.70 UCx on:
Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 5.x with glibc 2.5.x x86 or compatible
processors
SuSE Linux (SLES)
SuSE Linux 11.x with glibc 2.9.x and later x86 or compatible
processors
Informix 11.70 TCx on:
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions
*Core Editions are not supported.
Windows 2008
Microsoft Windows Server 2008 32-bit Editions
*Core Editions are not supported.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
Hard Drive
Windows
479 MB minimum of hard disk space for software.
68 MB of free disk space for log files.
68 MB of free disk space for job results.
Linux
742 MB minimum of hard disk space for software.
87 MB of free disk space for log files.
87 MB of free disk space for job results.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Windows 2008
Microsoft Windows Server 2008 Editions All Windows-compatible processors supported
*Core Editions are not supported.
Windows 2008
Microsoft Windows Server 2008 Editions All Windows-compatible processors supported
*Core Editions are not supported.
Hard Drive
1.5GB of minimum disk space is required for installing the software.
Miscellaneous
The File System iDataAgent will be automatically installed during installation of this software, if it is not already installed. For System Requirements and install information
specific to the File System iDataAgents, refer to:
System Requirements - Microsoft Windows File System iDataAgent
System Requirements - AIX File System iDataAgent
System Requirements - Linux File System iDataAgent
System Requirements - Solaris File System iDataAgent
SELinux
If you have SELinux enabled on the client computer, create the SELinux policy module as a root user before performing a backup. The SELinux Development package must
be installed on the client.
To create an SELinux policy module, perform the following steps as user "root":
1. Create the following files in the /usr/share/selinux/devel directory:
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
If you have Domino server running in a clustered environment, install the IBM Domino Agent on each Domino server. For more information, see Notes
Document Restore Consideration .
Multiple Domino versions (like Domino version 9.0 and 8.5) are supported on the same UNIX client.
Windows 2008
Microsoft Windows Server 2008 Editions All Windows-compatible processors supported
*Core Editions are not supported.
Windows 2008
Microsoft Windows Server 2008 Editions All Windows-compatible processors supported
*Core Editions are not supported.
Hard Drive
1.5 GB minimum of hard disk space for installing the software.
500 MB of free disk space is required for job result directory.
Miscellaneous
The File System iDataAgent will be automatically installed during installation of this software, if it is not already installed. For System Requirements and install information
specific to the File System iDataAgents, refer to:
System Requirements - Microsoft Windows File System iDataAgent
System Requirements - AIX File System iDataAgent
System Requirements - Linux File System iDataAgent
System Requirements - Solaris File System iDataAgent
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Mac OS X
Mac OS X v10.10.x
Mac OS X v10.11.x
Mac OS X v10.12.x
Mac OS X v10.7.x
Mac OS X v10.8.x
Mac OS X v10.9.x
Hard Drive
1 GB of minimum disk space is required for installing the software.
5 GB of free disk space is required for job result directory.
3 GB of free disk space is required for log directory.
Processor
Intel-based Macintosh computers
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Application
Microsoft Exchange 2016 64-bit Server up to the latest service pack
Microsoft Exchange 2013 64-bit Server up to the latest service pack
Microsoft Exchange 2010 64-bit Server up to the latest service pack
Microsoft Exchange 2007 64-bit Server up to the latest service pack
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions*
*Core Editions are not supported.
Hard Drive
1 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
Miscellaneous
The File System Agent is installed automatically during the installation of this software component (if it is not installed already). To review the system requirements of the
File System Agent, see System Requirements - Microsoft Windows File System Agent .
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Packages are installed automatically. Multiple versions of the package can be installed on the same computer.
Microsoft Visual C++ 2013 Redistributable Package
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Application
Microsoft Exchange 2016 64-bit Server up to the latest service pack
Microsoft Exchange 2013 64-bit Server up to the latest service pack
Microsoft Exchange 2010 64-bit Server up to the latest service pack
Microsoft Exchange 2007 64-bit Server up to the latest service pack
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions*
*Core Editions are not supported.
Hard Drive
1 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
Miscellaneous
The File System Agent is installed automatically during the installation of this software component (if it is not installed already). To review the system requirements of the
File System Agent, see System Requirements - Microsoft Windows File System Agent .
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
When using Windows Server 2008 R2 Core Editions, you need to install .NET Framework 4.0 manually.
Microsoft Visual C++
The following Redistributable Packages are installed automatically. Multiple versions of the package can be installed on the same computer.
Microsoft Visual C++ 2013 Redistributable Package
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Application
Microsoft Exchange 2013 64-bit Server up to the latest service pack
Microsoft Exchange 2010 64-bit Server up to the latest service pack
Microsoft Exchange 2007 64-bit Server up to the latest service pack
See the installation prerequisites for Exchange Server 2013 .
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions*
*Core Editions are not supported.
Hard Drive
1 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
Miscellaneous
The File System Agent is installed automatically during the installation of this software component (if it is not installed already). To review the system requirements of the
File System Agent, see System Requirements - Microsoft Windows File System Agent .
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Packages are installed automatically. Multiple versions of the package can be installed on the same computer.
Microsoft Visual C++ 2013 Redistributable Package
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Application
Microsoft Windows SharePoint Services version 3.0 up to the latest Service Pack
Microsoft SharePoint Server 2016*
Microsoft SharePoint Foundation 2013
Microsoft SharePoint Foundation 2010
Microsoft SharePoint 2013 Standard and Enterprise
Microsoft SharePoint 2010 Standard and Enterprise
Microsoft Search Server 2010 Express
Microsoft Search Server 2010
Microsoft Search Server 2008 up to the latest Service Pack
Microsoft Search Server 2008 Express up to the latest Service Pack
Microsoft Office SharePoint Server 2007 up to the latest Service Pack
Microsoft Office Project Server 2013
Microsoft Office Project Server 2010 (Project Server Service Application not supported)
Microsoft Office Project Server 2007 (PWA not supported)
Microsoft Office Forms Server 2007 up to the latest Service Pack
Microsoft FAST Search Server 2010
*See Consideration for SharePoint Server 2016.
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions
*Core Editions are not supported.
Hard Drive
708 MB minimum of hard disk space for installing the software.
500 MB of free disk space is required for log directory.
You must consider the size of the index cache while deciding on the required hard drive space for Search Service Application restore.
Also, allot an appropriate amount of temporary space in the Job Results folder to accommodate staging of the Site Collections and subsites.
Job Results folder size should be categorized based on the backupsets used as shown below:
For Databases - It should be twice the size of the largest service applications database size.
For Site Collections - It should be twice the size of the largest site collection size.
For Documents - It should be twice the size of the largest subsite.
Note: For Documents backupset, allocate space in the Job Results folder if you are not selecting the Use direct database access check box while running a backup
operation.
UNC paths are also supported for job results directory by the SharePoint Server Agent.
When assigning UNC paths, the designated directory must be ONE level below the directory which is shared for this purpose.
Examples:
\\machine1\<share_name>\job_results\ is shared. Then specify \\machine1\<share_name>\job_results\job_results_1 as the job results directory.
\\machine1\<share_name>\job_results\ is shared. Then specifying \\machine1\<share_name>\job_results as the job results directory is not supported.
Processor
All Windows-compatible processors supported
Miscellaneous
The File System Agent is installed automatically during the installation of this software component (if it is not installed already). To review the system requirements of the
File System Agent, see System Requirements - Microsoft Windows File System Agent .
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
.NET Framework
5/6/2017 Commvault Systems Page 476 of 587
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Notes:
It is mandatory to install .NET Framework 3.5 for 32-bit and 64-bit Windows 2008 and Windows 2003.
It is mandatory to install .NET Framework 3.5 for SharePoint 2007.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Application
Microsoft SQL Server 2016*
Microsoft SQL Server 2014 Editions up to the latest Service Pack*
Microsoft SQL Server 2012 Editions up to the latest Service Pack*
Microsoft SQL Server 2008 R2 Editions up to the latest Service Pack
Microsoft SQL Server 2008 Editions up to the latest Service Pack
Microsoft SQL Server 2005 Editions up to the latest Service Pack
.
*See Considerations for SQL Server
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions
*Core Editions not supported
Windows 7
Microsoft Windows 7 Editions
Windows Server 2008
Microsoft Windows Server 2008 Editions with a minimum of Service Pack 1*
*Core Editions not supported
Windows Vista
Microsoft Windows Vista Editions*
*Use the Commvault user account (and not the local systemaccount) to run the Commvault Communications Service (GxCVD).
Windows XP
Microsoft Windows XP Editions with a minimum of Service Pack 3
Windows Server 2016
Microsoft Windows Server 2016 Editions
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
For information on supported cluster types, see Clustering - Support .
Hard Drive
265MB of minimum disk space is required for installing the software.
50MB of additional hard disk space for log file growth.
724MB of temp space required for install or upgrade (where the temp folder resides).
Processor
All Windows-compatible processors supported
Miscellaneous
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
.NET Framework Requirements
Both .NET Framework 3.5 and 4.0 are required and are automatically installed.
Note: For .NET Framework 3.5, if the server is Windows 2012 or higher, you must manually enable the role.
Operating System
Windows 10
Microsoft Windows Client 10
Windows 8
Microsoft Windows Client 8.1
See Considerations for Microsoft Windows Server 2012, 2012 R2, and Windows 8 for more information.
Windows 7
Microsoft Windows 7 32-bit and x64 Editions
Windows Server 2008
Microsoft Windows Server 2008 Editions*
*Core Editions are not supported.
Windows Vista
Microsoft Windows Vista 32-bit and x64 Editions
Windows Server 2003
Microsoft Windows Server 2003 Editions [Extended Support ]
Windows XP
Microsoft Windows XP Home Editions with a minimum of Service Pack 3
Microsoft Windows XP Professional 32-bit and x64 Editions with a minimum of Service Pack 3
Windows Server 2016
Microsoft Windows Server 2016 Editions
*Nano Servers are not supported. See Considerations for Microsoft Windows Server 2016 for more information.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
Hard Drive
1 GB minimum of hard disk space for installing the software.
500 MB of free disk space is required for job result directory.
500 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
Office Communications Server
Live Communications Server 2005
Office Communications Server 2007
Office Communications Server 2007 R2
Lync Server 2010
Lync Server 2013
Miscellaneous
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Packages are installed automatically. Multiple versions of the package can be installed on the same computer.
Microsoft Visual C++ 2013 Redistributable Package
Microsoft Visual C++ 2010 Redistributable Package
Support for Windows Server 2000 Clients
The Commvault Version 11 software is not supported on Windows Server 2000 computers. If you want to protect the file system data of a Windows Server 2000 computer,
you must install the Commvault Version 9 software.To install a Version 9 client, see Installing Version 9 Windows Server 2000 Clients on a Version 11 CommCell
5/6/2017 Commvault Systems Page 480 of 587
Environment.
Supported File Systems
File Allocation Table (FAT) file systems
New Technology File Systems (NTFS)
Transactional File Systems
Distributed File System (DFS) data
Oracle ASM Cluster File System (Oracle ACFS)
Resilient File System (ReFS) on Windows Server 2012
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Linux Asianux
Asianux 4 x64 or compatible processors
Debian
Debian 8.x x64 or compatible processors
Debian 7.x x64 or compatible processors
Debian 6.x with glibc 2.11.x x64 or compatible processors
Debian 5.x x64 or compatible processors
Gentoo
Gentoo release 10.1 with glibc 2.6.x x64
OpenSuSE
OpenSuSE 12.1 with glibc 2.14.x x64
OpenSuSE 11.1 with glibc 2.9.x x64
Red Hat Enterprise Linux/Oracle Linux Enterprise/CentOS
Red Hat Enterprise Linux/Oracle Linux Enterprise/CentOS 7.x with glibc 2.17.x x64 or compatible processors
Red Hat Enterprise Linux/Oracle Linux Enterprise/CentOS 6.x with glibc 2.12.x x64 or compatible processors
Red Hat Enterprise Linux/Oracle Linux Enterprise/CentOS 5.x with glibc 2.5.x x64 or compatible processors
Red Hat Enterprise Linux/Oracle Linux Enterprise/CentOS 4.x with a minimum of glibc 2.3.4 x64 or compatible processors
Source Mage Linux
Source Mage Linux x64
SuSE Linux (SLES)
SuSE Linux 12.0 x64 or compatible processors
SuSE Linux 11.x with glibc 2.9.x and later x64 or compatible processors
SuSE Linux 10.x with glibc 2.4.x x64 or compatible processors
Ubuntu
Ubuntu 9.x x64 or compatible processors
Ubuntu 8.04 x64 or compatible processors
Ubuntu 16.04 LTS x64 or compatible processors
Ubuntu 14.04 LTS x64 or compatible processors
Ubuntu 12.04 LTS x64 or compatible processors
Ubuntu 10.04 LTS x64 or compatible processors
Solaris Solaris 11.x x64, Sparc T/M series
Windows 2008
Microsoft Windows Server 2008 R2 Editions* All Windows-compatible processors supported
*Core Editions are not supported.
Microsoft Windows Server 2008 32-bit and x64 Editions* All Windows-compatible processors supported
*Core Editions are not supported.
Windows 2016
Microsoft Windows Server 2016 Editions All Windows-compatible processors supported
Hard Drive
1GB of minimum disk space is required for installing the software.
256MB of free disk space is required for job result directory.
256MB of free disk space is required for log directory.
Miscellaneous
The File System iDataAgent will be automatically installed during installation of this software, if it is not already installed. For System Requirements and install information
specific to the File System iDataAgents, refer to:
System Requirements - AIX File System iDataAgent
System Requirements - HP-UX File System iDataAgent
System Requirements - Linux File System iDataAgent
System Requirements - Solaris File System iDataAgent
On Ubuntu 9.x 64-bit computers, it is required that you install the libstdc++.so.5 compatibility package. To install the package, use the following command:
[root]# sudo apt-get install libstdc++5
On Ubuntu and Debian computers, it is recommended that you install the latest packages for the operating system before installing the iDataAgent. To install the latest
packages, use the following command:
[root]# apt-get upgrade
SELinux
If you have SELinux enabled on the client computer, create the SELinux policy module as a root user before performing a backup. The SELinux Development package must
be installed on the client.
To create an SELinux policy module, perform the following steps as user "root":
1. Create the following files in the /usr/share/selinux/devel directory:
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
1 The dump.pathnode setting must be set to yes. This setting is required so that restores from incremental backups have the necessary information to complete. Consult
with SUN concerning on how to enable this setting.
Hard Disk
No minimum disk space requirement for installing the software.
All required components are installed automatically with the MediaAgent software. There is no separate software to install for NAS Clients. See System Requirements -
MediaAgent for information on install information specific to the MediaAgent.
2% of the backup size in free disk space is required for the job results directory. For example, if the backup is 40 GB, then you must have 0.8 GB of free space for the job
results directory.
256 MB of free disk space is required for log directory.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
5/6/2017 Commvault Systems Page 485 of 587
5/6/2017 Commvault Systems Page 486 of 587
System Requirements - OES File System iDataAgent
The following requirements are for the OES File System iDataAgent:
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
For information on supported cluster types, see Clustering - Support .
Hard Drive
1 GB of minimum disk space is required for installing the software.
5 GB of free disk space is required for job result directory.
3 GB of free disk space is required for log directory.
Miscellaneous
Novell TCP/IP Services configured on the computer.
Novell's Storage Management Service must be installed and configured in order to utilize the Target Service Agents.
You must have some form of name resolution between your CommServe, OES Linux computer, and MediaAgent to ensure proper operations. It is recommended that your
OES Linux computer has DNS services configured.
The OES File System iDataAgent should be used to protect the data on NSS volumes on an OES Linux computer. In order to protect the data on a POSIX File System, use the
Linux File System iDataAgent.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Windows 2008
Microsoft Windows Server 2008 R2 Editions with a minimum of Service Pack 1
Core Editions are not supported.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
For information on supported cluster types, see Clustering - Support .
Hard Drive
2 GB of minimum disk space is required for software installation.
256 MB of free disk space is required for the job result directory.
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Windows 2008
Microsoft Windows Server 2008 Editions with a minimum of Service Pack 1*
*Core Editions are not supported.
Hard Drive
See System Requirements - Oracle iDataAgent
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Windows 2008
Microsoft Windows Server 2008 R2 Editions* All Windows-compatible processors supported
*Core Editions are not supported.
Windows 2016
Microsoft Windows Server 2016 Editions All Windows-compatible processors supported
Hard Drive
512MB of minimum disk space is required for installing the software.
256MB of free disk space is required for job result directory.
256MB of free disk space is required for log directory.
Miscellaneous
The File System iDataAgent will be automatically installed during installation of this software, if it is not already installed. For System Requirements and install information
5/6/2017 Commvault Systems Page 493 of 587
specific to the File System iDataAgents, refer to System Requirements - Linux File System iDataAgent .
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Hard Drive
2 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for the job result directory.
256 MB of free disk space is required for the log directory.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Windows 2008
Microsoft Windows Server 2008 Editions with a minimum of Service Pack 1* All Windows-compatible processors supported
*Core Editions are not supported.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
Hard Drive
1 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Red Hat Enterprise Linux/CentOS 6.x with glibc 2.12.x x86, Power PC or compatible processors
Red Hat Enterprise Linux/CentOS 6.x with a minimum of glibc 2.12-1.25.x x64
Red Hat Enterprise Linux/CentOS 5.x with glibc 2.5.x x86, x64, Power PC or compatible processors
Red Hat Enterprise Linux/CentOS 4.x with a minimum of glibc 2.3.4 x86, x64, Power PC or compatible processors
SuSE Linux (SLES)
SuSE Linux 12.x with glibc 2.19.x x86, x64, Power PC or compatible processors
SuSE Linux 11.x with glibc 2.9.x and later x86, x64, Power PC or compatible processors
Solaris Solaris 11.x x64, Sparc T/M series
Windows 2008
Microsoft Windows Server 2008 Editions with a minimum of Service Pack 1*
*Core Editions are not supported.
Windows 2016
Microsoft Windows Server 2016 Editions
*Nano Servers are not supported. See Considerations for Microsoft Windows Server 2016 for more information.
SAP BR*Tools 7.4, 7.2, 7.1 and 7.0 for Oracle 10g (R1, R2 or higher) Databases on:
AIX AIX 7.2 64-bit Power PC
Windows 2008
Microsoft Windows Server 2008 Editions with a minimum of Service Pack 1*
*Core Editions are not supported.
Windows 2016
Microsoft Windows Server 2016 Editions
*Nano Servers are not supported. See Considerations for Microsoft Windows Server 2016 for more information.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
For information on supported cluster types, see Clustering - Support .
Hard Drive
2 GB of minimum disk space is required for software installation.
256 MB of free disk space is required for the job result directory.
256 MB of free disk space is required for the log directory.
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
5/6/2017 Commvault Systems Page 499 of 587
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Hard Drive
1 GB of minimum disk space is required for installing the software.
50 MB of minimum disk space is required for the log directory.
500 MB of minimum disk space is required for third-party software installations, like Apache Tomcat Server and Java.
Memory
4 GB RAM minimum required; 8 GB RAM recommended
Swap space = 2*RAM size
Miscellaneous
The File System iDataAgent will be automatically installed during installation of this software, if it is not already installed. For System Requirements and install information
specific to the File System iDataAgents, refer to System Requirements - Linux File System iDataAgent .
The following will be automatically installed during the installation of this software if it is not already installed:
Apache Tomcat Server
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
Hard Drive
Windows
674 MB minimum of hard disk space for Commvault and Job Results
10 MB of additional hard disk space for log file growth
4 KB for Job Results
Linux
584 MB minimum of hard disk space for Commvault and Job Results
1 MB for Job Results
Solaris
2.73 GB minimum of hard disk space for Commvault and Job Results
34 MB for Job Results
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
5/6/2017 Commvault Systems Page 503 of 587
5/6/2017 Commvault Systems Page 504 of 587
System Requirements - AIX File System iDataAgent
The following are the requirements for AIX File System iDataAgent:
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
Hard Drive
1 GB of minimum disk space is required for installing the software.
3 GB of free disk space is required for job result directory. To calculate the disk space requirements for job results directories for large file sets, see Job Results Directory
Disk Space Calculation .
1 GB of free disk space is required for log directory.
Files with mandatory locks are not backed up by default. See Configuring Backups for Locked Files to back up files with mandatory locks.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
For information on supported cluster types, see Clustering - Support .
Hard Drive
1 GB of minimum disk space is required for installing the software.
3 GB of free disk space is required for job result directory. To calculate the disk space requirements for job results directories for large file sets, see Job Results Directory
Disk Space Calculation .
1 GB of free disk space is required for log directory.
Miscellaneous
Schedule Jobs Using a Client Computer's Time Zone
The client computer has to be in one of the standard time zones recognized by the CommServe. Otherwise, the CommServe does not get updated with the client
computer's time zone and the jobs scheduled using the client computer's time zone might not run.
Supported File Systems
Unix File System (UFS)
Zettabyte File System (ZFS)
What Is Backed Up
File System Elements
Files with holes
Files with Advisory Locks
Files with names containing non-ASCII characters as long as the appropriate locales are set
Symbolic links that are browsed or manually added to the data contents
Shares with Macintosh File System data
Files for which the file path or file name contains more than 1024 characters
Files with mandatory locks are not backed up by default. See Configuring Backups for Locked Files to back up files with mandatory locks.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
For information on supported cluster types, see Clustering - Support .
Hard Drive
1 GB of minimum disk space is required for installing the software.
3 GB of free disk space is required for job result directory. To calculate the disk space requirements for job results directories for large file sets, see Job Results Directory
Disk Space Calculation .
1 GB of free disk space is required for log directory.
Miscellaneous
Schedule Jobs Using a Client Computer's Time Zone
The client computer has to be in one of the standard time zones recognized by the CommServe. Otherwise, the CommServe does not get updated with the client
computer's time zone and the jobs scheduled using the client computer's time zone might not run.
Supported File Systems
Hierarchical File System (HFS)
Journal File System (JFS)
Unix File System (UFS)
VERITAS File System (VxFS)
VERITAS Cluster File System (VxCFS)
Extended attributes in the VxFS and UFS file systems
Supported Volume Managers
Veritas Volume Manager (VxVM) 5.0 or higher
Logical Volume Manager (LVM)
What Is Backed Up
File System Elements
Files with holes
Files with Advisory Locks
Raw device files
A maximum path level of 10 symbolic links pointing to each raw device
Files with names containing non-ASCII characters as long as the appropriate locales are set
Symbolic links that are browsed or manually added to the data contents
Shares with Macintosh File System data
Files for which the file path or file name contains more than 1024 characters
Files with mandatory locks are not backed up by default. See Configuring Backups for Locked Files to back up files with mandatory locks.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
SuSE Linux 10.x with glibc 2.4.x x86, x64, Power PC or compatible processors
Ubuntu
Ubuntu 9.10 x86, x64 or compatible processors
Ubuntu 9.04 x86, x64 or compatible processors
Ubuntu 8.10 x86, x64 or compatible processors
Ubuntu 8.04 x86, x64 or compatible processors
Ubuntu 16.04 LTS x86, x64 or compatible processors
Ubuntu 15.10 x86, x64 or compatible processors
Ubuntu 15.04 x86, x64 or compatible processors
Ubuntu 14.10 x86, x64 or compatible processors
Ubuntu 14.04 LTS x86, x64 or compatible processors
Ubuntu 13.10 x86, x64 or compatible processors
Ubuntu 13.04 x86, x64 or compatible processors
Ubuntu 12.10 x86, x64 or compatible processors
Ubuntu 12.04 LTS x86, x64 or compatible processors
Ubuntu 11.10 x86, x64 or compatible processors
Ubuntu 11.04 x86, x64 or compatible processors
Ubuntu 10.04 LTS x86, x64 or compatible processors
Z- Linux on zSeries (System z9/z10) s390x 64-bit with 31-bit runtime libraries installed, s390 31-bit
Linux
Red Hat Enterprise Linux
Red Hat Enterprise Linux 6.x s390x 64-bit with 31-bit runtime libraries installed, s390 31-bit
Red Hat Enterprise Linux 5.x s390x 64-bit with 31-bit runtime libraries installed, s390 31-bit
Red Hat Enterprise Linux 4.x s390x 64-bit with 31-bit runtime libraries installed, s390 31-bit
SuSE Linux (SLES)
SuSE Linux 12.x Enterprise Server s390x 64-bit with 31-bit runtime libraries installed, s390 31-bit
SuSE Linux 11.x Enterprise Server s390x 64-bit with 31-bit runtime libraries installed, s390 31-bit
SuSE Linux 10.x Enterprise Server s390x 64-bit with 31-bit runtime libraries installed, s390 31-bit
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
Hard Drive
1 GB of minimum disk space is required for installing the software.
3 GB of free disk space is required for job result directory. To calculate the disk space requirements for job results directories for large file sets, see Job Results Directory
Disk Space Calculation .
1 GB of free disk space is required for log directory.
5/6/2017 Commvault Systems Page 509 of 587
Power PC Processor Support
Commvault supports the 64-bit Power PC architecture, also known by the identifier ppc64 (or "Big Endian"). The ppc64le architecture (or "Little Endian") is not supported.
Net-tools Package
On Red Hat Enterprise Linux/CentOS 7.1 computers, make sure to install the net-tools package.
Miscellaneous
Schedule Jobs Using a Client Computer's Time Zone
The client computer has to be in one of the standard time zones recognized by the CommServe. Otherwise, the CommServe does not get updated with the client
computer's time zone and the jobs scheduled using the client computer's time zone might not run.
SELinux
If you have SELinux enabled on the client computer, create the SELinux policy module as a root user before performing a backup. The SELinux Development package must
be installed on the client.
To create an SELinux policy module, perform the following steps as user "root":
1. Create the following files in the /usr/share/selinux/devel directory:
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Files with mandatory locks are not backed up by default. See Configuring Backups for Locked Files to back up files with mandatory locks.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
For information on supported cluster types, see Clustering - Support .
Hard Drive
1 GB of minimum disk space is required for installing the software.
3 GB of free disk space is required for job result directory. To calculate the disk space requirements for job results directories for large file sets, see Job Results Directory
Disk Space Calculation .
1 GB of free disk space is required for log directory.
SUNWcry package
Make sure to install the SUNWcry package.
Miscellaneous
Schedule Jobs Using a Client Computer's Time Zone
The client computer has to be in one of the standard time zones recognized by the CommServe. Otherwise, the CommServe does not get updated with the client
computer's time zone and the jobs scheduled using the client computer's time zone might not run.
Supported File Systems
Unix File System (UFS)
Oracle ASM Cluster File System (Oracle ACFS)
VERITAS File System (VxFS)
VERITAS Cluster File System (VxCFS)
Zettabyte File System (ZFS)
Extended attributes in the VxFS, UFS, and ZFS file systems
Supported Volume Managers
Veritas Volume Manager (VxVM) 5.0 or higher
Solaris Volume Manager (SVM)
What Is Backed Up
File System Elements
Files with holes
Files with Advisory Locks
Raw device files as file nodes
Symbolic links that are browsed or manually added to the data contents
Files with names containing non-ASCII characters as long as the appropriate locales are set
Shares with Macintosh File System data
Files for which the file path or file name contains more than 1024 characters
Files with mandatory locks are not backed up by default. See Configuring Backups for Locked Files to back up files with mandatory locks.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
Hard Drive
2 GB of minimum disk space is required for software installation.
256 MB of free disk space is required for the job result directory.
256 MB of free disk space is required for the log directory.
Miscellaneous
The operating system must have been installed with at least the user level software option selected.
SELinux
If you have SELinux enabled on the client computer, create the SELinux policy module as a root user before performing a backup. The SELinux Development package must
be installed on the client.
To create an SELinux policy module, perform the following steps as user "root":
1. Create the following files in the /usr/share/selinux/devel directory:
File Name Content of the File
<directory>/<file_name>.te The content of the file should be as follows:
where: policy_module(<name>,<version>)
<directory> is /usr/share/selinux/devel ##############################
<file_name> is the name of the UNIX file, created to save the policy module statement. where:
It is a good idea to use the same name for policy module and the file. <name> is the name of the policy module. You can give any unique name to the policy
For example: When you are creating a policy module for backup_IDA application, you module, such as a process or application name.
can use the following file name: backup_IDA.te <version> is the version of the policy module. It can be any number, such as 1.0.0.
For Example: While creating a policy module for the backup_IDA application, you can
use the following content.
policy_module(backup_IDA,1.0.0)
<directory>/<file_name>.fc The content of the file should be as follows:
where: Note that the following list of files is not exhaustive. If the process fails to launch,
<directory> is /usr/share/selinux/devel check /var/log/messages. Also, if required, add it to the following list of files.
<file_name> is the name of the UNIX file, created to save the policy module statement. /opt/<software installation directory>/Base/libCTreeWrapper.so --
It is a good idea to use the same name for policy module and the file. gen_context(system_u:object_r:texrel_shlib_t,s0)
For example: When you are creating a policy module for backup_IDA application, you /opt/<software installation directory>/Base/libCVMAGuiImplgso --
can use the following file name: backup_IDA.fc gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libdb2locale.so.1 --
gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libdb2osse.so.1 --
5/6/2017 Commvault Systems Page 513 of 587
gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libDb2Sbt.so --
gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libdb2trcapi.so.1 --
gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libDrDatabase.so --
gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libIndexing.so --
gen_context(system_u:object_r:texrel_shlib_t,s0)
/opt/<software installation directory>/Base/libSnooper.so --
gen_context(system_u:object_r:texrel_shlib_t,s0)
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Application
Microsoft Exchange 2016 64-bit Server up to the latest service pack
Microsoft Exchange 2013 64-bit Server up to the latest service pack
Microsoft Exchange 2010 64-bit Server up to the latest service pack
Microsoft Exchange 2007 64-bit Server up to the latest service pack
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions*
*Core Editions are not supported.
Hard Drive
1 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
Miscellaneous
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Packages are installed automatically. Multiple versions of the package can be installed on the same computer.
Microsoft Visual C++ 2013 Redistributable Package
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Windows 8
Microsoft Windows Client 8
Windows Server 2012
Microsoft Windows Server 2012 Editions
Microsoft Windows Server 2012 R2 Editions
Microsoft Windows Server 2012 R2 Editions
Windows 7
Microsoft Windows 7 32-bit and x64 Editions
Windows Server 2008
Microsoft Windows Server 2008 32-bit and x64 Editions*
*Core Editions are not supported.
Windows Vista
Microsoft Windows Vista Ultimate 32-bit Edition
Microsoft Windows Vista Ultimate x64 Edition
Windows Server 2003
Microsoft Windows Server 2003 Editions [Extended Support ]
Windows XP
Microsoft Windows XP Professional x64 Edition with a minimum of Service Pack 3
Windows Server 2016
Microsoft Windows Server 2016 Editions
Hard Drive
File Share Archiver Client
600 MB of minimum hard disk space is required for installing the software.
OnePass for Hitachi HNAS (BlueArc) File Server
1 GB of minimum disk space is required for installing the software.
500 MB of free disk space is required for job result directory.
In addition, number of archived files * 4 KB space is required for stub cache directory.
500 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
File Servers
Isilon
In order to support cluster failover:
You must use EMC Isilon SmartConnect Advanced.
OnePass operations uses the SmartConnect Internet Protocol (IP) address instead of the physical IP.
BlueArc
The OnePass for Hitachi HNAS (BlueArc) file server feature can perform data protection and recovery operations for data on Hitachi HNAS (BlueArc) file server versions
up to 12.5.
Miscellaneous
Special considerations apply if using the OnePass for Windows Agent in an IPv6 environment. See Configuring IPv6 for OnePass and IPv6 Requirements for more
information.
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software
works. Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault.
Platforms that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-
party minor releases or service packs are compatible with the Commvault software.
Operating System
Windows 10
Microsoft Windows Client 10
Windows 8
Microsoft Windows Client 8
Windows Server 2012
Microsoft Windows Server 2012 Editions
Microsoft Windows Server 2012 R2 Editions
Microsoft Windows Server 2012 R2 Editions
Windows 7
Microsoft Windows 7 32-bit and x64 Editions
Windows Server 2008
Microsoft Windows Server 2008 32-bit and x64 Editions*
*Core Editions are not supported.
Windows Vista
Microsoft Windows Vista Ultimate 32-bit Edition
Microsoft Windows Vista Ultimate x64 Edition
Windows Server 2003
Microsoft Windows Server 2003 Editions [Extended Support ]
Windows XP
Microsoft Windows XP Professional x64 Edition with a minimum of Service Pack 3
Windows Server 2016
Microsoft Windows Server 2016 Editions
Hard Drive
OnePass for Celerra File Server
1 GB of minimum disk space is required for installing the software.
500 MB of free disk space is required for job result directory.
In addition, number of archived files * 4 KB space is required for stub cache directory.
500 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
File Server
The File Archiver for Celera Agent can perform data protection/recovery operations for data on the following file server versions:
Vendor File Server Version
EMC Celerra DART OS 5.5
DART OS 5.6
DART OS 6.0
DART OS 7.0
Miscellaneous
Special considerations apply if using the OnePass for Windows Agent in an IPv6 environment. See Configuring IPv6 for OnePass and IPv6 Requirements for more
information.
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
5/6/2017 Commvault Systems Page 518 of 587
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Mac OS X
Mac OS X v10.10.x
Mac OS X v10.11.x
Mac OS X v10.12.x
Mac OS X v10.7.x
Mac OS X v10.8.x
Mac OS X v10.9.x
Hard Drive
1 GB of minimum disk space is required for installing the software.
5 GB of free disk space is required for job result directory.
3 GB of free disk space is required for log directory.
Processor
Intel-based Macintosh computers
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Windows 8
Microsoft Windows Client 8.1
See Considerations for Microsoft Windows Server 2012, 2012 R2, and Windows 8 for more information.
Windows 7
Microsoft Windows 7 32-bit and x64 Editions
Windows Server 2008
Microsoft Windows Server 2008 32-bit and x64 Editions*
*Core Editions are not supported.
Windows Vista
Microsoft Windows Vista Ultimate 32-bit Edition
Microsoft Windows Vista Ultimate x64 Edition
Windows Server 2003
Microsoft Windows Server 2003 Editions [Extended Support ]
Microsoft Windows Server 2003 Editions [Extended Support ]
Windows XP
Microsoft Windows XP Professional x64 Edition with a minimum of Service Pack 3
Windows Server 2016
Microsoft Windows Server 2016 Editions
Hard Drive
OnePass for Windows File System
1 GB of minimum disk space is required for installing the software.
500 MB of free disk space is required for job result directory.
In addition, number of archived files * 4 KB space is required for stub cache directory.
500 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
Miscellaneous
Special considerations apply if using the OnePass for Windows Agent in an IPv6 environment. See Configuring IPv6 for OnePass and IPv6 Requirements for more
information.
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
When using Windows Server 2008 R2 Core Editions, you need to install .NET Framework 4.0 manually.
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Windows 10
Microsoft Windows Client 10
Windows 8
Microsoft Windows Client 8.1
See Considerations for Microsoft Windows Server 2012, 2012 R2, and Windows 8 for more information.
Windows 7
Microsoft Windows 7 32-bit and x64 Editions
Windows Server 2008
Microsoft Windows Server 2008 32-bit and x64 Editions*
*Core Editions are not supported.
Windows Vista
Microsoft Windows Vista Ultimate 32-bit Edition
Microsoft Windows Vista Ultimate x64 Edition
Windows Server 2016
Microsoft Windows Server 2016 Editions
Hard Drive
Driverless OnePass for Windows
1 GB of minimum disk space is required for installing the software.
500 MB of free disk space is required for job result directory.
In addition, number of archived files * 4 KB space is required for stub cache directory.
500 MB of free disk space is required for log directory.
Memory
32 MB RAM minimum required beyond the requirements of the operating system and running applications
Processor
All Windows-compatible processors supported
Miscellaneous
Special considerations apply if using the OnePass for Windows Agent in an IPv6 environment. See Configuring IPv6 for OnePass and IPv6 Requirements for more
information.
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Windows 10
Microsoft Windows Client 10
Windows 8
Microsoft Windows Client 8
Windows Server 2012
Microsoft Windows Server 2012 Editions
Microsoft Windows Server 2012 R2 Editions
Windows 7
Microsoft Windows 7 32-bit and x64 Editions
Windows Server 2008
Microsoft Windows Server 2008 32-bit and x64 Editions*
*Core Editions are not supported.
Windows Vista
Microsoft Windows Vista Ultimate 32-bit Edition
Microsoft Windows Vista Ultimate x64 Edition
Windows Server 2003
Microsoft Windows Server 2003 Editions [Extended Support ]
Windows XP
Microsoft Windows XP Professional x64 Edition with a minimum of Service Pack 3
Windows
Microsoft Windows Server 2008 R2 Editions*
Hard Drive
OnePass for NetApp File Server
1 GB of minimum disk space is required for installing the software.
500 MB of free disk space is required for job result directory.
In addition, number of archived files * 4 KB space is required for stub cache directory.
500 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
File Servers
The File Archiver for NetApp Agent can perform data protection/recovery operations for data on the following file server versions:
ONTAP version 7.0
ONTAP version 7.0.2
ONTAP version 7.1
ONTAP version 7.1.2.1
ONTAP version 7.2
ONTAP version 7.3
ONTAP version 8.0 (7-Mode supported)
ONTAP version 8.0.2 (7-Mode supported)
ONTAP version 8.1 (7-Mode supported)
ONTAP version 8.2 (7-Mode supported)
ONTAP version 8.2.2 or later (Cluster-Mode supported)
vFiler
For versions earlier than 7.0 and version 7.1, a Network File Share Instance type must be used.
Each File Archiver for Windows agent can support multiple NetApp file servers, which have the same ONTAP version, whereas a separate File Archiver for Windows
agent is required for each ONTAP version.
Notes
For a proxy FPolicy server on a Windows 2008 or 2012 computer, the file server must use ONTAP version 8.0.2 and later. However, if you are using an ONTAP version older
than 8.0.2, then the proxy FPolicy server must be configured on a Windows 2003 computer.
Miscellaneous
Special considerations apply if using the OnePass for Windows Agent in an IPv6 environment. See Configuring IPv6 for OnePass and IPv6 Requirements for more
information.
For standalone installs of File Share Archiver Clients, it is required to have the .NET Framework 2.0 Redistributable Package installed on the computer.
5/6/2017 Commvault Systems Page 523 of 587
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Application
Microsoft Exchange 2016 64-bit Server up to the latest service pack
Microsoft Exchange 2013 64-bit Server up to the latest service pack
Microsoft Exchange 2010 64-bit Server up to the latest service pack
Microsoft Exchange 2007 64-bit Server up to the latest service pack
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions*
*Core Editions are not supported.
Hard Drive
1 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
Miscellaneous
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Packages are installed automatically. Multiple versions of the package can be installed on the same computer.
Microsoft Visual C++ 2013 Redistributable Package
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Novell OES2 Linux up to SP2 (SLES 10 SP2) 32-bit Intel Pentium or compatible minimum required
Novell OES11 Linux up to SP1 (SLES 11 SP1) 64-bit x64
Novell OES11 Linux up to SP1 (SLES 11 SP1) 32 -bit Intel Pentium or compatible minimum required
Novell OES 2015 Linux (SLES 11 SP3) Intel Pentium or compatible minimum required
Oracle Linux
Oracle Linux 6.x with kernel 2.6.32.x Intel Pentium or compatible minimum required
Oracle Linux 6.x Intel Pentium or compatible minimum required
Oracle Linux 5.x with kernel 2.6.18.x Intel Pentium or compatible minimum required
Red Hat Enterprise Linux
Red Hat Enterprise Linux 7.3 Advanced Platform with kernel 3.10.0-514 x64
Red Hat Enterprise Linux 7.3 Advanced Platform with kernel 3.10.0-514 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 7.2 Advanced Platform with kernel 3.10.0-327 x64
Red Hat Enterprise Linux 7.2 Advanced Platform with kernel 3.10.0-327 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 7.1 Advanced Platform with kernel 3.10.0-229 x64
Red Hat Enterprise Linux 7.1 Advanced Platform with kernel 3.10.0-229 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 7.0 Advanced Platform with kernel 3.10.0-123 x64
Hard Drive
1 GB of minimum disk space is required for installing the software.
5 GB of free disk space is required for job result directory.
3 GB of free disk space is required for log directory.
Cluster Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems. For information on supported cluster types, see Clustering
- Support .
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
The following requirements are for the Generic NAS File Archiver:
Operating System
Windows 7
Microsoft Windows 7 32-bit and x64 Editions
Windows Server 2008
Microsoft Windows Server 2008 32-bit and x64 Editions*
*Core Editions are not supported.
Windows Vista
Microsoft Windows Vista Ultimate 32-bit Edition
Microsoft Windows Vista Ultimate x64 Edition
Windows XP
Microsoft Windows XP Professional 32-bit Edition with a minimum of Service Pack 3
Microsoft Windows XP Professional x64 Edition with a minimum of Service Pack 3
Windows
Microsoft Windows Server 2003 32-bit and x64 Editions* with a minimum of Service Pack 2
*Core Editions are not supported.
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
For information on supported cluster types, see Clustering - Support .
Hard Drive
1 GB of minimum disk space is required for installing the software.
500 MB of free disk space is required for job result directory.
In addition, number of archived files * 4 KB space is required for stub cache directory.
500 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
File Servers
The File Archiver for Isilon and other Agents can perform data protection/recovery operations on the file server versions.
Miscellaneous
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Windows 2008
Microsoft Windows Server 2008 Editions All Windows-compatible processors supported
*Core Editions are not supported.
Windows 2008
Microsoft Windows Server 2008 Editions All Windows-compatible processors supported
*Core Editions are not supported.
Hard Drive
1.5 GB minimum of hard disk space for software.
500 MB of free disk space is required for job result directory.
IBM Notes Add-In
The IBM Notes Add-In is supported with the following Notes client applications running on a Microsoft Windows platform:
Notes Client 8.5.x
Notes Client 8.0.x
Notes Client 9.0.x
Miscellaneous
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Application
Microsoft Exchange 2016 64-bit Server up to the latest service pack
Microsoft Exchange 2013 64-bit Server up to the latest service pack
Microsoft Exchange 2010 64-bit Server up to the latest service pack
Microsoft Exchange 2007 64-bit Server up to the latest service pack
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions*
*Core Editions are not supported.
Hard Drive
1 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
Miscellaneous
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Packages are installed automatically. Multiple versions of the package can be installed on the same computer.
Microsoft Visual C++ 2013 Redistributable Package
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Application
Microsoft Exchange 2013 64-bit Server up to the latest service pack
Microsoft Exchange 2010 64-bit Server up to the latest service pack
Microsoft Exchange 2007 64-bit Server up to the latest service pack
See the installation prerequisites for Exchange Server 2013 .
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions*
*Core Editions are not supported.
Hard Drive
1 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
Miscellaneous
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Packages are installed automatically. Multiple versions of the package can be installed on the same computer.
Microsoft Visual C++ 2013 Redistributable Package
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions*
*Core Editions not supported
Hard Drive
1 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
Miscellaneous
The File System Agent is installed automatically during the installation of this software component (if it is not installed already). To review the system requirements of the
File System Agent, see System Requirements - Microsoft Windows File System Agent .
.NET Framework
.NET Framework 4.5 is automatically installed. Note that .NET Framework 4.5 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Packages are installed automatically. Multiple versions of the package can be installed on the same computer.
Microsoft Visual C++ 2013 Redistributable Package
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Amazon Regions
When Amazon adds a new region, Software Development Kit upgrades are required before Commvault support can be added. For this reason, Commvault support for
newly added regions will be added after the new regions are made available by Amazon.
Firewall Requirements
In an environment with firewalls, the following requirements apply:
To enable installation of the Virtual Server Agent to Amazon instances and communication with the CommServe system, open tunnel ports (for example, 8400 and
8403) in the security group for the instance.
To perform backup and restore operations using a VSA proxy on an Amazon instance, open port 443 in the security group for the VSA proxy instance.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Proxies
The Virtual Server Agent can be deployed on a physical or virtual machine running Linux.
Only machines that have the VSA installed can act as VSA proxies to perform backups and restores.
The following operating systems are supported for VSA proxies:
Redhat 6.3
CentOS 7.2
CentOS 7.3
At least one proxy is needed.
The proxy machine must have access to repositories and backup storage resources.
Port Requirements
When the Docker environment includes a firewall, ensure that CVD port 8400 is configured to accept incoming traffic from Commvault.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Proxies
The Virtual Server Agent can be deployed on a physical or virtual machine running Windows, Linux, or UNIX.
Only machines that have the VSA installed can act as VSA proxies to perform backups and restores.
The following operating systems are supported for VSA proxies:
CentOS 6.x, 7
RHEL 6.x, 7
Windows Server 2008 R2
Windows Server 2012 R2
At least one proxy is needed.
The proxy VM must have access to repositories and backup storage resources.
Port Requirements
When the FusionCompute environment includes a firewall, ensure that CVD port 8400 is configured to accept incoming traffic from Commvault.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Firewall Requirements
Tunnel ports (for example, 8400 and 8403) must be opened in the security group for the instance to enable installation of the Virtual Server Agent to Azure virtual machines
and communication with the CommServe system.
If you deploy a CommServe host in an environment with firewalls, create a persistent route from the CommServe host to the VSA proxy, as documented in Setting Up Proxy
Connections Using a Predefined Firewall Topology . Specify the RESTRICTED setting for connections from the CommServe host to the VSA proxy (step 3 under If you chose
not to use predefined firewall topologies) and the BLOCKED setting in the CommServe node settings for the proxy (step 9).
If a firewall proxy is installed, configure Internet options for the firewall proxy machine. On the HTTP Proxy tab of the Internet Options dialog box, enter the user name and
password for the firewall proxy machine, using only the user name and not including the domain name with the user name.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Hyper-V Requirements
Physical Machine Operating Systems - Hyper-V Virtual Servers
Microsoft Windows Server 2016
Microsoft Hyper-V Server 2016
Microsoft Windows Server 2012 R2 (including Core Edition)
Microsoft Hyper-V Server 2012 R2 (including Core Edition)
Microsoft Windows Server 2012 (including Core Edition)
Microsoft Hyper-V Server 2012 (including Core Edition)
Microsoft Windows Server 2008 R2 SP1*
*Core Editions are not supported.
Note: A cluster can include Nano Server nodes provided that at least one node in the cluster is running Windows Server 2016 (Data Center Edition recommended) and has
the Virtual Server Agent installed. The Enterprise server can perform remote backups for virtual machines running on Nano Server nodes if the virtual machines reside on
CSV or SMB storage.
Hard Drive
100GB recommended. If performing backups with the granular recovery option enabled, the location of the Job Results folder should contain additional space to
accommodate at least 2 percent of the total amount of data being backed up.
Memory
2 GB RAM minimum required beyond the requirements of the operating system and running applications
Miscellaneous
Allocation Unit Size of the NTFS Volumes
The cluster size or the allocation unit size of an NTFS volume in a virtual machine must be multiple of 1024 bytes. You can set the cluster size before formatting a volume.
The default cluster size is 4096 bytes.
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
CommServe Requirements
See System Requirements - CommServe .
MediaAgent Requirements
See System Requirements - MediaAgent .
2. Disable and stop the lvm2-lvmetad.socket service by running the following commands:
systemctl disable lvm2-lvmetad.socket
systemctl stop lvm2-lvmetad.socket
3. Disable lvmetad in the LVM config file by running the following command:
edit /etc/lvm/lvm.conf to include use_lvmetad = 0
Port Requirements
For application consistent backups of user VMs, ensure that user VMs can access Nutanix Controller VMs using the CVM Virtual IP (port 2074).
Ensure that the CommServe computer, MediaAgents, and Virtual Server Agent can communicate with Nutanix AHV using Prism port 9440.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
2. Disable and stop the lvm2-lvmetad.socket service by running the following commands:
systemctl disable lvm2-lvmetad.socket
systemctl stop lvm2-lvmetad.socket
3. Disable lvmetad in the LVM config file by running the following command:
edit /etc/lvm/lvm.conf to include use_lvmetad = 0
MediaAgent Requirements
The following packages must be installed on MediaAgents that are used for guest file browse and restore operations on Glance images:
QEMU disk image utility (qemu-img)
libguestfs
libguestfs-tools
Logical Volume Management (lvm)
Port Requirements
The security group associated with the proxy instance should permit all incoming and outgoing TCP traffic.
If unrestricted access cannot be set up, configure a one-way Commvault firewall between the CommServe host or MediaAgent and the VSA proxy instance. With this
firewall configuration, you can restrict communication to a single TCP port (typically port 8400).
When using the RHEL-OP distribution or in any OpenStack environment that includes a firewall, ensure that CVD port 8400 is configured to accept incoming traffic from
Commvault.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Proxies
Deploy the Virtual Server Agent on a Windows virtual machine in the Oracle VM Manager environment. The following virtual machine types are supported for VSA proxies:
Windows Server 2008 R2
Windows Server 2012 R2
Oracle Linux 6.x, 7.x
RHEL 6.x, 7.x
CentOS 6.x, 7.x
Notes:
Both Windows and UNIX proxies must be based on OVM domain type Xen HVM PV drivers.
Windows proxy machines should be installed with Oracle VM Windows PV drivers version 2.3.2 or later.
Only virtual machines that have the VSA installed can act as VSA proxies to perform backups and restores.
At least one proxy is needed.
If a VM resides on a shared repository, the proxy VM must reside on the same repository.
Port Requirements
When the Oracle VM Manager environment includes a firewall, ensure that CVD port 8400 is configured to accept incoming traffic from Commvault.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
2. Disable and stop the lvm2-lvmetad.socket service by running the following commands:
systemctl disable lvm2-lvmetad.socket
systemctl stop lvm2-lvmetad.socket
3. Disable lvmetad in the LVM config file by running the following command:
edit /etc/lvm/lvm.conf to include use_lvmetad = 0
Storage
Network File System (NFS), iSCSI, and Fibre Channel
Red Hat Guest Tools
Red Hat guest tools must be installed in VSA proxy machines.
Red Hat Subscriptions
Use the Red Hat Subscription Manager to subscribe to all required channels.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
VMware vSphere
The following versions are supported for vSphere, vCenter, vCenter Server Appliance, and ESX or ESXi:
4.1* or later, 5.0.x, 5.1.x, 5.5, 5.5.1, 5.5.2, 5.5.3**, 6.0, 6.0.1, 6.0.2, 6.0.3, 6.5***
Before configuring backup of any ESXi servers, ensure that you are using Essentials licensing level or higher. The vStorage APIs for Data Protection (VADP) are not provided
with the free version of ESXi.
* If VMs are part of ESX 4.1, then streaming and IntelliSnap backups are supported only through the vCenter. You cannot use a standalone ESX 4.1 server.
** VDDK 5.5 or higher is required for vSphere 5.5 support.
***VDDK 6.0.2 and VDDK 6.5 are both included with the Virtual Server Agent. The appropriate VDDK for the vSphere version is loaded automatically when
required. For more details, see VDDK Support for the Virtual Server Agent .
Customers can also update the VDDK manually . Do not place VDDK files in the VDDK installation in the CommVault base directory.
With VDDK 5.5 and later, 32-bit libraries and binaries are no longer supported.
Hardware Specifications
The hardware requirements for Virtual Server Agent installed on either physical or virtual machines is explained in Hardware Specifications for Virtual Server Agent .
Note:
If performing backups with the granular recovery option enabled, the location of the Job Results folder should contain additional space to accommodate at least 2 percent
of the total amount of data being backed up.
Miscellaneous
Allocation Unit Size of the NTFS Volumes
The cluster size or the allocation unit size of an NTFS volume in a virtual machine must be multiple of 1024 bytes. You can set the cluster size before formatting a volume.
The default cluster size is 4096 bytes.
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions
Microsoft Windows Server 2012 R2 Editions
Windows Server 2008
Microsoft Windows Server 2008 R2 x64 Editions*
*Core Editions are not supported.
Memory
24GB RAM
Processor
All Windows-compatible processors supported
Hardware Requirements
6 GB of local disk space for software
6TB of 10K locally attached SCSI or Fibre attached SAN disk dedicated to the index
SATA is not supported
Miscellaneous
The File System Agent is installed automatically during the installation of this software component (if it is not installed already). To review the system requirements of the
File System Agent, see System Requirements - Microsoft Windows File System Agent .
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Windows x64 MediaAgent
The Search Engine requires the use of a Windows x64 version MediaAgent.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Windows Server 2012 Microsoft Windows Server 2012 Editions All Windows-compatible processors supported
Miscellaneous
The following is automatically installed during the installation of this software if it is not already installed:
Apache Tomcat Server
File System iDataAgent - For System Requirements specific to the File System iDataAgent, refer to System Requirements - Microsoft Windows File System iDataAgent .
For successful web restore of NAS data and Domino emails, install a 32-bit File System proxy instance on a 64-bit machine.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Mac OS X
Mac OS X v10.10.x
Mac OS X v10.11.x
Mac OS X v10.12.x
Mac OS X v10.9.x (10.9.5 or later)
Hard Drive
1 GB of minimum disk space is required for installing the software.
5 GB of free disk space is required for job result directory.
3 GB of free disk space is required for log directory.
Processor
Intel-based Macintosh computers
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Hard Drive
1 GB of minimum disk space is required for installing the software.
5 GB of free disk space is required for job result directory.
3 GB of free disk space is required for log directory.
Miscellaneous
SELinux
If you have SELinux enabled on the client computer, create the SELinux policy module as a root user before performing a backup. The SELinux Development package must
be installed on the client.
To create an SELinux policy module, perform the following steps as user "root":
1. Create the following files in the /usr/share/selinux/devel directory:
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Volume Managers
Veritas Volume Manager (VxVM) 5.0 or higher
Logical Volume Manager (LVM)
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Windows 10
Microsoft Windows Client 10
Windows 8
Microsoft Windows Client 8.1
See Considerations for Microsoft Windows Server 2012, 2012 R2, and Windows 8 for more information.
Windows Vista
Microsoft Windows Vista Editions
Windows Server 2003
Microsoft Windows Server 2003 Editions [Extended Support ]
Windows XP
Microsoft Windows XP Home Editions with a minimum of Service Pack 3
Microsoft Windows XP Professional 32-bit and x64 Editions with a minimum of Service Pack 3
Hard Drive
1 GB minimum of hard disk space for installing the software.
500 MB of free disk space is required for job result directory.
500 MB of free disk space is required for log directory.
Processor
All Windows-compatible processors supported
Supported Windows Surface Devices
Surface Pro
Surface 3 and later.
Miscellaneous
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Package is installed automatically. Note that the Redistributable Package can co-exist with other versions of this software.
Microsoft Visual C++ 2010 Redistributable Package
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Microsoft Windows Server 2008 32-bit and x64 Editions* All Windows-compatible processors supported
*Core Editions are not supported.
Windows Vista
Microsoft Windows Vista 32-bit and x64 Editions All Windows-compatible processors supported
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
Hard Drive
CDR on Windows:
266 MB minimum of hard disk space for software
50 MB of additional hard disk space for log file growth
720 MB of temp space required for install or upgrade (where the temp folder resides)
Refer to Data Replication for important considerations when allocating replication log file space.
2. Create the policy file from command line. Use the following command. Ensure that you give the following commands in the /usr/share/selinux/devel directory.
[root]# make backup_IDA.pp
Compiling targeted backup_IDA module
/usr/bin/checkmodule: loading policy configuration from tmp/backup_IDA.tmp
/usr/bin/checkmodule: policy configuration loaded
/usr/bin/checkmodule: writing binary representation (version 6) to tmp/backup_IDA.mod
Creating targeted backup_IDA.pp policy package
rm tmp/backup_IDA.mod tmp/backup_IDA.mod.fc
[root]# semodule -i backup_IDA.pp
[root]#
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Hard Drive
1-Touch Server
6 GB of minimum disk space is required for installing the software.
512 MB of free disk space is required for job result directory.
3 GB of free disk space is required for log directory.
6-8 GB of a disk space is required per recovery job on a NIM master server. The disk space size depends on the size of the MKSYSB backup of the client's root volume
group (rootvg).
To find the disk space size:
1. Right-click the subclient and click Backup History.
2. On the Backup History Filter dialog box, click OK.
3. In the Backup Job History tab, right-click the 1-Touch Backup job and click View Job Details.
4. On the Job Details dialog box, click the Attempts tab and check the Size of Application for the 1-Touch Server Update phase.
5. Click OK.
For example, if you plan to recover two AIX services or LPARs at the same time and the average MKSYSB size is 8GB, you will need 16GB of disk space.
Client
No additional disk space required beyond File System iDataAgent disk space requirements.
Memory
3 GB RAM minimum required
Processor
Power PC (Includes IBM System p)
Notes
Server
The 1-Touch Server must be a dedicated AIX machine running the NIM master server environment.
Client
NIM client must be installed and/or configured on clients (EZ-NIM client).
Clients should have a configured network card that can be used to boot from a NIM master.
For clients with link aggregation or EtherChannel, ensure that standard network adapter is configured for communication with NIM server.
The 1-Touch server can be in the same subnet as the client computer, or it can be in a different subnet. However, if they are in different subnets, ensure that there is no
network firewall between the server and the client.
For each different subnet there should be NIM network resource defined. This is important not only when NIM master and client are in different subnets, but also in
case 1-Touch recovery is performed to a client that is in a different subnet than the NIM master and the original client. If the network resource is not defined for the
destination client subnet and selected during recovery, 1-Touch recovery will not be successful. For more information on defining NIM network resources, refer to IBM
NIM documentation.
Only active volume group will be backed up during 1-Touch backup.
This feature is not supported when bootable partitions are on the disk arrays (snapable disk).
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Hard Drive
No additional disk space required beyond File System iDataAgent disk space requirements.
Memory
4 GB RAM minimum required
Processor
Intel Pentium, x64 or compatible processors
Peripherals
A CD-ROM drive or ability to boot from an ISO image file is required to boot the client for recovery.
Bootloader
Only BIOS is supported
Limited support for UEFI. For more information, refer to 1-Touch for Linux - UEFI
Snapshot volumes will not be recovered as part of the 1-touch recovery. Hence, it is recommended that you mount and backup the snapshot data.
Supported VMs
VMware
Microsoft Hyper-V*
Oracle VM
Kernel-based VM for Linux (KVM)
Citrix Xen guest VM
*Host operating system version of Microsoft Windows Server 2012 R2 Editions or higher
Notes
CommServe
To enable 1-Touch recovery, the Force per-client certificate authentication on CommServe option has to be turned off on the CommServe at least for the duration of
the recovery. This option can be accessed from the CommServe Control Panel by clicking on Certificate Administration.
Client
iSCSI disks are supported for Virtualize Me; all the backed up iSCSI disks will be re-created as regular SCSI disks on the virtual machine if they are selected during
restores.
iSCSI disks are not supported for 1-Touch. These disks need to be manually unselected during interactive restores if any iSCSI disks are backed up.
SAN disks are supported for 1-Touch and Virtualize Me. For Virtualize Me, as FC HBA (Fibre Channel Host Bus Adapter) virtualization is not supported, multipath SAN
disks will be re-created as regular SCSI disks.
1-Touch supports native Linux multipathing. Vendor specific multipath implementations are not supported.
1-Touch recovery and Virtualize Me for Hyper-V is not supported if the virtual machine is generated using the Generation 2 specification.
Itanium (IA64) processor is not supported.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Client
Solaris 10 Update 6 or equivalent*
*The operating systemsupports Sun Sparc5 or higher recommended processors.
Hard Drive
1-Touch Server
1.5 GB of minimum disk space is required for installing the software.
512 MB of free disk space is required for job result directory.
3 GB of free disk space is required for log directory.
Client
512 MB of free disk space required beyond File System iDataAgent disk space requirements.
Memory
3 GB RAM minimum required
Processor
x64, Sparc T/M series
Supported File Systems and Volume Manager types
VERITAS Volume Manager (VxVM) 5.0 or higher (unencapsulated root volume only)
Solaris Volume Manager (svm)
UNIX File System (UFS)
VERITAS File System (VxFS)
Zettabyte File System (ZFS)
Notes
Server
The 1-Touch Server must be a dedicated Solaris machine running the JumpStart server environment.
For 1-Touch Server, use any Solaris system that is configured as a JumpStart server and has the required networking services, which include RARP, bootp, and tftp.
Configure the 1-Touch server using the Solaris Advanced Installation Guide (see, http://docs.sun.com/app/docs/doc/802-5740 ). It is recommended that you set the
primary mirror as the boot device for restores to succeed.
The Solaris JumpStart server version (including updates) should be greater than or equal to the version of the Solaris client whose data is targeted for recovery.
If Solaris 10 Update 6 or above JumpStart server is used as 1-Touch Server, please make sure that it has /boot/solaris/bin/root_archive. It is required for unpacking and
repacking Solaris miniroot in JumpStart server.
Ensure that the permissions setting for an NFS share on the JumpStart server is "ro" (read-only)
Solaris 10 boot image are supported.
Client
This feature is not supported when bootable partitions are on the disk arrays (snapable disk).
Cloning is not supported.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Windows 10
Microsoft Windows 10 32-bit and x64 Editions
Windows 8.1
Microsoft Windows 8.1 32-bit and x64 Editions
Windows 8
Microsoft Windows 8 32-bit and x64 Editions
Windows Server 2012 R2
Microsoft Windows Server 2012 R2 Editions
Windows Server 2012
Microsoft Windows Server 2012 Editions
Windows 7
Microsoft Windows 7 32-bit and x64 Editions
Windows Server 2008 R2
Microsoft Windows Server 2008 R2 x64 Editions*
*Core Editions are not supported.
Windows Vista
Microsoft Windows Vista 32-bit and x64 Editions
Windows XP
Microsoft Windows XP Professional 32-bit and x64 Editions
Hard Drive
7 GB minimum of hard disk space for installing the software.
500 MB of free disk space is required for job result directory.
500 MB of free disk space is required for log directory.
The RAM size of the client must be two times the size of the Live CD. The size of the Live CD can vary depending on the processor type and drivers added to the image. The
default size is approximately 1 GB. You can verify the size. The 1-Touch ISO image is located at:
SystemRecovery\Images\Windows 32-bit\BOOT_IMAGE\ISO\sources
SystemRecovery\Images\Windows x64\BOOT_IMAGE\ISO\sources
To perform an offline restore, make sure that you have an additional 30 GB of free disk space that includes the Job Results and Log files directory.
Processor
All Windows-compatible processors supported
Notes
Client
1-Touch Recovery and Virtualize Me support virtual machines created using Microsoft Hyper-V and VMWare.
1-Touch recovery is not supported on Windows 2003, XP, and Vista client computers that operates in a language other than English.
Ensure that the TCP/IP Services are configured on the computer before performing the backup.
Non-interactive restores are not supported on computers that have operating system disks connected using an iSCSI controller.
1-Touch recovery is supported for systems which boot from SAN or the recovery of SAN attached disks.
1-Touch recovery is not supported if the system partition of the client computer is located on the FAT 32 volume.
1-Touch recovery is not supported for computers upgraded from Windows 2000 to Windows XP operating system.
Virtualize Me for Hyper-V is not supported if the virtual machine is generated using the Generation 2 specification.
1-Touch recovery using Hyper-V is not supported if the Windows operating system is installed on a Disk 2 partition.
1-Touch recovery and Virtualize Me is not supported for VLAN (Virtual Local Area Network) configurations where the NIC (Network Interface Control) is configured with
VLAN tagging.
Virtualize Me for Hyper-V is not supported for computers configured with UEFI (Unified Extensible Firmware Interface) or EFI.
Restores are not supported for Resilient File Systems (Refs) and Storage Pools that operate on Microsoft Windows 2012 or Windows 8.0.
You must use a wired internet connection to recover a laptop.
Use Disaster Recovery to recover a CommServe. You cannot recover a CommServe using the1-Touch recovery.
1-Touch does not support recovery for multiboot systems.
Ensure that windows is not installed on the drive other than C:\. The unattended installation of windows on a drive other than C:\ is not supported. You cannot perform
the Online or Offline Restore when windows is installed on a drive other than C:\
If the client computer has more than 100 disks attached, the 1-Touch system state backup fails with the following error:
VDS Wrapper list maximum count reached. No more space in the list.
1-Touch does not support recovery of disks managed by Veritas Volume Manager due to inconsistent results with VDS.
1-Touch supports recovery of BitLocker Encryption enabled volumes with lock opened during backup; post restore this option gets disabled and you need to manually
enable the BitLocker Encryption option on the volumes.
Ensure that the client does not have multiple active partitions. You cannot perform 1-Touch recovery if the client has multiple active partitions.
If you have a recovery partition, make sure that it is removed prior to a backup operation.
5/6/2017 Commvault Systems Page 562 of 587
Obtain the valid Microsoft license key for the Windows operating system to perform Virtualize Me and 1-Touch recovery operations.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Operating System
Windows 10
Microsoft Windows Client 10
Windows 8
Microsoft Windows Client 8.1
Windows Server 2012
Microsoft Windows Server 2012 R2 Editions
Windows Server 2008
Microsoft Windows Server 2008 R2 Editions
Windows
Microsoft Windows Server 2016 Editions
Microsoft Windows 8 Editions
Microsoft Windows Server 2012 Editions
Microsoft Windows Server 2008 Editions
Processor
All Windows-compatible processors supported
Miscellaneous
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
Microsoft Visual C++
The following Redistributable Packages are installed automatically. Multiple versions of the package can be installed on the same computer.
Microsoft Visual C++ 2013 Redistributable Package
Microsoft Visual C++ 2010 Redistributable Package
Supported File Systems
New Technology File Systems (NTFS)
Resilient File System (ReFS) on Windows Server 2012
Supported Drivers
QSnap Driver is supported on versions Windows Server 2003 and later.
CvvD Driver is supported on versions Windows 2008 R2 and later.
Supported Sector Size for Hard Drives
Hard Disks with sector size of 512 bytes are supported for performing block-level backups. Hard Disks with sector size larger than 512 bytes are not supported.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
AIX 6.1 TL 07 SP10 ("6100-07-10-1415) 64-bit, or higher Power PC (Includes IBM System p)
Linux CentOS
CentOS 7.3 with kernel 3.10.0-514 Intel Pentium or compatible minimum required
CentOS 6.5 with kernel 2.6.32-431 Intel Pentium or compatible minimum required
Debian
Debian 8.x x64
Debian 7 with kernel 3.2.0-4-amd64 Intel Pentium or compatible minimum required
Debian 7 with kernel 3.2.0-4-amd64 x64
Oracle Linux
Oracle Linux 6.6 with kernel 3.8.13-68.1.3.el6uek.x86_64 Intel Pentium or compatible minimum required
Oracle Linux 6.6 with kernel 3.8.13-68.1.3.el6uek.x86_64 x64
Oracle Linux 6.4 with kernel 2.6.39-400 Intel Pentium or compatible minimum required
Oracle Linux 6.4 with kernel 2.6.39-400 x64
Red Hat Enterprise Linux
Red Hat Enterprise Linux 7.1 Advanced Platform with kernel 3.10.0-229 x64
Red Hat Enterprise Linux 6.7 Advanced Platform with kernel 2.6.32-573 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.7 Advanced Platform with kernel 2.6.32-573 x64
Red Hat Enterprise Linux 6 Advanced Platform with kernel 2.6.32-71 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6 Advanced Platform with kernel 2.6.32-71 x64
Red Hat Enterprise Linux 6 Advanced Platform with kernel 2.6.32-279 (Update 3) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6 Advanced Platform with kernel 2.6.32-279 (Update 3) x64
Red Hat Enterprise Linux 6 Advanced Platform with kernel 2.6.32-220 (Update 2) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6 Advanced Platform with kernel 2.6.32-220 (Update 2) x64
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-92 (Update 2) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-92 (Update 2) x64
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-308 (Update 8) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-308 (Update 8) x64
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-274 (Update 7) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-274 (Update 7) x64
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-238 (Update 6) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-238 (Update 6) x64
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-194 (Update 5) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-194 (Update 5) x64
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-164 (Update 4) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-164 (Update 4) x64
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-128 (Update 3) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 5 Advanced Platform with kernel 2.6.18-128 (Update 3) x64
SuSE Linux (SLES)
SuSE Linux 11 SP4 Enterprise Server with kernel 3.0.101-63 Intel Pentium or compatible minimum required
SuSE Linux 11 SP4 Enterprise Server with kernel 3.0.101-63 x64
SuSE Linux 11 SP2 Enterprise Server with kernel 3.0.13-0.27-default Intel Pentium or compatible minimum required
SuSE Linux 11 SP2 Enterprise Server with kernel 3.0.13-0.27-default x64
SuSE Linux 11 Enterprise Server with kernel 2.6.32.12-0.7-default Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 2.6.32.12-0.7-default x64
SuSE Linux 10 Enterprise Server with kernel 2.6.16.60-0.54.5 (Update 3) Intel Pentium or compatible minimum required
SuSE Linux 10 Enterprise Server with kernel 2.6.16.60-0.54.5 (Update 3) x64
SuSE Linux 10 Enterprise Server with kernel 2.6.16.60-0.21 (Update 2) Intel Pentium or compatible minimum required
SuSE Linux 10 Enterprise Server with kernel 2.6.16.60-0.21 (Update 2) x64
SuSE Linux 10 Enterprise Server with kernel 2.6.16.46-0.12 (Update 1) Intel Pentium or compatible minimum required
Cluster - Support
The software can be installed on a Cluster if clustering is supported by the above-mentioned operating systems.
Hard Drive
1 GB of minimum disk space is required for installing the software.
3 GB of free disk space is required for job result directory. To calculate the disk space requirements for job results directories for large file sets, see Job Results Directory
Disk Space Calculation .
1 GB of free disk space is required for log directory.
Supported File Systems
The following table lists the file systems supported for each supported operating system:
File System Operating System CVBF Data Blocks Backup Support
Extended 3 File System (ext3) Linux Yes Yes
Extended 4 File System (ext4) Linux Yes Yes
'X' File System (XFS) Linux Yes No
Reiser File System (reiserfs) Linux Yes Yes
Virtual FAT (vfat) Linux Yes No
Journal File System (JFS2) AIX Yes Yes
UNIX File System (UFS)* Solaris Yes No
Veritas File System (VxFS) Solaris Yes Yes
Zettabyte File System (ZFS)* Solaris Yes No
Notes:
ZFS must span the entire disk; disk slices are not supported.
The CVBF cache for UFS must be a UFS file system. For example, /opt/commvault/CVBF/cache.
Supported Volume Managers
AIX LVM
Linux LVM
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
NetBackup
After the discovery process is complete, NetBackup components, such as client computers, backup schedules, and media are mapped to the appropriate CommCell entity.
The following versions of NetBackup are supported for these NetBackup component groupings:
NetBackup Grouping Description Supported NetBackup Versions*
Configuration Clients, Policy Types, Policies, Policy Attributes (compression, 5.1, 6.0, 6.5, 7.0, 7.1, 7.5, and 7.6
encryption), Policy Schedules (frequency, calendar), Backup
Types, Media Server.
Jobs Backup and Admin Policy Job information is migrated for 5.1, 6.0, 6.5, 7.0, 7.1, 7.5, and 7.6
CommCell reporting purposes.
Media Lifecycle Policies, Storage Units, Robots, and Media Status are 5.1, 6.0, 6.5, 7.0, 7.1, 7.5, and 7.6
migrated for CommCell reporting purposes.
*Both Windows and Unix platforms are supported.
Hard Drive
1 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
Miscellaneous
.NET Framework
.NET Framework 2.0 is automatically installed. Note that .NET Framework 2.0 can co-exist with other versions of this software.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Hard Drive
1 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
Miscellaneous
.NET Framework
.NET Framework 2.0 is automatically installed. Note that .NET Framework 2.0 can co-exist with other versions of this software.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
EDC Networker
After the first full discovery process is complete, each EMC Networker component, such as clients, schedules, etc. is mapped to the appropriate CommCell entity. The
following versions of EMC Networker are supported for these EMC Networker components:
EMC Networker Grouping Description Supported EMC Networker Versions*
Configuration Clients, Groups, Save Sets, Schedules, Jobs, Directives. 7.2, 7.6, 7.6.1, 8.0, and 8.1 and for Fujitsu Networker 7.6.2,
7.6.3, and 7.5
Jobs Backup information is migrated for CommCell reporting 7.2, 7.6, 7.6.1, 8.0, and 8.1 and for Fujitsu Networker 7.6.2,
purposes. 7.6.3, and 7.5
*Windows, Linux, and Unix supported.
Hard Drive
1 GB of minimum disk space is required for installing the software.
256 MB of free disk space is required for job result directory.
256 MB of free disk space is required for log directory.
Miscellaneous
.NET Framework
.NET Framework 2.0 is automatically installed. Note that .NET Framework 2.0 can co-exist with other versions of this software.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Hard Drive
500 MB of additional hard disk space for the Media Explorer files and log growth.
Sufficient space for the Catalog database (based on your cataloging needs).
Sufficient space for the data you want to recover.
Miscellaneous
The following media requirements apply:
All necessary tape and disk media volumes required to complete the data recovery operation must be available.
For tape libraries, the correct drivers must be loaded.
Direct physical access to the media device must be available. (i.e., a locally attached tape library/drive tapes, or a mapped local drive on which disk library archives are
stored)
For data stored on disk volumes using a Unix MediaAgent, a separate file transfer tool (such as FTP for Unix) must be used.
.NET Framework
.NET Framework 4.0 should be installed.
Microsoft Visual C++
Microsoft Visual C++ 2010 Redistributable Package should be installed.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Windows 2016
Microsoft Windows Server 2016 Editions
Hardware Specifications
For large environments that have 200 or more clients across all CommCells, install Metrics Reporting Server on a separate, dedicated computer with the following
specifications:
500 GB of disk volume
8 CPU cores
32 GB RAM
For environments with 1 to 200 clients across all CommCells, you can install Metrics Reporting Server on one of your production CommServe computers.
Database Engine
Microsoft SQL Server 2012 with Service Pack 2 is automatically installed along with the Metrics Reporting software. If you have SQL Server 2008 R2 or SQL Server 2012
already installed in your environment, Metrics Reporting will use the existing SQL Server.
For SQL Server 2012 considerations and other important recommendations, such as SQL Server settings, see Database Engine under System Requirements - CommServe
.
Miscellaneous
Apache Tomcat Server
The Apache Tomcat Server is automatically installed.
IIS
Microsoft Internet Information Services (IIS) must be installed on the system drive of the Web Server. Do not install IIS on a non-system drive.
The following IIS versions are supported:
Microsoft Internet Information Services (IIS) Manager version 8.0 or 8.5 (on Windows 2012 only)
Microsoft Internet Information Services (IIS) Manager version 7.5
Microsoft Internet Information Services (IIS) Manager version 7.0 (on Windows 2008 only)
All components of Microsoft Internet Information Services (IIS) Manager version 7.0 should be installed on Windows 2008
.NET Framework Requirements
Both .NET Framework 3.5 and 4.0 are required and are automatically installed.
Note: For .NET Framework 3.5, if the server is Windows 2012 or higher, the role is only enabled during installation if the machine has an internet connection. If there is no
internet connection, you must manually enable the role.
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Hardware Specifications
The following hardware specifications are recommended for the Workflow engine:
A minimum of 20 GB of free disk space
At least 16 GB RAM memory
The memory should increase based on the type of workflows that you plan to deploy and run. For example, if your workflows have a large number of tasks and
a high level of complexity, you might need to increase the memory to optimize the Workflow engine performance.
The Workflow engine includes the SQL Server software. The software installation requires 30 GB of disk space for the Microsoft SQL Server application and
database and 20 GB of temp space.
In the future, you might need to provide additional space (several GB) to allow for database growth.
Database Engine
Microsoft SQL Server 2014 Standard Edition is automatically installed during the installation of the Workflow software. If you have Microsoft SQL Server 2012 Enterprise
Edition already installed in your environment, the Workflow Engine will use the existing SQL Server.
For more information, see Database Engine under System Requirements - CommServe .
Miscellaneous
.NET Framework Requirements
Both .NET Framework 3.5 and 4.0 are required and are automatically installed.
Note: For .NET Framework 3.5, if the server is Windows 2012 or higher, the role is only enabled during installation if the machine has an internet connection. If there is no
internet connection, you must manually enable the role.
The File System Agent is installed automatically during the installation of this software component (if it is not installed already). To review the system requirements of the
File System Agent, see System Requirements - Microsoft Windows File System Agent .
DISCLAIMER
Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault
provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works.
Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms
that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor
releases or service packs are compatible with the Commvault software.
Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.
Supported Components
Microsoft Windows Server 2012, 2012 R2, and Windows 8.x are supported in this release for the following CommCell components:
Components Windows Server 2012, 2012 R2 Windows 8.x
CommServe X
Web Server X
MediaAgent X X
Microsoft Windows File Systems X X
OnePass for Windows X X
CommServe
When you install the CommServe on a Windows Server 2012 computer, consider the following:
Using Third-Party Tools That Behave Like the Windows Start Menu
Windows Server 2012 and Windows 8 computers lack the Start menu feature from previous Windows versions. However, there are third-party tools (like Start8), which
behave like the Start menu. For the CommServe to run smoothly on a Windows Server 2012 computer, disable these programs as they cause problems with the TCP/IP
network.
Additional Considerations
The following sections list other important considerations when using Windows Server 2012, 2012R2, and Windows 8.x.
AlwaysOn Provided by SQL 2012 or Later
AlwaysOn is a new implementation on clusters. You can protect the AlwaysOn configuration on your CommServe and client computers.
Installation
Install .NET Framework 3.5 prior to installing Commvault. You can do so either by placing the Windows Server 2012 DVD in the disk drive or mounting the ISO, or by using
one of the following procedures:
1. Installing .Net Framework using Server Manager
2. Installing .Net Framework using PowerShell
3. Installing .Net Framework from Command Line
Installing .Net Framework Using Server Manager
1. Open Server Manager, click the Manage tab, and then click Add Roles and Features.
2. Click single server or remote install, then click Next.
3. On the Before you Begin window, click Next.
4. On the Select installation type window, click Next. Make sure that Role-based or feature-based installation option is selected.
5. Select the local computer and then click Next.
6. Click Next.
7. On the Select features window, expand .Net Framework 3.5 Features and then select .Net Framework 3.5 (includes .Net 2.0 and 3.0).
8. Click Install to complete the installation of .Net Framework 3.5.
Installing .Net Framework Using PowerShell
Open Windows PowerShell and run the following command to install the .Net Framework:
Add-windowsfeature NET-Framework-Core
Installing .Net Framework from Command Line
Run the following command to install .Net Framework from command line:
Supported Packages
Microsoft SQL Server 2012 Enterprise is supported by the following Commvault packages:
CommServe
Metrics Reporting
SQL Server Agent
Web Server
Workflow Engine
Supported Platforms
Microsoft SQL Server 2012 Enterprise is supported in the following platforms:
Windows Server 2012
Microsoft Windows Server 2012 Editions
Windows Server 2008
Microsoft Windows Server 2008 Editions* with a minimum of Service Pack 2
*Core and R2 Editions supported
If you are using Windows Server 2008 R2 Editions, Service Pack 1 or later must be installed.
where:
SQLUser and SQLUserPass are the user credentials to access the SQL Server.
CSDBPass is the password that you want to set for the Commvault user account. Make sure to provide a strong password.
7. Start all services on the SQL Server computer using the following steps:
a. Click the Start button on the Windows task bar and then click All Programs.
b. Navigate to Commvault and click Process Manager.
c. Select All Services in the Services tab.
d. Click Start to start all services.
Third-Party Platforms
When a third-party vendor operating system, application, or hardware product has reached End-of-Life, your software provider will publish notification of obsolescence at a
pre-determined location. All engineering support for a third-party vendor operating system, application, or hardware product that has reached EOL will expire immediately
upon the release of the notification of obsolescence. Commvault Customer Support will provide commercially reasonable assistance to customers with unsupported
platforms and applications limited to Tier One support assistance where possible. No hot fixes or updates will be released as part of this assistance.
To review the list of deprecated third-party vendor platforms, see Platforms .
The Installation Package Version column indicates the Commvault installation package version that provides extended support for the platform or application.
Procedure
Follow the steps that correspond to the operating system of your computer.
On Windows Computers
1. Create the bIgnoreCommServeVersion registry key by using the Windows Registry Editor.
a. On the Windows computer, open the Windows Registry Editor and navigate to the HKEY_LOCAL_MACHINE\SOFTWARE\ directory.
b. Right-click SOFTWARE and click New -> Key.
c. Name the key as GalaxyInstallerFlags.
d. Right-click GalaxyInstallerFlags and select New -> DWORD value. Name the key as bIgnoreCommServeVersion.
e. Double-click the bIgnoreCommServeVersion key and modify the Value data to 1.
2. Run the installation package and follow the installation wizard.
On UNIX Computers
From the installation package or mount point, run the following command and follow the installation wizard:
./cvpkgadd -allow-newer-commserve
Note: If you plan to install Commvault Version 9, you can also create a custom package and use the XML file to install the package silently. In the XML file, you must update
the value of the allowNewerCommServe parameter to 1.
where C:\Folder_Name is the folder that you created and pass.txt is the file where you want to save the encrypted password.
To register the V8 client with your CommServe computer, you must provide an authentication code. To obtain an authentication code, contact
[email protected].
Procedure
1. Log on to the computer as root.
2. To install the V8 software, mount the V8 installation DVD and then run the following command from the mount point:
cvpkgadd -decouple
Follow the instructions in the installation wizard, and make sure to select the UNIX File System Agent.
Note: The software is installed in decoupled mode. In decoupled mode, the computer does not establish connections with the V11 CommServe computer during the
installation. The computer is registered later in the process.
3. Install V8 Service Pack 6.
4. Download the v8_install_script.zip , extract the cvpkgxml script, and copy the script to the installation directory (for example, /opt/simpana).
5. From the installation directory, run the script by using one of the following commands:
For CommCell environments with user authentication, use the following command:
./cvpkgxml -cs-short CommServe_Name -cs CommServe_Hostname -user UserName -password EncryptedPassword
For CommCell environments without user authentication, use the following command:
./cvpkgxml -cs-short CommServe_Name -cs CommServe_Hostname
where:
CommServe_Hostname is the host name or fully qualified domain name of the CommServe computer.
EncryptedPassword is the encrypted password that was saved in the location you specified. For example, C:\Folder_Name\pass.txt.
6. Copy the ic.xml file that was generated after running the cvpkgxml script to a location that is accessible by the CommServe computer.
7. Log on to the CommServe computer and retrieve the ic.xml file.
8. Open the command prompt, go to the Installation_Directory_Path/Base directory, and run the following command to register the V8 client:
SIMCallWrapper.exe -input ic_XML_file -output XML_output_file
where:
ic_XML_file is the directory path where you saved the ic.xml file.
XML_output_file is the directory path where you want to save the output of the SIMCallWrapper command. For example, C:\temp\output.xml
9. Log on to the CommServe database by using the qlogin command and run the following qoperation command to authenticate the client registration:
qoperation execscript ?sn QS_UpdateClientRelease.sql ?si ClientName -si 8.0 -si AuthCode
where:
ClientName is the name of the V8 client.
AuthCode is the authentication code that you generated using the Coder Tool.
10. Update the password of the V8 client in the CommServe database.
5/6/2017 Commvault Systems Page 582 of 587
a. Open the Microsoft SQL Server Management Studio.
b. From the Object Explorer pane, go to Server_Instance > Databases > CommServe.
c. Retrieve the ID number of the V8 client from the output of the following query:
select * from App_Client
where:
ClientPassword is the password stored in the ic.xml file.
IDNumber is the ID number that you retrieved from the previous SQL query.
Related Topics
Uninstalling Version 8 UNIX Clients
Procedure
1. Log on to the Windows Server 2000 computer as an Administrator or as a member of the Administrator group.
2. From the media kit (also known as installation package), double-click Setup.exe.
Follow the instructions in the installation wizard and make sure to select the Windows File System Agent.
Result
You can perform backup and restore operations on the Windows Server 2000 client from your V11 CommCell environment.
Deprecated Products
These deprecated products can be upgraded to the current software version for data recovery operations only:
Image Level Agent
BlueArc File Archiver Agent
Celerra File Archiver Agent
Exchange Mailbox Archiver
File Archiver for UNIX Agent
Generic File Archiver for NAS
NetApp File Archiver Agent
Windows File Archiver Agent
These deprecated products cannot be upgraded to the current software version:
FAST Content Indexing Engine
GroupWise Agent
Novell Directory Services Agent
SharePoint Archiver Agent
For more information about Commvault® software modules and solutions, and for up-to-date system requirements, please contact us: www.commvault.com •
888.746.3849 • [email protected]
Commvault Worldwide Headquarters
1 Commvault Way • Tinton Falls, NJ 07724 • Phone: 888.746.3849 • Fax: 732.870.4525
Commvault Regional Offices
United States • Europe • Middle East & Africa • Asia-Pacific • Latin America & Caribbean Canada • India • Oceania