Planning Service Pack Installations

For a successful installation, perform the following preparation tasks before you install the service pack.


  • After the installation, the service pack cannot be uninstalled (that is, rolled back to the previous service pack version). Make sure that you plan the installation accordingly.

  • If the CommServe server is at Service Pack 13 or a previous service pack, and you want to update it to Feature Release 11.28 or later, you must first update it to Feature Release 11.24 or Feature Release 11.26.

  • If the CommServe server is at Service Pack 16 or a previous service pack, and you want to update it to Commvault Platform Release 2023 or a more recent platform release, you must first update it to Platform Release 2022E.

Remember the Installation Sequence

When you install a new service pack version in your CommCell environment, the service pack must be installed in the following sequence:

  1. CommServe computer

  2. MediaAgents

  3. Client computers


Use the CommCell Console to select the CommServe computer along with MediaAgents and clients during the service pack installation. The CommCell Console installs the service pack on the CommServe first, and then on the MediaAgents and clients.

Review Space Requirements

The following table outlines the space requirement for installing the service pack on a computer that has the File System Agent, MediaAgent, or other packages.

Operating System

File System Agent

File System Agent and MediaAgent

Multiple Packages


700 MB

750 MB

800 MB


750 MB

1 GB

1.5 GB


500 MB

700 MB

1 GB


450 MB


600 MB

For each additional package that you install on a File System Agent or MediaAgent computer, you will need an additional 500 MB of disk space. Remember that the space requirement will vary based on the package and the service pack version that is installed on the computer.

Review Considerations for the CommServe Computer

  • During the service pack installation on the CommServe computer, services are stopped and the CommCell Console is closed. Therefore, install the service pack at a time when you are not running jobs in your CommCell environment. You can wait for the jobs to finish, or you can terminate them.

  • If the CommServe computer is a standby CommServe host, see Installing Service Packs On High Availability CommServe Hosts.

  • If the CommServe computer is in a cluster environment, consider the following requirements:

    • The service pack must be installed on the active node of the cluster. During the installation on the active node, the installation program will provide options to update the passive nodes.

    • The service pack must be installed on physical nodes. Installations on virtual nodes are not supported.

    • For the service pack to be installed on passive nodes automatically, make sure that the installation media is located in a network share that is accessible by all cluster nodes. Access to the network share from the passive nodes must be already authenticated so that it does not prompt the installer for user credentials.

Review Considerations for Standalone CommCell Console

The CommCell Console that is installed on the CommServe computer is updated along with the CommServe software.

If you installed the CommCell Console on additional clients, see Installing the Service Pack on a Standalone CommCell Console.

Review Considerations for the MediaAgent and Client Computers

  • Outlook Add-In with ContentStore Email Viewer

    If you changed the display name of the ContentStore, you must rerun the name change command. You can use the Search Admin page or CVPConfigurationTool to make the change. For information on the Search Admin page, see Managing Configuration Commands for ContentStore Email Viewer Clients from the Search Admin Page. For information on CVPConfigurationTool, see Using CVPConfigurationTool from the Command Line.

  • Determine the Clients That You Want to Update

    For optimal and reliable performance in your CommCell environment, we recommend that the CommServe computer, the MediaAgents, and clients operate at the same service pack level.

    You can choose not to update all MediaAgents and clients. However, you will not benefit from software enhancements and new features.

    To view the service pack version of all clients in your CommCell environment, see Viewing the Service Pack Details for One or More Clients.

  • Determine the Windows Clients That Must Be Updated By Viewing The Client Readiness Report

    Starting in Service Pack 11, Microsoft Visual C++ Redistributable 2017 (vcredist2017.exe) is automatically installed. If a computer does not have the latest Windows updates, the installation of Microsoft Visual C++ Redistributable 2017 will fail.

    The following Windows updates must be installed:





    Microsoft Windows 10 and Microsoft Windows Server 2016 come with the Universal C Runtime already installed, so only the basic VC2017/2013/2010 redistributable installation may be required.

    The Client Readiness report identifies clients that need to be patched before moving to service pack 11. To view the report, you can download the report from Commvault Store: SP11 Client Readiness report.

  • Discover the SAP HANA Tenant Databases in a Multitenant Database Container Configuration

    Beginning in Service Pack 7, you can perform backup and restore operations on multitenant database containers from the CommCell Console.

    When you upgrade the SAP HANA client to Service Pack 7, or you upgrade the CommServe, and the SAP HANA client to Service Pack 7, after the upgrade, refresh the SAP HANA instance properties, and then discover the tenant databases.

    To refresh the SAP HANA instance, see Refreshing the SAP HANA Instance Properties After an Upgrade.

    To discover tenant databases, see Manually Discovering SAP HANA Databases.

  • Prepare Block-Level Clients for Restart After Service Pack Installations

    If you have block-level clients, you must restart the clients after installing the service pack only if the driver was updated. Therefore, plan the installation for a time when you can restart the Block-Level clients.

    After you restart the clients, native snapshots are deleted, which causes backup copy jobs to fail. To resolve this issue, see Knowledge Base article WFS0016: Native Snapshots are Deleted after the Restart of the Client Computer.

  • Review Considerations for Cluster Environments

    The service pack must be installed on the physical nodes of the cluster. Installations on virtual nodes are not supported.

  • Verify the Service Pack Version Installed on the CommServe Computer

    When you install a new service pack version, make sure that it is already installed on the CommServe computer, unless you plan to install the service pack on the CommServe computer and clients at the same time by using the CommCell Console.

  • Migrate the SAP Archive Link Repository to ObjectStore

    SAP Archive Link clients with V11 SP7 or later service packs use the Commvault ObjectStore as the storage repository to store and manage the backup data. Agents prior to V11 SP7 use a combination of the UNIX file system backups with the index maintained in a PostgreSQL database.

    To apply the latest service pack on clients with SP6 or earlier service packs, you must first migrate the contents and index that was stored in the old repository (PostgreSQL database) to the ObjectStore.

    To migrate the SAP Archive repository, contact Customer Support.

  • Stop the DB2 Services on HP UNIX and Windows Clients before You Start the Service Pack Installation

    We recommend that you stop the DB2 services before you start the Commvaultservice pack installation so that there are no errors when you install the service pack.

  • Recycle DB2 Services on UNIX Clients after the Service Pack Installation Completes

    Recycle the DB2 services on UNIX clients so that the DB2 log manager uses the new Commvault VENDOR library and that log archives are successful.

    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

  • Salesforce Cloud Connector Considerations

    The software supports Java 10 (JRE 10.0.2) or greater as part of the Cloud Apps package. Verify that the Linux platform that you use for Salesforce supports this Java version. For more information, see Salesforce: System Requirements.

Review Considerations for the Private Metrics Reporting Server

The Metrics Reporting Server must be at the same software version or later than a CommServe computer that uploads data to the Metrics Reporting Server. For example, you cannot enable a V11 CommServe computer to upload report data to a V10 Metrics Reporting Server.