0% found this document useful (0 votes)
87 views

Quick Start Guide and Deployment

The document provides installation instructions for Commvault software and server packages. It describes preparing servers, installing SQL Server, and configuring the CommServe and other packages. Checklists are included for preinstalling each component.

Uploaded by

Nguyen Hai Toan
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
87 views

Quick Start Guide and Deployment

The document provides installation instructions for Commvault software and server packages. It describes preparing servers, installing SQL Server, and configuring the CommServe and other packages. Checklists are included for preinstalling each component.

Uploaded by

Nguyen Hai Toan
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 587

Documentation PDF

PROTECT. ACCESS. COMPLY. SHARE


Table of Contents
Table of Contents 2
Quick Start Guide 40
Before You Begin 40
Quick Start Process 40
Deployment 41
Installations 42
The Installation Process 42
Server Installations 43
Installing the CommServe 43
Optional: Installing Other Server Packages 43
CommServe Installation 44
Plan the CommServe Installation 45
Verify System Requirements 45
Verify License Requirements 45
Verify Requirements for Installation Environments 45
Prepare the Computer for Restart 45
Determine the Configurations that Meet Your Requirements 45
Configuring an Existing SQL Instance for Server Packages 46
Before You Begin 46
Procedure 46
Pre-Installing the Microsoft SQL Server Software on a Non-Cluster Environment 47
Before You Begin 47
Installing the SQL Server and Creating the Commvault Instance 47
Postinstallation Tasks 47
Pre-Installing the Microsoft SQL Server Software on a Cluster Environment 49
Before You Begin 49
Installing the SQL Server and Creating the Commvault Instance 49
Postinstallation Tasks 50
Preinstallation Checklist for the CommServe 51
Download the Software 51
Determine the Installation Location 51
Review Microsoft SQL Server Considerations 51
Additional Packages Installed with the CommServe 51
Gather Installation Data 51
Installing the CommServe Software 53
Before You Begin 53
Procedure 53
What to Do Next 53
Postinstallation Tasks for the CommServe 54
Add Commvault to the Windows Firewall Exclusion List 54
Download the Software to the CommServe Cache 54
Configure Automatic Installation of Updates 54
Update the Installation Package 54
Other Server Packages 55
Installing the Analytics Engine 56
Before You Begin 56
Choose the Installation Method 56
What to Do Next 56
Installing the CommCell Console 57
Before You Begin 57
Choose the Installation Method 57
What to Do Next 57
Related Topics 57
Installing Compliance Search 58
Before You Begin 58
Choose the Installation Method 58
What to Do Next 58
Installing the ContentStore Mail Server 59
Before You Begin 59
Choose the Installation Method 59
What to Do Next 59
Installing the Metrics Reporting Server 60
Before You Begin 60
Procedure 60
What to Do Next 60
Installing the Search Engine 61
Before You Begin 61
Choose the Installation Method 61
What to Do Next 61
Installing the Web Console 62
Before You Begin 62
Choose the Installation Method 62
What to Do Next 62
Related Topics 62
Installing the Web Server 63
Before You Begin 63
Procedure 63
What to Do Next 63
Installing the Workflow Engine 64
Before You Begin 64
Procedure 64
What to Do Next 64
Installing the 1-Touch Server 65
Before You Begin 65
Procedure 65
What to Do Next 65
Preinstallation Checklist for Server Packages 66
Preinstallation Checklist for the Analytics Engine 67
Verify System Requirements 67
Verify License Requirements 67
Determine the Installation Location 67
Additional Packages Installed with the Analytics Engine 67
Gather Installation Data 67
Preinstallation Checklist for the CommCell Console on Windows 68
Verify System Requirements 68
Verify License Requirements 68
Determine the Installation Location 68
Install the CommServe Package 68
Review Firewall Settings 68
Set Up the CommCell Console as a Remote Web-Based Application 68
Set Up the Java Runtime Environment 68
Gather Installation Data 68
Preinstallation Checklist for the CommCell Console on UNIX 70
Verify System Requirements 70
Verify License Requirements 70
Determine the Installation Location 70
Install the CommServe Package 70
Review Firewall Settings 70
Set Up the CommCell Console as a Remote Web-Based Application 70
Set Up the Java Runtime Environment 70
Gather Installation Data 70
Preinstallation Checklist for Compliance Search 71
Verify System Requirements 71
Verify License Requirements 71
Determine the Installation Location 71
Gather Installation Data 71
Preinstallation Checklist for the ContentStore Mail Server 72
Verify System Requirements 72
Verify License Requirements 72
Determine the Installation Location 72
Gather Installation Data 72
Preinstallation Checklist for Metrics Reporting Server 73
Verify System Requirements 73
Verify Service Plan Requirements 73
Determine the Installation Location 73
Gather Installation Data 73
Preinstallation Checklist for the Search Engine 74
Verify System Requirements 74
Verify License Requirements 74
Determine the Installation Location 74
Test IOPS of the Installation Location 74
Install Required Software to Content Index Exchange or Domino Mailbox Data 74
Disable Anti-Virus Software 74
Additional Packages Installed with the Search Engine 74
Gather Installation Data 74
Preinstallation Checklist for the Web Console 76
Verify System Requirements 76
Verify License Requirements 76
Determine the Installation Location 76
Install the Web Server Package 76
Gather Installation Data 76
Preinstallation Checklist for the Web Server 77
Verify System Requirements 77
Verify License Requirements 77
Determine the Installation Location 77
Additional Packages Installed with the Web Server 77
Gather Installation Data 77
Preinstallation Checklist for the Workflow Engine 78
Verify System Requirements 78
Verify License Requirements 78
Determine the Installation Location 78
Gather Installation Data 78
Preinstallation Checklist for the 1-Touch Server on UNIX 79
Verify System Requirements 79
Verify License Requirements 79
Determine the Installation Location 79
Gather Installation Data 79
MediaAgent Installations 80
Plan the MediaAgent Installation 81
Verify System Requirements 81
Verify License Requirements 81
Verify Requirements for Installation Environments 81
Determine the Role of Your MediaAgent 81
Download the Software 81
Determine the Configurations that Meet Your Requirements 81
Preinstallation Checklist for the MediaAgent on Windows 82
Determine the Installation Location 82
Collect Cluster Environment Details 82
Gather Installation Data 82
Preinstallation Checklist for the MediaAgent on UNIX 83
Determine the Installation Location 83
Collect Cluster Environment Details 83
Gather Installation Data 83
Installing the MediaAgent 84
Before You Begin 84
Choose the Installation Method 84
What To Do Next 84
Installing a MediaAgent Docker Image 85
Before You Begin 85
Procedure 85
What To Do Next 85
Postinstallation Tasks for the MediaAgent 86
Perform General Postinstallation Tasks 86
Get Started with MediaAgent Features and Configurations 86
Client Installations 88
Plan the Installation on Windows Computers 89
Download the Software 89
Collect Cluster Environment Details 89
Determine the Configurations that Meet Your Requirements 89
Allowing a Duplicate Hostname and CVD Port During Client Installation 90
Procedure 90
Changing the Branding Settings of a Windows Installation Package 91
Procedure 91
Result 91
Changing the Display Language of the Commvault Software on Windows Computers 92
Before You Begin 92
Procedure 92
Language Support 93
Installing Commvault on Non-English Clients 93
Enabling 32-Bit Installations on 64-Bit Windows Computers 94
Before You Begin 94
Procedure 94
Considerations for Installing 32-Bit Software on 64-Bit Windows Computers 95
General 95
Windows File System Agent 95
Exchange Agents 95
SQL Server Agent 95
32-Bit Installation Support on 64-bit Windows Computers 96
Install 32-bit On x64 96
Comments 96
Backup 96
Archive 96
Replication 97
Virtualization 97
Laptop 97
Installation of Restore Only Agents 98
Considerations for Cluster Environments 98
Considerations for Database Agents 98
Multi-Instance Installations 99
32-Bit and 64-Bit Mixed Environments 99
Different CommCells 99
Considerations for Installing Multi-Instances 100
General Requirements 100
CommServe 100
MediaAgent 100
Exchange Agents 100
Enabling Multi-Instance Installations 101
Before You Begin 101
Procedure 101
What to Do Next 101
Multi-Instance Support 102
Multi-Instance Installations 102
Comments 102
Backup 102
Archive 102
Replication 103
Virtualization 103
Laptop 103
Database Service Restart Requirements when Deploying Windows Agents 104
Plan the Installation on UNIX, Linux, and Macintosh Computers 105
Download the Software 105
Collect Cluster Environment Details 105
Determine the Configurations that Meet Your Requirements 105
Adding SUDO Users with Root Privileges on a UNIX Client 106
Before You Begin 106
Procedure 106
Allowing a Duplicate Hostname and CVD Port During Client Installation 107
Procedure 107
Changing the Branding Settings of a UNIX Installation Package 108
Procedure 108
Result 108
Creating User Groups to Install or Upgrade Commvault on a Macintosh Computer 109
Procedure 109
Enabling 32-Bit Installations on 64-Bit Linux Computers 110
Prerequisites 110
Procedure 110
Installation of UNIX Agents by a Non-Root User 111
Prerequisites 111
Supported Installation Methods 111
Supported Agents 111
Postinstallation Tasks 111
Installation of UNIX Agents in a Predefined Directory 113
Installation of Restore Only Agents 114
Considerations for Cluster Environments 114
Considerations for Database Agents 114
Multi-Instance Installations 115
32-Bit and 64-Bit Mixed Environments 115
Different CommCells 115
Considerations for Installing Multi-Instances 116
General Requirements 116
CommServe 116
MediaAgent 116
Exchange Agents 116
Enabling Multi-Instance Installations 117
Before You Begin 117
Procedure 117
What to Do Next 117
Multi-Instance Support 118
Multi-Instance Installations 118
Comments 118
Backup 118
Archive 118
Replication 119
Virtualization 119
Laptop 119
Database Service Restart Requirements when Deploying UNIX Agents 120
Preinstallation Checklist for Clients 121
Commvault Packages Available for Windows 121
Commvault Packages Available for UNIX, Linux, and Macintosh* 121
Preinstallation Checklist for the Active Directory Agent 122
Verify System Requirements 122
Verify License Requirements 122
Determine the Installation Location 122
Review User Permissions 122
Gather Installation Data 122
Preinstallation Checklist for ContinuousDataReplicator on Windows 123
Verify System Requirements 123
Verify License Requirements 123
Determine the Installation Location 123
Additional Packages Installed with the ContinuousDataReplicator 123
Gather Installation Data 123
Preinstallation Checklist for ContinuousDataReplicator on UNIX 124
Verify System Requirements 124
Verify License Requirements 124
Determine the Installation Location 124
Gather Installation Data 124
Preinstallation Checklist for the DB2 Agent on Windows 125
Verify System Requirements 125
Verify License Requirements 125
Determine the Installation Location 125
Gather Installation Data 125
Preinstallation Checklist for the DB2 Agent on UNIX 126
Verify System Requirements 126
Verify License Requirements 126
Determine the Installation Location 126
Gather Installation Data 126
Preinstallation Checklist for the Documentum Agent on Windows 127
Verify System Requirements 127
Verify License Requirements 127
Determine the Installation Location 127
Review Installation Scenarios 127
Prepare 64-bit Computers for 32-bit Agent Installations 127
Gather Installation Data 127
Preinstallation Checklist for the Documentum Agent on UNIX 128
Verify System Requirements 128
Verify License Requirements 128
Determine the Installation Location 128
Gather Installation Data 128
Preinstallation Checklist for the IBM Domino Mailbox Archiver on Windows 129
Verify System Requirements 129
Verify License Requirements 129
Determine the Installation Location 129
Gather Installation Data 129
Preinstallation Checklist for the IBM Domino Mailbox Archiver on UNIX 130
Verify System Requirements 130
Verify License Requirements 130
Determine the Installation Location 130
Gather Installation Data 130
Preinstallation Checklist for the Driver for File Archiver 131
Verify System Requirements 131
Verify License Requirements 131
Determine the Installation Location 131
Gather Installation Data 131
Preinstallation Checklist for the Exchange Compliance Archiver Agent 132
Verify System Requirements 132
Verify License Requirements 132
Determine the Installation Location 132
Preconfigure the Exchange Server 132
Gather Installation Data 132
Preinstallation Checklist for the Exchange Database Agent 133
Verify System Requirements 133
Verify License Requirements 133
Determine the Installation Location 133
Verify Client Computer Details for DAG Environments 133
Verify Exchange User Account 133
Gather Installation Data 133
Preinstallation Checklist for the Exchange Offline Mining Tool 134
Verify System Requirements 134
Verify License Requirements 134
Determine the Installation Location 134
Supported Exchange Server Versions 134
Preconfigure the Exchange Server 134
Gather Installation Data 134
Preinstallation Checklist for the Exchange Public Folder Agent 135
Verify System Requirements 135
Verify License Requirements 135
Determine the Installation Location 135
Preconfigure the Exchange Server 135
Gather Installation Data 135
Preinstallation Checklist for the Exchange Public Folder Archiver Agent 136
Verify System Requirements 136
Verify License Requirements 136
Determine the Installation Location 136
Preconfigure the Exchange Server 136
Gather Installation Data 136
Preinstallation Checklist for the File Share Archiver Client 137
Verify System Requirements 137
Verify License Requirements 137
Determine the Installation Location 137
Gather Installation Data 137
Preinstallation Checklist for the Windows File System Agent 138
Verify System Requirements 138
Verify License Requirements 138
Determine the Installation Location 138
Gather Installation Data 138
Preinstallation Checklist for the UNIX, Linux, and Macintosh File System Agent 140
Verify System Requirements 140
Verify License Requirements 140
Determine the Installation Location 140
Gather Installation Data 140
Preinstallation Checklist for the Informix Agent on Windows 143
Verify System Requirements 143
Verify License Requirements 143
Determine the Installation Location 143
Gather Installation Data 143
Preinstallation Checklist for the Informix Agent on UNIX 144
Verify System Requirements 144
Verify License Requirements 144
Determine the Installation Location 144
Gather Installation Data 144
Preinstallation Checklist for the MySQL Agent on Windows 145
Verify System Requirements 145
Verify License Requirements 145
Determine the Installation Location 145
Gather Installation Data 145
Preinstallation Checklist for the MySQL Agent on UNIX 146
Verify System Requirements 146
Verify License Requirements 146
Determine the Installation Location 146
Gather Installation Data 146
Preinstallation Checklist for the IBM Notes Database Agent on Windows 147
Verify System Requirements 147
Verify License Requirements 147
Determine the Installation Location 147
Gather Installation Data 147
Preinstallation Checklist for the IBM Notes Database Agent on UNIX 148
Verify System Requirements 148
Verify License Requirements 148
Determine the Installation Location 148
Gather Installation Data 148
Preinstallation Checklist for the IBM Notes Document Agent on Windows 149
Verify System Requirements 149
Verify License Requirements 149
Determine the Installation Location 149
Gather Installation Data 149
Preinstallation Checklist for the IBM Notes Document Agent on UNIX 150
Verify System Requirements 150
Verify License Requirements 150
Determine the Installation Location 150
Gather Installation Data 150
Preinstallation Checklist for the OES File System Agent 151
Verify System Requirements 151
Verify License Requirements 151
Determine the Installation Location 151
Gather Installation Data 151
Preinstallation Checklist for the Oracle Agent on Windows 152
Verify System Requirements 152
Verify License Requirements 152
Determine the Installation Location 152
Prepare the Oracle Services to Restart 152
Gather Installation Data 152
Preinstallation Checklist for the Oracle Agent on UNIX 153
Determine the Installation Location 153
Verify System Requirements 153
Verify License Requirements 153
Verify Access Permissions on AIX computers 153
Gather Installation Data 153
Preinstallation Checklist for the OWA Proxy Enabler 154
Verify System Requirements 154
Verify License Requirements 154
Where to Install 154
Configure Internet Information Services (IIS) 154
Gather Installation Data 154
Preinstallation Checklist for the PostgreSQL Agent on Windows 155
Verify System Requirements 155
Verify License Requirements 155
Determine the Installation Location 155
Gather Installation Data 155
Preinstallation Checklist for the PostgreSQL Agent on UNIX 156
Verify System Requirements 156
Verify License Requirements 156
Determine the Installation Location 156
Gather Installation Data 156
Preinstallation Checklist for the SAP Archive Link Agent on UNIX 157
Verify System Requirements 157
Verify License Requirements 157
Determine the Installation Location 157
Configure the ObjectStore 157
Gather Installation Data 157
Preinstallation Checklist for the SAP for HANA Agent on UNIX 158
Verify System Requirements 158
Verify License Requirements 158
Determine the Installation Location 158
Gather Installation Data 158
Preinstallation Checklist for the SAP for Oracle Agent on Windows 159
Verify System Requirements 159
Verify License Requirements 159
Determine the Installation Location 159
Gather Installation Data 159
Preinstallation Checklist for the SAP for Oracle Agent on UNIX 160
Verify System Requirements 160
Verify License Requirements 160
Determine the Installation Location 160
Gather Installation Data 160
Preinstallation Checklist for the SAP for MaxDB Agent on Windows 161
Verify System Requirements 161
Verify License Requirements 161
Determine the Installation Location 161
Gather Installation Data 161
Preinstallation Checklist for the SAP for MaxDB Agent on UNIX 162
Verify System Requirements 162
Verify License Requirements 162
Determine the Installation Location 162
Gather Installation Data 162
Preinstallation Checklist for the SharePoint Server Agent 163
Verify System Requirements 163
Verify License Requirements 163
Determine the Installation Location 163
Verify Required Permissions 163
Configure User Accounts 163
Gather Installation Data 163
Preinstallation Checklist for the SQL Server Agent 165
Verify System Requirements 165
Verify License Requirements 165
Determine the Installation Location 165
Gather Installation Data 165
Preinstallation Checklist for the Sybase Agent on Windows 166
Verify System Requirements 166
Verify License Requirements 166
Determine the Installation Location 166
Gather Installation Data 166
Preinstallation Checklist for the Sybase Agent on UNIX 167
Verify System Requirements 167
Verify License Requirements 167
Determine the Installation Location 167
Gather Installation Data 167
Preinstallation Checklist for the Virtual Server Agent on Windows 168
Verify System Requirements 168
Verify License Requirements 168
Determine the Installation Location 168
User Accounts 169
Deployment Planning 169
Gather Installation Data 169
Preinstallation Checklist for the Virtual Server Agent on Linux 170
Verify System Requirements 170
Verify License Requirements 170
Determine the Installation Location 170
User Accounts 170
Deployment Planning 170
Gather Installation Data 170
Installing Commvault on Clients 172
Before You Begin 172
Choose the Installation Method 172
What To Do Next 172
Postinstallation Tasks for Clients 173
Windows 173
UNIX, Linux, and Macintosh 173
Changing UNIX Groups and Permissions on UNIX Clients 174
Before You Begin 174
Procedure 174
Files and Folders Created During UNIX Installations 175
Files and Folders Created during Agent Installations 175
Additional Files Created during Installations on Cluster Environments 177
Setting Read Permissions on AIX Clients 178
Before You Begin 178
Procedure 178
Installing Commvault Tools 179
Before You Begin 179
Choose the Installation Method 179
What to Do Next 179
Preinstallation Checklist for CommServe Failover 180
Verify System Requirements 180
Verify License Requirements 180
Determine the Installation Location 180
Gather Installation Data 180
Preinstallation Checklist for the CommServe SNMP Enabler 181
Verify System Requirements 181
Verify License Requirements 181
Determine the Installation Location 181
Install Windows SNMP Services 181
Gather Installation Data 181
Preinstallation Checklist for the External Data Connector on Windows 182
Verify System Requirements 182
Verify License Requirements 182
Determine the Installation Location 182
Gather Installation Data 182
Preinstallation Checklist for the External Data Connector on UNIX 183
Verify System Requirements 183
Verify License Requirements 183
Determine the Installation Location 183
Gather Installation Data 183
Preinstallation Checklist for MongoDB 184
Verify System Requirements 184
Verify License Requirements 184
Determine the Installation Location 184
Supported MongoDB Versions 184
Gather Installation Data 184
Installation Methods 185
Using the CommCell Console 185
Using the Installation Package 185
Using the Download Manager 185
Installations Using the CommCell Console (Remote Installations) 186
Prerequisites for Installations Using the CommCell Console 187
Download the Software 187
Verify User Permissions 187
Review Considerations for Client Computers 187
Review Firewall and Network Port Requirements 187
Review Space Requirements for Client Computers 188
Installing Commvault Remotely Using the CommCell Console 189
Before You Begin 189
Procedure 189
What to Do Next? 189
Running the Remote Installation Script from the Command Line 190
Before You Begin 190
Procedure 190
Selecting Computers from a Directory Service During Remote Installations 191
Before You Begin 191
Procedure 191
Related Topics 191
Configuring PowerBroker Environments for Installations Using the CommCell Console 192
Procedure 192
Configuring the Timeout Interval for Installations Using the CommCell Console 193
Procedure 193
Related Topics 193
Installing Commvault by Automatically Detecting the Applications Installed on Clients 194
Before You Begin 194
Procedure 194
Result 194
What to Do Next 194
Running the Installing Automatically Discovered Applications Workflow 195
How Does It Work? 195
Procedure 195
Installations Using the Installation Package 196
Install Locally on a Computer 196
Install on Multiple Computers 196
Local Installation 197
Installing Commvault Locally on Windows Computers Using the Installation Package 198
Before You Begin 198
Procedure 198
What to Do Next 198
Installing Commvault Locally on UNIX, Linux, and Macintosh Computers Using the Installation Package 199
Before You Begin 199
Procedure 199
What to Do Next 199
Installing Commvault on All Computers Across Your Organization 200
Procedure 200
Additional Installations Operations Using the Installation Package 201
Create a Custom Package 201
Create a Solaris IPS Package 201
Run Unattended Installations 201
Preinstall Commvault as a Software Image 201
Custom Packages 202
Process Flow 202
Creating a Base Package Using the Cloud Services Website 203
Before You Begin 203
Procedure 203
What to Do Next 204
Creating a Custom Package for Windows Computers Using the Installation Package 205
Before You Begin 205
Procedure 205
What to Do Next? 205
Planning for the Custom Package Creation on Windows Computers 206
Determine the type of Windows processor 206
Select the Commvault instance 206
Determine the custom package directory 206
Decide which agents to include in the custom package 206
Decide which custom package options to set 206
Gather installation data for CommCell options 207
Gather installation data for agent specific options 207
Creating a Custom Package for UNIX, Linux, and Macintosh Computers 208
Before You Begin 208
Procedure 208
What to Do Next? 208
Planning for the Custom Package Creation on UNIX, Linux, and Macintosh Computers 209
Determine the type of custom package that you need 209
Select the Commvault instance 209
Determine the custom package directory 209
Decide which agents to include in the custom package 209
Decide whether to record your installation selections 209
Decide whether to create a decoupled package 210
Gather installation data for CommCell options 210
Gather installation data for agent specific options 210
Installing the Custom Package on Windows Computers 211
Before You Begin 211
Procedure 211
Postinstallation Tasks 211
Related Topics 211
Installing the Custom Package on UNIX, Linux, and Macintosh Computers 212
Before You Begin 212
Procedure 212
Postinstallation Tasks 212
Related Topics 212
Installing the Custom Package on Windows Computers Using the Answer File 213
Before You Begin 213
Procedure 213
Postinstallation Tasks 213
Related Topics 213
Installing the Custom Package on UNIX, Linux, and Macintosh Computers Using the Answer File 214
Before You Begin 214
Procedure 214
Postinstallation Tasks 214
Related Topics 214
Installing a Windows Custom Package Configured as a Self-Extracting Executable File 215
Before You Begin 215
Procedure 215
Postinstallation Tasks 215
Installing the Custom Package Using a Third-Party Software 216
Before You Begin 216
Procedure 216
Related Topics 216
Installing UNIX Native Packages 217
Before You Begin 217
Procedure 217
Postinstallation Tasks 217
Related Topics 217
Setting Up Packages for Active Directory GPO Installations 218
Procedure 218
Results 218
Solaris IPS Packages 219
Process for Packaging the Software 219
Supported Solaris Versions 219
Supported Agents 219
Creating a Solaris IPS Package 220
Before You Begin 220
Procedure 220
Installing a Solaris IPS Package 221
Before You Begin 221
Procedure 221
What to Do Next 221
Unattended Installation 222
Process Flow 222
Preinstall Commvault as a Software Image 223
Process Flow 223
Preinstall Commvault as a Software Image: Setting Up Computers at the Factory 224
Procedure 224
What to Do Next 224
Preinstall Commvault as a Software Image: Registering the Clients 225
Before You Begin 225
Procedure 225
Installations Using the Download Manager 226
Install Locally on a Windows Computer 226
Create a Custom Package for Windows Computers 226
Installing Commvault Locally on Windows Computers Using the Download Manager 227
Before You Begin 227
Procedure 227
Creating a Custom Package for Windows Computers Using the Download Manager 228
Before You Begin 228
Procedure 228
What to Do Next 228
Installation Support 229
Installation Methods 229
Installation Configurations 229
Reinstalling Agents 230
Important Considerations 230
Related Topics 230
Reinstalling the Laptop Package 231
Procedure 231
Client Registrations 232
Registering the Client Using the CommCell Console 233
Before You Begin 233
Procedure 233
Registering the Client Using the Command Line 234
Before You Begin 234
Procedure 234
Registering the Client Using the Process Manager 235
Before You Begin 235
Procedure 235
Creating Workflows for Monitoring Client Registrations 236
Procedure 236
Sample XML Request 236
Multi-CommCell Routing for Client Registrations 237
Process Flow 237
Setting Up a Master CommServe for Multi-CommCell Routing 238
Before You Begin 238
Procedure 238
What to Do Next 238
Configuring Client Registration Rules for Multi-CommCell Routing 239
Before You Begin 239
Procedure 239
What to Do Next 239
Troubleshooting Installations 240
CommCell Console 240
Download Manager 240
File System Agent Installations 240
Remote Installations 240
Server Package Installations 240
Third-Party Software 240
UNIX Installations 240
Installer Error Codes 241
Related Topics 241
Install/Upgrade/Remove/Repair Software Job Summary Report 242
About this Report 242
What this Report Contains 242
How to Generate the Report 242
Scheduling the Report 242
Customizations That You Can Perform With This Report 242
Additional Options 243
Repairing Installations 246
Procedure 246
Installations - FAQ 247
Can I install an older Commvault version on a Windows or UNIX client computer? 247
What are the installation scenarios in which the installer may prompt for a reboot? 247
Upgrades 248
Generating the Preupgrade Readiness Report 249
Prerequisites 249
Procedure 249
What to Do Next 249
Request an Upgrade 250
For V10 Users 250
For V9 Users 250
Requesting an Upgrade through the Cloud Services Website: Using the Request for Upgrade Option 251
Before You Begin 251
Procedure 251
What to Do Next 252
Requesting an Upgrade through the Cloud Services Website: Submitting a Form 253
Before You Begin 253
Procedure 253
What to Do Next 253
Testing the CommServe Upgrade Using the Database Upgrade Tool 254
Before You Begin 254
Procedure 254
What to Do Next 254
CommServe Upgrade 255
Standard Upgrade 255
Upgrade with Hardware Refresh 255
Upgrade in a Disaster Recovery Environment 255
Standard CommServe Upgrade 256
Plan the CommServe Upgrade 257
Verify Supported Commvault Versions 257
Verify System Requirements 257
Verify License Requirements 257
Verify Additional Requirements Based on CommServe Environment Types 257
Prepare the Computer for Restart 257
Review Deprecated Products 257
Review Upgrade Considerations 257
Upgrade Considerations for the CommServe (V10 to V11) 258
Preupgrade Considerations 258
Postupgrade Considerations 258
Upgrade Considerations for the CommServe (V9 to V11) 260
Preupgrade Considerations 260
Postupgrade Considerations 260
Moving the Database Engine Back to the CommServe Computer 262
Procedure 262
What to Do Next 262
Preupgrade Tasks for the CommServe 263
Request an Upgrade 263
Download the Software 263
Run a Disaster Recovery Backup 263
Disable CommCell Activities 263
Uninstall Older Deprecated Products 263
Uninstall the Resource Pack 263
Upgrading the CommServe Software 264
Before You Begin 264
Procedure 264
What to Do Next 264
Postupgrade Tasks for the CommServe 265
Enable CommCell Activities 265
Run Test Backups and Restores 265
Apply the New License 265
Download the Software to the CommServe Cache 265
Review the Service Level Agreement (SLA) Value 265
Log Off from the CommServe Database 265
Update the Installation Package 265
CommServe Upgrade with Hardware Refresh: Overview 266
Scenarios to Use Hardware Refresh 266
Steps to Perform Hardware Refresh 266
CommServe Upgrade with Hardware Refresh: Preparing the New Hardware 267
CommServe Upgrade with Hardware Refresh: Preparing the Old CommServe Computer for Shutdown 268
Procedure 268
What to Do Next 269
CommServe Upgrade with Hardware Refresh: Setting Up the CommServe Database in a New Hardware 270
Before You Begin 270
Procedure 270
What to Do Next 272
CommServe Upgrade with Hardware Refresh: Post Migration Operations 273
Access the CommCell Console Remotely 273
Configure Cluster Environment 273
Configure the File Archiver Agent 273
Tune the SQL Server Memory Usage 273
Verify Commvault Network Components (If CommServe Name Changed) 274
Upgrade CommCell Environment Configured with Database Mirroring 275
Before You Begin 275
Procedure 275
Upgrade CommCell Environment Configured with Log Shipping 276
Procedure 276
Upgrade CommCell Environment Where a Remote MediaAgent is Configured as Standby CommServe 277
Procedure 277
MediaAgent Upgrade 278
Standard Upgrade 278
Upgrade with Hardware Refresh 278
Standard MediaAgent Upgrade 279
Plan the MediaAgent Upgrade 280
Verify Supported Commvault Versions 280
Verify System Requirements 280
Verify License Requirements 280
Decide Which MediaAgents To Upgrade 280
Review Deprecated Products 280
Review Upgrade Considerations 280
Upgrade Considerations for the MediaAgent (V10 to V11) 281
Preupgrade Considerations 281
Postupgrade Considerations 281
Upgrade Considerations for the MediaAgent (V9 to V11) 282
Preupgrade Considerations 282
Postupgrade Considerations 282
Managing Features on MediaAgents from Previous Versions 283
Support for Mixed MediaAgent and Client Versions 284
Backups or Auxiliary Copy 284
Preupgrade Tasks for MediaAgents 285
Download the Software 285
Stop Running Jobs 285
Prepare the DDB MediaAgent for an Upgrade 285
Uninstall Older Deprecated Products 285
Upgrading MediaAgents 286
Before You Begin 286
Choose the Upgrade Method 286
What to Do Next 286
MediaAgent Upgrade with Hardware Refresh 287
Client Upgrade 288
Plan the Client Upgrade 289
Verify Supported Commvault Versions 289
Verify System Requirements 289
Verify License Requirements 289
Decide Which Clients To Upgrade 289
Determine Whether You Have Version 8 Clients Running UNIX and NetWare File System Agents 289
Review the Restart Requirements for Database Agents 289
Review Deprecated Products 289
Review Upgrade Considerations 289
General Upgrade Considerations for Clients (V10 to V11) 291
Preupgrade Considerations 291
Postupgrade Considerations 291
Upgrade Considerations for the CommCell Console (V10 to V11) 292
Preupgrade Considerations 292
Postupgrade Considerations 292
Upgrade Considerations for Compliance Search (V10 to V11) 293
Preupgrade Considerations 293
Postupgrade Considerations 293
Upgrade Considerations for the DB2 Agent (V10 to V11) 294
Preupgrade Considerations 294
Postupgrade Considerations 294
Upgrade Considerations for the Documentum Agent (V10 to V11) 295
Preupgrade Considerations 295
Postupgrade Considerations 295
Upgrade Considerations for Exchange Server Agents (V10 to V11) 296
Preupgrade Considerations 296
Postupgrade Considerations 296
Upgrade Considerations for the IBM i File System Agent (V10 to V11) 297
Upgrade Considerations for IBM Agents (V10 to V11) 298
Preupgrade Considerations 298
Postupgrade Considerations 298
Upgrade Considerations for the Informix Agent (V10 to V11) 299
Preupgrade Considerations 299
Postupgrade Considerations 299
Upgrade Considerations for the Macintosh File System Agent (V10 to V11) 300
Preupgrade Considerations 300
Postupgrade Considerations 300
Upgrade Considerations for the Private Metrics Reporting Server (V10 to V11) 301
Preupgrade Considerations 301
Upgrade Considerations for the MySQL Agent (V10 to V11) 302
Preupgrade Considerations 302
Postupgrade Considerations 302
Upgrade Considerations for OnePass for UNIX File System (V10 to V11) 303
Preupgrade Considerations 303
Postupgrade Considerations 303
Upgrade Considerations for OnePass for Windows File System and NAS Clients (V10 to V11) 304
Preupgrade Considerations 304
Postupgrade Considerations 304
Upgrade Considerations for the OpenVMS File System Agent (V10 to V11) 305
Upgrade Considerations for the Oracle Agent (V10 to V11) 306
Preupgrade Considerations 306
Postupgrade Considerations 306
Upgrade Considerations for the Oracle RAC Agent (V10 to V11) 307
Preupgrade Considerations 307
Postupgrade Considerations 307
Upgrade Considerations for SAP HANA Agents (V10 to V11) 308
Preupgrade Considerations 308
Postupgrade Considerations 308
Upgrade Considerations for SAP for Oracle Agent (V10 to V11) 309
Preupgrade Considerations 309
Postupgrade Considerations 309
Upgrade Considerations for SAP for MaxDB Agents (V10 to V11) 310
Preupgrade Considerations 310
Postupgrade Considerations 310
Upgrade Considerations for the Search Engine (V10 to V11) 311
Preupgrade Considerations 311
Postupgrade Considerations 311
Upgrade Considerations for the UNIX File System Agent (V10 to V11) 312
Preupgrade Considerations 312
Upgrade Considerations for the Virtual Server Agent for Amazon (V10 to V11) 313
Preupgrade Considerations 313
Postupgrade Considerations 313
Upgrade Considerations for the Virtual Server Agent for Citrix Xen (V10 to V11) 314
Preupgrade Considerations 314
Postupgrade Considerations 314
Upgrade Considerations for the Virtual Server Agent for Microsoft Azure (V10 to V11) 315
Preupgrade Considerations 315
Postupgrade Considerations 315
Upgrade Considerations for the Virtual Server Agent for Microsoft Hyper-V (V10 to V11) 316
Preupgrade Considerations 316
Postupgrade Considerations 316
Upgrade Considerations for the Virtual Server Agent for VMware (V10 to V11) 317
Preupgrade Considerations 317
Postupgrade Considerations 317
Upgrade Considerations for the Web Console (V10 to V11) 318
Preupgrade Considerations 318
Postupgrade Considerations 318
Upgrade Considerations for the Web Server (V10 to V11) 319
Preupgrade Considerations 319
Postupgrade Considerations 319
Upgrade Considerations for the Windows File System Agent (V10 to V11) 320
Preupgrade Considerations 320
Postupgrade Considerations 320
Upgrade Considerations for 1-Touch for UNIX (V10 to V11) 321
Preupgrade Considerations 321
Postupgrade Considerations 321
Upgrade Considerations for 1-Touch for Windows (V10 to V11) 322
Preupgrade Considerations 322
Postupgrade Considerations 322
General Upgrade Considerations for Clients (V9 to V11) 324
Preupgrade Considerations 324
Postupgrade Considerations 324
Upgrade Considerations for the CommCell Console (V9 to V11) 326
Preupgrade Considerations 326
Postupgrade Considerations 326
Upgrade Considerations for Compliance Search (V9 to V11) 327
Preupgrade Considerations 327
Postupgrade Considerations 327
Upgrade Considerations for ContinuousDataReplicator (V9 to V11) 328
Preupgrade Considerations 328
Postupgrade Considerations 328
Upgrade Considerations for Data Classification for UNIX (V9 to V11) 329
Upgrade Considerations for the DB2 Agent (V9 to V11) 330
Preupgrade Considerations 330
Postupgrade Considerations 330
Upgrade Considerations for the Documentum Agent (V9 to V11) 331
Preupgrade Considerations 331
Postupgrade Considerations 331
Upgrade Considerations for Exchange Server Agents (V9 to V11) 332
Preupgrade Considerations 332
Postupgrade Considerations 332
Upgrade Considerations for IBM Agents (V9 to V11) 333
Preupgrade Considerations 333
Postupgrade Considerations 333
Upgrade Considerations for the Informix Agent (V9 to V11) 334
Preupgrade Considerations 334
Postupgrade Considerations 334
Upgrade Considerations for the MySQL Agent (V9 to V11) 335
Preupgrade Considerations 335
Postupgrade Considerations 335
Upgrade Considerations for OnePass for UNIX File System (V9 to V11) 336
Preupgrade Considerations 336
Postupgrade Considerations 336
Upgrade Considerations for OnePass for Windows File System and NAS File Archiver Clients (V9 to V11)337
Preupgrade Considerations 337
Postupgrade Considerations 337
Upgrade Considerations for the Oracle Agent (V9 to V11) 338
Preupgrade Considerations 338
Postupgrade Considerations 338
Upgrade Considerations for the Oracle RAC Agent (V9 to V11) 340
Preupgrade Considerations 340
Postupgrade Considerations 340
Upgrade Considerations for SAP for Oracle (V9 to V11) 341
Preupgrade Considerations 341
Postupgrade Considerations 341
Upgrade Considerations for SAP for MaxDB Agents (V9 to V11) 342
Preupgrade Considerations 342
Postupgrade Considerations 342
Upgrade Considerations for the Search Engine (V9 to V11) 343
Preupgrade Considerations 343
Postupgrade Considerations 343
Upgrade Considerations for the SharePoint Server Agent (V9 to V11) 344
Preupgrade Considerations 344
Postupgrade Considerations 344
Upgrade Considerations for the UNIX File System Agent (V9 to V11) 345
Preupgrade Considerations 345
Upgrade Considerations for the Virtual Server Agent for VMware (V9 to V11) 346
Preupgrade Considerations 346
Postupgrade Considerations 346
Upgrade Considerations for the Virtual Server Agent for Microsoft Hyper-V (V9 to V11) 347
Preupgrade Considerations 347
Postupgrade Considerations 347
Upgrade Considerations for the Web Console (V9 to V11) 348
Preupgrade Considerations 348
Postupgrade Considerations 348
Upgrade Considerations for the Web Server (V9 to V11) 349
Preupgrade Considerations 349
Postupgrade Considerations 349
Upgrade Considerations for the Windows File System Agent (V9 to V11) 350
Preupgrade Considerations 350
Postupgrade Considerations 350
Upgrade Considerations for 1-Touch for UNIX (V9 to V11) 351
Preupgrade Considerations 351
Postupgrade Considerations 351
Upgrade Considerations for 1-Touch for Windows (V9 to V11) 352
Preupgrade Considerations 352
Postupgrade Considerations 352
Preupgrade Tasks for Clients 353
Download the Software 353
Stop Running Jobs 353
Uninstall Older Deprecated Products 353
Uninstall the Resource Pack 353
Upgrading Clients 354
Before You Begin 354
Choose the Upgrade Method 354
What to Do Next 354
Upgrade Methods 355
Using the CommCell Console 355
Using the Installation Package 355
Using the Download Manager (Windows Only) 355
Upgrades Using the CommCell Console (Remote Upgrades) 356
Prerequisites for Upgrades Using the CommCell Console 357
Download the Software 357
Verify User Permissions 357
Review Space Requirements for Client Computers 357
Upgrading Commvault Remotely Using the CommCell Console 358
Before You Begin 358
Procedure 358
What to Do Next? 358
Running the Remote Upgrade Script from the Command Line 359
Before You Begin 359
Procedure 359
Upgrades Using the Installation Package 360
Upgrade Locally on a Computer 360
Run Unattended Upgrades 360
Upgrading Commvault Locally on Windows Computers Using the Installation Package 361
Before You Begin 361
Procedure 361
Upgrading Commvault Locally on UNIX, Linux, and Macintosh Computers Using the Installation Package 362
Before You Begin 362
Procedure 362
Running Unattended Upgrades on Windows Computers Using the Installation Package 363
Before You Begin 363
Procedure 363
Running Unattended Upgrades on UNIX, Linux, and Macintosh Computers Using the Installation Package 364
Before You Begin 364
Procedure 364
Upgrading Commvault on Windows Computers Using the Download Manager 365
Before You Begin 365
Procedure 365
Upgrade - Support 366
UNIX / Linux / Macintosh - Local 366
UNIX / Linux / Macintosh - Silent 366
Upgrade using the CommCell Console 366
Upgrade using the Download Manager 366
Windows - Local 366
Windows - Silent 366
Server 366
Backup 366
Archive 366
Virtualization 366
Search 367
Laptops 367
Replication 367
Additional Components 367
Upgrades - Troubleshooting 368
Table of Contents 368
UPG0003: Upgrade may fail with Microsoft SQL Server installation error (Unable to locate log file) 368
UPG0004: DB2 Online Backup Fails with SQL2428N error After Upgrading Commvault 368
UPG0005: Upgrade fails with an invalid drive error 368
Common Remote Upgrade Failures on UNIX Clients 369
Common Remote Upgrade Failures on Windows Clients 369
Detecting failed component installations during a Remote upgrade 370
Error removing the software installation directory 370
In a cluster, upgrade failed to retrieve the instance name of the active node 370
Failed to rename the Oracle DLL file 370
Reboot or log off requirements during the upgrade 370
SQL Server services fail to start 371
SQL Server service pack upgrade failed 371
SQL Server upgrade fails due to Security Policy settings 371
Unfinished upgrade on a remote client 371
Upgrade failed due to CommServe database files residing in the software installation path 372
Upgrade failed due to running an application on a remote client 372
Upgrade Failed due to communication problems between the CommServe and remote client 372
Upgrade failed due to an open software file or folder on the remote client 372
Upgrade failed due to incorrect password for SQL Server SA user 373
Upgrade failed due to insufficient disk space 373
Upgrade failed due to insufficient privileges 373
Upgrade failed due to VC++ Runtime Library version 373
Upgrade failed due to running Oracle services in the remote client 373
Upgrade fails when performed from mapped network drives 374
Troubleshooting Errors Found During a Request an Upgrade or Test Upgrade 375
Upgrades - FAQ 377
How can I request an upgrade? 377
Service Packs 378
Service Pack Release Cycle 378
Service Pack Installation 378
Hotfix Installation 378
Available Service Packs in Version 11 379
Service Pack 7 379
Service Pack 6 379
Service Pack 5 379
Plan the Service Pack Installation 380
Remember the Installation Sequence 380
Review Space Requirements 380
Review Considerations for the CommServe Computer 380
Review Considerations for Standalone CommCell Console 380
Review Considerations for the MediaAgent and Client Computers 380
Configuring Automatic Service Pack Installations 381
Before You Begin 381
Procedure 381
What to Do Next 381
Related Tasks 381
Run Manual Service Pack Installations 382
Using the CommCell Console 382
Using the Installation Package 382
Using the Download Manager (Windows Only) 382
Installing the Service Pack Remotely Using the CommCell Console 383
Before You Begin 383
Procedure 383
What to Do Next 383
Related Tasks 383
Prerequisites for Service Pack Installations Using the CommCell Console 384
Download the Software 384
Verify User Permissions 384
Review Space Requirements for Client Computers 384
Enable Client Readiness Validation During the Service Pack Installation 384
Running the Remote Service Pack Installation Script from the Command Line 385
Before You Begin 385
Procedure 385
Copying Version 10 Updates to a Version 11 CommServe Cache 386
Before You Begin 386
Procedure 386
Result 386
Enabling Client Readiness Validation During Service Pack Installations 387
Procedure 387
Installing the Service Pack Locally on Windows Computers Using the Installation Package 388
Before You Begin 388
Procedure 388
What to Do Next 388
Related Tasks 388
Installing the Service Pack Locally on UNIX, Linux, or Macintosh Computers Using the Installation Package389
Before You Begin 389
Procedure 389
What to Do Next 389
Related Tasks 389
Installing the Service Pack on Windows Computers Using the Download Manager 390
Before You Begin 390
Procedure 390
What to Do Next 390
Related Tasks 390
Installing the Service Pack on RPM Package Clients 391
Before You Begin 391
Procedure 391
What to Do Next 391
Installing the Service Pack on a Standalone CommCell Console 392
Before You Begin 392
Procedure 392
Result 392
Managing Service Packs 393
Viewing the Service Pack Details for One or More Clients 394
Procedure 394
Installing Hotfixes 395
Before You Begin 395
Procedure 395
Troubleshooting Service Pack Installations 396
USP0001: Installation of Updates Fail on Client Computers 396
USP0002: Failed to Install Updates and Service Packs through the CommCell Console on a Recently Upgraded Cluster Client 396
Download the Commvault Software 397
Download Using the Download Manager 397
Download Using the CommCell Console 397
Additional Software 397
Downloading Software for Windows Computers Using the Download Manager 398
Before You Begin 398
Procedure 398
What to Do Next 398
Downloading Software for UNIX, Linux, and Macintosh Computers Using the Download Manager 400
Before You Begin 400
Procedure 400
What to Do Next 400
Downloading Software Using the CommCell Console 402
Before You Begin 402
Procedure 402
What to Do Next 402
Related Topics 402
Configure Download Settings in the CommCell Console 403
Changing the FTP Site Used to Download Software 404
Procedure 404
Changing the Network Protocol Used for Downloading Software from the CommCell Console 405
Before You Begin 405
Procedure 405
Configuring the CommCell Console to Download Software Using an Internet Gateway 406
Before You Begin 406
About This Task 406
Procedure 406
Skipping the Download of Software for Deconfigured Clients 407
Procedure 407
Manage the CommServe Cache 408
Changing the Location of the CommServe Cache Directory 409
Procedure 409
Committing the CommServe Cache 410
Procedure 410
Viewing the CommServe Cache Details 411
Procedure 411
Deleting the CommServe Cache Contents 412
Procedure 412
Manage the Remote Cache 413
Setting Up a Remote Cache on a Client Computer 414
Procedure 414
Configuring the Package Synchronization Settings of a Remote Cache 415
Procedure 415
Synchronizing the Remote Cache Contents with the CommServe Cache 416
Procedure 416
Deleting the Remote Cache Contents 417
Procedure 417
Deleting a Remote Cache Location 418
Procedure 418
Installation Media List 419
Media Name 419
Media Content 419
Download Media 419
Limited Distribution Tools 419
Downloading Installation Media 420
Before You Begin 420
Procedure 420
Uninstallations 421
Uninstall Commvault from Client and MediaAgent Computers 422
Uninstall remotely using the CommCell Console (Preferred Method) 422
Uninstall locally from a client 422
Other Commvault Software 422
Prepare to Uninstall Commvault from Client and MediaAgent Computers 423
General Considerations 423
Considerations for Specific Commvault Packages 423
Uninstalling Commvault Remotely Using the CommCell Console 424
Before You Begin 424
Procedure 424
What to Do Next 424
Running the Remote Uninstallation Script from the Command Line 425
Before You Begin 425
Procedure 425
Uninstalling Commvault Locally from Windows Clients 426
Before You Begin 426
Procedure 426
What to Do Next 426
Uninstalling Commvault Locally from UNIX and Linux Clients 427
Before You Begin 427
Procedure 427
What to Do Next 427
Uninstalling Commvault Locally from a Macintosh Client 428
Procedure 428
What to Do Next 428
Uninstalling UNIX Native Packages 429
Before You Begin 429
Procedure 429
What to Do Next 429
Uninstalling the Outlook Add-In 430
Procedure 430
Uninstalling Version 8 UNIX Clients 431
Procedure 431
What to Do Next 431
Uninstall Third-Party Software Workflow 432
How Does It Work? 432
Procedure 432
Uninstalling Commvault Packages from Cluster Group Clients 433
Procedure 433
Uninstalling the CommServe Software 434
Before You Begin 434
Procedure 434
System Requirements 435
Commvault Platform Support Policy 435
System Requirements - CommServe 436
Best Practice 436
Operating System 436
Cluster - Support 436
Processor 436
Hardware Specifications 436
Database Engine 436
Hardware Validation for CommServe Database 436
Miscellaneous 436
Notes on Combined Installations 437
System Requirements - MediaAgent 438
Best Practice 438
Operating System 438
Architecture 438
Hardware Specifications 439
AIX LPAR Support 439
Miscellaneous 439
Hardware Compatibility List 439
System Requirement - Analytics Engine 441
System Requirements - Web Server 442
Best Practice 442
Operating System 442
Processor 442
Additional Software 442
Restore Cache Directory 442
Hardware Specifications 442
Cluster Support 442
Database Engine 442
Miscellaneous 442
System Requirements for the Admin Console 444
Operating System 444
Hard Drive 444
Memory 444
Processor 444
Supported Web Browsers 444
Additional Requirements 444
System Requirements - CommCell Console as a Stand-Alone Application 445
Operating System 445
Architecture 445
Hard Drive 445
Display 445
Miscellaneous 445
System Requirements - CommCell Console as a Remote Web-Based Application 447
Operating System 447
Supported Web Browsers 447
Display 447
Miscellaneous 447
System Requirements - Web Console 448
Best Practice 448
Operating System 448
Hard Drive 448
Processor 448
Supported Web Browsers 448
Cluster Not Supported 448
Miscellaneous 448
System Requirements - Active Directory iDataAgent 449
Operating System 449
Hard Drive 449
Processor 449
Miscellaneous 449
System Requirements - DB2 iDataAgent 450
Application/Operating System 450
Architecture 450
Cluster - Support 452
Hard Drive 452
Solaris Zones/Containers Support 452
AIX LPAR/WPAR Support 452
Miscellaneous 452
libstdc++.so 453
System Requirements - DB2 MultiNode iDataAgent (DB2 DPF) 454
Application/Operating System 454
Architecture 454
Hard Drive 454
Solaris Zones/Containers Support 454
AIX LPAR/WPAR Support 454
Miscellaneous 454
System Requirements - DB2 MultiNode iDataAgent (DB2 pureScale) 456
Application/Operating System 456
Architecture 456
System Requirements - Documentum iDataAgent 457
Application/Operating System 457
Architecture 457
Hard Drive 457
Supported Databases 457
Solaris Zones/Containers Support 457
AIX LPAR/WPAR Support 457
Miscellaneous 457
System Requirements - Image Level iDataAgent 459
Operating System 459
Architecture 459
Cluster - Support 460
Hard Drive 460
AIX LPAR/WPAR Support 460
Miscellaneous 460
Supported UNIX File Systems and Restore Types 461
Supported Windows File System Types 461
System Requirements - Informix iDataAgent 463
Application/Operating System 463
Architecture 463
Cluster - Support 465
Hard Drive 465
Solaris Zones/Containers Support 465
AIX LPAR/WPAR Support 465
Miscellaneous 465
System Requirements - Notes Database iDataAgent 467
Application/Operating System 467
Architecture 467
Hard Drive 468
Miscellaneous 468
Notes on Domino 8.5.X on Windows 2012 468
System Requirements - Notes Document iDataAgent 470
Application/Operating System 470
Architecture 470
Hard Drive 471
Miscellaneous 471
Notes on Domino 8.5.X on Windows 2012 471
System Requirements - Macintosh File System iDataAgent 472
Operating System 472
Hard Drive 472
Processor 472
System Requirements - Exchange Database Agent 473
Application 473
Operating System 473
Hard Drive 473
Processor 473
Miscellaneous 473
System Requirements - Exchange Mailbox (Classic) Agent 474
Application 474
Operating System 474
Hard Drive 474
Processor 474
Miscellaneous 474
System Requirements - Exchange Public Folder Agent 475
Application 475
Operating System 475
Hard Drive 475
Processor 475
Miscellaneous 475
System Requirements - SharePoint Server iDataAgent 476
Application 476
Operating System 476
Hard Drive 476
Processor 476
Miscellaneous 476
Consideration for SharePoint Server 2016 477
System Requirements - SQL Server Agent 478
Application 478
Operating System 478
Cluster - Support 478
Hard Drive 478
Processor 478
Miscellaneous 478
Considerations for SQL Server 478
System Requirements - Windows File System Agent 480
Operating System 480
Cluster - Support 480
Hard Drive 480
Processor 480
Office Communications Server 480
Miscellaneous 480
System Requirements - MySQL iDataAgent 482
Application/Operating System 482
Architecture 482
Cluster - Support 483
Hard Drive 483
Notes on Block-Level Backups 483
Solaris Zones/Containers Support 483
Miscellaneous 483
System Requirements - NAS iDataAgent 485
File Server Operating System 485
Hard Disk 485
MediaAgent Operating System 485
Miscellaneous 485
System Requirements - OES File System iDataAgent 487
Operating System 487
Architecture 487
Cluster - Support 487
Hard Drive 487
Miscellaneous 487
System Requirements - Oracle iDataAgent 488
Application/Operating System 488
Architecture 488
Cluster - Support 488
Hard Drive 488
Express Database Edition Support 489
Oracle Exadata Database Machine Support 489
Solaris Zones/Containers Support 489
AIX LPAR/WPAR Support 489
Miscellaneous 489
System Requirements - Oracle RAC iDataAgent 491
Application/Operating System 491
Architecture 491
Hard Drive 491
Oracle Exadata Database Machine Support 491
Solaris Zones/Containers Support 491
AIX LPAR/WPAR Support 491
Miscellaneous 491
System Requirements - PostgreSQL iDataAgent 493
Application/Operating System 493
Architecture 493
Hard Drive 493
Notes on Block-Level Backups 493
Miscellaneous 493
System Requirements - SAP HANA iDataAgent 495
Application/Operating System 495
Architecture 495
Hard Drive 495
System Requirements - SAP MaxDB iDataAgent 496
Application/Operating System 496
Architecture 496
Cluster - Support 496
Hard Drive 496
Solaris Zones/Containers Support 496
AIX LPAR/WPAR Support 496
Miscellaneous 496
System Requirements - SAP Oracle Agent 498
Application/Operating System 498
Architecture 498
Cluster - Support 499
Hard Drive 499
Solaris Zones/Containers Support 499
AIX LPAR/WPAR Support 499
Miscellaneous 499
System Requirements: SAP Archive Link Agent 501
Operating System 501
Architecture 501
Hard Drive 501
Memory 501
Miscellaneous 501
System Requirements - Sybase iDataAgent 502
Application/Operating System 502
Architecture 502
Cluster - Support 502
Hard Drive 502
Solaris Zones/Containers Support 502
Miscellaneous 503
System Requirements - AIX File System iDataAgent 505
Operating System 505
Architecture 505
Cluster - Support 505
Hard Drive 505
AIX LPAR/WPAR Support 505
IBM Fileset Dependency 505
Miscellaneous 505
System Requirements - FreeBSD File System iDataAgent 506
Operating System 506
Architecture 506
Cluster - Support 506
Hard Drive 506
Miscellaneous 506
System Requirements - HP-UX File System iDataAgent 507
Operating System 507
Architecture 507
Cluster - Support 507
Hard Drive 507
Miscellaneous 507
System Requirements - Linux File System iDataAgent 508
Operating System 508
Architecture 508
Cluster - Support 509
Hard Drive 509
Power PC Processor Support 510
Net-tools Package 510
Miscellaneous 510
System Requirements - Solaris File System iDataAgent 512
Operating System 512
Architecture 512
Cluster - Support 512
Hard Drive 512
Solaris Zones/Containers Support 512
SUNWcry package 512
Miscellaneous 512
System Requirements - Oracle Archive 513
Application/Operating System 513
Architecture 513
Cluster - Support 513
Hard Drive 513
Miscellaneous 513
System Requirements - Exchange Mailbox Agent 515
Application 515
Operating System 515
Hard Drive 515
Processor 515
Miscellaneous 515
System Requirements - OnePass for Hitachi HNAS (BlueArc) and Isilon 516
Operating System 516
Hard Drive 516
Processor 516
File Servers 516
Miscellaneous 516
System Requirements - OnePass for Celerra 518
Operating System 518
Hard Drive 518
Processor 518
File Server 518
Miscellaneous 518
System Requirements - OnePass for Macintosh File System 520
Operating System 520
Hard Drive 520
Processor 520
System Requirements - OnePass for Windows 521
Operating System 521
Hard Drive 521
Processor 521
Miscellaneous 521
System Requirements - Driverless OnePass for Windows File System 522
Operating System 522
Hard Drive 522
Memory 522
Processor 522
Miscellaneous 522
System Requirements - OnePass for NetApp 523
Operating System 523
Hard Drive 523
Processor 523
File Servers 523
Miscellaneous 523
System Requirements - OnePass for Exchange Mailbox (Classic) 525
Application 525
Operating System 525
Hard Drive 525
Processor 525
Miscellaneous 525
System Requirements - OnePass for UNIX File Systems 526
Operating System 526
Architecture 526
Hard Drive 527
Cluster Support 527
Solaris Zones/Containers Support 528
AIX LPAR/WPAR Support 528
Miscellaneous 528
System Requirements - Generic File Archiver for NAS 529
Operating System 529
Cluster - Support 529
Hard Drive 529
Processor 529
File Servers 529
Miscellaneous 529
System Requirements - Domino Mailbox Archiver Agent 530
Application/Operating System 530
Architecture 530
Hard Drive 531
Miscellaneous 531
Notes on IBM Notes Add-In Installations 531
Notes on Domino 8.5.X on Windows 2012 531
System Requirements - Exchange Compliance Archiver Agent 532
Application 532
Operating System 532
Hard Drive 532
Processor 532
Miscellaneous 532
System Requirements - Exchange Public Folder Archiver Agent 533
Application 533
Operating System 533
Hard Drive 533
Processor 533
Miscellaneous 533
System Requirements - Google Mail and Google Drive 534
Operating System 534
Hard Drive 534
Processor 534
Miscellaneous 534
System Requirements for Virtual Server Agent with Amazon 535
Amazon Version 535
Virtual Server Agent Proxy Requirements 535
Amazon Regions 535
Guest Operating Systems 535
Firewall Requirements 535
System Requirements for Virtual Server Agent with Citrix Xen 536
Versions of XenServers Supported 536
Proxy Operating System 536
Virtual Server Agent Installations for Citrix Xen 536
System Requirements - Virtual Sever Agent for Docker 537
Supported Docker Host Versions 537
Proxies 537
Port Requirements 537
System Requirements - Virtual Server Agent for Huawei FusionCompute 538
Supported FusionCompute Versions 538
Proxies 538
Port Requirements 538
System Requirements for Virtual Server Agent with Microsoft Azure 539
Azure Version 539
Virtual Server Agent Proxy Requirements 539
Guest Operating Systems 539
Firewall Requirements 539
System Requirements - Virtual Server Agent for Microsoft Hyper-V 540
Hyper-V Requirements 540
Virtual Machine Operating Systems 540
Hyper-V Integration Services 540
Hard Drive 540
Memory 540
Miscellaneous 540
Notes on Virtual Server Agent Installations for Hyper-V 540
System Requirements for Virtual Server Agent with Nutanix AHV 541
Nutanix AHV Requirements 541
Quiescing for Application Consistent Backups 541
CommServe Requirements 541
MediaAgent Requirements 541
Virtual Server Agent (Proxy) Requirements 541
Port Requirements 541
Guest Operating Systems 541
System Requirements for OpenStack 542
Virtual Server Agent (Proxy) Requirements 542
MediaAgent Requirements 542
Port Requirements 542
System Requirements for Oracle VM 543
Proxies 543
Port Requirements 543
System Requirements - Virtual Server Agent (Red Hat Enterprise Virtualization) 544
Red Hat Enterprise Virtualization Requirements 544
System Requirements for Virtual Server Agent with VMware 545
VMware vSphere 545
vCenter, ESX, and VDDK Versions Required for Specific Features 545
Hardware Specifications 546
Miscellaneous 546
System Requirements - Search Engine 547
Operating System 547
Memory 547
Processor 547
Hardware Requirements 547
Search-Only Search Engine VM Requirements 547
Miscellaneous 547
System Requirements - Compliance Search 548
Operating System 548
Architecture 548
Web Server for Compliance Search 548
Supported Web Browsers 548
Miscellaneous 548
System Requirements - Laptop Backup (Macintosh) 549
Operating System 549
Hard Drive 549
Processor 549
System Requirements - Laptop Backup (Linux) 550
Operating System 550
Architecture 550
Hard Drive 551
Miscellaneous 551
Supported File Systems 551
Volume Managers 552
System Requirements - Laptop Backup (Windows) 553
Operating System 553
Hard Drive 553
Processor 553
Supported Windows Surface Devices 553
Miscellaneous 553
System Requirements - ContinuousDataReplicator 554
Operating System 554
Architecture 554
Cluster - Support 555
Hard Drive 555
Solaris Zones/Containers Support 556
AIX LPAR/WPAR Support 556
Miscellaneous 556
Notes on Windows Installation 557
Notes on Linux Installation 557
System Requirements - 1-Touch for AIX 558
Operating System 558
Hard Drive 558
Memory 558
Processor 558
Notes 558
Supported File system and volume manager types 558
System Requirements - 1-Touch for Linux 559
Operating System 559
Hard Drive 559
Memory 559
Processor 559
Peripherals 559
Bootloader 559
Supported file system and volume manager types 559
Supported VMs 560
Notes 560
System Requirements - 1-Touch for Solaris 10 561
Operating System 561
Hard Drive 561
Memory 561
Processor 561
Supported File Systems and Volume Manager types 561
Notes 561
System Requirements - 1-Touch for Windows 562
Client 562
Hard Drive 562
Processor 562
Notes 562
System Requirements for Block-Level Backup for Windows 564
Operating System 564
Processor 564
Miscellaneous 564
System Requirements for Block-Level Backup for UNIX 565
Operating System 565
Architecture 565
Cluster - Support 566
Hard Drive 566
External Data Connector - System Requirements 567
NetBackup 567
Hard Drive 567
Miscellaneous 567
External Data Connector - System Requirements 568
Tivoli Storage Manager 568
Hard Drive 568
Miscellaneous 568
External Data Connector - System Requirements - EMC Networker 569
EDC Networker 569
Hard Drive 569
Miscellaneous 569
System Requirements - Media Explorer 570
Operating System 570
Architecture 570
Hard Drive 570
Miscellaneous 570
System Requirements - Private Metrics Reporting Server 571
Operating System 571
Architecture 571
Hardware Specifications 571
Database Engine 571
Supported Web Browsers 571
Miscellaneous 571
System Requirements - Workflow 572
Operating System 572
Architecture 572
Hardware Specifications 572
Database Engine 572
Miscellaneous 572
Considerations for Microsoft Windows Server 2016 573
Supported Components 573
Windows File System iDataAgent 573
Considerations for Microsoft Windows Server 2012, 2012 R2, and Windows 8.x 574
Supported Components 574
CommServe 574
Windows File System iDataAgent 574
OnePass for Windows 574
Additional Considerations 574
Considerations for SQL Server 2012 576
Supported Packages 576
Supported Platforms 576
Installing CommServe Using an Existing Instance of SQL Server 2012 576
Upgrading from SQL 2008 to SQL 2012 576
Notes on AlwaysOn Provided by SQL 2012 or Later 577
End-of-Life, Deprecated and Extended Support - Obsolescence Policy 578
Commvault Products and Features 578
Third-Party Platforms 578
Service Pack Lifecycle Support Policy 578
End-of-Life, Deprecated and Extended Support - Platforms 579
List of Deprecated Platforms and Applications 579
List of Deprecated Platforms Supported by Commvault Version 8 580
List of Platforms and Applications on Extended Support 580
Installing Clients from Older Commvault Versions 581
Before You Begin 581
Procedure 581
Installing Version 8 UNIX Clients on a Version 11 CommCell Environment 582
Before You Begin 582
Procedure 582
Related Topics 583
Installing Version 9 Windows Server 2000 Clients on a Version 11 CommCell Environment 584
Before You Begin 584
Procedure 584
Result 584
End-of-Life, Deprecated and Extended Support - Products 585
Deprecated Products 585
End-of-Life, Deprecated and Extended Support - Features 586
Trademark Acknowledgment 587
Commvault Worldwide Headquarters 587
Commvault Regional Offices 587
V11 SP7

Quick Start Guide


You can use this Quick Start Guide to set up a simple CommCell environment and to perform basic data protection and recovery operations, which might be useful as a
proof of concept or in a test environment. This guide is not intended to be used to deploy the software in a production environment without careful planning. If you are
deploying the software in a production environment, see Installations .

Before You Begin


To gain an understanding of the general concepts and capabilities of the software, review the overview information about the software:
Software Overview
Software Capabilities
CommCell Environment Group Overview
CommCell Logical Architecture

Quick Start Process


1. Installing a CommServe and MediaAgent on a computer. The Windows File System Agent is automatically installed as part of the CommServe installation.
2. Accessing the CommCell environment using the CommCell Console.
For more information about the CommCell Console, see CommCell Console - Basic .
3. Configuring a storage device for the data you back up.
4. Creating a subclient, defining the data to back up, and creating a storage policy to map the backed up data from its original location to the storage device you configure.
5. Backing up data from the client computer.
6. Restoring data back to the client computer.
Performing these steps will give you a better understanding of the basic data protection operations of the software.

5/6/2017 Commvault Systems Page 40 of 587


Deployment
Deployment of Commvault software is the process of getting new software operating properly in your environment, and may include planning, installation, upgrade,
applying updates, configuration, and running and testing the installed software, as well as uninstallation and reinstallation activities.
Production data is protected by installing agent software on the physical or virtual hosts which use operating system or application-specific APIs to properly protect data in
a consistent state, so it can be restored. Proxy agents can be used to protect data such as virtual machines by communicating with the hosting infrastructure, such as
vCenter or Hyper-V. Production data is processed by the agents and backed up through MediaAgents to disk, tape or cloud storage.
At a minimum, three components must be installed and configured to form a CommCell environment:
1. CommServe - the central management system within a CommCell environment, coordinating and managing all activity
2. MediaAgent - manages the transmission of data between clients and backup media
3. Client - a software module installed on a computer to access and protect data makes the computer a client
All installed components must be able to communicate with the CommServe for normal data protection operations to function.
Browse the Table of Contents for the information you need to deploy Commvault software.

5/6/2017 Commvault Systems Page 41 of 587


Installations
To protect and manage data in your environment, the Commvault software must be distributed across the computers that you want to protect. The group of protected
computers is referred to as your CommCell environment, while each protected computer is referred to as a client.

The Installation Process


To set up a CommCell environment, you must deploy the Commvault software in the following order:
1. Install the CommServe and other server packages.
Commvault provides a group of server packages to manage and control your CommCell environment.
To get started, follow the instructions described in Server Installations .
2. Install the MediaAgent.
The MediaAgent manages the transmission of data between clients and backup media.
To get started, follow the instructions described in MediaAgent Installations .
3. Install Agents on Client Computers.
Commvault provides a range of installable agents to protect the data from file systems, applications, and databases in your organization.
To get started, follow the instructions described in Client Installations .
4. Optional: Install Commvault Tools.
Commvault provides a range of tools and utilities for your CommCell environment.
To get started, follow the instructions described in Installing Commvault Tools .
IMPORTANT: Read the release notes before you begin any installation. The latest version of the release notes is available in Release Notes - Known Issues .

5/6/2017 Commvault Systems Page 42 of 587


Server Installations
The installation of server packages is divided into two parts:
Installing the CommServe
The CommServe is the command center of the CommCell environment and the most important server package.
Follow the installation tasks described in CommServe Installation .
Optional: Installing Other Server Packages
Some server packages are installed with the CommServe. However, your environment might require additional server packages.
For more information, see Other Server Packages .

5/6/2017 Commvault Systems Page 43 of 587


CommServe Installation
Complete the following tasks to install the CommServe software in your environment:
1. Plan the installation.
Review general guidelines to prepare your environment for the installation. For more information, see Plan the CommServe Installation .
2. Review the preinstallation checklist.
Download the software and gather the information that you must provide during the installation. For more information, see Preinstallation Checklist for the
CommServe .
3. Install the software.
Install the CommServe software by using the installation package that was created from the Download Manager. For instructions, see Installing the CommServe
Software .
4. Perform postinstallation tasks.
Review the tasks that you must perform after the installation in Postinstallation Tasks for the CommServe .

5/6/2017 Commvault Systems Page 44 of 587


Plan the CommServe Installation
For a successful installation, some careful planning is required to ensure that Commvault integrates seamlessly with your environment.
Use the following checklist to prepare the computer where the CommServe software will be installed:
 Verify System Requirements
Make sure that the computer's operating system and hardware are supported by the CommServe software. For more information, see System Requirements .
 Verify License Requirements
The CommServe software does not require a license. Other packages that are installed along with the CommServe might require a license. To review the list of packages,
see Additional Packages Installed with the CommServe .
 Verify Requirements for Installation Environments
If you plan to install the CommServe software in a virtual machine, cluster environment, or disaster recovery environment, review the following requirements:
Virtual Machine
You must install the CommServe software on a virtual machine configured with fast-access storage media. Ensure that the CPU and memory resources recommended
in System Requirements are always available for the virtual machine.
Cluster Environment
You must install the CommServe software on the active node first, and then on the passive nodes of the cluster. For more information, see Installing Server Packages in
a Cluster Environment .
Additional cluster environment scenarios:
If you plan to configure an active-active cluster environment, you must install the CommServe software as described in Setting Up the CommServe Software in an
Active-Active Cluster Environment .
If the Microsoft SQL Server is already installed on the computer where you plan to install the CommServe software, review the following requirements:
The user account that is configured for the SQL Server service must have permissions on the drive or parent folder where you plan to install the CommServe
software.
The physical nodes that host the cluster server must have the same port numbers configured. For example, if you have a cluster server VS1 and three physical
computers configured to host VS1, then the three physical computers must have the same network TCP port numbers configured on the network interface used
by VS1.
Disaster Recovery Environment
To review the available disaster recovery solutions, see CommServe Disaster Recovery Solutions .
If you plan to use the method where the CommServe fails over to a standby host, review the preinstallation requirements mentioned in CommServe Installation:
Considerations for Disaster Recovery .
 Prepare the Computer for Restart
During the CommServe installation, you might be required to restart the computer after installing the Microsoft .Net Framework and Microsoft SQL Server software.
Therefore, plan the installation for a time when a restart can occur.
 Determine the Configurations that Meet Your Requirements
Every environment has different requirements. Consider the following additional configurations prior to completing your installation planning:
Configure Internet Information Services (IIS)
If you plan to install the Web Server and Web Console along with the CommServe software, enable Internet Information Services (IIS) on the computer. By default, the
Web Server and Web Console are automatically installed when IIS is enabled.
The Web Console and Web Server are not supported on cluster environments. If you plan to install the CommServe on a cluster environment, either disable IIS or clear
the selection of the Web Server and Web Console components during the CommServe installation.
Configure a Floating Host Name
A floating host name is a virtual host name that is useful in those scenarios when the CommServe computer needs to be moved or changed at some point in time. For
example, the floating name eliminates the need to redirect all clients after moving the CommServe to a new computer (hardware refresh). For more information, see
Configuring a Floating Host Name for the CommServe or MediaAgent Software .
Install the CommServe Database on an Existing SQL Server Instance
If you want to install the database on an existing SQL instance, you must configure Commvault to use the instance that you want. For more information, see Configuring
an Existing SQL Instance for Server Packages .
Install Commvault in a Different Language
If you want to install the software in a different language, you can configure the installation program to list the supported language options. For more information, see
Changing the Display Language of the Commvault Software on Windows Computers .
For the list of software that can be installed in a different language, see Language Support .

5/6/2017 Commvault Systems Page 45 of 587


Configuring an Existing SQL Instance for Server Packages
By default, when you install a server package, such as the CommServe and Web Server, for the first time on a computer, the installation program creates a dedicated
Microsoft SQL Server instance for the Commvault software.
If you want to use an existing SQL Server instance that was not created by the Commvault software, you can configure the szUserSQLInstanceName registry key to specify the
instance on which you want to install the server package. The instance must reside on the computer where you plan to install the server package.

Before You Begin


Check the Microsoft SQL Server versions supported by the Commvault software. See the Database Engine section in System Requirements - CommServe .

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.

5/6/2017 Commvault Systems Page 46 of 587


Pre-Installing the Microsoft SQL Server Software on a Non-Cluster Environment
By default, Commvault installs the Microsoft SQL Server 2014 Standard Edition during the installation of the CommServe software or other server packages. For more
information on scalability, performance, and other features supported by the standard edition, refer to the Microsoft documentation.
Based on your environment requirements, if you need to install the SQL Server before installing Commvault server packages, use the steps in this procedure to install the
SQL Server manually.

Before You Begin


Create an installation package by using the Download Manager. The installation package must include the Microsoft SQL Server and the necessary Commvault server
packages, such as the CommServe or Workflow Engine. For instructions about creating the package, see Downloading Software for Windows Computers Using the
Download Manager .
The computer on which you want to install the SQL Server must have the following properties:
The latest Microsoft ODBC Driver for SQL Server must be installed.
The computer must have a static IP address.

Installing the SQL Server and Creating the Commvault Instance


1. Log on to the client computer as an Administrator or as a member of the Administrator group on that computer.
2. Install .NET Framework 3.5 using the Server Manager Interface.
3. From the installation package that was created using the Download Manager, run the following program:
WinX64\ThirdParty\MSSQL\SQL_Standard_Edition\Setup.exe
The SQL Server Installation Center wizard is displayed.
4. From the left-hand navigation area, click Installation. Then, on the right pane, click New SQL Server stand-alone installation or add features to an existing
installation.
5. On the Product Key page, click Next. The product key is already provided.
6. On the License Terms page, select the I accept the license terms check box and then click Next.
7. On the Microsoft Update page, determine whether you want to enable the Microsoft Update feature and then click Next.
The Install Setup Files page is displayed, where the setup files are copied and then the installation automatically starts.
8. On the Setup Role page, click Next to proceed with the SQL Server Feature Installation.
9. On the Feature Selection page, from the features to install, select Database Engine Services and Management Tools - Complete and then click Next.
10. On the Instance Configuration page, click Named Instance, type Commvault, and then click Next.
11. On the Server Configuration page, complete the following steps:
a. In the Services Accounts tab, click the Account Name cell that corresponds to the SQL Server Database Engine service, and from the list, click More to specify the
local system account. The account name for the service should display NT AUTHORITY\SYSTEM.
Keep the default account names for the SQL Server Agent and SQL Server Browser services.
b. Click the Collation tab, and make sure the collation of the TEMPDB is set to to SQL_Latin1_General_CP1_CI_AS.
c. Click Next.
12. On the Database Engine Configuration page, complete the following steps in the Server Configuration tab:
a. Click Mixed Mode (SQL Server authentication and Windows authentication).
b. Enter and confirm the password for 'sa' SQL user in the Enter Password and Confirm password boxes.
c. Click the Add Current User button.
In the Data Directories and FILESTREAM tabs, accept the default values and then click Next.
13. On the Feature Configuration Rules page, check whether the rules ran successfully and then click Next.
14. On the Ready to Install page, verify the features to be installed and then click Install.
The Installation Progress page is displayed indicating the installation process.
15. On the Complete page, click Close.
The SQL Server is successfully installed.

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.

5/6/2017 Commvault Systems Page 47 of 587


Install the server package
You can now install the CommServe software or the appropriate server package on the computer where you installed the SQL Server software.

5/6/2017 Commvault Systems Page 48 of 587


Pre-Installing the Microsoft SQL Server Software on a Cluster Environment
By default, Commvault installs the Microsoft SQL Server 2014 Standard Edition during the installation of the CommServe software or other server packages. For more
information on scalability, performance, and other features supported by the standard edition, refer to the Microsoft documentation.
Based on your environment requirements, if you need to install the SQL Server before installing Commvault server packages, use the steps in this procedure to install the
SQL Server manually.
Note: The Microsoft SQL Server Express Edition is not supported on clustered environments.
Use this procedure to perform the following tasks:
Install the SQL Server in the active node and passive nodes of a cluster group.
Create the Commvault instance in the cluster group.

Before You Begin


Create an installation package by using the Download Manager. The installation package must include the Microsoft SQL Server and the necessary Commvault server
packages, such as the CommServe or Workflow Engine. For instructions about creating the package, see Downloading Software for Windows Computers Using the
Download Manager .
Review the following cluster environment requirements.
Verify that the latest service packs for the operating system are installed on all the nodes of the cluster group.
The latest Microsoft ODBC Driver for SQL Server must be installed on all the nodes of the cluster group.
You will need to add a Group in Active Directory, and add a user to that group which will have full access to both nodes of the cluster. For more information on the
Microsoft SQL Server Group, see http://technet.microsoft.com/en-us/library/ms345196.aspx . This account could be the same account that the cluster services run
under, but must be added to a Group.
The cluster should be functional, and the cluster group to which you want to install Microsoft SQL Server should be configured with a disk resource. You should
review http://technet.microsoft.com/en-us/library/ms189910.aspx for the full set of prerequisites to installing Microsoft SQL Server on a cluster.
To avoid a failure of installation on Windows Server 2008 R2, make sure that the Windows Service Pack 1 is installed.

Installing the SQL Server and Creating the Commvault Instance


1. Log on to the active node of the cluster group as an Administrator or as a member of the Administrator group on that computer.
2. Install .NET Framework 3.5 using the Server Manager Interface.
3. From the installation package that was created using the Download Manager, run the following program:
WinX64\ThirdParty\MSSQL\SQL_Standard_Edition\Setup.exe
The SQL Server Installation Center wizard is displayed.
4. From the left-hand navigation area, click Installation. Then, on the right pane, click New SQL Server failover cluster installation.
5. On the Product Key page, click Next. The product key is already provided.
6. On the License Terms page, select the I accept the license terms check box and then click Next.
7. On the Microsoft Update page, determine whether you want to enable the Microsoft Update feature and then click Next.
The Install Setup Files page is displayed, where the setup files are copied and then the installation automatically starts.
8. On the Setup Role page, click Next to proceed with the SQL Server Feature Installation.
9. On the Feature Selection page, from the features to install, select Database Engine Services and Management Tools - Complete and then click Next.
10. On the Instance Configuration page, complete the following steps:
Enter the SQL Server Network Name. This is the name of the CommServe client, which you will see in the CommCell Browser pane of the CommCell Console.
Click Named Instance and specify a name for the instance. For example, you can type Commvault.
Click Next.
11. On the Cluster Resource Group page, accept the default options and click Next.
12. On the Cluster Disk Selection page, select the shared disks to be included in the SQL Server resource cluster group and click Next.
13. On the Cluster Network Configuration page, we recommend you to have, at a minimum, the IPv4 check box selected.
If you want the SQL Server to use a specific IP address, clear the DHCP check box for the IP Type you selected and then specify the IP Address and Subnet Mask. Click
Next to continue.
14. On the Server Configuration page, complete the following steps:
a. In the Account Name and Password boxes for each SQL Server service, enter the username and password of the domain account that you used to log on to the
computer.
Note: Make sure that the user account that you specify for the SQL Server service has permissions on the drive or parent folder where you plan to install the
CommServe software.
b. Click the Collation tab, and make sure the collation of the TEMPDB is set to to SQL_Latin1_General_CP1_CI_AS.
c. Click Next.
15. On the Database Engine Configuration page, complete the following steps in the Server Configuration tab:
a. Click Mixed Mode (SQL Server authentication and Windows authentication).
b. Enter and confirm the password for 'sa' SQL user in the Enter Password and Confirm password boxes.
c. Click the Add Current User button.
In the Data Directories and FILESTREAM tabs, accept the default values and then click Next.
16. On the Feature Configuration Rules page, check whether the rules ran successfully and then click Next.
17. On the Cluster Installation Rules page, check if the rules ran successfully and then click Next
18. On the Ready to Install page, verify the features to be installed and then click Install.
The Installation Progress page is displayed indicating the installation process.
19. On the Complete page, click Close.
After the installation is complete on the active node, install the SQL Server on the passive nodes:
5/6/2017 Commvault Systems Page 49 of 587
a. Log on to the passive node of the cluster group as an Administrator or as a member of the Administrator group on that computer.
b. Install .NET Framework 3.5 using the Server Manager Interface.
c. From the installation package that was created using the Download Manager, run the following program:
WinX64\ThirdParty\MSSQL\SQL_Standard_Edition\Setup.exe
The SQL Server Installation Center wizard is displayed.
d. In the left-hand navigation area, click Installation, then click Add node to a SQL Server failover cluster and complete the installation on the passive node.

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.

Install the server package


You can now install the CommServe software or the appropriate server package on the active node, and then on the passive nodes of the cluster.

5/6/2017 Commvault Systems Page 50 of 587


Preinstallation Checklist for the CommServe
The CommServe computer is the command and control center of the CommCell environment.
Use this preinstallation checklist to download the software and to gather all of the information you will need during the installation.
 Download the Software
Use the Download Manager application to download the latest Commvault software. During the download, the application bundles an installation package with the
software you chose to download. You must use the installation package to install the CommServe software.
To download the software, see Downloading Software for Windows Computers Using the Download Manager .
 Determine the Installation Location
Based on your environment, install the CommServe software on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer that will host the CommServe software.
Clustered First on the active physical node of the cluster, and then on the passive physical nodes.
You must determine on which passive nodes you want to install the software. In the event of a failure, the active node can fail over to
one of the passive nodes.
Disaster Recovery If you plan to use the disaster recovery method where the CommServe fails over to an standby host, install the CommServe on the
production and standby server computers.

 Review Microsoft SQL Server Considerations


The Microsoft SQL Server is automatically installed with the CommServe software. If SQL Server is already installed on the computer, the installation wizard skips the
SQL Server installation.
Commvault Systems, Inc. has an ISV-R royalty contract with Microsoft, allowing the Commvault software to be bundled with a full copy of the SQL Server
Standard Edition. Commvault Systems, Inc. reports the license usage (per country) every month to Microsoft.
When the Microsoft SQL Server is installed as part of the CommServe installation, the Commvault software automatically sets the system administrator (sa)
password. If SQL Server was installed separately and if the sa password does not match the default password set by Commvault, the installation wizard will prompt
you for the password.
 Additional Packages Installed with the CommServe
Use the following table to review the packages that are installed by default during the CommServe installation:
Packages Automatically Selected Notes
CommCell Console The CommCell Console requires Java Runtime Environment (JRE). If JRE is not installed on the computer, it will be
installed along with the CommCell Console. For more information about the JRE requirements, see System
Requirements - CommCell Console .
File System Core None
File System Consumes a license.
Web Console The Web Server and Web Console packages are automatically selected if IIS is enabled on the computer.
The MediaAgent package is installed as part of the Web Server package.
Web Server The Search Advanced Document Type Support package is installed as part of the Web Server package and it
MediaAgent
Search Advanced Document Type Support consumes a license.
Workflow Engine None

 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.
Commvault package to install
Install the CommServe package, which is listed under the Server category.
Destination folder for the Commvault software
By default, the software is installed in C:\Program Files\CommVault\ContentStore.
You can change the destination folder, but it cannot be on a mapped network drive.
The installation program uses the C:\%allusersprofile% folder as a temporary location to copy the installation files. This location does not change, even if you choose to
install the software on a drive other than C:.
Destination folder for the Database Engine
The database engine is the Microsoft SQL Server software. By default, the software binaries are installed in C:\Program Files\Microsoft SQL Server.
You can change the destination folder, but it cannot be on a mapped network drive.

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.

5/6/2017 Commvault Systems Page 52 of 587


Installing the CommServe Software
Install the CommServe software by using the installation package that was created from the Download Manager application.
If you want to install the CommServe software in a cluster environment, see Installing Server Packages in a Cluster Environment .

Before You Begin


Prepare your environment for the installation as described in Plan the CommServe Installation .
Download the software and gather the information that you must provide during the installation. For more information, see Preinstallation Checklist for the
CommServe .

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 .

5/6/2017 Commvault Systems Page 53 of 587


Postinstallation Tasks for the CommServe
The following sections describe the tasks that you must perform to complete the CommServe installation process. Depending on your environment settings and
requirements, some of the tasks may not be required.
Note: Some of the tasks listed below are performed from the CommCell Console. To access the CommCell Console, see Opening the CommCell Console .

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 .

Download the Software to the CommServe Cache


If you plan to perform installations from the CommCell Console, the Commvault software must be available in the CommServe cache directory.
If the CommServe computer has Internet connectivity, no action is required. The Commvault software is automatically downloaded to the CommServe cache as part of
the installation job.
If the CommServe computer has Internet connectivity with restrictions, or if there is no internet connectivity, you can adjust the download settings in the CommCell
Console. For more information, see Configure Download Settings in the CommCell Console .
If the CommServe computer does not have internet connectivity, and the download settings do not satisfy your requirements, create a new installation package with all
the software needed by your organization, and then copy the package to the CommServe cache. For instructions, see the download software procedure for Windows
and UNIX computers.

Configure Automatic Installation of Updates


To keep the Commvault software up-to-date on the CommServe computer and on the clients that you plan to have in your CommCell, you can configure the CommCell to
install updates automatically. For instructions, see Configuring Automatic Service Pack Installations .

Update the Installation Package


To continue using the installation package as a media resource, verify that the package contains all the software needed by your organization. If some software is missing,
you must create a new installation package with the required software.
The installation package is also useful if you plan to install the following server packages, as they can only be installed from the package:
Metrics Reporting
Web Server
Workflow Engine
To create the installation package, see Downloading Software for Windows Computers Using the Download Manager . If you need to create an installation package for
UNIX computers, see Downloading Software for UNIX, Linux, and Macintosh Computers Using the Download Manager .
Note: As a best practice, keep the installation package up-to-date, or at the same service pack level as that of the CommServe computer.

5/6/2017 Commvault Systems Page 54 of 587


Other Server Packages
By default, some server packages are installed with the CommServe.
You might decide to install the necessary server packages in the following scenarios:
You chose not to install other server packages with the CommServe because you wanted to offload additional processes from the CommServe computer.
Your environment requires server packages that are not installed with the CommServe, such as the ContentStore Mail Server and the Metrics Reporting Server.
The following table lists the available server packages and specifies whether a package is installed with the CommServe. Click the name of the server package that you want
to install.

Package Name Installed with the CommServe by Notes


default
CommCell Console The CommCell Console is always installed with the CommServe; it cannot be deselected
during the CommServe installation. However, you can install additional consoles on other
computers.
Compliance Search
ContentStore Mail Server
Metrics Reporting Server
Search Engine
Web Console Installed only if IIS was enabled on the CommServe computer.
Web Server Installed only if IIS was enabled on the CommServe computer.
Workflow Engine
1-Touch Server

5/6/2017 Commvault Systems Page 55 of 587


Installing the Analytics Engine
Install the Analytics Engine by using the CommCell Console or the installation package that was created from the Download Manager application.

Before You Begin


Review Commvault requirements and gather the information that you must provide during the installation. For more information, see Preinstallation Checklist for the
Analytics Engine .

Choose the Installation Method


Use one of the following methods to install the software:
Remote installations, where you use the CommCell Console to install the software remotely on one or more computers.
For instructions, see Installing Commvault Remotely Using the CommCell Console .
Local installations, where you use the installation package to install the software locally on a computer.
For instructions, see Installing Commvault Locally on Windows Computers Using the Installation Package .

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 .

5/6/2017 Commvault Systems Page 56 of 587


Installing the CommCell Console
By default, the CommCell Console is installed as part of the CommServe installation. You can install additional consoles on other computers by using the CommCell Console
or the installation package that was created from the Download Manager application.

Before You Begin


Prepare your environment by reviewing the following tasks:
Review Commvault requirements and gather the information that you must provide during the installation. For more information, see the preinstallation checklist for
the CommCell Console on Windows or UNIX .
If you want to install the software in a different language, you can configure the installation program to list the supported language options. For more information, see
Changing the Display Language of the Commvault Software on Windows Computers .

Choose the Installation Method


Use one of the following methods to install the software:
Remote installations, where you use the CommCell Console that was installed on the CommServe computer to install additional consoles on other computers.
For instructions, see Installing Commvault Remotely Using the CommCell Console .
Local installations, where you use the installation package to install the console locally on a computer.
Based on your computer's operating system, see installing Commvault locally on Windows or UNIX .

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

5/6/2017 Commvault Systems Page 57 of 587


Installing Compliance Search
Install Compliance Search by using the CommCell Console or the installation package that was created from the Download Manager application.

Before You Begin


Review Commvault requirements and gather the information that you must provide during the installation. For more information, see Preinstallation Checklist for
Compliance Search .

Choose the Installation Method


Use one of the following methods to install the software:
Remote installations, where you use the CommCell Console to install the software remotely on one or more computers.
For instructions, see Installing Commvault Remotely Using the CommCell Console .
Local installations, where you use the installation package to install the software locally on a computer.
For instructions, see Installing Commvault Locally on Windows Computers Using the Installation Package .

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 .

5/6/2017 Commvault Systems Page 58 of 587


Installing the ContentStore Mail Server
Install the ContentStore Mail Server by using the CommCell Console or the installation package that was created from the Download Manager application.

Before You Begin


Review Commvault requirements and gather the information that you must provide during the installation. For more information, see Preinstallation Checklist for the
ContentStore Mail Server .

Choose the Installation Method


Use one of the following methods to install the software:
Remote installations, where you use the CommCell Console to install the software remotely on one or more computers.
For instructions, see Installing Commvault Remotely Using the CommCell Console .
Local installations, where you use the installation package to install the software locally on a computer.
For instructions, see Installing Commvault Locally on Windows Computers Using the Installation Package .

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 .

5/6/2017 Commvault Systems Page 59 of 587


Installing the Metrics Reporting Server
Install the Metrics Reporting Server by using the installation package that was created from the Download Manager application.

Before You Begin


Prepare your environment by reviewing the following tasks:
Verify that the installation package that was created from the Download Manager includes the Metrics Reporting Server software. If missing, create a new installation
package and include the software. For instructions, see Downloading Software for Windows Computers Using the Download Manager .
Review Commvault requirements and gather the information that you must provide during the installation. For more information, see Preinstallation Checklist for
Metrics Reporting Server .
If you plan to install the Metrics Reporting database on an existing Microsoft SQL Server instance, see Configuring an Existing SQL Instance for Server Packages .

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 .

5/6/2017 Commvault Systems Page 60 of 587


Installing the Search Engine
Install the Search Engine by using the CommCell Console or the installation package that was created from the Download Manager application.

Before You Begin


Review Commvault requirements and gather the information that you must provide during the installation. For more information, see Preinstallation Checklist for the
Search Engine .

Choose the Installation Method


Use one of the following methods to install the software:
Remote installations, where you use the CommCell Console to install the software remotely on one or more computers.
For instructions, see Installing Commvault Remotely Using the CommCell Console .
Local installations, where you use the installation package to install the software locally on a computer.
For instructions, see Installing Commvault Locally on Windows Computers Using the Installation Package .

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 .

5/6/2017 Commvault Systems Page 61 of 587


Installing the Web Console
By default, the Web Console is installed as part of the CommServe installation when IIS is enabled on the computer.
If you did not install the Web Console during the CommServe installation, or if you want to install additional consoles on other computers, you can do so by using the
CommCell Console or the installation package that was created from the Download Manager application.
Note: The Admin Console is included with the Web Console package. To learn more about the solutions available in the Admin Console, visit the Commvault Solutions for
Data Protection and Recovery website.

Before You Begin


Prepare your environment by reviewing the following tasks:
Review Commvault requirements and gather the information that you must provide during the installation. For more information, see Preinstallation Checklist for the
Web Console .
Important: The Web Console requires a Web Server. If not installed, you can install the Web Server on the same computer as the Web Console, or on a different
computer.
If you want to install the software in a different language, you can configure the installation program to list the supported language options. For more information, see
Changing the Display Language of the Commvault Software on Windows Computers .

Choose the Installation Method


Use one of the following methods to install the software:
Remote installations, where you use the CommCell Console to install the software remotely on one or more computers.
For instructions, see Installing Commvault Remotely Using the CommCell Console .
Local installations, where you use the installation package to install the software locally on a computer.
For instructions, see Installing Commvault Locally on Windows Computers Using the Installation Package .

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

5/6/2017 Commvault Systems Page 62 of 587


Installing the Web Server
By default, the Web Server is installed as part of the CommServe installation when IIS is enabled on the computer.
If you did not install the Web Server during the CommServe installation, or if you want to install additional Web Servers on other computers, you can do so by using the
installation package that was created from the Download Manager application.

Before You Begin


Prepare your environment by reviewing the following tasks:
Verify that the installation package that was created from the Download Manager includes the Web Server software. If missing, create a new installation package and
include the software. For instructions, see Downloading Software for Windows Computers Using the Download Manager .
Review Commvault requirements and gather the information that you must provide during the installation. For more information, see Preinstallation Checklist for the
Web Server .
If you plan to install the Web Server database on an existing Microsoft SQL Server instance, see Configuring an Existing SQL Instance for Server Packages .

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 .

5/6/2017 Commvault Systems Page 63 of 587


Installing the Workflow Engine
By default, the Workflow Engine is installed as part of the CommServe installation.
If you did not install the Workflow Engine during the CommServe installation, or if you want to install additional engines on other computers, you can do so by using the
installation package that was created from the Download Manager application.
Note: If you want to install the Workflow Engine on an active-active cluster environment, follow the instructions in Setting Up the Workflow Engine in an Active-Active Cluster
Environment .

Before You Begin


Prepare your environment by reviewing the following tasks:
Verify that the installation package that was created from the Download Manager includes the Workflow Engine software. If missing, create a new installation package
and include the software. For instructions, see Downloading Software for Windows Computers Using the Download Manager .
Review Commvault requirements and gather the information that you must provide during the installation. For more information, see Preinstallation Checklist for the
Workflow Engine .
If you plan to install the Workflow database on an existing Microsoft SQL Server instance, see Configuring an Existing SQL Instance for Server Packages .

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.

5/6/2017 Commvault Systems Page 64 of 587


Installing the 1-Touch Server
Install the 1-Touch Server on UNIX computers by using the installation package that was created from the Download Manager application.
1-Touch Server installations are supported on AIX and Solaris computers. To set up 1-Touch on FreeBSD or Linux computers, see Virtualize Me for FreeBSD or
Deployment - 1-Touch for Linux respectively.

Before You Begin


Review Commvault requirements and gather the information that you must provide during the installation. For more information, see the Preinstallation Checklist for the
1-Touch Server on UNIX .

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 .

5/6/2017 Commvault Systems Page 65 of 587


Preinstallation Checklist for Server Packages
To collect the information required during the installation, review the preinstallation checklist page for each server package that you plan to install.
Analytics Engine
CommCell Console (Windows | UNIX )
Compliance Search
ContentStore Mail Server
Metrics Reporting Server
Search Engine
Web Console
Web Server
Workflow Engine
1-Touch Server on UNIX

5/6/2017 Commvault Systems Page 66 of 587


Preinstallation Checklist for the Analytics Engine
The Analytics Engine is a lightweight indexing engine that supports several Commvault features, such as Data Analytics, Data Cube, and more.
Use this preinstallation checklist to prepare the computer where the Analytics Engine 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 Analytics Engine satisfies the minimum requirements for the features that you intend to configure on the Analytics
Engine. Because the Analytics Engine supports several different features, some features have different minimum requirements. See the feature documentation for a list
of specific Analytics Engine requirements.
For general system requirements information, see System Requirements - Analytics Engine .
 Verify License Requirements
The Analytics Engine does not require a license to install.
 Determine the Installation Location
Based on your environment, install the Analytics Engine on an appropriate computer.
 Additional Packages Installed with the Analytics Engine
Use the following table to review the packages that are automatically selected during the Analytics Engine installation.
Packages Automatically Selected Notes
File System Core None
File System Does not consume a license.
MediaAgent Consume a license.

 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 MediaAgent using either the CommCell Console or the installation package created by the Download Manager.
Commvault package to install
Install the Analytics package, which is listed under the Server 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 installation program reads the details from the previous installation.

5/6/2017 Commvault Systems Page 67 of 587


Preinstallation Checklist for the CommCell Console on Windows
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.

 Install the CommServe Package


Verify that the CommServe package is already installed and configured in your environment. The CommCell Console must establish connections with the CommServe
computer to open the user interface. For information about installing the CommServe, see Preinstallation Checklist for the CommServe .
 Review Firewall Settings
If you plan to install the CommCell Console on a computer other than the CommServe computer, and there is a firewall between the two computers, firewall port 8401
must be open to allow communications.
If the computer uses a proxy to connect to the CommServe computer, configure third-party ports to establish connections with the CommServe computer. For more
information, see Configuring Access to the CommCell Console Using TPPM .
 Set Up the CommCell Console as a Remote Web-Based Application
If you plan to use the CommCell Console as a remote web-based application, review the following requirements:
The CommCell Console must be installed on the CommServe computer.
Internet Information Service (IIS) must be enabled on the CommServe computer.
The computer from which you plan to remotely access the CommCell Console must have Java enabled in the web browser. For more information, see System
Requirements - CommCell Console as a Remote Web-Based Application .
By default, the CommCell Console uses port 81 for internet access. (If port 81 is used by another application, the console uses the next available port. Check IIS to see
which port is being used). By default, the URL to access the console is http://commserve_computer_host:81/console.

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

 Set Up the Java Runtime Environment


The CommCell Console requires Java Runtime Environment (JRE). If JRE is not installed on the computer, it will be installed along with the CommCell Console. For more
information about the JRE requirements, see System Requirements - CommCell Console .
 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 CommCell Console by using the installation package created by the Download Manager. If you have a CommCell Console installed and you want to
install CommCell Consoles on additional computers, you can install the additional CommCell Consoles by using the installed CommCell Console.
Commvault package to install
Install the CommCell Console package, which is listed under the Server category.
Destination folder for the software installation
This information is required if the computer does not yet have any Commvault packages installed. By default, the software is installed in C:\Program
Files\CommVault\ContentStore.
You can change the destination folder, but it cannot be on a mapped network drive.
The installation program uses the C:\%allusersprofile% folder as a temporary location to copy the installation files. This location does not change, even if you choose to
install the software on a drive other than C:.
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 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
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.

 Install the CommServe Package


Verify that the CommServe package is already installed and configured in your environment. The CommCell Console must establish connections with the CommServe
computer to open the user interface. For information about installing the CommServe, see Preinstallation Checklist for the CommServe .
 Review Firewall Settings
If you plan to install the CommCell Console on a computer other than the CommServe computer, and there is a firewall between the two computers, firewall port 8401
must be open to allow communications.
If the computer uses a proxy to connect to the CommServe computer, configure third-party ports to establish connections with the CommServe computer. For more
information, see Configuring Access to the CommCell Console Using TPPM .
 Set Up the CommCell Console as a Remote Web-Based Application
If you plan to use the CommCell Console as a remote web-based application, review the following requirements:
The CommCell Console must be installed on the CommServe computer.
Internet Information Service (IIS) must be enabled on the CommServe computer.
The computer from which you plan to remotely access the CommCell Console must have Java enabled in the web browser. For more information, see System
Requirements - CommCell Console as a Remote Web-Based Application .
By default, the CommCell Console uses port 81 for internet access. (If port 81 is used by another application, the console uses the next available port. Check IIS to see
which port is being used). By default, the URL to access the console is http://commserve_computer_host:81/console.

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

 Set Up the Java Runtime Environment


The CommCell Console requires the Oracle Java Runtime Environment (JRE). You must install the JRE software before you start the CommCell Console installation. For
more information, see System Requirements - CommCell Console .
 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 CommCell Console by using the installation package created by the Download Manager. If you have a CommCell Console installed and you want to
install CommCell Consoles on additional computers, you can install the additional CommCell Consoles by using the installed CommCell Console.
Commvault package to install
For installations using the CommCell Console, install the CommCell Console package, which is listed under the Server category.
For installations using the installation package, install the CommCell Console package.
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 CommCell Console 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 uses the default network interface name (host name) of the computer to communicate
with the CommServe computer. If the computer has multiple network interfaces, decide which interface name you prefer to use.
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.

5/6/2017 Commvault Systems Page 70 of 587


Preinstallation Checklist for Compliance Search
The Compliance Search package is web application that enables users to search, collect, and deliver relevant electronically stored information (ESI) for compliance or
electronic discovery (eDiscovery) requests. Compliance officers and legal teams can use Compliance Search to perform advanced queries on the content of emails, files,
and other ESI across all of the storage repositories in your CommCell environment.
Use this preinstallation checklist to prepare the computer where Compliance Search 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 Compliance Search satisfies the minimum requirements. For more information, see System Requirements - Compliance
Search .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use Compliance Search. For more
information, see License Requirements - Compliance Search .
 Determine the Installation Location
Based on your environment, install Compliance Search on an appropriate computer with the following considerations in mind:
A Web Server is required to provide users with access to the Compliance Search site. Therefore, we recommend installing the Compliance Search package together
with the Web Server package, or on a computer where the Web Server package is already installed.
If you require Compliance Search to be installed on a separate computer, you must install the Web Server in your CommCell environment before you can install
Compliance Search.
Compliance Search requires the content indexing feature provided by the Search Engine package. Therefore, you will not be able to search data in Compliance
Search until you install a Search Engine and configure content indexing. For information about where to install the Search Engine package in combination with
Compliance Search in your CommCell environment, see Recommendations for Deployment .
 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 Compliance Search package using either the CommCell Console or the installation package created by the Download Manager.
Commvault package to install
Install the Compliance Search package, which is listed under the Server 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.
Web Server Client Name
During installation, you are prompted to select a client with the Web Server package installed. If you are installing the Compliance Search and Web Server on the
same computer, the installation computer name will be selected by default.

5/6/2017 Commvault Systems Page 71 of 587


Preinstallation Checklist for the ContentStore Mail Server
The ContentStore Mail Server allows you to give end users the ability to access backed up or archived messages on mobile devices that support an IMAP client. The
ContentStore Mail Server is based on IMAP (Internet Message Access Protocol). For more information, see ContentStore Mail Server .
Use the preinstallation checklist to prepare the computer where the ContentStore Mail Server will be installed and to gather all of the information that you will need during
the installation.
 Verify System Requirements
Make sure that the Windows operating system on the ContentStore Mail Server is x64-bit version.
 Verify License Requirements
The ContentStore Mail Server does not require a license.
 Determine the Installation Location
The ContentStore Mail Server computer must be able to access the Web Server and Web Console computers using the URL that you define after the ContentStore Mail
Server is installed.
 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 ContentStore Mail Server only by using the installation package that was created by the Download Manager.
Commvault package to Install
Install the ContentStore Mail Server package, which is listed under the Server 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 .

5/6/2017 Commvault Systems Page 72 of 587


Preinstallation Checklist for Metrics Reporting Server
The Metrics Reporting Server allows you to access reports that help you to monitor one or more CommCell computers from a single location on your Web Console. For
more information, see Reports Overview .
Use this preinstallation checklist to prepare the computer where the Private Metrics Reporting Server 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 Metrics Reporting Server satisfies the minimum requirements. For more information, see System Requirements -
Private Metrics Reporting Server .
 Verify Service Plan Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Private Metrics Reporting Server.
For more information, see Service Plan Requirements for Metrics Reports and Build Your Own Reports .
 Determine the Installation Location
Based on your environment, install the Metrics Reporting Server on an appropriate computer with the following considerations in mind:
CommCell environments with more than 200 clients: we strongly recommend that you install both the Metrics Reporting package and the CommServe package
on a separate computer from the backup CommServe computers.
Additional packages, including CommCell Console, Web Server, and Web Console, must be installed along with the CommServe software. To review the list of
packages, see the Additional Packages Installed with the CommServe section in Preinstallation Checklist for the CommServe . If any of the additional
packages are not already installed on the computer, the missing packages will be installed.
CommCell environments with 1 to 200 clients: you can install the Metrics Reporting package on the backup CommServe computer. The backup CommServe
computer must also have CommCell Console, Web Server, and Web Console installed.
 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 Metrics Reporting package only by using the installation package created by the Download Manager.
Commvault package to install
Install the Metrics Reporting package, which is listed under the Server category.
Destination folder for the Metrics Report Database
By default, the Metrics Report Database is installed in C:\Program Files\CommVault\ContentStore.
You can change the destination folder, but it cannot be on a mapped network drive.

5/6/2017 Commvault Systems Page 73 of 587


Preinstallation Checklist for the Search Engine
The Search Engine package is used to content index data, which enables users to retrieve documents and emails from archival storage using basic and advanced search
queries. The Search Engine also provides search functionality to other Commvault software, such as Compliance Search and Web Console. For more information, see
Search - Overview .
Use this preinstallation checklist to prepare the computer where the Search Engine 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 Search Engine satisfies the minimum requirements. For more information, see System Requirements - Search Engine
.
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Search Engine. For more
information, see License Requirements - Search Engine .
 Determine the Installation Location
Based on your environment, install the Search Engine on an appropriate computer with the following considerations in mind:
The Search Engine package is typically installed to provide search functionality for other packages, such as Compliance Search. For information about where to
install the Search Engine package in combination with other software packages, see Recommendations for Deployment .
 Test IOPS of the Installation Location
It is recommended that you test the input/output operations per second (IOPS) of your installation location. The minimum IOPS that we recommend depends on your
deployment scenario. For more information, see Testing IOPS of Search Engine Nodes with IOmeter .
 Install Required Software to Content Index Exchange or Domino Mailbox Data
Note: For Exchange data, this method of content indexing applies to the classic agents only. If you use the Exchange Mailbox Agent, see Content Indexing Messages
Using the Exchange Mailbox Agent .
If you are planning to use the Search Engine to content index Exchange or Domino Mailbox data, additional software must be installed and configured on the
MediaAgent and Web Server computers. You may complete this requirement before or after you install the Search Engine package. For more information, see Content
Indexing Exchange Data and Content Indexing Domino Mailbox Data.
 Disable Anti-Virus Software
It is recommended that anti-virus software is not installed on the computer where the Search Engine package is to be installed. If anti-virus software must be installed as
a business requirement, the Search Engine package directory and content indexing data directories must be excluded from real-time or scheduled scanning. See
Excluding Folder for Anti-Virus Scanning .
 Additional Packages Installed with the Search Engine
Use the following table to review the packages that are automatically selected during the Search Engine installation.
Packages Automatically Selected Notes
Search Advanced Document Type Support Consumes a license.
File System Core None
File System Does not consume a license.
MediaAgent Does not consume a license.

 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 Search Engine using either the CommCell Console or the installation package created by the Download Manager.
Commvault package to install
Install the Search Engine package, which is listed under the Server 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.
Search Engine Data Path (Index Location)
By default, the Search Engine index data is stored at: C:\Program Files\CommVault\ContentStore\CVCIEngine\solr\CIIndex. If you want to change the location of the Search
Engine data path, ensure the new path meets the system requirements.
Search Engine Cloud Name
During the installation, you have the option to install the package as a new Search Engine Cloud or as an additional node to an existing Search Engine Cloud. If you
are installing the Search Engine package as an additional node, you must know the name of the existing Search Engine Cloud to which you want to add the new
node.
A single Search Engine Cloud can contain a maximum of four nodes. Any Search Engine Clouds that contain the maximum number of nodes will not be available to
add additional nodes during installation.
Base Port
During the installation, you have the option to select a network port number to be used by the Search Engine. Ensure that you select a port number that is not in
use by another service or application.
5/6/2017 Commvault Systems Page 74 of 587
5/6/2017 Commvault Systems Page 75 of 587
Preinstallation Checklist for the Web Console
The Web Console is a web-based application end-users can use to manage their data, as well as to perform other useful operations such as reporting and managing virtual
machines. For more information, see Web Console - Overview .
Use this preinstallation checklist to prepare the computer where the Web 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 Web Console satisfies the minimum requirements. For more information, see System Requirements - Web Console .
 Verify License Requirements
The Web Console does not require a license.
 Determine the Installation Location
Based on your environment, install the Web Console on an appropriate computer.
By default, the Web Console is installed as part of the CommServe installation when Internet Information Services (IIS) is enabled. The Web Console can be installed
on a separate computer than the CommServe and Web Server computers to support the following:
Offloading the Web Console processes from the CommServe or Web Server computers
Setting up the Web Console in a perimeter network outside of the organization's network to provide global access for external users
Ensure that Internet Information Services (IIS) is enabled on the computer where the software will be installed.
If you Install the Web Console on a separate computer, that computer must be able to connect to the Web Server and CommServe computers.
If you want to allow Single Sign On (SSO) for users from domains that are not trusted, install the Web Console on those domains. This applies when you have
multiple domains in your environment where some of them are not trusted.
The Web Console cannot be installed on a clustered environment. For example, if you plan to install the Web Console on the CommServe computer, but the
CommServe computer is installed on a clustered environment, then you must install the Web Console on a different computer.
 Install the Web Server Package
Verify that the Web Server package is already installed and configured in your environment. For information about the Web Server requirements, see System
Requirements - Web Server . For information about installing the Web Server, see Preinstallation Checklist for the Web Server .
 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 Web Console by using either the CommCell Console or the installation package created by the Download Manager.
If you plan to install the Web Console on a computer that has other server components installed, only the following information is required:
Commvault package to install
Destination folder for the software installation
Commvault package to install
Install the Web Console package, which is listed under the Server 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.
Web Server Client Name
During installation, you are prompted to select a client with the Web Server package installed. If you are installing the Web Console and Web Server on the same
computer, the installation computer name will be selected by default.

5/6/2017 Commvault Systems Page 76 of 587


Preinstallation Checklist for the Web Server
The Web Server is a web service that communicates with the CommServe to provide end users access to CommCell operations on the web.
Use this preinstallation checklist to prepare the computer where the Web Server 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 Web Server satisfies the minimum requirements. For more information, see System Requirements - Web Server .
 Verify License Requirements
The Web Server does not require a license.
 Determine the Installation Location
Based on your environment, install the Web Server on an appropriate computer.
The Web Server requires that the Internet Information Services (IIS) is enabled on the computer where the software will be installed. If not enabled, IIS can be enabled
during the installation.
 Additional Packages Installed with the Web Server
Use the following table to review the packages that are automatically selected during the Web Server installation.
Packages Automatically Selected Notes
Search Advanced Document Type Support Consumes a license.
File System Core None
File System Does not consume a license.
MediaAgent Does not consume a license.

 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 Web Server only by using the installation package that was created by the Download Manager.
If you plan to install the Web Server on a computer that has other server components installed, only the following information is required:
Commvault package to install
Destination folder for the Web Server database
Commvault package to install
Install the Web Server package, which is listed under the Server 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 installation program reads the details from the previous installation.
Destination folder for the Database Engine
The database engine is the Microsoft SQL Server software. By default, the software binaries are installed in C:\Program Files\Microsoft SQL Server.
You can change the destination folder, but it cannot be on a mapped network drive.

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.

5/6/2017 Commvault Systems Page 77 of 587


Preinstallation Checklist for the Workflow Engine
Workflow is a tool that automates business processes by putting together a set of tasks in a specific order. For more information, see Workflow: Overview .
Use the preinstallation checklist to prepare the computer where the Workflow Engine 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 Workflow Engine satisfies the minimum requirements specified in System Requirements .
 Verify License Requirements
The Workflow Engine does not require a license.
 Determine the Installation Location
Based on your environment, install the Workflow Engine on an appropriate computer with the following considerations in mind:
The Workflow computer must have direct connectivity to the CommServe computer because it requires access to the database. There should be no firewall
configured between the Workflow and CommServe computers.
By default, the Workflow Engine is installed as part of the CommServe installation. However, if you plan to offload workflow processes from the CommServe
computer, you can install additional Workflow engines on other computers.
For installations in a clustered environment, you must install the Workflow Engine on the active node first, and then on the passive nodes.
 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 Workflow Engine by using the installation package that was created by the Download Manager.
If you plan to install the Workflow Engine on a computer that has other server components installed, only the following information is required:
Commvault package to install
Destination folder for the Workflow database
Commvault package to Install
Install the Workflow Engine package, which is listed under the Server 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 installation program reads the details from the previous installation.
Destination folder for the Database Engine
The database engine is the Microsoft SQL Server software. By default, the software binaries are installed in C:\Program Files\Microsoft SQL Server.
You can change the destination folder, but it cannot be on a mapped network drive.
Destination folder for the Workflow 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

5/6/2017 Commvault Systems Page 78 of 587


Preinstallation Checklist for the 1-Touch Server on UNIX
The 1-Touch Server secures the required information from the client's backup and then uses this information to re-create the client environment during 1-Touch recovery.
For more information, see Overview - 1-Touch for UNIX .
Use this preinstallation checklist to prepare the computer where the 1-Touch Server 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 1-Touch Server satisfies the minimum requirements specified in the system requirements page for your operating
system:
System Requirements - 1-Touch for AIX
System Requirements - 1-Touch for Solaris
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the 1-Touch Server. For more
information, see the license requirements page for your operating system:
License Requirements - 1-Touch for AIX
License Requirements - 1-Touch for Solaris
 Determine the Installation Location
Install the 1-Touch Server on the computer where you want the required information from the client's backup to reside. The 1-Touch Server cannot be installed on
cluster environments.
 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 1-Touch Server only by using the installation package that was created by the Download Manager.
Commvault package to install
Install the 1-Touch Server 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 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.

5/6/2017 Commvault Systems Page 79 of 587


MediaAgent Installations
Complete the following tasks to install the MediaAgent in your environment:
1. Plan the installation.
Review general guidelines to prepare your environment for the installation. For more information, see Plan the MediaAgent Installation .
2. Review the preinstallation checklist.
Gather the information that you must provide during the installation. Based on the computer's operating system, review the following topics:
Preinstallation Checklist for the MediaAgent on Windows
Preinstallation Checklist for the MediaAgent on UNIX
3. Install the software.
Install the MediaAgent using either the CommCell Console or the installation package that was created from the Download Manager. For more information, see
Installing the MediaAgent .
If you want to install the MediaAgent on a Docker container, see Installing a MediaAgent Docker Image .
4. Perform postinstallation tasks.
Review the tasks that you must perform after the installation in Postinstallation Tasks for the MediaAgent .

5/6/2017 Commvault Systems Page 80 of 587


Plan the MediaAgent Installation
For a successful installation, some careful planning is required to ensure that Commvault integrates seamlessly with your environment.
Use the following checklist to prepare the computer where the MediaAgent will be installed:
 Verify System Requirements
Make sure that the computer's operating system and hardware are supported by the MediaAgent. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the MediaAgent. For more
information, see License Requirements .
 Verify Requirements for Installation Environments
If you plan to install the MediaAgent on a virtual machine, the virtual machine must be configured with fast-access storage media. Ensure that the CPU and memory
resources recommended in System Requirements are always available for the virtual machine.
If you plan to configure a Docker container with a preinstalled MediaAgent image, follow the installation steps in Installing a MediaAgent Docker Image .
 Determine the Role of Your MediaAgent
The MediaAgent can have different roles. Determine which of the following roles are required in your environment, and review their respective requirements:
Role Requirements
MediaAgent as a Data Mover The MediaAgent computer must meet the requirements specified in System Requirements .
MediaAgent to host the Deduplication database The MediaAgent computer must meet the requirements specified in Deduplication Building Block Guide .
MediaAgent to host the Index Cache The MediaAgent computer must meet the requirements specified in Index Cache - Prerequisites .
MediaAgent for Snap Copy The client computer where you want to perform IntelliSnap backups must meet the MediaAgent requirements
specified in System Requirements .

 Download the Software


Choose one of the following methods to download the software:
If you plan to install from the CommCell Console, no action is required. The Commvault software is automatically downloaded during the installation.
Note: Before you use the CommCell Console to perform installations, you must review some prerequisites. For more information, see Prerequisites for Installations
Using the CommCell Console .
If you plan to use the installation package, make sure that the package includes the MediaAgent software. If missing, create a new installation package and include
the software. For instructions, see Downloading Software for Windows Computers Using the Download Manager .
Note: The installation package that you used to install the CommServe software was Windows-based. If you need to install on UNIX computers, see Downloading
Software for UNIX, Linux, and Macintosh Computers Using the Download Manager .
 Determine the Configurations that Meet Your Requirements
Every environment has different requirements. Consider the following additional configurations and information prior to completing your installation planning:
For Windows Computers
Install Commvault in a New Instance
If Commvault is already installed on the computer, but your environment requires the MediaAgent in a separate instance, you can install the MediaAgent in a new
instance. For more information, see Multi-Instance Installations .
Configure a Floating Host Name
A floating host name is a virtual host name that is useful in those scenarios when the MediaAgent needs to be moved or changed at some point in time. For
example, the floating name minimizes the downtime for failover operations when the MediaAgent undergoes a hardware refresh. For more information, see
Configuring a Floating Host Name for the CommServe or MediaAgent Software .
For UNIX Computers
Install as a SUDO User With Root Privileges
If you want to install as a SUDO user, add the SUDO user to the /etc/sudoers file. For more information, see Adding SUDO Users with Root Privileges on a UNIX Client .
Install as a Non-Root User
If the computer where you want to run the installation does not have a root user defined, you can install agents as a non-root user. Before the installation, review
the considerations described in Installation of UNIX Agents by a Non-Root User .
Install in a Predefined Directory or Mount Point
If you want to install in a predefined directory, review the considerations described in Installation of UNIX Agents in a Predefined Directory .
Install Commvault in a New Instance
If Commvault is already installed on the computer, but your environment requires the MediaAgent in a separate instance, you can install the MediaAgent in a new
instance. For more information, see Multi-Instance Installations .
Change the Branding of the Installation Package
You can change the software name to a different name, such as your organization's name. For more information, see Changing the Branding of a UNIX Installation
Package .
Configure the Kernel Parameter
You can configure or modify the kernel parameters on the MediaAgent. For more information, see Kernel Parameter Configuration .

5/6/2017 Commvault Systems Page 81 of 587


Preinstallation Checklist for the MediaAgent on Windows
The MediaAgent manages the transmission of data between clients and backup media. The backup media is a storage device where you want to store the backed up data.
For more information, see MediaAgent - Overview .
Use this preinstallation checklist to gather all of the information you will need during the installation.
 Determine the Installation Location
Based on your environment, install the MediaAgent on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer that is configured with the backup media.
Clustered On the physical nodes of the cluster that are configured with the backup
media.

 Collect Cluster Environment Details


If you plan to install the MediaAgent on a cluster environment, review the following checklist to prepare for the installation:
Review Network TCP Port Requirements
The physical nodes that host the cluster server must have the same port numbers configured. For example, if you have a cluster server VS1 and three physical
computers configured to host VS1, then the three physical computers must have the same network TCP port numbers configured on the network interface used by
VS1.
Select Physical Nodes to Install the Software
Select the physical nodes (active and passive) on which you want to install the package. In the event of a failure, the active node can fail over to one of the passive
nodes.
Collect Domain Administrator Account Details
If you plan to use the CommCell Console to install the software remotely on the physical nodes, the installation program requires the user name and password of
the Domain Administrator account. The Domain Administrator account must have administrative rights on the active and all passive nodes where you plan to
perform the installation.
 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 MediaAgent using either the CommCell Console or the installation package created by the Download Manager. Any checklist item that applies to only
one of these installation methods is noted.
Commvault package to install
Install the MediaAgent package, which is listed under the Server category.
The VSS Provider package is installed as part of the MediaAgent 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.
Index Directory
Select a directory where Commvault can store the index of your backups.
For best indexing results, the directory should be in a dedicated volume, and the overall path length, including the directory name, must be limited to 75 characters.
For other recommendations, see Recommendations for the Index Directory .

5/6/2017 Commvault Systems Page 82 of 587


Preinstallation Checklist for the MediaAgent on UNIX
The MediaAgent manages the transmission of data between clients and backup media. The backup media is a storage device where you want to store the backed up data.
For more information, see MediaAgent - Overview .
Use this preinstallation checklist to gather all of the information you will need during the installation.
 Determine the Installation Location
Based on your environment, install the MediaAgent on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer that is configured with the backup media.
Clustered On the physical nodes of the cluster that are configured with the backup
media.

 Collect Cluster Environment Details


If you plan to install the MediaAgent on a cluster environment, review the following checklist to prepare for the installation:
Review Network TCP Port Requirements
The physical nodes that host the cluster server must have the same port numbers configured. For example, if you have a cluster server VS1 and three physical
computers configured to host VS1, then the three physical computers must have the same network TCP port numbers configured on the network interface used by
VS1.
Select Physical Nodes to Install the Software
Select the physical nodes (active and passive) on which you want to install the package. In the event of a failure, the active node can fail over to one of the passive
nodes.
Collect Domain Administrator Account Details
If you plan to use the CommCell Console to install the software remotely on the physical nodes, the installation program requires the user name and password of
the Domain Administrator account. The Domain Administrator account must have administrative rights on the active and all passive nodes where you plan to
perform the installation.
 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 MediaAgent using either the CommCell Console or the installation package created by the Download Manager. Any checklist item that applies to only
one of these installation methods is noted.
Commvault package to install
For installations using the CommCell Console, install the MediaAgent package, which is listed under the Server category.
For installations using the installation package, install the MediaAgent 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 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.
Index Directory
Select a directory where Commvault can store the index of your backups.
For best indexing results, the directory should be in a dedicated volume, and the overall path length, including the directory name, must be limited to 75 characters.
For other recommendations, see Recommendations for the Index Directory .

5/6/2017 Commvault Systems Page 83 of 587


Installing the MediaAgent
Install the MediaAgent by using either the CommCell Console or the installation package that was created from the Download Manager application.

Before You Begin


Prepare your environment for the installation as described in Plan the MediaAgent Installation .
Gather the information that you must provide during the installation as described in the preinstallation checklist for the MediaAgent on Windows or UNIX .

Choose the Installation Method


The most commonly used methods to install the MediaAgent are the following:
Remote installations, where you use the CommCell Console to install the software remotely on one or more computers.
For instructions, see Installing Commvault Remotely Using the CommCell Console .
Local installations, where you use the installation package to install the software locally on a computer.
Based on your computer's operating system, see installing Commvault locally on Windows or UNIX .
For other installation methods using the installation package, see Installations Using the Installation Package .

What To Do Next
Review the tasks that you must perform after the installation in Postinstallation Tasks for the MediaAgent .

5/6/2017 Commvault Systems Page 84 of 587


Installing a MediaAgent Docker Image
Commvault provides a Docker image containing the preinstalled UNIX version of the MediaAgent software.
You must install the image on a UNIX-based Docker container.

Before You Begin


Download the MediaAgent image from the Docker repository.
Prepare your environment for the installation as described in Plan the MediaAgent Installation . Review system requirements, license requirements, and MediaAgent
roles.
Assign a directory in your Docker host to be used by the Commvault software. Use the export name $CVDIR to assign the directory.

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 .

5/6/2017 Commvault Systems Page 85 of 587


Postinstallation Tasks for the MediaAgent
The following sections describe the tasks that you must perform to complete the installation and to get started with the MediaAgent.

Perform General Postinstallation Tasks


Based on your environment settings, or the installation options that you set, you might have to perform some general tasks to complete the installation.
The tasks are grouped based on the computer's operating system where you installed 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 .

On UNIX, Linux, and Macintosh


Register the Client after Decoupled Installation
If you installed Commvault in decoupled mode, the client was not registered during the installation. To register the client, use one of the following methods:
Registering the Client Using the CommCell Console
Registering the Client Using the Command Line
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:
Veritas Clusters
Non-Veritas Cluster
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 - Getting Started - Overview .
Change UNIX Groups and Access Permissions on UNIX Clients
If you need to change the UNIX group and access permissions that you defined during the installation, see Changing UNIX Groups and Permissions on UNIX Clients .
Note: You must perform this task when you install a database on an existing client and the packages have different permissions.
Set Read Permissions on AIX Clients
If you installed agents on an AIX computer, and you did not set read permissions for other users during the installation, see Setting Read Permissions on AIX Clients
.
View Files Created During the Installation
For some agents, additional files and folders are created outside the installation directory. If you want to view the files and folders that were created outside the
installation directory, see Files and Folders Created During UNIX Installations .
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 .

Get Started with MediaAgent Features and Configurations


Refer to the following tasks to get started with the MediaAgent:
Configure ACSLS Client Service on Solaris
On a Solaris MediaAgent, the ACSLS Client Service must be configured before configuring the STK library attached to an ACSLS Server. To configure a STK library that is
controlled by an ACSLS server, you can use the Config ACSLS Services package to add the required services.
1. Log on to the MediaAgent computer as root.
2. Start the following program:
5/6/2017 Commvault Systems Page 86 of 587
<software installation path>/Base/config_acsls
The following menu appears if ACSLS services are not configured:

Please select one of the options below:


1) Config ACSLS Services
2) Exit

Your selection: [2]

3. Type 1, and then press Enter.


The following message appears:

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:

ACSLS services are currently CONFIGURED.

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.

5/6/2017 Commvault Systems Page 87 of 587


Client Installations
Complete the following tasks to install agents or other Commvault software on Windows and UNIX computers.
1. Plan the installation.
Review general guidelines to prepare your environment for the installation. Based on the computer's operating system, review the following topics:
Plan the Installation on Windows Computers
Plan the Installation on UNIX, Linux, and Macintosh Computers
2. Review the preinstallation checklist.
For the agent or Commvault software that you want to install, gather the information that you must provide during the installation. For more information, see
Preinstallation Checklist for Clients .
3. Install the software.
Install the software using either the CommCell Console or the installation package that was created from the Download Manager. For more information, see Installing
Commvault on Clients .
4. Perform postinstallation tasks.
Review the tasks that you must perform after the installation in Postinstallation Tasks for Clients .

5/6/2017 Commvault Systems Page 88 of 587


Plan the Installation on Windows Computers
For a successful installation, some careful planning is required to ensure that Commvault integrates seamlessly with your environment.
Use the following checklist to prepare for the installation of agents or other Commvault software on Windows computers:
 Download the Software
Choose one of the following methods to download the software:
If you plan to install from the CommCell Console, no action is required. The Commvault software is automatically downloaded during the installation.
Note: Before you use the CommCell Console to perform installations, you must review some prerequisites. For more information, see Prerequisites for Installations
Using the CommCell Console .
If you plan to use the installation package, make sure that the package includes the required software. If missing, create a new installation package and include the
required software. For instructions, see Downloading Software for Windows Computers Using the Download Manager .
 Collect Cluster Environment Details
If you plan to install a Commvault package on a cluster environment, review the following checklist to prepare for the installation:
Note: To determine whether the package can be installed on a cluster environment, see Cluster Configuration - Support .
Review Network TCP Port Requirements
The physical nodes that host the cluster server must have the same port numbers configured. For example, if you have a cluster server VS1 and three physical
computers configured to host VS1, then the three physical computers must have the same network TCP port numbers configured on the network interface used by
VS1.
Select Physical Nodes to Install the Software
Select the physical nodes (active and passive) on which you want to install the package. In the event of a failure, the active node can fail over to one of the passive
nodes.
Collect Domain Administrator Account Details
If you plan to use the CommCell Console to install the software remotely on the physical nodes, the installation program requires the user name and password of
the Domain Administrator account. The Domain Administrator account must have administrative rights on the active and all passive nodes where you plan to
perform the installation.
 Determine the Configurations that Meet Your Requirements
Every environment has different requirements. Consider the following additional configurations and information prior to completing your installation planning:
Install Restore-Only Agents
If you plan to use the client computer only as a destination for restoring backup data, you can install the agent in restore-only mode. Before the installation, review the
considerations described in Installation of Restore Only Agents .
Install 32-bit Agents on 64-bit Computers
If you need to protect 32-bit application data on Windows 64-bit computers, you can install agents in 32-bit mode. The preferred method for installing 32-bit agents on
64-bit computers is to install the agents by using the CommCell Console.
For more information, see Enabling 32-Bit Installations on 64-Bit Windows Computers .
Install Commvault in a Different Language
This configuration is only applicable if you plan to use the installation package to install the software listed in Language Support .
If you want to install the software in a different language, you can configure the installation program to list the supported language options. For more information, see
Changing the Display Language of the Commvault Software on Windows Computers .
Install Commvault in a New Instance
If Commvault is already installed on the computer, but your environment requires a separate instance of the software, you can install Commvault in a new instance. For
more information, see Multi-Instance Installations .
Install Commvault on Computers Sharing the Same Host Name
If you want to use the same host name and CVD port number on multiple computers during the installation, you can configure the CommServe computer to allow
clients that have the same host name and CVD port.
For more information, see Allowing a Duplicate Hostname and CVD Port During Client Installation .
Change the Branding of the Installation Package
If you want the installation wizard to display your company name and logo, and to adjust other branding settings, see Changing the Branding Settings of a Windows
Installation Package .
Review Database Service Restart Requirement for Database Agents
If you plan to install database agents, the database services might need a restart to complete the agent installation. The installation wizard provides the required
options to restart database services during the installation.
To determine whether your agent requires a database restart, see Database Service Restart Requirements when Deploying Windows Agents .

5/6/2017 Commvault Systems Page 89 of 587


Allowing a Duplicate Hostname and CVD Port During Client Installation
You can install the Commvault software on computers that have the same host name and CVD port by adding the nAllowDuplicateHostName additional setting. The computer
name must be unique.
Important: To use this feature, a two-way firewall must exist between the CommServe computer and the client computer. For information, see Firewall Using Direct
Connections .

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 .

5/6/2017 Commvault Systems Page 90 of 587


Changing the Branding Settings of a Windows Installation Package
You can change the branding settings of the installation package that was created from the Download Manager. This is useful if you want the installation wizard to display
your company name and logo.

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.

5/6/2017 Commvault Systems Page 91 of 587


Changing the Display Language of the Commvault Software on Windows
Computers
By default, when you use the installation package that was created from the Download Manager, the installation program uses the system locale of the computer on which
you run the program.
You can install the Commvault software in a different language by configuring the bShowLanguageDialog registry key. When configured, the installation wizard displays a
language selection page where you can select your preferred language. Only the Commvault software is affected by the language change, and not other programs.

Before You Begin


Review the languages supported by Commvault. For more information, see Language Support .
Ensure that your computer supports the language that you want to use.

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.

5/6/2017 Commvault Systems Page 92 of 587


Language Support
The Commvault software supports a variety of languages.
The following table displays the Commvault components that can be configured in a different language:
Components Supported Languages
1-Touch Recovery (Windows) English (United States)
CommCell Console Chinese (Traditional)
IBM Notes Add-In Chinese (Simplified)
Laptop Monitor Tool (Installed with the Windows File System Agent.) French (Canada)
Outlook Add-In French (France)
Reports (Applicable to reports available from the CommCell Console.) German (Germany)
Search Console (The underlying Content Indexing component supports UTF-8 Italian
character sets.) Japanese
Web Console Russian
Korean
Portuguese (Brazil)
Spanish (Mexico)
Spanish (Spain)

Dutch (Netherlands) is supported only by the following components:


1-Touch Recovery (Windows)
IBM Notes Add-In
Outlook Add-In
Reports
Search Console
Installing Commvault on Non-English Clients
When you install the software on non-English clients, you must provide the following information in English:
CommServe name
Software installation path
Database path
Index cache path
Library mount path
Deduplication path

5/6/2017 Commvault Systems Page 93 of 587


Enabling 32-Bit Installations on 64-Bit Windows Computers
If you have a 64-bit Windows computer and you want to protect 32-bit applications, you can configure the installation program to install 32-bit agents. This is useful if you
need to protect 32-bit versions of the following applications:
Documentum
Microsoft SQL Server
Microsoft Exchange Mailbox
IBM Notes Database

Before You Begin


Determine whether the agent that you want to install supports 32-bit installations. For more information, see 32-Bit Installation Support on 64-bit Windows Computers
.
Review requirements, limitations, and other information associated with enabling 32-bit installations. For more information, see Considerations for Installing 32-Bit
Software on 64-bit Windows Computers .

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 .

5/6/2017 Commvault Systems Page 94 of 587


Considerations for Installing 32-Bit Software on 64-Bit Windows Computers
After you understand the requirements and limitations that are associated with enabling 32-bit installations, you can begin your 32-bit installations. For instructions, see
Enabling 32-Bit Installations on 64-Bit Windows Computers .

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.

Windows File System Agent


The 32-bit version of the agent does not support the following operations:
VSS backups and restores.
System state backups.
Full system restores for RSM, RSS, Terminal Services, and disk quota.

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.

SQL Server Agent


The 32-bit version of the SQL Server Agent does not support VSS backups and restores.

5/6/2017 Commvault Systems Page 95 of 587


32-Bit Installation Support on 64-bit Windows Computers
The following 32-bit agents are supported on Microsoft Windows 64-bit platforms:
For more information on the platforms supported for each agent, see System Requirements .
Install 32-bit On x64 Comments

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

5/6/2017 Commvault Systems Page 96 of 587


Oracle Archiving
Replication
ContinuousDataReplicator
Virtualization
Amazon
Citrix Xen
Docker
FusionCompute
KVM
Microsoft Azure
Microsoft Hyper-V
Nutanix AHV
OpenStack
Oracle VM
oVirt
Red Hat Enterprise
Virtualization
VMware
Laptop
Laptop Backup (Linux)
Laptop Backup (Macintosh)
Laptop Backup (Windows)

5/6/2017 Commvault Systems Page 97 of 587


Installation of Restore Only Agents
During the installation, you can choose to install an agent in restore-only mode if you want to use the client only as a destination to restore backup data. Agents installed in
this mode do not consume any licenses and do not allow backup operations.
If you install the agent using the CommCell Console (remote installation), then on the Enter Additional Install Options page, make sure to select the Install Agents for
Restore Only check box.
If you install the agent using the installation package (local installation), then on the Select Packages page, make sure to select the Restore Only check box along with
the agent that you want to install.
Note that unlicensed agents appear grayed-out in the CommCell Browser. If the client only has agents in restore-only mode, the client will also appear grayed-out as shown
in the following image:

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 .

Considerations for Cluster Environments


In a cluster environment, if there are physical nodes that you do not need to protect, you can install the agent in restore-only mode to avoid the consumption of additional
licenses per node.

Considerations for Database Agents


If you plan to install the following database agents in restore-only mode, make sure to create and configure an instance from the CommCell Console:
Oracle
SAP Oracle
SAP MaxDB
Refer to the respective agent documentation for information on configuring instances.

5/6/2017 Commvault Systems Page 98 of 587


Multi-Instance Installations
By default, the Commvault software is installed on Instance001. You can install additional Commvault packages on a separate instance by enabling the multi-instancing
feature.
You can have multiple Commvault instances running on the same computer. Each instance can operate simultaneously, independent of the other, because every instance
has its own set of software binaries, services, and updates.
The multi-instancing feature is useful in the following environments:
32-Bit and 64-Bit Mixed Environments
You can use the multi-instancing feature to install the 32-bit and 64-bit versions of an agent in separate instances.
Suppose you have a 64-bit Windows computer with a mix of 32-bit and 64-bit applications. By default, a regular Commvault installation installs 64-bit agents to protect
the application data. To protect the 32-bit applications, you must install the 32-bit version of the agent in a different instance.
Different CommCells
You can use the multi-instancing feature to make a computer a client of multiple CommCells. This is useful if you want to load-balance backup operations between two
CommCells.
Suppose you have a CommCell environment with two CommServe computers (A and B), and you want to protect a computer that has a large file system data as well as
Microsoft SQL Server and Exchange Server applications. You can install the SQL Server Agent and Exchange Agent on an instance that points to CommServe A, and
install the Windows File System Agent on a different instance that points to CommServe B. The backup jobs are handled separately by CommServe A and B.
To install multiple instances on a computer, see Enabling Multi-Instance Installations .

5/6/2017 Commvault Systems Page 99 of 587


Considerations for Installing Multi-Instances
After you understand the requirements and limitations that are associated with installing multi-instances, you can begin your installation of multi-instances. For
instructions, see Enabling Multi-Instance Installations .

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.

5/6/2017 Commvault Systems Page 100 of 587


Enabling Multi-Instance Installations
You can install multiple instances of the Commvault software on a computer.
On a Windows computer, you can have a maximum of 20 instances.
On a UNIX computer, you can have a maximum of 999 instances.

Before You Begin


Determine whether the agent that you want to install supports multi-instancing. For more information, see Multi-Instance Support .
Review requirements, limitations, and other information associated with multi-instancing. For more information, see Considerations for Installing Multi-Instances .

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

5/6/2017 Commvault Systems Page 101 of 587


Multi-Instance Support
Use the following table to determine which agents support installations on multiple instances:
Multi-
Instance Comments
Installations

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.

5/6/2017 Commvault Systems Page 103 of 587


Database Service Restart Requirements when Deploying Windows Agents
Use the following table to determine whether you need to restart database services after a database agent installation, upgrade, or service pack installation on Windows
clients:
Database Agent Installation Upgrade Service Pack Installation
DB2 No Yes No
Exchange Database No No No
IBM Notes Database No No No
Informix No No No
Microsoft SQL Server No No No
MySQL No No No
Oracle No No No
Oracle RAC No No No
PostgreSQL No No No
SAP HANA No No No
SAP Oracle No No No
SharePoint Server No No No
Sybase No No No
Oracle Service restart database services oracle services restart DB2 services restart DB2 upgrade DB2 installation Oracle upgrade Oracle Installation

5/6/2017 Commvault Systems Page 104 of 587


Plan the Installation on UNIX, Linux, and Macintosh Computers
For a successful installation, some careful planning is required to ensure that Commvault integrates seamlessly with your environment.
Use the following checklist to prepare for the installation of agents or other Commvault software on UNIX, Linux, and Macintosh computers:
 Download the Software
Choose one of the following methods to download the software:
If you plan to install from the CommCell Console, no action is required. The Commvault software is automatically downloaded during the installation.
Note: Before you use the CommCell Console to perform installations, you must review some prerequisites. For more information, see Prerequisites for Installations
Using the CommCell Console .
If you plan to use the installation package, create an installation package with the required software. For instructions, see Downloading Software for UNIX, Linux, and
Macintosh Computers Using the Download Manager .
 Collect Cluster Environment Details
If you plan to install a Commvault package on a cluster environment, review the following checklist to prepare for the installation:
Note: To determine whether the package can be installed on a cluster environment, see Cluster Configuration - Support .
Review Network TCP Port Requirements
The physical nodes that host the cluster server must have the same port numbers configured. For example, if you have a cluster server VS1 and three physical
computers configured to host VS1, then the three physical computers must have the same network TCP port numbers configured on the network interface used by
VS1.
Select Physical Nodes to Install the Software
Select the physical nodes (active and passive) on which you want to install the package. In the event of a failure, the active node can fail over to one of the passive
nodes.
Collect Domain Administrator Account Details
If you plan to use the CommCell Console to install the software remotely on the physical nodes, the installation program requires the user name and password of
the Domain Administrator account. The Domain Administrator account must have administrative rights on the active and all passive nodes where you plan to
perform the installation.
 Determine the Configurations that Meet Your Requirements
Every environment has different requirements. Consider the following additional configurations and information prior to completing your installation planning:
Install Restore-Only Agents
If you plan to use the client computer only as a destination for restoring backup data, you can install the agent in restore-only mode. Before the installation, review the
considerations described in Installation of Restore Only Agents .
Install 32-Bit or 64-Bit Agents
By default, 64-bit agents are installed on UNIX computers. Note the following:
On FreeBSD and Linux computers, if the installation program detects that the computer has a 32-bit operating system, the program automatically installs 32-bit
agents.
Note: If you have a 64-bit Linux computer and you need to protect 32-bit applications, you can configure the installation program to install 32-bit agents. For more
information, see Enabling 32-Bit Installations on 64-Bit Linux Computers .
AIX and Solaris computers must have a 64-bit operating system. Commvault does not support installations on 32-bit operating systems.
Install as a SUDO User With Root Privileges
If you want to install as a SUDO user, add the SUDO user to the /etc/sudoers file. For more information, see Adding SUDO Users with Root Privileges on a UNIX Client .
Install as a Non-Root User
If the computer where you want to run the installation does not have a root user defined, you can install agents as a non-root user. Before the installation, review the
considerations described in Installation of UNIX Agents by a Non-Root User .
Install in a Predefined Directory or Mount Point
If you want to install in a predefined directory, review the considerations described in Installation of UNIX Agents in a Predefined Directory .
Install Commvault in a New Instance
If Commvault is already installed on the computer, but your environment requires a separate instance of the software, you can install Commvault in a new instance. For
more information, see Multi-Instance Installations .
Install Commvault on Computers Sharing the Same Host Name
If you want to use the same host name and CVD port number on multiple computers during the installation, you can configure the CommServe computer to allow
clients that have the same host name and CVD port.
For more information, see Allowing a Duplicate Hostname and CVD Port During Client Installation .
Change the Branding of the Installation Package
If you want the installation wizard to display your company name and a different software name, and to adjust other branding settings, see Changing the Branding
Settings of a UNIX Installation Package .
Create User Groups on Macintosh Computers
If you are required to create a user group with permissions to install the software, see Creating User Groups to Install or Upgrade Commvault on a Macintosh Computer
.
Review Database Service Restart Requirement for Database Agents
If you plan to install database agents, the database services might need a restart to complete the agent installation. The installation wizard provides the required
options to restart database services during the installation.
To determine whether your agent requires a database service restart, see Database Service Restart Requirements when Deploying UNIX Agents .

5/6/2017 Commvault Systems Page 105 of 587


Adding SUDO Users with Root Privileges on a UNIX Client
You can install the Commvault software as a SUDO user with root privileges. The SUDO user must be added to the /etc/sudoers file.

Before You Begin


For HP-UX, AIX and Solaris computers, install SUDO on the client before adding a SUDO user.
On Solaris computers, edit the /etc/default/login configuration file and set the "PATH=" variable to the directory where SUDO is installed.

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

3. Add the SUDO user.


If you want users to perform all UNIX commands as root users, enter the following:
sudouser ALL=(ALL) ALL

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

## Path to the Commvault Installation directory


Cmnd_Alias INSTALLDIRCMDS = Installation_Directory/*

sudouser ALL = DVDINSTALLCMDS, DVDUNINSTALLCMDS, INSTALLDIRCMDS, /bin/sh, /usr/bin/Commvault

5/6/2017 Commvault Systems Page 106 of 587


Allowing a Duplicate Hostname and CVD Port During Client Installation
You can install the Commvault software on computers that have the same host name and CVD port by adding the nAllowDuplicateHostName additional setting. The computer
name must be unique.
Important: To use this feature, a two-way firewall must exist between the CommServe computer and the client computer. For information, see Firewall Using Direct
Connections .

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 .

5/6/2017 Commvault Systems Page 107 of 587


Changing the Branding Settings of a UNIX Installation Package
You can change the branding settings of the installation package that was created from the Download Manager. This is useful if you want to customize the Commvault
software to display your company information.
Changing the branding settings is available only for the installation of new clients (first-time Commvault installations). This operation is not supported for service pack
installations or installing additional Commvault software to an existing client

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.

5/6/2017 Commvault Systems Page 108 of 587


Creating User Groups to Install or Upgrade Commvault on a Macintosh
Computer
Some Macintosh computers, depending on their environment settings, might require a dedicated user group with permissions to install the Commvault software. You can
create a user group with the required permissions to install the software.

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.

5/6/2017 Commvault Systems Page 109 of 587


Enabling 32-Bit Installations on 64-Bit Linux Computers
By default, 64-bit agents are installed on Linux computers.
If you have a 64-bit Linux computer and you need to protect 32-bit applications, you can configure the installation program to install 32-bit agents.

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 .

5/6/2017 Commvault Systems Page 110 of 587


Installation of UNIX Agents by a Non-Root User
Many newer UNIX systems and their derivatives do not explicitly have a root user defined at the time of installation. The SUDO command is used for root access on such
systems, but the root access obtained this way is limited to the command that is run. To overcome these limitations, create a non-root user with special privileges to install
the Commvault software.
If there is more than one non-root user running installations on the same computer, then the software is installed on different Commvault instances. For example, if an
Oracle and DB2 user performed installations, two separate instances exist with different registry locations running independently of each other.

Prerequisites
The non-root user must have read and write permissions to the /tmp/locks directory.

Supported Installation Methods


You can install as a non-root user by using the installation package that was created from the Download Manager. Installations that use the CommCell Console are not
supported.
The following installation tasks are supported:
Local installations (including installations in decoupled mode)
Custom package creation and installation
Unattended installations (silent installations that use prerecorded XML files)

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

5/6/2017 Commvault Systems Page 112 of 587


Installation of UNIX Agents in a Predefined Directory
If you plan to install the Commvault software in a predefined directory or mount point, all software files are copied to the commvault subdirectory. For example, if your
predefined directory or mount point is /opt/sw, the software files are copied to /opt/sw/commvault. Therefore, ensure that your predefined directory structure does not contain
the commvault subdirectory.
By default, the software binaries are installed in the /opt/commvault directory. During a remote installation, if the installation program detects an existing directory, then the
program performs the following actions:
Treats the directory as an existing Commvault instance.
To avoid overwriting the existing software files, the program creates a new directory (with a number appended) to install a new instance. For example, if you install a
second instance, the new instance is installed in /opt/commvault2.

5/6/2017 Commvault Systems Page 113 of 587


Installation of Restore Only Agents
During the installation, you can choose to install an agent in restore-only mode if you want to use the client only as a destination to restore backup data. Agents installed in
this mode do not consume any licenses and do not allow backup operations.
If you install the agent using the CommCell Console (remote installation), then on the Enter Additional Install Options page, make sure to select the Install Agents for
Restore Only check box.
If you install the agent using the installation package (local installation), then on the Select Packages page, make sure to select the Restore Only check box along with
the agent that you want to install.
Note that unlicensed agents appear grayed-out in the CommCell Browser. If the client only has agents in restore-only mode, the client will also appear grayed-out as shown
in the following image:

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 .

Considerations for Cluster Environments


In a cluster environment, if there are physical nodes that you do not need to protect, you can install the agent in restore-only mode to avoid the consumption of additional
licenses per node.

Considerations for Database Agents


If you plan to install the following database agents in restore-only mode, make sure to create and configure an instance from the CommCell Console:
Oracle
SAP Oracle
SAP MaxDB
Refer to the respective agent documentation for information on configuring instances.

5/6/2017 Commvault Systems Page 114 of 587


Multi-Instance Installations
By default, the Commvault software is installed on Instance001. You can install additional Commvault packages on a separate instance by enabling the multi-instancing
feature.
You can have multiple Commvault instances running on the same computer. Each instance can operate simultaneously, independent of the other, because every instance
has its own set of software binaries, services, and updates.
The multi-instancing feature is useful in the following environments:
32-Bit and 64-Bit Mixed Environments
You can use the multi-instancing feature to install the 32-bit and 64-bit versions of an agent in separate instances.
Suppose you have a 64-bit Windows computer with a mix of 32-bit and 64-bit applications. By default, a regular Commvault installation installs 64-bit agents to protect
the application data. To protect the 32-bit applications, you must install the 32-bit version of the agent in a different instance.
Different CommCells
You can use the multi-instancing feature to make a computer a client of multiple CommCells. This is useful if you want to load-balance backup operations between two
CommCells.
Suppose you have a CommCell environment with two CommServe computers (A and B), and you want to protect a computer that has a large file system data as well as
Microsoft SQL Server and Exchange Server applications. You can install the SQL Server Agent and Exchange Agent on an instance that points to CommServe A, and
install the Windows File System Agent on a different instance that points to CommServe B. The backup jobs are handled separately by CommServe A and B.
To install multiple instances on a computer, see Enabling Multi-Instance Installations .

5/6/2017 Commvault Systems Page 115 of 587


Considerations for Installing Multi-Instances
After you understand the requirements and limitations that are associated with installing multi-instances, you can begin your installation of multi-instances. For
instructions, see Enabling Multi-Instance Installations .

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.

5/6/2017 Commvault Systems Page 116 of 587


Enabling Multi-Instance Installations
You can install multiple instances of the Commvault software on a computer.
On a Windows computer, you can have a maximum of 20 instances.
On a UNIX computer, you can have a maximum of 999 instances.

Before You Begin


Determine whether the agent that you want to install supports multi-instancing. For more information, see Multi-Instance Support .
Review requirements, limitations, and other information associated with multi-instancing. For more information, see Considerations for Installing Multi-Instances .

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

5/6/2017 Commvault Systems Page 117 of 587


Multi-Instance Support
Use the following table to determine which agents support installations on multiple instances:
Multi-
Instance Comments
Installations

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.

5/6/2017 Commvault Systems Page 119 of 587


Database Service Restart Requirements when Deploying UNIX Agents
Use the following table to determine whether you need to restart database services after a database agent installation, upgrade, or service pack installation on UNIX clients:
Database Agent Installation Upgrade Service Pack Installation
DB2 No Yes No
DB2 MultiNode No Yes No
Informix No No No
Microsoft SQL Server No No No
MySQL No No No
Oracle No No No
Oracle RAC No No No
PostgreSQL No No No
SAP HANA No No No
SAP Oracle No No No
Sybase No No No
Oracle Service restart database services oracle services restart DB2 services restart DB2 upgrade DB2 installation Oracle upgrade Oracle Installation

5/6/2017 Commvault Systems Page 120 of 587


Preinstallation Checklist for Clients
To collect the information required during the installation, review the preinstallation checklist page for each agent, search package, or tool that you plan to install.
Use the following sections to select the preinstallation checklist page based on your computer's operating system:

Commvault Packages Available for Windows


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

Commvault Packages Available for UNIX, Linux, and Macintosh*


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.

5/6/2017 Commvault Systems Page 121 of 587


Preinstallation Checklist for the Active Directory Agent
The Active Directory Agent backs up and restores individual Active Directory attributes. You can also configure the agent to back up the Domain Controller and computers
in the same domain. For more information, see Overview - Active Directory Agent .
Use this preinstallation checklist to prepare the computer where the Active Directory 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 Active Directory Agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Active Directory Agent. For more
information, see License Requirements - Active Directory Agent .
 Determine the Installation Location
Based on your environment, install the Active Directory Agent on an 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.

 Review User Permissions


Review the user permission that you must have on the computer where you want to install the Active Directory Agent:

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.

5/6/2017 Commvault Systems Page 122 of 587


Preinstallation Checklist for ContinuousDataReplicator on Windows
ContinuousDataReplicator (CDR) replicates data from a source computer to a destination computer. For more information, see Overview - ContinuousDataReplicator .
Use this preinstallation checklist to prepare the computer where the ContinuousDataReplicator 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 ContinuousDataReplicator satisfies the minimum requirements. For more information, see System Requirements -
ContinuousDataReplicator .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the ContinuousDataReplicator. For
more information, see License Requirements - ContinuousDataReplicator .
 Determine the Installation Location
Based on your environment, install the ContinuousDataReplicator on an appropriate computer.
Environment Where to install the software
Non-Clustered On two Windows computers that you want to back up. The source computer from which you will replicate data and destination
computer to which you will replicate the data.
Clustered On all physical nodes of the cluster.

 Additional Packages Installed with the ContinuousDataReplicator


The following packages are automatically selected during the ContinuousDataReplicator installation:
Driver for Continuous Data Replicator
File System
File System Core
VSS Provider
 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 ContinuousDataReplicator 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 Continuous Data Replicator package, which is listed under the Microsoft Windows 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.
CDR driver information
This information is only applicable to installations using the CommCell Console.
By default, the log file is created in the C:\Program Files\CommVault\ContentStore\Replication Logs directory. You can change the destination directory. For more information,
see Location of Replication Logs .
Replication logs path location
This information is only applicable to installations using the installation package.
Determine the location for the replication logs.

5/6/2017 Commvault Systems Page 123 of 587


Preinstallation Checklist for ContinuousDataReplicator on UNIX
ContinuousDataReplicator (CDR) replicates data from a source computer to a destination computer. For more information, see Overview - ContinuousDataReplicator .
Use this preinstallation checklist to prepare the computer where the ContinuousDataReplicator 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 ContinuousDataReplicator satisfies the minimum requirements. For more information, see System Requirements -
ContinuousDataReplicator .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the ContinuousDataReplicator. For
more information, see License Requirements - ContinuousDataReplicator .
 Determine the Installation Location
Based on your environment, install the ContinuousDataReplicator on an appropriate computer.
Environment Where to install the software
Non-Clustered On two UNIX computers that you want to back up. The source computer from which you will replicate data and destination computer
to which you will replicate the data.
Clustered On all physical nodes of the cluster.

 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 ContinuousDataReplicator 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 Continuous Data Replicator package, which is listed under the Replication category.
For installations using the installation package, install the Continuous Data Replicator 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 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.
CDR driver information
This information is only applicable to installations using the CommCell Console.
By default, the log file is created in the opt/commvault directory. You can change the destination directory. For more information, see Location of Replication Logs .
CDR source or destination
This information is only applicable to installations using the installation package.
Determine if the computer will be used by CDR as a source machine, or destination machine, or both.
CDR cache directory location and size
This information is only applicable to installations using the installation package.
Determine the location for the CDR cache and cache size.

5/6/2017 Commvault Systems Page 124 of 587


Preinstallation Checklist for the DB2 Agent on Windows
The DB2 Agent backs up and restores DB2 databases in your enterprise. You can also configure the agent to incorporate archiving and snap management solutions. For
more information, see the DB2 Backup Administrator Guide .
Use this preinstallation checklist to prepare the computer where the DB2 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 agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the DB2 Agent. For more information,
see License Requirements .
 Determine the Installation Location
Based on your environment, install the Oracle Agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the DB2 server resides.
Clustered On the physical nodes of the cluster where the DB2 server resides.
Cluster installations are not supported on FreeBSD and Macintosh
computers.

 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 DB2 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 DB2 package, which is listed under the Database category.
Note: If the File System Agent is not installed on the computer, the File System Core package is 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 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.

Restart the DB2 services


Oracle services must be restarted after the installation.
For installations using the CommCell Console, select the Restart Oracle/DB2 Service (if applicable. Oracle DB2 instance needs to be restarted to load
Simpana media library for Data Protection) option.
For installations using the installation package, select the Process Manager option.
Destination folder for the DB2 Archive Path
Determine the location where the DB2 archive logs are stored. When you determine the DB2 Archive path size, consider the on-demand log backup threshold.
Note: If you install the software in a clustered environment, the DB2 Archive path must reside on a shared drive.
The DB2 Archive path cannot reside on a temporary location.
If the specified folder does not exist, the Commvault software creates the folder when the first archive log backup job runs.
Destination folder for the DB2 Retrieve Path
Determine the location where the files required for the DB2 recovery process are stored. When you select the "Restore Logs" option on the CommCell Console
restore, logs archived after the full restore are restored to the DB2 Retrieve path and then the rollforward starts.
Note: If you install the software in a clustered environment, the DB2 Restore Log path must reside on a shared drive.
The DB2 Retrieve path cannot reside on a temporary location.
If the specified folder does not exist, the Commvault software creates the folder when the first archive log backup job runs.
Destination folder for the DB2 Audit Error Path
Determine the location where the DB2 audit error logs are stored.
Note: If you install the software in a clustered environment, the DB2 Audit Error path must reside on a shared drive.
The DB2 Audit Error path cannot reside on a temporary location.
If the specified folder does not exist, the Commvault software creates the folder when the first archive log backup job runs.

5/6/2017 Commvault Systems Page 125 of 587


Preinstallation Checklist for the DB2 Agent on UNIX
The DB2 Agent backs up and restores DB2 databases in your enterprise. You can also configure the agent to incorporate archiving and snap management solutions. For
more information, see the DB2 Backup Administrator Guide .
Use this preinstallation checklist to prepare the computer where the DB2 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 agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the DB2 Agent. For more information,
see License Requirements .
 Determine the Installation Location
Based on your environment, install the Oracle Agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the DB2 server resides.
Clustered On the physical nodes of the cluster where the DB2 server resides.

 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 Oracle 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
For installations using the CommCell Console, install the DB2 package, which is listed under the Database category.
For installations using the installation package, install the DB2 package.
Note: If the File System Agent is not installed on the computer, the software automatically installs the File System Core package with the package that you select.
The File System Agent will not consume any license. If you want to use any of the file system advanced features (for example, optimized scan or 1-touch operations)
to protect the file system data, select the File System package.
For more information on the package options and 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 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.
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.

Destination directory for the DB2 Archive Path


Determine the location where the DB2 archive logs are stored. When you determine the DB2 Archive path size, consider the on-demand log backup threshold.
Note: If you install the software in a clustered environment, the DB2 Archive path must reside on a shared drive.
The DB2 Archive path cannot reside on a temporary location.
Destination directory for the DB2 Retrieve Path
Determine the location where the files required for the DB2 recovery process are stored. When you select the "Restore Logs" option on the CommCell Console
restore, logs archived after the full restore are restored to the DB2 Retrieve path and then the rollforward starts.
Note: If you install the software in a clustered environment, the DB2 Restore Log path must reside on a shared drive.
The DB2 Retrieve path cannot reside on a temporary location.
Destination directory for the DB2 Audit Error Path
Determine the location where the DB2 audit error logs are stored.
Note: If you install the software in a clustered environment, the DB2 Audit Error path must reside on a shared drive.
The DB2 Audit Error path cannot reside on a temporary location.

5/6/2017 Commvault Systems Page 126 of 587


Preinstallation Checklist for the Documentum Agent on Windows
The Documentum Agent backs up and restores EMC Documentum® Repository data, such as databases, storage areas and full-text indexes in your enterprise.
Documentum Repository with Oracle, DB2 and SQL databases are supported. The database components that are backed up include data files and logs, which hold the
Repository's meta data. For more information, see Overview - Documentum Agent .
Use this preinstallation checklist to prepare the computer where the Documentum 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 Documentum Agent satisfies the minimum requirements. For more information, see System Requirements -
Documentum Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Documentum Agent. For more
information, see License Requirements - Documentum Agent .
 Determine the Installation Location
Based on your environment, install the Documentum Agent on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the Documentum Repository resides with the Oracle or the DB2 databases.
Clustered On the physical nodes of the cluster where the Documentum Repository resides with the Oracle or the DB2
databases.

 Review Installation Scenarios


Verify that the Documentum Content Server and the database application (Oracle, or DB2, or SQL) are installed on the same computer or on separate computers.
If 32-bit Documentum Content Server and 32-bit database application are installed on the same computer, the setup is known as Single Server Setup . Similarly, a
64-bit Documentum Content Server and 64-bit database application installed on the same computer is also known as Single Server Setup.
If 32-bit Documentum Content Server and 32-bit or 64-bit database application are installed on different computers, the setup is known as Distributed Server Setup
.

You must restart the Oracle database application after installing the Documentum Agent on Oracle database.

 Prepare 64-bit Computers for 32-bit Agent Installations


You can install a 32-bit Documentum Content Server and a 32-bit database application, like Oracle, DB2, or SQL, on a 64-bit Windows operating system. For more
information, see Enabling 32-Bit Installations on 64-Bit Windows Computers .
 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 Documentum 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 Documentum package, which is listed under the Database 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.

5/6/2017 Commvault Systems Page 127 of 587


Preinstallation Checklist for the Documentum Agent on UNIX
The Documentum Agent backs up and restores EMC Documentum® Repository data, such as databases, storage areas and full-text indexes in your enterprise.
Documentum Repository with Oracle and DB2 databases are supported. The database components that are backed up include data files and logs, which hold the
Repository's meta data. For more information, see Overview - Documentum Agent .
Use this preinstallation checklist to prepare the computer where the Documentum 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 Documentum Agent satisfies the minimum requirements. For more information, see System Requirements -
Documentum Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Documentum Agent. For more
information, see License Requirements - Documentum Agent .
 Determine the Installation Location
Based on your environment, install the Documentum Agent on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the Documentum Repository resides with the Oracle or the DB2 databases.
Clustered On the physical nodes of the cluster where the Documentum Repository resides with the Oracle or the DB2
databases.

 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 Documentum 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
For installations using the CommCell Console, install the Documentum package, which is listed under the File System category.
For installations using the installation package, install the Documentum 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 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.

5/6/2017 Commvault Systems Page 128 of 587


Preinstallation Checklist for the IBM Domino Mailbox Archiver on Windows
Use the Domino Mailbox Archiver to move old and infrequently used mailbox items to secondary storage. This frees up primary disk space, and end-user mailboxes
become easier to manage. Added options of Client Add-In integration and compliance archiving help ensure all archived Domino data is easily traceable and retrievable
whenever the need arises.
Use this preinstallation checklist to prepare the computer where the Domino Mailbox Archiver 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 Domino Mailbox Archiver satisfies the minimum requirements. For more information, see System Requirements -
Domino Mailbox Archiver Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Domino Mailbox Archiver. For
more information, see License Requirements - Domino Mailbox Archiver .
 Determine the Installation Location
Install the Domino Mailbox Archiver on an IBM Domino that you want to back up. The Domino Mailbox Archiver cannot be installed on cluster environments.
 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 Domino Mailbox Archiver 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 Domino Mailbox Archiver package, which is listed under the Applications 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.
Domino server details
This information is only applicable to installations using the CommCell Console.
Collect the following Domino server details:
Name of the Domino instance
Path to the directory where the instance resides
Path to the directory where the Domino software resides
Partitions for Domino Mailbox Archiver
This information is only applicable to installations using the installation package.
Select the partitions that you want to protect. After the installation, the partitions will use the storage policy that you assigned during installation.

5/6/2017 Commvault Systems Page 129 of 587


Preinstallation Checklist for the IBM Domino Mailbox Archiver on UNIX
Use the Domino Mailbox Archiver to move old and infrequently used mailbox items to secondary storage. This frees up primary disk space, and end-user mailboxes
become easier to manage. Added options of Client Add-In integration and compliance archiving help ensure all archived Domino data is easily traceable and retrievable
whenever the need arises.
Use this preinstallation checklist to prepare the computer where the Domino Mailbox Archiver 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 Domino Mailbox Archiver satisfies the minimum requirements. For more information, see System Requirements -
Domino Mailbox Archiver Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Domino Mailbox Archiver. For
more information, see License Requirements - Domino Mailbox Archiver .
 Determine the Installation Location
Install the Domino Mailbox Archiver on an IBM Domino that you want to back up. The Domino Mailbox Archiver cannot be installed on cluster environments.
 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 Domino Mailbox Archiver 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 Domino Mailbox Archiver package, which is listed under the Applications category.
For installations using the installation package, install the Domino Mailbox Archiver 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 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.
Domino server details
This information is only applicable to installations using the CommCell Console.
Collect the name of the Domino server.
Domino home directory
This information is only applicable to installations using the installation package.
Retrieve the path of the Domino home directory.
Domino partition details
This information is only applicable to installations using the installation package.
Collect the following partition details:
Name of the Domino partition
Name of the Domino data directory

5/6/2017 Commvault Systems Page 130 of 587


Preinstallation Checklist for the Driver for File Archiver
The Driver for File Archiver recalls the files archived by OnePass for Windows. For more information, see Overview - OnePass for Windows .
Use this preinstallation checklist to prepare the computer where the Driver for File Archiver 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 Driver for File Archiver satisfies the minimum requirements. For more information, see System Requirements -
OnePass for Windows .
 Verify License Requirements
The Driver for File Archiver does not require a license.
 Determine the Installation Location
Install the Driver for File Archiver on the computer on which you plan to recall the stubs created by OnePass. If you are installing the Driver for File Archiver in a cluster
environment, then install the package on the physical node.
 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 Driver for File Archiver using either the CommCell Console or the installation package created by the Download Manager.
Commvault package to install
Install the Driver for File Archiver package, which is listed under the Microsoft Windows category.
Regardless of the installation method, the File System Core package is automatically included in the installation.
Refer to Preinstallation Checklist - File System Agent (Windows) to gather the information required during the installation of the File System Agent. The
following items are not required during installation.
CVD port for CommCell communication
Firewall services
Windows Firewall for Computer Profiles
Windows Firewall Exclusion List

5/6/2017 Commvault Systems Page 131 of 587


Preinstallation Checklist for the Exchange Compliance Archiver Agent
The Exchange Compliance Archiver Agent works along with the message journaling feature of the Exchange server to archive all incoming and outgoing messages and
attachments. For more information, see Overview - Exchange Archiver Agents .
Use this preinstallation checklist to prepare the computer where the Exchange Compliance Archiver 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 Exchange Compliance Archiver Agent satisfies the minimum requirements. For more information, see System
Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Exchange Compliance Archiver
Agent. For more information, see License Requirements .
 Determine the Installation Location
Based on your environment, install the Exchange Compliance Archiver Agent on an appropriate computer.

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.

 Preconfigure the Exchange Server


Perform the required tasks on the Exchange server. For more information, see the prerequisites for Exchange Compliance Archiver Agent .
 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 Exchange Compliance Archiver 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
For installations using the CommCell Console, install the Exchange Compliance Archiver package, which is listed under the Applications 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.
Mailbox and profile information
Collect the following details to create a new Exchange profile:
Domain user account created with Exchange administrative permissions (this is the Exchange Administrator account).
The domain name should not be included with the account name during installation.1
Name of the domain where the Exchange server resides.1
Name of the mailbox that is associated with the Exchange Administrator account.
Name of the Exchange server. This is the Mailbox Role Server name (NetBIOS).
Any passwords that are associated with any accounts.
A profile is created during the installation and associated with the mailbox. Decide on a name for the profile.
1 Not applicable to installations from the CommCell Console

5/6/2017 Commvault Systems Page 132 of 587


Preinstallation Checklist for the Exchange Database Agent
The Exchange Database Agent backs up and restores Exchange databases in your enterprise. You can also configure the agent to incorporate snap management solutions.
For more information, see Overview - Exchange Database Agent .
Use this preinstallation checklist to prepare the computer where the Exchange Database 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 Exchange Database Agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Exchange Database Agent. For
more information, see License Requirements .
 Determine the Installation Location
Based on your environment, install the Exchange Database Agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On the computer where the Exchange server is installed.
Clustered On the physical nodes of the cluster where the Exchange server is
installed.

 Verify Client Computer Details for DAG Environments


In a DAG environment, the computer where you install the Exchange Database Agent must have a fully qualified domain name. In addition, you must have a
Windows administrative account that has access to all of the computers.
If you install the Exchange Database Agent on a computer that already has the Windows File System Agent installed on it, then you have already provided the
appropriate client details.
You must install the Exchange Database Agent on all of the participating clients.
 Verify Exchange User Account
The Exchange Administrator account to be used for installation must be a member of the appropriate groups:
If you install to a clustered environment:
Backup Operator
Local Administrator group
Exchange Trusted Subsystem if you are using a cluster continuous replication (CCR) environment (Exchange 2007)
If you install to a non-clustered (stand-alone) environment:
Backup Operator
Local Administrator group
 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 Exchange Database 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 Exchange Database package, which is listed under the Applications 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.
Exchange Server details
Collect the following Exchange server details:
Server name
Version (for example, Exchange 2010)
Exchange administrator account details
Collect the following details of the Exchange Administrator account:
Domain user account created with Exchange administrative permissions (this is the Exchange administrator account.)
Name of the domain where the Exchange server resides.

5/6/2017 Commvault Systems Page 133 of 587


Preinstallation Checklist for the Exchange Offline Mining Tool
Note: Live Browse replaces the Exchange Offline Mining Tool. For more information, see Recovering Messages from an Offline Exchange Database .
The Exchange Offline Mining Tool is a stand-alone console used to locate email messages from an offline copy of the Exchange database.
Use this preinstallation checklist to prepare the computer where the Exchange Offline Mining Tool will be installed and to gather all of the information you will need during
the installation.
 Verify System Requirements
There are no minimum system requirements for the Exchange Offline Mining Tool.
 Verify License Requirements
The Exchange Offline Mining Tool does not require a license.
 Determine the Installation Location
Install the Exchange Offline Mining Tool on the Windows Server client that has Microsoft Outlook 2010 or later installed.
 Supported Exchange Server Versions
Microsoft Exchange Server 2007 or later.
 Preconfigure the Exchange Server
For installing the Exchange Offline Mining Tool on Exchange 2013 or later:
Install Visual C++ Redistributable for Visual Studio 2012. For instructions, see Visual C++ Redistributable for Visual Studio 2012 .
If you installed Exchange Server 2013 SP1 (minimum) or later, download the appropriate Microsoft Security Advisory Package as described in the Microsoft Support
article "Microsoft Security Advisory: Insecure library loading could allow remote code execution": http://support.microsoft.com/kb/2533623 . Install the package on
the same client where the Exchange Offline Mining Tool is installed.
 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 Exchange Offline Mining Tool 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 Exchange Offline Mining Tool package, which is listed under the Applications category.
If the File System Agent is not installed on the computer, the File System Core package is 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.

5/6/2017 Commvault Systems Page 134 of 587


Preinstallation Checklist for the Exchange Public Folder Agent
The Exchange Public Folder Agent backs up public folders for quick retrieval of shared data between Exchange users, such as group documents, messages, attachments,
and calendars. For more information, see Overview - Microsoft Exchange Server Agents .
Use this preinstallation checklist to prepare the computer where the Exchange Public Folder 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 Exchange Public Folder Agent satisfies the minimum requirements. For more information, see System Requirements
.
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Exchange Public Folder Agent. For
more information, see License Requirements .
 Determine the Installation Location
Based on your environment, install the Exchange Public Folder Agent on an appropriate computer.

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.

 Preconfigure the Exchange Server


Perform the required tasks on the Exchange server. For more information, see the Prerequisites for Exchange Public Folder Agent .
 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 Exchange Public Folder 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 Exchange Public Folder package, which is listed under the Applications 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.
Mailbox and Profile information
Collect the following details to create a new Exchange profile:
Domain user account created with Exchange administrative permissions (this is the Exchange Administrator account).
The domain name should not be included with the account name during installation.1
Name of the domain where the Exchange server resides.1
Name of the mailbox that is associated with the Exchange Administrator account.
Name of the Exchange server. This is the Mailbox Role Server name (NetBIOS).
Any passwords that are associated with any accounts.
A profile is created during the installation and associated with the mailbox. Decide on a name for the profile.
1 Not applicable to installations from the CommCell Console

5/6/2017 Commvault Systems Page 135 of 587


Preinstallation Checklist for the Exchange Public Folder Archiver Agent
The Exchange Public Folder Archiver Agent moves messages meeting specific criteria to secondary storage. Archived messages can be replaced with special header icons
called stubs, which contain information for recovery. For more information, see Overview - Exchange Archiver Agents .
Use this preinstallation checklist to prepare the computer where the Exchange Public Folder Archiver 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 plan to install the Exchange Public Folder Archiver Agent satisfies the minimum requirements. For more information, see System
Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Exchange Public Folder Archiver
Agent. For more information, see License Requirements .
 Determine the Installation Location
Based on your environment, install the Exchange Public Folder Archiver Agent on an appropriate computer.

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.

 Preconfigure the Exchange Server


Perform the required tasks on the Exchange server. For more information, see the Prerequisites for Exchange Public Folder Archiver Agent .
 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 Exchange Public Folder Archiver 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 Exchange Public Folder Archiver package, which is listed under the Applications 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.
Mailbox and profile information
Collect the following details to create a new Exchange profile:
Domain user account created with Exchange administrative permissions (this is the Exchange Administrator account).
The domain name should not be included with the account name during installation.1
Name of the domain where the Exchange server resides.1
Name of the mailbox that is associated with the Exchange Administrator account.
Name of the Exchange server. This is the Mailbox Role Server name (NetBIOS).
Any passwords that are associated with any accounts.
A profile is created during the installation and associated with the mailbox. Decide on a name for the profile.
1 Not applicable to installations from the CommCell Console

5/6/2017 Commvault Systems Page 136 of 587


Preinstallation Checklist for the File Share Archiver Client
The File Share Archiver Client recalls archived files that reside on the Hitachi HNAS (BlueArc) and Isilon file server. For more information, see Overview - OnePass for Hitachi
HNAS (BlueArc) and Isilon .
Use this preinstallation checklist to prepare the computer where the File Share Archiver Client 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 Share Archiver Client satisfies the minimum requirements. For more information, see System Requirements -
OnePass for Hitachi HNAS (BlueArc) and Isilon .
 Verify License Requirements
The File Share Archiver Client does not require a license.
 Determine the Installation Location
Based on your environment, install the File Share Archiver Client on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer from where you want to recall the stubs. You can also install the File Share Archiver Client on the File System Agent
client computer.
Clustered On all physical nodes of the cluster.

 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 File Share Archiver Client 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 File Share Archiver Client package, which is listed under the Microsoft Windows category.

If you are installing the File Share Archiver Client using the CommCell Console, the File System Core package is installed automatically.

Destination folder for the software installation


By default, the software is installed in C:\Program Files\CommVault\ContentStore.
You can change the destination folder, but it cannot be on a mapped network drive.
The installation program uses the C:\%allusersprofile% folder as a temporary location to copy the installation files. This location does not change, even if you choose to
install the software on a drive other than C:.
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.

5/6/2017 Commvault Systems Page 137 of 587


Preinstallation Checklist for the Windows File System Agent
The File System Agent protects and restores the file system data on Windows computers. You can also configure the agent to incorporate archiving and snap management
solutions. For more information, see Overview - Windows File System Agent .
The File System Agent is the combination of the following packages:
Package Description
File System Core Base package which establishes connections between the client computer and the CommServe
database.
Provides the ability to perform laptop backups and restores.
File System Provides advanced features to protect the file system data, which include:
All backup and restore capabilities, such as IntelliSnap backups.
Ability to generate Discovery and File Level Analytics reports.
Ability to perform 1-Touch and OnePass operations.

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.

 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 File System 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 File System package, which is listed under the Microsoft Windows category.

Regardless of the installation method, the File System Core package is automatically included in the installation.

Destination folder for the software installation


By default, the software is installed in C:\Program Files\CommVault\ContentStore.
You can change the destination folder, but it cannot be on a mapped network drive.
The installation program uses the C:\%allusersprofile% folder as a temporary location to copy the installation files. This location does not change, even if you choose to
install the software on a drive other than C:.
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.
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.

5/6/2017 Commvault Systems Page 138 of 587


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

5/6/2017 Commvault Systems Page 139 of 587


Preinstallation Checklist for the UNIX, Linux, and Macintosh File System Agent
The File System Agent protects and restores the file system data on UNIX, Linux, and Macintosh computers. You can also configure the agent to incorporate archiving and
snap management solutions. For more information, see Overview - UNIX/Linux File Systems and Macintosh File System - Overview .
The File System Agent is the combination of the following packages:
Package Description
File System Core Base package which establishes connections between the client computer and the CommServe
database.
Provides the recursive scan functionality as well as the ability to perform laptop backups and restores.
File System Provides advanced features to protect the file system data, which include:
All backup and restore capabilities, such as optimized scans and IntelliSnap backups.
Ability to generate Discovery and File Level Analytics reports.
Ability to perform 1-Touch and OnePass operations.

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.

 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 File System 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
For installations using the CommCell Console, install the File System package, which is listed under the File System category.
For installations using the installation package, install the File System package.

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.

5/6/2017 Commvault Systems Page 142 of 587


Preinstallation Checklist for the Informix Agent on Windows
The Informix Agent provides a unique, simplified, and end-to-end backup and recovery solution for the Informix systems and user databases in your enterprise. The
Informix Agent offers a complete protection of your system databases and provides a granular backup and recovery of your data, emergency boot files (ixbar), ONCONFIG
files, and logical log files. For more information, see Overview - Informix Agent .
Use this preinstallation checklist to prepare the computer where the Informix 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 Informix Agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Informix Agent. For more
information, see License Requirements .
 Determine the Installation Location
Install the Informix Agent on the Windows computer that you want to back up. The Informix Agent cannot be installed on cluster environments.
 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 Informix Agent using either the CommCell Console or the installation package created by the Download Manager. Any checklist item that applies to
only one of these installation methods is noted.
Commvault package to install
Install the Informix package, which is listed under the Database 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.

5/6/2017 Commvault Systems Page 143 of 587


Preinstallation Checklist for the Informix Agent on UNIX
The Informix Agent provides a unique, simplified, and end-to-end backup and recovery solution for the Informix systems and user databases in your enterprise. The
Informix Agent offers a complete protection of your system databases and provides a granular backup and recovery of your data, emergency boot files (ixbar), ONCONFIG
files, and logical log files. For more information, see Overview - Informix Agent .
Use this preinstallation checklist to prepare the computer where the Informix 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 Informix Agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Informix Agent. For more
information, see License Requirements .
 Determine the Installation Location
Install the Informix Agent on the computer that you want to back up. The Informix Agent cannot be installed on cluster environments.
 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 Informix Agent using either the CommCell Console or the installation package created by the Download Manager. Any checklist item that applies to
only one of these installation methods is noted.
Commvault package to install
For installations using the CommCell Console, install the Informix package, which is listed under the Database category.
For installations using the installation package, install the Informix package.
Note: If the File System Agent is not installed on the computer, the software automatically installs the File System Core package with the package that you select.
The File System Agent will not consume any license. If you want to use any of the file system advanced features (for example, optimized scan or 1-touch operations)
to protect the file system data, select the File System package.
For more information on the package options and 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 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.
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.

5/6/2017 Commvault Systems Page 144 of 587


Preinstallation Checklist for the MySQL Agent on Windows
The MySQL Agent backs up and restores MySQL system databases, user databases and transaction logs in your enterprise. The MySQL Agent also performs both full system
rebuilds and granular backup and recovery of your data. For more information, see Overview - MySQL Agent .
Use this preinstallation checklist to prepare the computer where the MySQL 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 MySQL Agent satisfies the minimum requirements. For more information, see System Requirements - MySQL Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the MySQL Agent. For more
information, see License Requirements - MySQL Agent.
 Determine the Installation Location
Based on your environment, install the MySQL Agent on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the MySQL Server resides.
Clustered On the physical nodes of the cluster where the MySQL Server
resides.

 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 MySQL 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 MySQL package, which is listed under the Database 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.

5/6/2017 Commvault Systems Page 145 of 587


Preinstallation Checklist for the MySQL Agent on UNIX
The MySQL Agent backs up and restores MySQL system databases, user databases and transaction logs in your enterprise. The MySQL Agent also performs both full system
rebuilds and granular backup and recovery of your data. For more information, see Overview - MySQL Agent .
Use this preinstallation checklist to prepare the computer where the MySQL 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 MySQL Agent satisfies the minimum requirements. For more information, see System Requirements - MySQL Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the MySQL Agent. For more
information, see License Requirements - MySQL Agent .
 Determine the Installation Location
Based on your environment, install the MySQL Agent on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the MySQL Server resides.
Clustered On the physical nodes of the cluster where the MySQL Server
resides.

 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 MySQL 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
For installations using the CommCell Console, install the MySQL package, which is listed under the Database category.
For installations using the installation package, install the MySQL package.
Note: If the File System Agent is not installed on the computer, the software automatically installs the File System Core package with the package that you select.
The File System Agent will not consume any license. If you want to use any of the file system advanced features (for example, optimized scan or 1-touch operations)
to protect the file system data, select the File System package.
For more information on the package options and 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 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.

5/6/2017 Commvault Systems Page 146 of 587


Preinstallation Checklist for the IBM Notes Database Agent on Windows
Use the IBM Notes Database Agent as a disaster recovery tool. You can use this agent if your primary goal is full database recovery in case of a database or system crash
rather than small day-to-day restore jobs. You can restore all the versions of a database if a restore of the database in a specific state is needed. For more information, see
Overview - IBM Domino Agents .
Use this preinstallation checklist to prepare the computer where the Notes Database 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 Notes Database Agent satisfies the minimum requirements. For more information, see System Requirements - Notes
Database Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Notes Database Agent. For more
information, see License Requirements - Notes Database Agent .
 Determine the Installation Location
Install the Notes Database Agent on an IBM Domino that you want to back up. The Notes Database Agent cannot be installed on cluster environments.
 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 Notes Database 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 Domino Database package, which is listed under the Applications 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.
Domino server details
This information is only applicable to installations using the CommCell Console.
Collect the following Domino server details:
Name of the Domino instance
Path to the directory where the instance resides
Path to the directory where the Domino software resides
Partitions for Notes Database
This information is only applicable to installations using the installation package.
Select the partitions that you want to protect. After the installation, the partitions will use the storage policy that you assigned during installation.

5/6/2017 Commvault Systems Page 147 of 587


Preinstallation Checklist for the IBM Notes Database Agent on UNIX
Use the IBM Notes Database Agent as a disaster recovery tool. You can use this agent if your primary goal is full database recovery in case of a database or system crash
rather than small day-to-day restore jobs. You can restore all the versions of a database if a restore of the database in a specific state is needed. For more information, see
Overview - IBM Domino Agents .
Use this preinstallation checklist to prepare the computer where the Notes Database 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 Notes Database Agent satisfies the minimum requirements. For more information, see System Requirements - Notes
Database Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Notes Database Agent. For more
information, see License Requirements - Notes Database Agent .
 Determine the Installation Location
Install the Notes Database Agent on an IBM Domino that you want to back up. The Notes Database Agent cannot be installed on cluster environments.
 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 Notes Database 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
For installations using the CommCell Console, install the Domino Database package, which is listed under the Applications category.
For installations using the installation package, install the Domino Database 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 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.
Domino server details
This information is only applicable to installations using the CommCell Console.
Collect the name of the Domino server.
Domino home directory
This information is only applicable to installations using the installation package.
Retrieve the path of the Domino home directory.
Domino partition details
This information is only applicable to installations using the installation package.
Collect the following partition details:
Name of the Domino partition
Name of the Domino data directory

5/6/2017 Commvault Systems Page 148 of 587


Preinstallation Checklist for the IBM Notes Document Agent on Windows
Use the IBM Notes Document Agent to protect individual documents of a database. You can use this agent if your primary goal is partial database recovery or if you need to
bring part of a large database online after a system failure. You can perform small restore jobs in the course of day-to-day database use, like retrieving data accidentally
deleted by a user.. For more information, see Overview - IBM Domino Agents .
Use this preinstallation checklist to prepare the computer where the Notes Document 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 Notes Document Agent satisfies the minimum requirements. For more information, see System Requirements - Notes
Document Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Notes Document Agent. For more
information, see License Requirements - Notes Document Agent .
 Determine the Installation Location
Install the Notes Document Agent on an IBM Domino that you want to back up. The Notes Document Agent cannot be installed on cluster environments.
 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 Notes Document 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 Domino Document package, which is listed under the Applications 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.
Domino server details
This information is only applicable to installations using the CommCell Console.
Collect the following Domino server details:
Name of the Domino instance
Path to the directory where the instance resides
Path to the directory where the Domino software resides
Partitions for Notes Document
This information is only applicable to installations using the installation package.
Select the partitions that you want to protect. After the installation, the partitions will use the storage policy that you assigned during installation.

5/6/2017 Commvault Systems Page 149 of 587


Preinstallation Checklist for the IBM Notes Document Agent on UNIX
Use the IBM Notes Document Agent to protect individual documents of a database. You can use this agent if your primary goal is partial database recovery or if you need to
bring part of a large database online after a system failure. You can perform small restore jobs in the course of day-to-day database use, like retrieving data accidentally
deleted by a user.. For more information, see Overview - IBM Domino Agents .
Use this preinstallation checklist to prepare the computer where the Notes Document 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 Notes Document Agent satisfies the minimum requirements. For more information, see System Requirements - Notes
Document Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Notes Document Agent. For more
information, see License Requirements - Notes Document Agent .
 Determine the Installation Location
Install the Notes Document Agent on an IBM Domino that you want to back up. The Notes Document Agent cannot be installed on cluster environments.
 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 Notes Document 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
For installations using the CommCell Console, install the Domino Document package, which is listed under the Applications category.
For installations using the installation package, install the Domino Document 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 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.
Domino server details
This information is only applicable to installations using the CommCell Console.
Collect the name of the Domino server.
Domino home directory
This information is only applicable to installations using the installation package.
Retrieve the path of the Domino home directory.
Domino partition details
This information is only applicable to installations using the installation package.
Collect the following partition details:
Name of the Domino partition
Name of the Domino data directory

5/6/2017 Commvault Systems Page 150 of 587


Preinstallation Checklist for the OES File System Agent
The OES File System Agent backs up and restores the NSS file system data residing on OES computers. For more information, see Overview - OES File System .
Use this preinstallation checklist to prepare the computer where the OES 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 OES File System Agent satisfies the minimum requirements. For more information, see System Requirements - OES
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 OES File System Agent. For more
information, see License Requirements - OES File System .
 Determine the Installation Location
Based on your environment, install the OES File System Agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On the OES computer on which the NSS file system data
resides.
Clustered On all physical nodes of the cluster.

 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 OES File System 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
For installations using the CommCell Console, install the Novell OES File System package, which is listed under the File System category.
For installations using the installation package, install the Novell OES File System package.
If the File System Agent is not installed on the computer, the File System Core package is 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 .
User account for Novell SMS
This information is only applicable to installations using the CommCell Console.
Collect the Novell FS user account credentials to log onto the Novell SMS (Storage Management Services).
User account for Target Service Agent (TSA)
This information is only applicable to installations using the installation package.
To run backup or restores, Commvault needs to log onto the TSA agent service. Collect the TSA user account and password that Commvault must use.

5/6/2017 Commvault Systems Page 151 of 587


Preinstallation Checklist for the Oracle Agent on Windows
The Oracle Agent backs up and restores Oracle databases in your enterprise. You can also configure the agent to incorporate archiving and snap management solutions.
For more information, see the Oracle Backup Administrator Guide .
Use the preinstallation checklist to prepare the computer where the 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 agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Oracle Agent. For more
information, see License Requirements .
 Determine the Installation Location
Based on your environment, install the Oracle Agent on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the Oracle server resides.
Clustered On the physical nodes of the cluster where the Oracle server resides.
If you want to protect the Oracle Real Application Clusters (RAC), install the agent on all the nodes of the Oracle
RAC.

 Prepare the Oracle Services to Restart


Commvault software restarts the Oracle services after the installation. Plan your installation for a time when a reboot can occur.
 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 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 Oracle package, which is listed under the Database category.
Note:
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.

Restart the Oracle services


Oracle services must be restarted after the installation.
For installations using the CommCell Console, select the Restart Oracle/DB2 Service (if applicable. Oracle DB2 instance needs to be restarted to load
Simpana media library for Data Protection) option.
For installations using the installation package, select the Process Manager option.

5/6/2017 Commvault Systems Page 152 of 587


Preinstallation Checklist for the Oracle Agent on UNIX
The Oracle Agent backs up and restores Oracle databases in your enterprise. You can also configure the agent to incorporate archiving and snap management solutions.
For more information, see the Oracle Backup Administrator Guide .
Use this preinstallation checklist to prepare the computer where the Oracle Agent will be installed and to gather all of the information you will need during the installation.
 Determine the Installation Location
Based on your environment, install the Oracle Agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the Oracle server resides.
For Oracle Solaris computers, install the Oracle Agent on one of the following setups:
The computer hosting the global zone on which the Oracle server resides.
A computer in a non-global zone on which the Oracle server resides.
Clustered On the physical nodes of the cluster where the Oracle server resides.
If you want to protect the Oracle Real Application Clusters (RAC), install the Oracle Agent on all the nodes of the Oracle
RAC.
Cluster installations are not supported on FreeBSD and Macintosh computers.

 Verify System Requirements


Verify that the computer where you plan to install the Oracle Agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Oracle Agent. For more
information, see License Requirements .
 Verify Access Permissions on AIX computers
Grant read permissions for other users (chmod o+r) on shared libraries and executables to allow services to start without any issues.
 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 Oracle 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
For installations using the CommCell Console, install the Oracle package, which is listed under the Database category.
For installations using the installation package, install the Oracle package.
Note: If the File System Agent is not installed on the computer, the software automatically installs the File System Core package with the package that you select.
The File System Agent will not consume any license. If you want to use any of the file system advanced features (for example, optimized scan or 1-touch operations)
to protect the file system data, select the File System package.
For more information on the package options and 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 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.
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.

5/6/2017 Commvault Systems Page 153 of 587


Preinstallation Checklist for the OWA Proxy Enabler
The OWA Proxy Enabler allows end users to retrieve messages from any remote location through a Web application for Outlook.
If you plan to use Office App to provide your users access to archived messages, you do not need to install the Outlook Web App Proxy Enabler.
Do not install the OWA Proxy Enabler on Exchange 2013 or later. For more information about using Office App, see Accessing Archived Messages Using Exchange
Server 2013 or Later .
Use this preinstallation checklist to prepare the computer where the OWA Proxy Enabler 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 plan to install the OWA Proxy Enabler satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
The OWA Proxy Enabler does not require a license.
 Where to Install
Install the OWA (Outlook Web App) Proxy Enabler on the Exchange server computer where the Client Access server (CAS) role is configured. This component is not
supported on cluster environments.
 Configure Internet Information Services (IIS)
Install and configure Internet Information Services (IIS) on the Exchange server computer.
 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 OWA Proxy Enabler 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 OWA Proxy Enabler package, which is listed under the Applications category.
If the File System Agent is not installed on the computer, the File System Core package is 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.
Exchange Server details
Collect the following Exchange server details:
Server name
Version (for example, Exchange 2010)

5/6/2017 Commvault Systems Page 154 of 587


Preinstallation Checklist for the PostgreSQL Agent on Windows
The PostgreSQL Agent backs up and restores PostgreSQL system databases, user databases and transaction logs in your enterprise. The PostgreSQL Agent also performs
both full system rebuilds and granular backup and recovery of your data. For more information, see Overview - PostgreSQL Agent .
Use this preinstallation checklist to prepare the computer where the PostgreSQL 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 PostgreSQL Agent satisfies the minimum requirements. For more information, see System Requirements -
PostgreSQL Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the PostgreSQL Agent. For more
information, see License Requirements - PostgreSQL Agent .
 Determine the Installation Location
Based on your environment, install the MySQL Agent on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the PostgreSQL Server resides.
Clustered On the physical nodes of the cluster where the PostgreSQL Server
resides.

 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 PostgreSQL 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 PostgreSQL package, which is listed under the Database 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.

5/6/2017 Commvault Systems Page 155 of 587


Preinstallation Checklist for the PostgreSQL Agent on UNIX
The PostgreSQL Agent backs up and restores PostgreSQL system databases, user databases and transaction logs in your enterprise. The PostgreSQL Agent also performs
both full system rebuilds and granular backup and recovery of your data. For more information, see Overview - PostgreSQL Agent .
Use this preinstallation checklist to prepare the computer where the PostgreSQL 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 PostgreSQL Agent satisfies the minimum requirements. For more information, see System Requirements -
PostgreSQL Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the PostgreSQL Agent. For more
information, see License Requirements - PostgreSQL Agent .
 Determine the Installation Location
Based on your environment, install the MySQL Agent on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the PostgreSQL Server resides.
Clustered On the physical nodes of the cluster where the PostgreSQL Server
resides.

 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 PostgreSQL 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
For installations using the CommCell Console, install the PostgreSQL package, which is listed under the Database category.
For installations using the installation package, install the PostgreSQL.
Note: If the File System Agent is not installed on the computer, the software automatically installs the File System Core package with the package that you select. The
File System Agent will not consume any license. If you want to use any of the file system advanced features (for example, optimized scan or 1-touch operations) to
protect the file system data, select the File System package.
For more information on the package options and 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 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.

5/6/2017 Commvault Systems Page 156 of 587


Preinstallation Checklist for the SAP Archive Link Agent on UNIX
The SAP Archive Link agent provides a versatile data repository solution that can be integrated with the SAP Archive software. For more information, see SAP Archive Link
Agent Overview .
Use this preinstallation checklist to prepare the computer where the SAP Archive Link 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 SAP Archive Link agent satisfies the minimum requirements. For more information, see System Requirements: SAP
Archive Link Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the SAP Archive Link agent. For more
information, see License Requirements: SAP Archive Link Agent .
 Determine the Installation Location
Based on your environment, install the SAP Archive Link agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On the computer where you want to archive the SAP data.
Clustered On the physical computer.

 Configure the ObjectStore


Verify the you have configured an ObjectStore in your CommCell environment. For more information, see Configuring an ObjectStore .
Note the user name and password for the ObjectStore account, and the host name of the Web Server.
 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 SAP Archive Agent using 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 SAP Archive package.
Note:
If the File System Agent is not installed on the computer, the software automatically installs the File System Core package with the package that you select. The File
System Agent will not consume any license. If you want to use any of the file system advanced features (for example, optimized scan or 1-touch operations) to
protect the file system data, select the File System package.
For more information on the package options and 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 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 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.

5/6/2017 Commvault Systems Page 157 of 587


Preinstallation Checklist for the SAP for HANA Agent on UNIX
The SAP HANA Agent provides a simplified end-to-end backup and recovery solution for both large scale single node and multi-node SAP HANA environments. It uses the
SAP Backint interface program to back up the data directly to the attached media. In case of a data loss, you can restore the backed up data and the log files directly from
the media using the SAP Backint interface program. For more information, see Overview - SAP HANA Agent .
Use this preinstallation checklist to prepare the computer where the SAP HANA 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 SAP HANA Agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the SAP HANA Agent. For more
information, see License Requirements .
 Determine the Installation Location
Install the SAP HANA Agent on the computer that you want to back up. The SAP HANA Agent cannot be installed on cluster environments.
 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 SAP HANA 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
For installations using the CommCell Console, install the SAP for Hana package, which is listed under the Database category.
For installations using the installation package, install the SAP for Hana package.
Note: If the File System Agent is not installed on the computer, the software automatically installs the File System Core package with the package that you select.
The File System Agent will not consume any license. If you want to use any of the file system advanced features (for example, optimized scan or 1-touch operations)
to protect the file system data, select the File System package.
For more information on the package options and 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 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.
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.
Setting SAPHANAEXE Directory
Note: The SAPHANAEXE directory is the SAP kernel directory for the SAP application. This directory contains the binaries. You can look at the SAP environmental
variables to get this value.
You can use /usr/sap/<SID>/SYS/global/hdb/opt for this parameter. Substitute the SID with your value.

5/6/2017 Commvault Systems Page 158 of 587


Preinstallation Checklist for the SAP for Oracle Agent on Windows
The SAP for Oracle Agent backs up and restores Oracle databases in your enterprise. For more information, see Overview - SAP Oracle Agent .
Use this preinstallation checklist to prepare the computer where the SAP Oracle 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 SAP Oracle Agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the SAP Oracle Agent. For more
information, see License Requirements .
 Determine the Installation Location
Based on your environment, install the SAP Oracle Agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On the computer that you want to back up.
Clustered On each physical node of the cluster.

 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 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 SAP for Oracle package, which is listed under the Database 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.

Restart the SAP for Oracle services


Oracle services must be restarted after the installation.
For installations using the CommCell Console, select the Restart Oracle/DB2 Service (if applicable. Oracle DB2 instance needs to be restarted to load
Simpana media library for Data Protection) option.
For installations using the installation package, select the Process Manager option.

5/6/2017 Commvault Systems Page 159 of 587


Preinstallation Checklist for the SAP for Oracle Agent on UNIX
The SAP for Oracle Agent backs up and restores Oracle databases in your enterprise. For more information, see Overview - SAP Oracle Agent .
Use this preinstallation checklist to prepare the computer where the SAP for Oracle 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 SAP Oracle Agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the SAP Oracle Agent. For more
information, see License Requirements .
 Determine the Installation Location
Based on your environment, install the SAP Oracle Agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On the computer that you want to back up.
Clustered On each physical node of the cluster.

 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 Oracle 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
For installations using the CommCell Console, install the SAP for Oracle package, which is listed under the Database category.
For installations using the installation package, install the SAP for Oracle package.
Note: If the File System Agent is not installed on the computer, the software automatically installs the File System Core package with the package that you select.
The File System Agent will not consume any license. If you want to use any of the file system advanced features (for example, optimized scan or 1-touch operations)
to protect the file system data, select the File System package.
For more information on the package options and 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 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.
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.

5/6/2017 Commvault Systems Page 160 of 587


Preinstallation Checklist for the SAP for MaxDB Agent on Windows
The SAP agents provide the flexibility to back up the SAP for MaxDB databases in different environments. You can perform a full or an incremental backup of the entire
database, individual data files, and log files at any point of time. For more information, see Overview - SAP MaxDB Agent .
Use this preinstallation checklist to prepare the computer where the SAP MaxDB 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 SAP MaxDB Agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the SAP MaxDB Agent. For more
information, see License Requirements .
 Determine the Installation Location
Based on your environment, install the SAP MaxDB Agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On the computer that you want to back up.
Clustered On each physical node of the cluster.

 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 SAP MaxDB Agent using either the CommCell Console or the installation package created by the Download Manager. Any checklist item that applies
to only one of these installation methods is noted.
Commvault package to install
Install the SAP for MaxDB package, which is listed under the Database 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.

5/6/2017 Commvault Systems Page 161 of 587


Preinstallation Checklist for the SAP for MaxDB Agent on UNIX
The SAP agents provide the flexibility to back up the SAP for MaxDB databases in different environments. You can perform a full or an incremental backup of the entire
database, individual data files, and log files at any point of time. For more information, see Overview - SAP MaxDB Agent .
Use this preinstallation checklist to prepare the computer where the SAP MaxDB 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 SAP MaxDB Agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the SAP MaxDB Agent. For more
information, see License Requirements .
 Determine the Installation Location
Based on your environment, install the SAP MaxDB Agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On a computer hosting the global zone or the Unix Server that you want to backup.
It is recommended to install the software on the global zone to protect non-changing or static data on non-global zones. However, if
the data is dynamic or contains application data, install the software on the non-global zone.
Clustered On the physical node of the cluster.

 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 SAP MaxDB 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
For installations using the CommCell Console, install the SAP for MaxDB package, which is listed under the Database category.
For installations using the installation package, install the SAP for MaxDB package.
Note: If the File System Agent is not installed on the computer, the software automatically installs the File System Core package with the package that you select.
The File System Agent will not consume any license. If you want to use any of the file system advanced features (for example, optimized scan or 1-touch operations)
to protect the file system data, select the File System package.
For more information on the package options and 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 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.
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.

5/6/2017 Commvault Systems Page 162 of 587


Preinstallation Checklist for the SharePoint Server Agent
The SharePoint Server Agent backs up and restores content databases and transaction logs in your enterprise. The SharePoint Server Agent also performs both full system
rebuilds and granular backup and recovery of your data. For more information, see Overview - SharePoint Server Agent .
Use this preinstallation checklist to prepare the computer where the SharePoint Server 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 SharePoint Server Agent satisfies the minimum requirements. For more information, see System Requirements -
SharePoint Server Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the SharePoint Server Agent. For
more information, see License Requirements - SharePoint Server Agent .
 Determine the Installation Location
Based on your environment, install the SharePoint Server Agent on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the SharePoint Server resides.
Clustered On the physical nodes of the cluster where the SharePoint Server
resides.

On the SharePoint farm, install the software on the Application Server that hosts the Central Administration site.

 Verify Required Permissions


Verify that you have the required permissions for the following accounts:
Accounts Permissions Required
SharePoint user account that has access to the SharePoint farm Local administrative rights
FARM administrator rights
SP Shell administrator permissions
Full control under Policy for Web Application for every Web Application
SQL System Admin Server Role for the instance where SharePoint Databases
resides
Site Administrator permissions for all Site Collections
Full permissions to the Job Results and Log Files folders
SQL Server Services account for the SharePoint instance Full permissions to the Job Results and Log Files folders.
SharePoint Services Timer account Full permissions to the Job Results and Log Files folders.
All Web Application Pools accounts Full permissions to the Job Results and Log Files folders.

Commvault services account, also known as the SharePoint Administrator account, is used to run the SharePoint backup operation.

 Configure User Accounts


Ensure to meet the following prerequisites before installing the SharePoint Agent:
Commvault services account must be a member of the local administrators group.
Log onto the SharePoint server as a Commvault service account user to run the following command:
Add-SPShellAdmin -username DOMAIN\YourUser

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.

 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 SharePoint Server 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 SharePoint package, which is listed under the Applications 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
5/6/2017 Commvault Systems Page 163 of 587
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.
SharePoint Server details
Collect the following SharePoint server details:
Server name
Administrator user account to access the SharePoint server

5/6/2017 Commvault Systems Page 164 of 587


Preinstallation Checklist for the SQL Server Agent
The Microsoft SQL Server Agent backs up and restores SQL system databases, user databases and transaction logs in your enterprise. The SQL Server Agent also performs
both full system rebuilds and granular backup and recovery of your data. For more information, see SQL Server Agent Overview .
Use this preinstallation checklist to prepare the computer where the SQL Server Agent will be installed and to gather all the information required during the installation.
 Verify System Requirements
Verify that the computer where you will install the Microsoft SQL Server Agent satisfies the minimum requirements. For more information, see System Requirements -
SQL Server Agent .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the SQL Server Agent. For more
information, see License Requirements - SQL Server Agent .
 Determine the Installation Location
Based on your environment, install the SQL Server Agent on the appropriate computer.
Environment Where to install the software
Non-Clustered On the computer where the SQL Server resides.
Clustered On the physical nodes of the cluster where the SQL Server
resides.

 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 SQL 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 SQL Server package, which is listed under the Database 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.
SQL Server details
If the option to install SQL Server is disabled, verify that there is at least one network protocol enabled. For SQL Server 2005, go to SQL Server Configuration
Manager and enable protocols for each instance.
Microsoft SQL Server Management Objects (SMO) is required on the client machine. By default, SMO is automatically installed with SQL Server 2005 or later
versions.

5/6/2017 Commvault Systems Page 165 of 587


Preinstallation Checklist for the Sybase Agent on Windows
The Sybase Agent provides a unique, simplified, and end-to-end backup and recovery solution for the Sybase systems and user databases in your enterprise. The Sybase
Agent offers a complete protection of your system databases and provides a granular backup and recovery of your data, transaction logs, and administration files. For
more information, see Overview - Sybase Agent .
Use this preinstallation checklist to prepare the computer where the Sybase 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 Sybase Agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Sybase Agent. For more
information, see License Requirements .
 Determine the Installation Location
Based on your environment, install the Sybase Agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the Sybase server resides.
Clustered On the physical nodes of the cluster where the Sybase server
resides.

 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 Sybase Agent using either the CommCell Console or the installation package created by the Download Manager. Any checklist item that applies to
only one of these installation methods is noted.
Commvault package to install
Install the Sybase package, which is listed under the Database 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.

5/6/2017 Commvault Systems Page 166 of 587


Preinstallation Checklist for the Sybase Agent on UNIX
The Sybase Agent provides a unique, simplified, and end-to-end backup and recovery solution for the Sybase systems and user databases in your enterprise. The Sybase
Agent offers a complete protection of your system databases and provides a granular backup and recovery of your data, transaction logs, and administration files. For
more information, see Overview - Sybase Agent .
Use this preinstallation checklist to prepare the computer where the Sybase 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 Sybase Agent satisfies the minimum requirements. For more information, see System Requirements .
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use the Sybase Agent. For more
information, see License Requirements .
 Determine the Installation Location
Based on your environment, install the Sybase Agent on an appropriate computer.
Environment Where to install the software
Non-Clustered On the computer on which the Sybase server resides.
For Solaris computers, install the Sybase Agent on one of the following setups:
The computer hosting the global zone on which the Sybase server resides and satisfies the minimum requirements specified in
the System Requirements.
A computer in a non-global zone on which the Sybase server resides and satisfies the minimum requirements specified in the
System Requirements.
Clustered On the physical nodes of the cluster where the Sybase server resides.

 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 Sybase 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
For installations using the CommCell Console, install the Sybase package, which is listed under the Database category.
For installations using the installation package, install the Sybase package.
Note: If the File System Agent is not installed on the computer, the software automatically installs the File System Core package with the package that you select.
The File System Agent will not consume any license. If you want to use any of the file system advanced features (for example, optimized scan or 1-touch operations)
to protect the file system data, select the File System package.
For more information on the package options and 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 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.
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.

5/6/2017 Commvault Systems Page 167 of 587


Preinstallation Checklist for the Virtual Server Agent on Windows
The Virtual Server Agent (VSA) protects all of your virtual machines and unifies the data protection of physical and virtual environments. For more information, see one of
the following:
Amazon
Citrix Xen
Huawei FusionCompute
Microsoft Azure
Microsoft Hyper-V
Nutanix AHV
OpenStack
Oracle VM
Red Hat Virtualization
VMware
Use the preinstallation checklist to prepare the computer where the Virtual Server Agent will be installed and to gather all the information you will need during the
installation.
Note: When you install or upgrade to v11 Service Pack 4 or later on a machine where the Virtual Server Agent is installed, .NET framework 4.5 (for Windows machines) and
the latest VDDK driver (for VMware) are installed if they are not already present. After these components are installed, you must reboot the machines where they were
installed.
 Verify System Requirements
Based on your virtual environment, verify that the computer where you will install the agent satisfies the minimum requirements specified on the system requirements
page for your operating system:
System Requirements for Virtual Server Agent with Amazon
System Requirements for Virtual Server Agent with Citrix Xen
System Requirements for Virtual Server Agent with Huawei FusionCompute
System Requirements for Virtual Server Agent with Microsoft Azure
System Requirements for Virtual Server Agent with Microsoft Hyper-V
System Requirements for Virtual Server Agent with Nutanix AHV
System Requirements for Virtual Server Agent with OpenStack
System Requirements for Virtual Server Agent with Oracle VM
System Requirements for Virtual Server Agent with Red Hat Virtualization
System Requirements for Virtual Server Agent with VMware
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell environment has the required licenses to use the Virtual Server
Agent.
For more information, see:
License Requirements for Virtual Server Agent with Amazon
License Requirements for Virtual Server Agent with Citrix Xen
License Requirements for Virtual Server Agent with Huawei FusionCompute
License Requirements for Virtual Server Agent with Microsoft Azure
License Requirements for Virtual Server Agent with Microsoft Hyper-V
License Requirements for Virtual Server Agent with Nutanix AHV
License Requirements for OpenStack
License Requirements for Oracle VM
License Requirements - Virtual Server Agent for Red Hat Virtualization
License Requirements for Virtual Server Agent with VMware
 Determine the Installation Location
Based on your environment, install the Virtual Server Agent on an appropriate computer. Each computer where the Virtual Server Agent is installed serves as a VSA
proxy to manage backup and restore operations.
Environment Where to install the software
Non-Clustered For Amazon, install on one or more machines or Amazon instances.
For backups, the VSA must be installed on an Amazon instance in each region to be protected. Each VSA proxy can protect
instances in the same region.
For VM conversion and restores, the VSA can be installed on an Amazon instance or on an external machine.
For Citrix Xen, install on a dedicated virtual machine on a standalone XenServer.
For FusionCompute, install on a Linux, UNIX, or Windows machine.
For Microsoft Azure, install on a physical server or a VM in the Azure cloud that has a public IP address configured.
For Microsoft Hyper-V, install on a standalone Hyper-V server.
For Nutanix AHV, install on one or more virtual machines running in the Nutanix cluster.
For OpenStack, install on one or more instances running in the OpenStack data center.
For Oracle VM, install on a Windows virtual machine running in Oracle VM Manager.
For Red Hat Virtualization, install on one or more virtual machines in the same data center as the virtual machines to be backed
up.
For VMware, install on one or more Windows physical computers or virtual machines.
Clustered For Amazon, install on one or more machines or Amazon instances.
For backups, the VSA must be installed on an Amazon instance in each region to be protected. Each VSA proxy can protect
instances in the same region.
For VM conversion and restores, the VSA can be installed on an Amazon instance or on an external machine.
For Citrix Xen, install on one or more dedicated virtual machines on each XenServer in a Xen pool.
For FusionCompute, install on a Linux, UNIX, or Windows machine.
For Microsoft Azure, install on a physical server or a VM in the Azure cloud that has a public IP address configured.
For Microsoft Hyper-V, install on all Hyper-V servers (physical nodes) in the cluster.
For Nutanix AHV, install on one or more virtual machines running in the Nutanix cluster.
For OpenStack, install on one or more instances running in the OpenStack data center.
For Oracle VM, install on a Windows virtual machine running in Oracle VM Manager.
For Red Hat Virtualization, install on one or more virtual machines in the same data center as the virtual machines to be backed
up.
5/6/2017 Commvault Systems Page 168 of 587
Virtual Server Agent for VMware does not support clustered environments.

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

5/6/2017 Commvault Systems Page 169 of 587


Preinstallation Checklist for the Virtual Server Agent on Linux
The Virtual Server Agent (VSA) protects all of your virtual machines and unifies the data protection of physical and virtual environments. For more information, see one of
the following:
Docker
Huawei FusionCompute
Nutanix AHV
OpenStack
Red Hat Virtualization
Use the preinstallation checklist to prepare the computer where the Virtual Server Agent will be installed and to gather all the information you will need during the
installation.
 Verify System Requirements
Based on your virtual environment, verify that the computer where you will install the agent satisfies the minimum requirements specified in the following:
System Requirements for Virtual Server Agent with Docker
System Requirements for Virtual Server Agent with Huawei FusionCompute
System Requirements for Virtual Server Agent with Nutanix AHV
System Requirements for Virtual Server Agent with OpenStack
System Requirements for Virtual Server Agent with Red Hat Virtualization
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell environment has the required licenses to use the Virtual Server
Agent. For more information, see one of the following:
License Requirements for Virtual Server Agent with Docker
License Requirements for Virtual Server Agent with Huawei FusionCompute
License Requirements for Virtual Server Agent with Nutanix AHV
License Requirements for Virtual Server Agent with OpenStack
License Requirements for Virtual Server Agent with Red Hat Virtualization
 Determine the Installation Location
Based on your environment, install the Virtual Server Agent on an appropriate computer. Each computer where the Virtual Server Agent is installed serves as a VSA
proxy to manage backup and restore operations.
Environment Where to install the software
Non-Clustered For Docker, install on a 32-bit or 64-bit UNIX machine.
For FusionCompute, install on a Linux, UNIX, or Windows machine.
For Nutanix AHV, install on one or more virtual machines running in the Nutanix cluster.
For OpenStack, install on one or more instances running in the OpenStack data center.
For Red Hat Virtualization, install on one or more virtual machines in the same data center as the virtual machines to be backed
up.
Clustered For Docker, install on a 32-bit or 64-bit UNIX machine.
For FusionCompute, install on a Linux, UNIX, or Windows machine.
For Nutanix AHV, install on one or more virtual machines running in the Nutanix cluster.
For OpenStack, install on one or more instances running in the OpenStack data center.
For Red Hat Virtualization, install on one or more virtual machines in the same data center as the virtual machines to be backed
up.

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

5/6/2017 Commvault Systems Page 171 of 587


Installing Commvault on Clients
Install agents and other Commvault software by using either the CommCell Console or the installation package that was created from the Download Manager application.

Before You Begin


Prepare your environment for the installation as described in the following topics:
Plan the Installation on Windows Computers
Plan the Installation on UNIX, Linux, and Macintosh Computers
Gather the information that you must provide during the installation as described in Preinstallation Checklist for Clients .

Choose the Installation Method


The most commonly used methods to install Commvault are the following:
Remote installations, where you use the CommCell Console to install the software remotely on one or more computers.
For instructions, see Installing Commvault Remotely Using the CommCell Console .
If you have third-party applications installed in your clients (such as Oracle), you can configure the CommCell Console to automatically detect the application and install
the required Commvault software. For instructions, see Installing Commvault By Enabling Automatic Detection of Applications Installed on Clients .
Local installations, where you use the installation package to install the software locally on a computer.
Based on your computer's operating system, see installing Commvault locally on Windows or UNIX .
For other installation methods using the installation package, see Installations Using the Installation Package .

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.

5/6/2017 Commvault Systems Page 172 of 587


Postinstallation Tasks for Clients
Based on your environment settings, or the installation options that you set, you might have to perform some postinstallation tasks to complete the client installation.
The following sections describe general tasks for Windows and UNIX clients.

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 .

UNIX, Linux, and Macintosh


Register the Client after Decoupled Installation
If you installed Commvault in decoupled mode, the client was not registered during the installation. To register the client, use one of the following methods:
Registering the Client Using the CommCell Console
Registering the Client Using the Command Line
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:
Veritas Clusters
Non-Veritas Cluster
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 - Getting Started - Overview .
Change UNIX Groups and Access Permissions on UNIX Clients
If you need to change the UNIX group and access permissions that you defined during the installation, see Changing UNIX Groups and Permissions on UNIX Clients
.
Note: You must perform this task when you install a database on an existing client and the packages have different permissions.
Set Read Permissions on AIX Clients
If you installed agents on an AIX computer, and you did not set read permissions for other users during the installation, see Setting Read Permissions on AIX Clients
.
View Files Created During the Installation
For some agents, additional files and folders are created outside the installation directory. If you want to view the files and folders that were created outside the
installation directory, see Files and Folders Created During UNIX Installations .
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 .

5/6/2017 Commvault Systems Page 173 of 587


Changing UNIX Groups and Permissions on UNIX Clients
When you install the Commvault software for the first time on a client, you can set the UNIX group and access permissions for all the installation files, including registry
entries.
If you need to change the UNIX group and access permissions settings that you configured during the installation, you can run a script to update the settings. This is useful
in the following situations:
You must set the permissions when you install a database agent on an existing client and the packages have different permissions.
You want to set a different group for your Commvault files and directories.
You want to change the access permissions for those users who are not part of the UNIX group. These users also known as "other users".
For example, based on your security needs, you do not want other users to read and execute Commvault files.
You want to apply your current access permissions to newly installed files and directories. This is useful when you installed additional agents to the client, and the
installed files are using different access permissions.
Note: You cannot change the UNIX group and access permissions during subsequent agent installations on the same client:
If you perform a local installation by using the installation package, the installer does not prompt for the UNIX group again.
If you perform a remote installation by using the CommCell Console, any modification to the UNIX group and access permissions will not be applied to the client.

Before You Begin


No jobs should be running on the client.
For example, if you remove "write" permissions for the UNIX group, some Commvault directories will continue to have "write" permissions to allow backup and restore
operations to complete.

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:

Executables(/opt/InstallDir) ... FAILED

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.

5/6/2017 Commvault Systems Page 174 of 587


Files and Folders Created During UNIX Installations
During the installation of an agent, the Commvault software creates a set of files and folders under the software installation directory (/opt/commvault/). For some agents,
the software needs to create additional files and/or folders outside the installation directory.
Table of Contents
Files and Folders Created during Agent Installations
Additional Files Created during Installations on Cluster Environments

Files and Folders Created during Agent Installations


Select an agent from the following list to see the files and/or folders that are created outside the Commvault installation directory.
ContinuousDataReplicator
DB2 and DB2 Multinode Agent
Domino Mailbox Archiver Agent
File System Agent
Informix Agent
MediaAgent
Sybase Agent
Other Agents
ContinuousDataReplicator
Platforms Folders Created Files Created Other changes
AIX /dev/flr0 PdDv changed None
/dev/fsdm1 CuDv changed
CDR Cache will be created under user-defined /usr/lib/drivers/flrdd
directory: /etc/flrdd.conf
<userdefined DIR>/cvcdrcache /etc/fsdmdd.conf
/etc/fsfdd.conf
/usr/lib/drivers/flrdd
/usr/lib/methods/cfgflr
/usr/lib/methods/ucfgflr
/usr/lib/methods/undflr
/var/adm/cvlt_driver
HP-UX CDR Cache will be created under user-defined /usr/conf/mod/cvfsf
directory:
<userdefined DIR>/cvcdrcache
Linux /dev/cvcdr Redhat - /lib/modules/?uname ?r?/updates/cdr.ko None
/dev/cvfsdm SUSE - /lib/modules/?uname ?r?/extra/cdr.ko
CDR Cache will be created under user-defined
directory:
<userdefined DIR>/cvcdrcache
Solaris CDR Cache will be created under user-defined /usr/kernel/drv/cvfsf.conf None
directory: /dev/cvfsf/*
userdefined DIR>/cvcdrcache /usr/kernel/drv/sparcv9/cvfsf
/usr/kernel/drv/amd64/cvfsf

DB2 and DB2 Multinode Agent


Platforms Folders Created Files Created Other Changes
AIX None None Symbolic links to Galaxy libraries will be created
under the $DB2_HOME/sqllib/lib directory
HP-UX None None Symbolic links to Galaxy libraries will be created
under the $DB2_HOME/sqllib/lib directory
Linux None None Symbolic links to Galaxy libraries will be created
under the $DB2_HOME/sqllib/lib directory
Solaris None None Symbolic links to Galaxy libraries will be created
under the $DB2_HOME/sqllib/lib directory

Domino Mailbox Archiver Agent


Platforms Folders Created Files Created Other Changes
AIX None <NotesSoftwareDir>/latest/ibmpow/liblndmhook.a None
Linux None <NotesSoftwareDir>/latest/linux/liblndmhook.so None
Solaris None <NotesSoftwareDir>/latest/linux/liblndmhook.so None

File System Agent


Platforms Folders Created Files Created Other Changes
AIX /etc/CommVaultRegistry/Galaxy/InstanceXXX /etc/CommVaultRegistry/.global.lock Startup Scripts:
/opt/commvault /etc/gxsetup_guid /etc/inittab
/var/log/.gxsetup /etc/galaxy (created only if a V9 OSSV Plug-In is used on /etc/rc.galaxy
/var/log/commvault a V10 CommCell)
.gxupdate /etc/rc.galaxy
created in /usr/bin/cvpkgcheck
/var/log/commvault/Log_Files/.gxsetup.$$ /usr/bin/cvpkgchg (created only after an upgrade)
during update install /usr/bin/cvpkgrm
archived in /var/log/.gxsetup after update /usr/bin/detect
install /usr/bin/commvault
5/6/2017 Commvault Systems Page 175 of 587
Folders created only when the OnePass Files created only when the OnePass feature is
feature is enabled: enabled:
/dev/flr0 /etc/flrdd.conf
/dev/fsdm1 /etc/fsdmdd.conf
/etc/fsfdd.conf
/usr/lib/drivers/flrdd
/usr/lib/methods/cfgflr
/usr/lib/methods/ucfgflr
/usr/lib/methods/undflr
/var/adm/cvlt_driver
FreeBSD /etc/CommVaultRegistry/Galaxy/InstanceXXX /etc/CommVaultRegistry/.global.lock Startup script:
/opt/commvault /etc/gxsetup_guid /usr/local/etc/rc.d/Galaxy.sh
/var/log/.gxsetup /usr/bin/cvpkgcheck
/var/log/commvault /usr/bin/cvpkgchg
.gxupdate /usr/bin/cvpkgrm
created in /usr/bin/detect
/var/log/commvault/Log_Files/.gxsetup.$$ /usr/bin/commvault
during update install
archived in /var/log/.gxsetup after update
install
HP-UX /etc/CommVaultRegistry/Galaxy/InstanceXXX /dev/cxbf (created only if CXBF is installed) Startup scripts:
/opt/seed /etc/CommVaultRegistry/.global.lock /sbin/rc3.d/K99Galaxy
/opt/commvault /etc/gxsetup_guid /sbin/rc3.d/S99Galaxy
/var/log/.gxsetup /usr/bin/cvpkgcheck
/var/log/commvault /usr/bin/cvpkgchg
.gxupdate /usr/bin/cvpkgrm
created in /usr/bin/detect
/var/log/commvault/Log_Files/.gxsetup.$$ /usr/bin/commvault
during update install
archived in /var/log/.gxsetup after update
install

Linux /etc/CommVaultRegistry/Galaxy/InstanceXXX /etc/CommVaultRegistry/.global.lock Startup Scripts: /etc/init.d/Galaxy ( Linux using insserv


/opt/seed /etc/gxsetup_guid such as Suse)
/opt/commvault /etc/rc.d/init.d/Galaxy <dir>/K01Galaxy where <dir>=/etc/rc.d/rc0.d;
/var/log/.gxsetup /usr/bin/cvpkgcheck /etc/rc0.d ; /sbin/rc.d/rc0.d ; sbin/rc0.d ;
/var/log/commvault /usr/bin/cvpkgchg /etc/init.d/runlevels/%0 only if <dir> exists
.gxupdate /usr/bin/cvpkgrm <dir>/K01Galaxy where <dir>=/etc/rc.d/rc6.d;
created in /usr/bin/detect /etc/rc6.d ; /sbin/rc.d/rc6.d ; sbin/rc6.d ;
/var/log/commvault/Log_Files/.gxsetup.$$ /usr/bin/commvault /etc/init.d/runlevels/%6 only if <dir> exists
during update install /var/lock/subsys/Galaxy <dir>/S99Galaxy where <dir>=/etc/rc.d/rc2.d;
archived in /var/log/.gxsetup after update /etc/rc2.d ; /sbin/rc.d/rc2.d ; sbin/rc2.d ;
install Symbolic Links to /etc/rc.d/init.d/Galaxy: /etc/init.d/runlevels/%2 only if <dir> exists
/etc/rc.d/rc0.d/K01Galaxy <dir>/S99Galaxy where <dir>=/etc/rc.d/rc4.d;
/etc/rc.d/rc1.d/K01Galaxy /etc/rc4.d ; /sbin/rc.d/rc4.d ; sbin/rc4.d ;
/etc/rc.d/rc2.d/K01Galaxy /etc/init.d/runlevels/%4 only if <dir> exists
/etc/rc.d/rc3.d/K01Galaxy <dir>/S99Galaxy where <dir>=/etc/rc.d/rc3.d;
/etc/rc.d/rc4.d/K01Galaxy /etc/rc3.d ; /sbin/rc.d/rc3.d ; sbin/rc3.d ;
/etc/rc.d/rc5.d/K01Galaxy /etc/init.d/runlevels/%3 only if <dir> exists (Linux only
/etc/rc.d/rc6.d/K01Galaxy except Ubuntu)
<dir>/S99Galaxy where <dir>=/etc/rc.d/rc5.d;
/etc/rc5.d ; /sbin/rc.d/rc5.d ; sbin/rc5.d ;
/etc/init.d/runlevels/%5 only if <dir> exists (Linux only
except Ubuntu)
<dir>/K99Galaxy where <dir>=/etc/rc.d/rc3.d;
/etc/rc3.d ; /sbin/rc.d/rc3.d ; sbin/rc3.d ;
/etc/init.d/runlevels/%3 only if <dir> exists (Linux only
except Ubuntu)
<dir>/K99Galaxy where <dir>=/etc/rc.d/rc5.d;
/etc/rc5.d ; /sbin/rc.d/rc5.d ; sbin/rc5.d ;
/etc/init.d/runlevels/%5 only if <dir> exists (Linux only
except Ubuntu)
<dir>/S99Galaxy where <dir>=/etc/rc.d/rc<n>.d;
/etc/rc<n>.d ; /sbin/rc.d/rc<n>.d ; sbin/rc<n>.d ;
/etc/init.d/runlevels/%<n> only if <dir> exists, where
<n> is the second field in line ?id:2:initdefault:? of
/etc/inittab
<dir>/K99Galaxy where <dir>=/etc/rc.d/rc<n>.d;
/etc/rc<n>.d ; /sbin/rc.d/rc<n>.d ; sbin/rc<n>.d ;
/etc/init.d/runlevels/%<n> only if <dir> exists, where
<n> is the second field in line ?id:2:initdefault:? of
/etc/inittab
Solaris /etc/CommVaultRegistry/Galaxy/InstanceXXX /etc/CommVaultRegistry/.global.lock Startup Scripts: <dir>/S99Galaxy where
/opt/commvault /etc/rc3.d/K99Galaxy <dir>=/etc/rc.d/rc<n>.d; /etc/rc<n>.d ;
/var/log/.gxsetup /etc/rc3.d/S99Galaxy /sbin/rc.d/rc<n>.d ; sbin/rc<n>.d ;
/var/log/commvault /etc/gxsetup_guid /etc/init.d/runlevels/%<n> only if <dir> exists, where
.gxupdate /usr/bin/cvpkgcheck <n> is the second field in line ?id:2:initdefault:? of
created in /usr/bin/cvpkgchg /etc/inittab for solaris 10+ if this did not exist in
/var/log/commvault/Log_Files/.gxsetup.$$ /usr/bin/cvpkgrm /etc/inittab then we use 3
during update install /usr/bin/detect <dir>/K99Galaxy where <dir>=/etc/rc.d/rc<n>.d;
archived in /var/log/.gxsetup after update /usr/bin/commvault /etc/rc<n>.d ; /sbin/rc.d/rc<n>.d ; sbin/rc<n>.d ;
install /etc/init.d/runlevels/%<n> only if <dir> exists, where
Folders created only when the OnePass <n> is the second field in line ?id:2:initdefault:? of
/etc/inittab for solaris 10+ if this did not exist in
5/6/2017 Commvault Systems Page 176 of 587
feature is enabled: /etc/inittab then we use 3
/dev/flr0
/dev/fsdm1
Macintosh /etc/CommVaultRegistry/Galaxy/InstanceXXX /usr/local/bin/commvault For Process Manager.app, symbolic link to:
/opt/commvault /usr/local/bin/cvpkgrm /opt/commvault/Base/Process Manager.app
/var/log/.gxsetup /usr/local/bin/cvpkgchg Startup Scripts:
/var/log/commvault /usr/local/bin/cvpkgcheck /Library/StartupItems/Galaxy/StartupParameters.plist
/Applications/Process Manager.app /usr/local/bin/detect (Mac OS X v10.7.x and Mac OS X v10.8.x only)
/Library/StartupItems/Galaxy /usr/local/bin/laptop2startup.$GALAXY_INST.command, /Library/StartupItems/Galaxy/Galaxy (Mac OS X
.gxupdate where GALAXY_INST = Instance001, Instance002, ? v10.7.x and Mac OS X v10.8.x only)
created in /Library/LaunchDaemons/com.commvault.galaxy.plist
/var/log/commvault/Log_Files/.gxsetup.$$
during update install
archived in /var/log/.gxsetup after update
install

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

Additional Files Created during Installations on Cluster Environments


In addition to the files and/or folders created during the installation of an agent, the following section describes additional modifications made when installing on a Veritas
cluster (VCS) environment.
Veritas Cluster
A new application called GxClusterPlugin_service_group_name is created in the Veritas cluster, and dependency links will be set up from this newly created application to all of
the resources in the group of type IP, mount point and disk group. This ensures that the plug-in is started after all of the other resources have come online or is stopped
before any other resource goes offline during failovers.
The plug-in must be able to read the main.cmd file, which is typically located under /etc/VRTSvcs/conf/config. If the file is not present, it will be created with the following
command:
hacf -cftocmd directory_path

After the command is ran, the main.cmd file is created with the same ownership as that of Commvault processes.

5/6/2017 Commvault Systems Page 177 of 587


Setting Read Permissions on AIX Clients
During the installation, the software assigns read permissions for other users (chmod o+r) on shared libraries and executables. "Other users" are those users that are not
part of the UNIX group.
On AIX clients, other users must have read permissions to ensure that Commvault services start without issues.
If you removed the read permissions during the installation, you can add it back by running a script.

Before You Begin


No jobs should be running on the AIX client. You have to restart the services for the changes to take effect.

Procedure
1. From the command prompt, go to the /usr/bin directory and run the following command:
cvpkgchg

2. To change access permissions, type 2 and press Enter.


3. Type d to confirm your selection and press Enter.
4. To allow read permissions to other users, type 4 and press Enter.
5. Type d to confirm your selection and press Enter.
6. To apply your changes, type yes to restart the Commvault services.

5/6/2017 Commvault Systems Page 178 of 587


Installing Commvault Tools
You can install Commvault tools by using the CommCell Console or the installation package that was created from the Download Manager application.

Before You Begin


Collect the information that is required during the installation. Refer to the preinstallation checklist of the tool that you want to install:
CommServe Failover
CommServe SNMP Enabler
External Data Connector
On Windows
On UNIX
MongoDB

Choose the Installation Method


Use one of the following methods to install the tools that you need:
Remote installations, where you use the CommCell Console to install the software remotely on one or more computers. Only supported for the External Data
Connector.
For instructions, see Installing Commvault Remotely Using the CommCell Console .
Local installations, where you use the installation package to install the software locally on a computer.
Based on your computer's operating system, see installing Commvault locally on Windows or UNIX .

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 .

5/6/2017 Commvault Systems Page 179 of 587


Preinstallation Checklist for CommServe Failover
CommServe Failover monitors the status of the active and passive CommServe hosts and allows you to fail over CommCell operations to the standby host when the
production CommServe host is down. For more information, see CommCell Disaster Recovery Failover .
Use this preinstallation checklist to prepare the computer where CommServe Failover 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 CommServe Failover satisfies the hardware requirements specified in System Requirements .
 Verify License Requirements
The CommServe Failover component does not require a license.
 Determine the Installation Location
Install the CommServe Failover on the following computers:
Production and standby CommServe hosts.
Make sure a SQL Server Agent is installed in a separate instance on the production and standby CommServe hosts. The CommServe Failover component must be
installed to the same instance as the SQL Server Agent. For information about installing the SQL Server agent, see SQL Server Agent Installation: Considerations for
Disaster Recovery Failover .
Individual Windows host acting as Witness Server in the standby CommServe location. You can also use an existing MediaAgent computer to act as the Witness
Server. If the MediaAgent computer is in the same location as the production CommServe computer, then install the failover component on a Windows host in the
standby CommServe location.
All the hosts with CommServe Failover must be able to communicate with each other using TCP/IP.
Login to the host computer as member of the Administrators group.
 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 CommServe Failover only by using the installation package that was created by the Download Manager.
Install Instance Selection
For CommServe hosts with multiple instances, select instance with SQL Server Agent (e.g. Instance002). Install Instance on the CommServe hosts must be the same as
that of the SQL Server Agent. Any/Default instance can be used for the Witness Servers.
Commvault package to install
Install the CommServe Failover package, which is listed under the Tools 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.
CommServe Name
If you are using DNS for the failover configuration, specify the floating CommServe host name. The production and standby CommServe hosts use the same floating
CommServe host name.

5/6/2017 Commvault Systems Page 180 of 587


Preinstallation Checklist for the CommServe SNMP Enabler
The CommServe SNMP Enabler sends alerts from the CommServe computer to other computers using the SNMP protocol. For more information, see Setting up Alerts and
Notifications - SNMP Traps .
Use this preinstallation checklist to prepare the computer where the SNMP Enabler will be installed and to gather all of the information you will need during the installation.
 Verify System Requirements
There are no minimum requirements for the SNMP Enabler.
 Verify License Requirements
The SNMP Enabler does not require a license.
 Determine the Installation Location
Install the SNMP Enabler on the CommServe computer. The SNMP Enabler cannot be installed on cluster environments.
 Install Windows SNMP Services
SNMP Services (a Windows Server feature) must be installed and running on the CommServe computer. The following SNMP protocols are supported:
SNMP Version 1 (SNMPv1)
SNMP Version 3 (SNMPv3)
 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 CommServe SNMP Enabler only by using the installation package that was created by the Download Manager.
Commvault package to install
Install the CommServe SNMP Enabler package, which is listed under the Tools category.
SNMP Traps
To add computer groups and trap destinations to the SNMP service, gather the following details:
Decide on a name for the group of computers that will receive the SNMP traps (also known as community name).
If trap destinations are required, collect the host name, IP or IPX address of the destination computers.

5/6/2017 Commvault Systems Page 181 of 587


Preinstallation Checklist for the External Data Connector on Windows
You can use the External Data Collector (EDC) to collect information from other product environments, and then merge the data into your CommCell. For more
information, see External Data Connector - Overview .
Use this preinstallation checklist to prepare the computer where EDC 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 EDC satisfies the minimum requirements, based on your environment:
External Data Connector - System Requirements - Backup Exec
External Data Connector - System Requirements - EMC Networker
External Data Connector - System Requirements - NetBackup
External Data Connector - System Requirements - Tivoli Storage Manager
External Data Connector - System Requirements - Veeam
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use EDC. For more information, see
License Requirements - External Data Connector .
 Determine the Installation Location
Install the software on a server hosting third party software, such as NetBackup Master Server, EMC Networker Server, Tivoli Storage Manager Server, and BackupExec
Server, to merge all information about them into the CommServe database.
The computer will be added as a client in the CommCell as soon as the installation completes successfully.
 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 CommServe package only by using the installation package created by the Download Manager.
Commvault package to install
Install the External Data Connector package, which is listed under the Tools category.
If the File System Agent is not installed on the computer, the File System Core package is 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 .
Only the following items are required during installation.
Destination folder for the software installation
CommServe host name
Client computer details
Client groups
Subclient policy and storage policy

5/6/2017 Commvault Systems Page 182 of 587


Preinstallation Checklist for the External Data Connector on UNIX
You can use the External Data Collector (EDC) to collect information from other product environments, and then merge the data into your CommCell. For more
information, see External Data Connector - Overview .
Use this preinstallation checklist to prepare the computer where EDC 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 EDC satisfies the minimum requirements, based on your environment:
External Data Connector - System Requirements - EMC Networker
External Data Connector - System Requirements - NetBackup
External Data Connector - System Requirements - Tivoli Storage Manager
 Verify License Requirements
Based on the licensing mechanism used in your CommCell environment, verify that the CommCell has the required licenses to use EDC. For more information, see
License Requirements - External Data Connector .
 Determine the Installation Location
Install the software on a server hosting third party software, such as NetBackup Master Server, EMC Networker Server, Tivoli Storage Manager Server, and BackupExec
Server, to merge all information about them into the CommServe database.
The computer will be added as a client in the CommCell as soon as the installation completes successfully.
 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 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
For installations using the CommCell Console, install the External Data Connector package, which is listed under the Tools category.
For installations using the installation package, install the External Data Connector package.
If the File System Agent is not installed on the computer, the File System Core package is 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 .
Only the following items are required during installation.
Installation directory
Client computer details
Log directory
UNIX group
Access Permissions for the UNIX group and other computer users
CommServe host name

5/6/2017 Commvault Systems Page 183 of 587


Preinstallation Checklist for MongoDB
MongoDB is a third-party software used by the Web Console to add and reply to comments on files and folders in your Edge Drive.
Use this preinstallation checklist to prepare the computer where MongoDB will be installed and to gather all of the information you will need during the installation.
 Verify System Requirements
MongoDB supports the same operating systems as the CommServe software. To review the operating systems, see System Requirements - CommServe .
 Verify License Requirements
MongoDB does not require a license.
 Determine the Installation Location
Install MongoDB on the CommServe computer.
Note: Commvault does not support MongoDB installations when the CommServe software is installed on a cluster environment.
 Supported MongoDB Versions
The Commvault software is bundled with MongoDB Enterprise 3.0.2.
Commvault supports MongoDB Enterprise 3.0 or later versions. If you have an older version, you must update the software manually. Make sure to stop the
Commvault MongoDb service before installing the service pack or updates.
 Gather Installation Data
During the installation, you must select the MongoDB package that is listed under the Tools category.
You can install MongoDB only by using the installation package that was created by the Download Manager.

5/6/2017 Commvault Systems Page 184 of 587


Installation Methods
You can install the Commvault software in your environment by using one of the following methods:
Using the CommCell Console
This method is available if the CommServe cache directory was configured with the required Commvault software.
This method, also known as remote installation, is one of the commonly used methods to install the software. For instructions, see Installing Commvault Remotely
Using the CommCell Console .
Using the Installation Package
This method is available if an installation package was created from the Download Manager and published through a network share or DVD.
Installing Commvault locally on a computer is one of the most common ways to install the software by using the installation package. For instructions, see the
installation steps on Windows or UNIX computers.
For more information on the ways you can use the installation package, see Installations Using the Installation Package .
Using the Download Manager
This method is available if you have access to the latest Download Manager application. This method is useful if your CommServe computer does not have Internet
connectivity and you cannot perform installations from the CommCell Console.
For more information, see Installations Using the Download Manager .

5/6/2017 Commvault Systems Page 185 of 587


Installations Using the CommCell Console (Remote Installations)
Use the CommCell Console to remotely install agents and other Commvault software on one or more computers. Installations from the CommCell Console are known as
remote installations.
When you perform a remote installation, the CommServe sends the software to each of the selected computers, and then silently installs the software in parallel.
To perform remote installations, the Commvault software must be available in the CommServe cache directory. If the software is not available, it is automatically
downloaded during the remote installation.
Remote installations are useful in the following scenarios:
You want to install the software simultaneously on multiple computers without the need to physically log on to the computers. This applies to large data centers or
distributed WAN environments.
You want to schedule the installation to run at a specified date and time.
For instructions, see Installing Commvault Remotely Using the CommCell Console .
For those clients with third-party applications (such as Oracle), you can configure the CommCell Console to install the Commvault software automatically based on the
application that is installed on the client. For instructions, see Installing Commvault By Enabling Automatic Detection of Applications Installed on Clients .

5/6/2017 Commvault Systems Page 186 of 587


Prerequisites for Installations Using the CommCell Console
Before you perform a remote installation, make sure to review the following prerequisites:
Download the Software
Verify User Permissions
Review Considerations for Client Computers
Review Firewall and Network Port Requirements
Review Space Requirements for Client Computers

Download the Software


To perform remote installations, the Commvault software must be available in the CommServe cache directory.
If the CommServe computer has Internet connectivity, no action is required. The Commvault software is automatically downloaded to the CommServe cache as part of
the installation job.
If the CommServe computer has Internet connectivity with restrictions, or if there is no internet connectivity, you can adjust the download settings in the CommCell
Console. For more information, see Configure Download Settings in the CommCell Console .
If the CommServe computer does not have internet connectivity, and the download settings do not satisfy your requirements, create a new installation package with all
the software needed by your organization, and then copy the package to the CommServe cache. For instructions, see the download software procedure for Windows
and UNIX computers.

Verify User Permissions


To perform remote installations, you must be a CommCell user with the right set of permissions:
To install on existing clients, the user must have Install Package/Update permissions on the clients where the software will be installed.
To install on new clients, the user must have Install Client permissions at the CommCell level.
To install on the CommServe computer, the user must have Administrative Management permissions at the CommCell level. Do not add non-administrators to
an administrative user group.
For information on assigning user permissions, see Associating Entities and Roles to a User .
If the Authentication for Agent Installs feature is enabled, users must have Install Client permissions at the CommCell level.
For UNIX client computers, SSH must be enabled, and the PermitRootLogins entry in the sshd_config file must be set to yes.

Review Considerations for Client Computers


For installations on Windows computers, the Remote Registry service must be enabled and configured to automatically start during the computer startup.
For installations on UNIX computers that reside in a PowerBroker? environment, you need to configure a few settings. For more information, see Configuring
PowerBroker Environments for Installations Using the CommCell Console .
For installations on EDC Discovered clients or virtual machines, you must configure the CommCell Browser to display these type of clients by completing the following
steps:
a. From the CommCell Console ribbon, on the Home tab, click Control Panel, and then click User Preferences.
b. In the User Preferences dialog box, click the Client Computer Filter tab, and select the check boxes corresponding to EDC clients or virtual machines.

Review Firewall and Network Port Requirements


If you are installing the software on existing clients, you do not need to open additional network ports.
For new clients, you must open the following network ports to install the software remotely from the CommCell Console.
Note: All the network ports listed in this section are inbound ports.
For UNIX, Linux, and Macintosh computers, you must enable SSH (Secure Shell) and open port 22.
If you have a Solaris 11 computer, you must also set the cipher as follows:
a. Run the following command to stop SSH:
svcadm disable ssh

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

Review Space Requirements for Client Computers


During the installation, the disk space used on the client computers might vary depending on the agents that you plan to install.
The following table displays the approximate disk space required to install or upgrade agents on Windows and UNIX client computers.
Important: The space values provided in the table do not include the disk space used by the installation files that are copied to the client. Therefore, make sure to always
have additional disk space available on the client.
Package Windows UNIX
File System Core (Laptop package) 500 MB 500 MB

File System Agent 1250 MB 1050 MB


MediaAgent 1350 MB 1250 MB
Other Agents 1550 MB 1550 MB

5/6/2017 Commvault Systems Page 188 of 587


Installing Commvault Remotely Using the CommCell Console
You can install agents and other Commvault software on remote computers by using the CommCell Console.
If the Commvault software is not available in the CommServe cache directory, the software is automatically downloaded during the remote installation job.
Note: For installations on UNIX computers, the CommCell Console supports root, non-root, and SUDO users.

Before You Begin


Review the Installation Support page to verify whether the software can be installed from the CommCell Console.
Review the prerequisites to enable installations from the CommCell Console. For more information, see Prerequisites for Installations Using the CommCell Console .
Prepare your environment and gather the information that you must provide during the installation:
For those server packages that support remote installations, go to Other Server Packages , select the package that you want to install, and on the installation
procedure, see the Before You Begin section.
For MediaAgents, see Plan the MediaAgent Installation and the preinstallation checklist on Windows or UNIX .
For agents, see the installation planning on Windows or UNIX, Linux, and Macintosh , and then see Preinstallation Checklist for Clients .
For tools, see the Before You Begin section in Installing Commvault Tools .
Determine whether you want to save the selections that you make during the installation in a script so that you can run it later from the command-line interface.
If you plan to use SSH keys to authenticate logon attempts on UNIX computers, you must create an SSH key pair (private and public keys) and store the key files as
follows:
The private key file must be on the CommServe computer or on a location that is accessible by the CommServe computer.
The public key file must be on each of the UNIX computers where you plan to install the Commvault software.
Important: SSH keys are only supported in PuTTY format. If you have OpenSSH keys, you can use PuTTYgen to convert the keys to PuTTY format.

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 .

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 that you plan to install the software 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 Installation Script from the Command Line .

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 .

5/6/2017 Commvault Systems Page 189 of 587


Running the Remote Installation Script from the Command Line
You can run remote installations from the command line by using the .xml file that was created when you saved the installation in a script. The .xml file contains the
selections you made during the installation.
Saving the remote installation in a script is useful in the following scenarios:
You want to run the installation at a later time.
You want to save your installation selections if you must reinstall the software due to a hardware failure.
You might have a batch script with a set of administrative tasks, and you want to define the installation task in the batch script (by calling the .xml).

Before You Begin


You must have saved the installation as a script. For instructions, see Installing Commvault Remotely Using the CommCell Console .

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

3. To run the script (.xml file), type the following command:


qoperation execute -af Path_to_XML_File

4. To log off of the CommServe database, type the following command:


qlogout

5/6/2017 Commvault Systems Page 190 of 587


Selecting Computers from a Directory Service During Remote Installations
When you perform installations from the CommCell Console, you can install the software on computers that are part of the following directory services:
Windows Active Directory
Network Information Service (NIS)
Open LDAP
During the installation, you can select computers from more than one directory service.

Before You Begin


The installation wizard in the CommCell Console must be open on the Select how to discover the computers for installing the software page.

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

5/6/2017 Commvault Systems Page 191 of 587


Configuring PowerBroker Environments for Installations Using the CommCell
Console
If a UNIX computer is in an environment that uses PowerBroker? servers for root access control, you must configure a few settings before you install the Commvault
software on the UNIX computer.

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

Step 2: Configure an additional setting on the CommServe computer.


Configure the sCmdToExecForNonRootUsers additional setting to enable remote installations for non-root users.
1. Log on to the CommCell Console.
2. From the CommCell Browser, right-click the CommServe node and click Properties.
3. In the CommCell Properties dialog box, on the Additional Settings tab, click Add.
4. In the Add Additional Settings on Windows Client dialog box, complete the following steps:
a. In the Name box, type sCmdToExecForNonRootUsers.
The Category and Type details fill automatically.
b. In the Value box, specify the full path for the pbrun command. For example:
/usr/local/bin/pbrun -u root
c. Click OK.
5. Click OK to close the properties dialog box.
You can now perform remote installations on UNIX computers.

5/6/2017 Commvault Systems Page 192 of 587


Configuring the Timeout Interval for Installations Using the CommCell Console
The default timeout for installations performed from the CommCell Console is 120 minutes. If after two hours the installation job does not finish, the job stops running.
To change the timeout interval, configure the nPushInstallTimeoutInMin additional setting on the CommServe computer. This configuration is useful if, for example, you
need to increase the timeout interval to give the installation job more time to finish in the following scenarios:
The network in the CommCell environment is very slow.
You are installing the software on many computers.
For example, if your installation job stops and the software was not installed on all the computers, you should configure the additional setting to increase the timeout.

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

5/6/2017 Commvault Systems Page 193 of 587


Installing Commvault by Automatically Detecting the Applications Installed on
Clients
When you use Commvault to protect your data, and you install a third-party application on a client, you must install the Commvault software package for that application
on the client. This can be a labor intensive process for backup administrators because they have to maintain close communication with application and system
administrators to make sure that all applications are protected.
In the following situations, configure the Commvault software to automatically detect the installed client third-party applications and optionally install the Commvault
software package:
You want to simplify application agent deployment in an enterprise environment.
You have a managed service provider (MSP) environment.
You plan to add additional third-party applications after you install the Commvault software.
You plan to refresh the hardware.
You can enable this feature for a client or client group. When you enable this feature, every 24 hours, the software checks each client and client group member for the
third-party applications that are listed in the following table.
Application Linux or UNIX configurations Windows configurations
Active Directory N/A Yes
DB2 Yes Yes
Microsoft Exchange Database N/A Yes
Microsoft SQL Server N/A Yes
MySQL Yes Yes
Oracle Yes Yes
PostgreSQL Yes Yes
Sybase Yes Yes

Before You Begin


1. Install the File System core package on all clients that need to have applications automatically detected.
2. Create a client group for the clients. For more information, see Creating a Client Computer Group .

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.

5/6/2017 Commvault Systems Page 194 of 587


Running the Installing Automatically Discovered Applications Workflow
When you enable the application-aware installations, the software detects third-party applications that are installed on the client in the past 24 hours.
After the software detects the third-party applications, run the predefined workflow to 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.
You can schedule the workflow, or manually execute the workflow from the CommCell Console.

How Does It Work?


The predefined workflow automates the following operations:
Installing the Commvault package for the third-party application if it does not exist on the client.
Configuring the client on the CommServe computer.
Registering 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
MySQL MySQL
Oracle Oracle
PostgreSQL PostgreSQL
Sybase Sybase

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 .

5/6/2017 Commvault Systems Page 195 of 587


Installations Using the Installation Package
Use one of the following methods to deploy the Commvault software on your environment by using the installation package.
Install Locally on a Computer
You can install the Commvault software interactively on a computer. For more information, see Local Installations .
Install on Multiple Computers
You can install a base package on all the computers that you want to protect, and then perform the necessary configurations from the CommCell Console. For more
information, see Installing Commvault on All the Computers Across Your Organization .
To review other installation options to deploy the Commvault software, see Additional Installations Operations Using the Installation Package .

5/6/2017 Commvault Systems Page 196 of 587


Local Installation
You can interactively install agents and other Commvault software on a computer. This type of installation is known as local installation, because you directly install the
software on a computer.
During installation, you can choose to configure and register the computer at a later time.
Based on your computer's operating system, see the following instructions:
Installing Commvault Locally on Windows Computers Using the Installation Package
Installing Commvault Locally on UNIX, Linux, and Macintosh Computers Using the Installation Package

5/6/2017 Commvault Systems Page 197 of 587


Installing Commvault Locally on Windows Computers Using the Installation
Package
You can install agents and other Commvault software by using the installation package that was created from the Download Manager application.
Note: For the CommServe installation, see Installing the CommServe Software . To install other server packages, go to Other Server Packages and select the package
that you want to install.

Before You Begin


Verify that the installation package that was created from the Download Manager includes the software that you want to install. If some of the software is missing,
create a new installation package and include the required software. For instructions, see Downloading Software for Windows Computers Using the Download Manager
.
Prepare your environment and gather the information that you must provide during the installation:
For MediaAgents, see Plan the MediaAgent Installation and Preinstallation Checklist for the MediaAgent on Windows .
For agents, see Plan the Installation on Windows Computers and Preinstallation Checklist for Clients .
For tools, see the Before You Begin section in Installing Commvault Tools .

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 .

5/6/2017 Commvault Systems Page 198 of 587


Installing Commvault Locally on UNIX, Linux, and Macintosh Computers Using
the Installation Package
You can install agents and other Commvault software by using the installation package that was created from the Download Manager application.
If installing on a clustered environment, install the software on all the physical nodes of the cluster.
Note: For 1-Touch installations, see Installing the 1-Touch Server .

Before You Begin


Verify that the installation package that was created from the Download Manager includes the software that you want to install. If some of the software is missing,
create a new installation package and include the required software. For instructions, see Downloading Software for UNIX, Linux, and Macintosh Computers Using the
Download Manager .
Prepare your environment and gather the information that you must provide during the installation:
For CommCell Console installations, see the Before You Begin section in Installing the CommCell Console .
For MediaAgents, see Plan the MediaAgent Installation and Preinstallation Checklist for the MediaAgent on UNIX .
For agents, see Plan the Installation on UNIX, Linux, and Macintosh Computers and Preinstallation Checklist for Clients .
For tools, see the Before You Begin section in Installing Commvault Tools .
If the installation package was distributed as a DVD, make sure to mount the DVD.
Important: On AIX 6.1 (or later) computers, if the installation package was converted to an ISO image file, do not use the loopmount command to mount the ISO.
Instead, use one of the following solutions:
Install the software by using the CommCell Console.
Mount the ISO on a Linux computer and then export the NFS share to the AIX computer.
Create a custom package, and copy it to the local disk on the AIX computer.

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

3. On the welcome page, click Next.


4. On the Install Task page, select Install packages on this machine and click Next.
5. Follow the instructions in the installation wizard.
If you want to install Commvault in decoupled mode, where the client does not establish connections with the CommServe computer, complete the following steps:
a. When you reach the CommServe Host Name page, do not specify the host name, and click Next.
b. On the Decoupled Install page, select Yes and click Next.
Notes:
If you are installing the software in a cluster environment, repeat the installation procedure for each physical node on the cluster.
If you installed the software in decoupled mode, remember to register the client with the CommServe computer.

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 .

5/6/2017 Commvault Systems Page 199 of 587


Installing Commvault on All Computers Across Your Organization
One of the most efficient ways to distribute the Commvault software in your organization is to install a base package on the computers that you want to protect.
After the package is installed and the computers are part of your CommCell environment, you can perform the necessary configurations from the CommCell Console, such
as installing the required Commvault agents.
This installation method is recommended for managed service providers (MSP) and for those who want to deploy the Commvault software efficiently on multiple
computers.

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 .

5/6/2017 Commvault Systems Page 200 of 587


Additional Installations Operations Using the Installation Package
The installation package offers a variety of installation options to help you deploy the Commvault software on your environment.
The following list describes additional operations that you can perform using the installation package.
Create a Custom Package
Create a custom installation package with the agents and configurations that your environment needs. For more information, see Custom Packages .
Create a Solaris IPS Package
Create IPS packages for Solaris environments that use a network based package management system. For more information, see Solaris IPS Packages .
Run Unattended Installations
Install the software silently on a computer using an answer file. For more information, see Unattended Installations .
The following list describes advanced operations for specific deployment scenarios:
Preinstall Commvault as a Software Image
If you want to install the Commvault software on computers that will be distributed to different organizations or CommCell environments, see Preinstall Commvault as
a Software Image .

5/6/2017 Commvault Systems Page 201 of 587


Custom Packages
You can create a customized installation package, commonly known as custom package, based on the agents and options that you select in the installation wizard.
When the custom package is deployed on a computer, the package installs the software based on your selections, reducing user interaction. The extent of user interaction
depends on the amount of information you want the user to enter during installation.
Custom packages are useful if you need to deploy the same agents and configurations across multiple computers. You can adjust custom packages to your environment
requirements. For example:
To protect all laptop computers in your organization, you can configure the custom package as a laptop package.
To protect UNIX computers operated by native package management systems, you can configure the custom package as a native package.

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

5/6/2017 Commvault Systems Page 202 of 587


Creating a Base Package Using the Cloud Services Website
Applies To: Windows and Macintosh
From the Cloud Services website, you can create a base package to add new client and proxy computers to your CommCell environment. The base package contains the File
System Agent, which establishes connections between the client computer and the CommServe database.

Before You Begin


Obtain a user account for the Cloud Services website. See Getting Access to the Cloud Services Website .

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.

5/6/2017 Commvault Systems Page 204 of 587


Creating a Custom Package for Windows Computers Using the Installation
Package
You can create a custom package with the agents and options required for your Windows computers.

Before You Begin


Obtain the installation package that was created from the Download Manager and distributed across your organization. You need the installation package to create a
custom package.
If the installation package is not available, you can create one by using the steps in Downloading Software for Windows Computers Using the Download Manager .
Tip: You can also create a custom package directly from the Download Manager. For instructions, see Creating a Custom Package for Windows Computers Using the
Download Manager .
Collect the information required during the custom package creation. For more information, see Planning for the Custom Package Creation on Windows Computers .

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 .

5/6/2017 Commvault Systems Page 205 of 587


Planning for the Custom Package Creation on Windows Computers
Before you run the installation wizard, you must collect the information that is required during the custom package creation.
Use the following checklist before creating the custom package. Record the information so you can refer to it during the package creation.
Note: You can make certain options available to users during the package installation. The options that can be made available have the Display to User note. To install the
package with minimal user interaction, provide all the necessary information during the package creation.
 Determine the type of Windows processor
On the computers where you plan to install the custom package, determine whether the computers use a 32-bit or 64-bit processor. You can configure the custom
package to support 32-bit and 64-bit binaries.
 Select the Commvault instance
Determine which instance should the custom package use during installation. You can configure the package to use an existing instance or to create a new one.
If you select an existing instance, the instance must exist on the computers where you plan to install the package.
Note: During the package installation, if the selected instance is not detected, the package creates the instance and then installs the software on the new instance.
If you create a new instance, the package installs the software on a new instance, irrespective of the existence of other instances on the computers.
Display to User: Users can select the instance during the custom package installation.
 Determine the custom package directory
By default, the custom package is created in C:\CustomInstallPackageName.
You can change the location where the folder resides. If the folder you plan to use does not exist, it is automatically created during the package creation.
 Decide which agents to include in the custom package
Determine the data that you want to protect in your organization. For example, if you want to protect Microsoft SQL databases, you need to include the SQL Server
Agent in the custom package.
Display to User: Users can select the agents to install during the custom package installation. The agents displayed to the users will be based on the agents you
selected. If you want the package to install the agents automatically, do not display the agents to users.
 Decide which custom package options to set
The installation wizard provides a set of advanced options to configure the custom package. The following table provides information about each option.
Note: Notify users about the type of configurations that you plan to use for the package. For example, if you configure the package for decoupled installation, the client
must be registered with the CommServe after the installation.
Option Description When to use the option
Include MS SQL Server Adds the Microsoft SQL Server software to the custom You included server packages to the custom package, such as the
package. Web Server and Workflow Engine.
Server packages use the SQL Server to create database instances,
which coordinate the server operations within the CommCell
environment.
Include .NET Framework 4.0 Installer If any of the agents that you selected requires .NET The computers where you plan to install the custom package do
Framework 4.0, the installation wizard automatically adds not have .NET Framework 4.0 installed.
the .NET software to the custom package.
Create self-extracting executable Creates the custom package as a self-extracting You can use this option in the following scenarios:
executable file, which automatically starts the installation To simplify the installation for end-users, as they only need to
when the file is run. run the executable file to start the installation.
To easily upload the executable file to a site for the end-user
to retrieve.
You can also run the executable file in silent mode.
Save user answers in the custom Creates an answer file, which stores the selections that You can use this option in the following scenarios:
package you make during the custom package creation. You want to customize the package with specific options that
If you choose not to save your selections, the package satisfy your environment requirements.
uses the default installation settings for all CommCell You want to enable users to make their own selections during
and agent specific options. Also, you cannot configure the package installation. To accomplish this, you must display
the package to display the options to users during the the options that you want users to answer.
installation. You want to perform unattended installations by using the
answer file. To accomplish this, you must provide the
answers for all the options, and must not display options to
users.
Tip: As a security measure, if the CommCell is configured to
authenticate client installations, do not provide your user
account during the custom package creation. The account
information will be recorded in the answer file.
Instead, create a separate CommCell user with the required
permissions so that it can be used during the package creation.
If you choose to save user answers in the custom package, the following options become available:
Option Description When to use the option
Create answer file (without packages) Creates the custom package with only the answer file, You can use this option in the following scenarios:
which stores the selections that you make during the You want to create a sample answer file which you can later
custom package creation. edit with your preferences.
No other files are included in the package, such as You already created a custom package, and you want to
binaries, updates and executables. generate a new answer file with different selections.
Remember: To install the software using the answer file, you
must have an installation package or a separate custom package
with the software you selected.
Create a de-coupled installation package Configures the custom package to skip the client You can use this option in the following scenarios:
registration with the CommServe computer. You want to install the package on computers that do not
During the installation, the client will not establish any have open connections with the CommServe computer.
5/6/2017 Commvault Systems Page 206 of 587
connections with the CommServe computer. You want to preinstall the software as part of the computer's
Remember: The client must be registered after the factory settings. This is useful if you want to ship the
installation. computers to users as a software appliance.
The option is not supported in the following scenarios:
If the computer where you want to install the package is in a
clustered environment.
If you included the CommServe, Web server, Web Console, or
Search Engine in the custom package.
Launch RegisterMe at the end of install Opens the Register Me application automatically at the You want to register the client immediately after the package
end of the custom package installation. installation. This option is automatically selected when you select
This application helps you register the client, on which Create a de-coupled installation package.
you installed the package, with the CommServe If you plan to register the client at a later time, do not use this
computer. option.
Repair if existing instance found Repairs existing installations of the Commvault software. You can use this option to solve the following issues on client
Requirements: computers:
The software that you include in the custom package Registry corruption
must match the software that is installed on the The custom package recreates missing or deleted Commvault
client to be fixed. registries while preserving the existing ones.
The CommServe name that you specify in the custom Service corruption
package must match the CommServe name The custom package reconfigures Commvault services that
configured in the client to be fixed. were deleted or that were not configured properly.
Installation file corruption
The custom package recreates missing or corrupt installation
files.

 Gather installation data for CommCell options


This information is applicable only if you plan to save your answers (or selections) during the custom package creation.
During package creation, the installation wizard requests information related to the CommCell environment, which includes the following items:
CommServe name
Note: If you configure the custom package to install the software in decoupled mode, the package will not communicate with the CommServe computer during the
installation.
Client groups
Configure for laptop backup (applicable if only the File System Core is selected)
Destination folder for the software installation
Firewall services
Important: To configure firewall settings during the custom package creation, the computer where you create the package must have a Commvault instance
installed with direct communication or proper firewall settings to communicate with the CommServe computer.
Subclient and storage policy
Windows Firewall for Computer Profiles
For more information on the above items, see the Gather Installation Data section in Preinstallation Checklist for the Windows File System Agent .
Display to User: Users can select CommCell options during the custom package installation.
 Gather installation data for agent specific options
This information is applicable only if you plan to save your answers (or selections) during the custom package creation.
During package creation, the installation wizard requests additional information for some of the agents that you chose to include in the custom package.
To gather the data, go to Preinstallation Checklist for Clients and select the preinstallation checklist page for your agents. Then, on the preinstallation checklist page,
read the Gather Installation Data section. If you only see information related to the package name and client computer details, then no additional information is
required for the agent.
Display to User: Users can select agent specific options during the custom package installation.

5/6/2017 Commvault Systems Page 207 of 587


Creating a Custom Package for UNIX, Linux, and Macintosh Computers
You can create a custom package with the agents and options required for your UNIX, Linux, and Macintosh computers.

Before You Begin


Obtain the installation package that was created from the Download Manager and distributed across your organization. You need the installation package to create a
custom package.
If the installation package is not available, you can create one by using the steps in Downloading Software for UNIX, Linux, and Macintosh Computers Using the
Download Manager .
Collect the information required during the custom package creation. For more information, see Planning for the Custom Package Creation on UNIX, Linux, and
Macintosh Computers .

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

3. On the welcome page, click Next.


4. On the Install Task page, select Create custom package and click Next.
5. On the Custom Package Type page, choose the type of package that you want to create:
General Package
If you want to create a package using Commvault's package management system, select General Package only.
Native Package
If you have computers that only accept native packages, select the native package that you want to create.
Follow the instructions in the installation wizard.
Remember: 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?
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).

5/6/2017 Commvault Systems Page 208 of 587


Planning for the Custom Package Creation on UNIX, Linux, and Macintosh
Computers
Before you run the installation wizard, you must collect the information that is required during the custom package creation.
Use the following checklist before creating the custom package. Record the information so you can refer to it during the package creation.
Note: You can make certain options available to users during the package installation. The options that can be made available have the Display to User note. To install the
package with minimal user interaction, provide all the necessary information during the package creation.
 Determine the type of custom package that you need
There are two main types of custom packages: general and native packages.
General custom packages are created using Commvault's package management system. These packages are supported on most UNIX operating systems.
Native packages are created using native package managers, such as the RPM package manager. These packages are supported on specific UNIX operating systems.
Determine whether the computers in your environment enforce native packages.
Use the following table to see the UNIX operating systems that are supported for each type of custom package:
Type of Custom Package Supported UNIX Operating Systems Requirements
General package AIX PPC None
Darwin x86 (Macintosh)
FreeBSD 7 on x86 and x64
HP-UX IA64
Linux x86, x64, PPC64, and s390
Solaris 10 on x64 and SPARC
APT native package Linux x86, x64, PPC64, and s390 None
HP-UX native package HP-UX IA64 If you create the package as a non-root user, the computer administrator must
grant you permissions to access the native package directory (/opt) during the
package creation. To grant permissions, the administration must run the following
commands:
User setacl ?u:non_root_user_name:rwx /opt

Group setacl ?g:non_root_user_group_name:rwx /opt

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

Group setfacl ?m g:non_root_user_group_name:rwx /opt

Solaris native package Solaris 10 on x64 and SPARC None

 Select the Commvault instance


Determine which instance should the custom package use during installation. You can configure the package to use an existing instance or to create a new one.
If you select an existing instance, the instance must exist on the computers where you plan to install the package.
During the package installation, if the selected instance is not detected, the package creates the instance and then installs the software on the new instance.
If you create a new instance, the package installs the software on a new instance, irrespective of the existence of other instances on the computers.
Display to User: Users can select the instance during the custom package installation.
 Determine the custom package directory
By default, the custom package is created in the /opt directory. The custom package files, such as general and native packages, are saved in /opt/UnixCustomPackage.
You can choose a different directory. For example, if you choose the /tmp directory, the custom package files are saved in /tmp/UnixCustomPackage.
 Decide which agents to include in the custom package
Determine the data that you want to protect in your organization. For example, if you want to protect Oracle databases, you need to include the Oracle Agent in the
custom package.
Display to User: Users can select the agents to install during the custom package installation. The agents displayed to the users will be based on the agents you
selected. If you want the package to install the agents automatically, do not display the agents to users.
 Decide whether to record your installation selections
Use the following table to help you determine the approach that you want to take during the package creation:
Approach How does the package behave? When to use this approach?
Do not record your The package uses the default installation settings for all You want to create a package with the default installation settings.
5/6/2017 Commvault Systems Page 209 of 587
selections CommCell and agent options. The package is also This is useful if the computers where you plan to install the package do not
configured to install the software in decoupled mode. require special configurations.
You cannot configure the package to display the
installation options to users during the installation.
Record your selections The package records the selections that you make for You want to customize the package with specific options to meet your
one or more CommCell and agent options. Your environment requirements.
selections are saved in an answer file. You want users to make their own selections during the package
You can configure the package to display one or more installation. To accomplish this, you must display the options that you
options to users during the installation. want users to answer.
You want users to install the package silently. To accomplish this, you
must provide the answers for all the options, and you must not display
the options to the users.
Users can also edit the answer file to customize the installation.
Tip: As a security measure, if the CommCell is configured to authenticate
client installations, do not provide your user account during the custom
package creation. The account information will be recorded in the answer file.
Instead, create a separate CommCell user with the required permissions so
that it can be used during the package creation.

 Decide whether to create a decoupled package


This information is applicable only if you plan to record your installation selections.
You can configure the custom package to install the software in decoupled mode. During the package installation, the client will not establish any connections with the
CommServe computer. Therefore, the client will not be registered with the CommServe computer. The client must be registered after the installation.
To configure the package for decoupled installations, you must not provide the CommServe details during the package creation. This is useful in the following
scenarios:
To install the package on computers that do not have open connections with the CommServe computer.
To preinstall the software as part of the computer's factory settings. This is useful if you want to ship the computers to users as a software appliance.
If the computer where you want to install the package is in a clustered environment, do not configure the package for decoupled installations.
 Gather installation data for CommCell options
This information is applicable only if you plan to record your installation selections.
During package creation, the installation wizard requests information related to the CommCell environment, which includes the following items:
CommServe name
Note: If you configure the custom package to install the software in decoupled mode, the package will not communicate with the CommServe computer during the
installation.
Client groups
Configure for laptop backup (applicable if only the File System Core is selected)
Firewall services
Important: To configure firewall settings during the custom package creation, the computer where you create the package must have a Commvault instance
installed with direct communication or proper firewall settings to communicate with the CommServe computer.
Installation directory for the software installation (applicable only to general packages)
Log directory
Subclient and storage policy
UNIX group and access permissions
For more information on the above items, see the Gather Installation Data section in Preinstallation Checklist for the UNIX, Linux, and Macintosh File System Agent .
Display to User: Users can select CommCell options during the custom package installation.
 Gather installation data for agent specific options
This information is applicable only if you plan to save your answers (or selections) during the custom package creation.
During package creation, the installation wizard requests additional information for some of the agents that you chose to include in the custom package.
To gather the data, go to Preinstallation Checklist for Clients and select the preinstallation checklist page for your agents. Then, on the preinstallation checklist page,
read the Gather Installation Data section. If you only see information related to the package name and client computer details, then no additional information is
required for the agent.
Display to User: Users can select agent specific options during the custom package installation.

5/6/2017 Commvault Systems Page 210 of 587


Installing the Custom Package on Windows Computers
You can install a custom package by running the setup application that is included in the package contents.
This procedure is useful if the package was configured to prompt for user input during the installation.
Note: If the custom package is a self-extracting executable file, see Installing a Windows Custom Package Configured as a Self-Extracting Executable File .

Before You Begin


Obtain the custom package from the location specified by the user who created it.
If the package is in the Download Center, see Downloading a Software Package in Download Center - Web Console .
Based on the agents that are included in the custom package, verify that the computer on which you want to install the package satisfies the minimum requirements
specified in System Requirements .
If the custom package requires user input during the installation, but you did not create the package, the user who created the package will provide you with the
necessary information to prepare for the installation.
If you have a 64-bit Windows computer and you need to protect 32-bit applications, you must configure a registry key to enable 32-bit agent installations. For more
information, see the Alternate Method in Enabling 32-Bit Installations on 64-Bit Windows Computers .

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

5/6/2017 Commvault Systems Page 211 of 587


Installing the Custom Package on UNIX, Linux, and Macintosh Computers
You can install the custom package in interactive mode. This is useful if the package was configured to prompt for user input during the installation.
Note: The custom package includes a general package, and might also include native packages. Interactive installations apply only to general packages. If you want to install
a native package, see Installing UNIX Native Packages .

Before You Begin


Obtain the custom package from the location specified by the user who created it.
If the package is in the Download Center, see Downloading a Software Package in Download Center - Web Console .
Based on the agents that are included in the custom package, verify that the computer on which you want to install the package satisfies the minimum requirements
specified in System Requirements .
If the custom package requires user input during the installation, but you did not create the package, the user who created the package will provide you with the
necessary information to prepare for the installation.
If you have a 64-bit Linux computer and you want to protect 32-bit applications, you must create a lock file to enable 32-bit agent installations. For instructions, see the
Alternate Method in Enabling 32-Bit Installations on 64-Bit Linux Computers .

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

5/6/2017 Commvault Systems Page 212 of 587


Installing the Custom Package on Windows Computers Using the Answer File
You can install the custom package in silent mode by using the answer file, rather than by using the installation wizard. The answer file is the .xml file that contains the
parameters and values that were selected during the custom package creation and is included in the package.
Installations in silent mode are also known as unattended installations.
Note: If the custom package was configured to prompt for user input, the installation in silent mode skips the installation prompts and uses the default installation
settings. To interact with the installation prompts, install the package by running the setup application. For instructions, see Installing the Custom Package on Windows
Computers .

Before You Begin


Obtain the custom package from the location specified by the user who created it.
If the package is in the Download Center, see Downloading a Software Package in Download Center - Web Console .
Based on the agents that are included in the custom package, verify that the computer on which you want to install the package satisfies the minimum requirements
specified in System Requirements .
Find the answer file and review important considerations.
The answer file is the install.xml file that is included in the custom package. For example, suppose you have a Windows x64 computer and the name of the package is
CustomPackageName. The install.xml file is located in the CustomPackageName\CustomPackageName_WinX64 folder.
If the custom package consists of only the answer file, you must have a separate installation package on which you can run the file. The answer file needs the
software binaries from an installation package to install the software.
If you want to customize the .xml file, see Customizing the Answer File of a Windows Custom Package .
If you have a 64-bit Windows computer and you need to protect 32-bit applications, you must configure a registry key to enable 32-bit agent installations. For more
information, see the Alternate Method in Enabling 32-Bit Installations on 64-Bit Windows Computers .

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

5/6/2017 Commvault Systems Page 213 of 587


Installing the Custom Package on UNIX, Linux, and Macintosh Computers Using
the Answer File
You can install the custom package in silent mode by using the answer file. The answer file is the .xml file that contains the parameters and values that were selected during
the custom package creation and is included in the package.
Installations in silent mode are also known as unattended installations.
Note: If the custom package was configured to prompt for user input, the installation in silent mode skips the installation prompts and uses the default installation
settings. To interact with the installation prompts, use the steps described in Installing the Custom Package on UNIX, Linux, and Macintosh Computers .

Before You Begin


Obtain the custom package from the location specified by the user who created it.
If the package is in the Download Center, see Downloading a Software Package in Download Center - Web Console .
Based on the agents that are included in the custom package, verify that the computer on which you want to install the package satisfies the minimum requirements
specified in System Requirements .
Find the answer file and review important considerations.
The answer file is the default.xml file that is included in the custom package. For example, suppose the custom package is located in the /opt/UnixCustomPackage directory.
The default.xml file is 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.
If you want to customize the .xml file, see Customizing the Answer File of a UNIX, Linux, and Macintosh Custom Package .
If you have a 64-bit Linux computer and you want to protect 32-bit applications, you must create a lock file to enable 32-bit agent installations. For instructions, see the
Alternate Method in Enabling 32-Bit Installations on 64-Bit Linux Computers .

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

5/6/2017 Commvault Systems Page 214 of 587


Installing a Windows Custom Package Configured as a Self-Extracting Executable
File
If the custom package was configured as a self-extracting executable file, you can install the custom package by running the executable file interactively or silently.
Note: If the custom package is a folder with contents, and not a self-extracting executable file, see Installing the Custom Package on Windows Computers .

Before You Begin


Obtain the custom package from the location specified by the user who created it.
If the package is in the Download Center, see Downloading a Software Package in Download Center - Web Console .
Based on the agents that are included in the custom package, verify that the computer on which you want to install the package satisfies the minimum requirements
specified in System Requirements .
If you have a 64-bit Windows computer and you need to protect 32-bit applications, you must configure a registry key to enable 32-bit agent installations. For more
information, see the Alternate Method in Enabling 32-Bit Installations on 64-Bit Windows Computers .

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

5/6/2017 Commvault Systems Page 215 of 587


Installing the Custom Package Using a Third-Party Software
You can configure a third-party software to install the custom package silently on multiple computers. An example of a third-part software on Windows is the Microsoft
Center Configuration Manager (SCCM).
If your computer has a batch script with a set of administrative tasks, you can also use this procedure to configure the batch script with the installation command.

Before You Begin


Obtain the custom package from the location specified by the user who created it.
If the package is in the Download Center, see Downloading a Software Package in Download Center - Web Console .
Review the following requirements:
For Windows custom packages, the package must be either a self-extracting executable file or a package that includes the answer file. If the package consists of only
the answer file, you must have a separate installation package on which you can run the file. The answer file needs the software binaries from an installation
package to install the software.
For UNIX custom packages, there are no specific requirements.

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)

5/6/2017 Commvault Systems Page 216 of 587


Installing UNIX Native Packages
Some UNIX environments are run by native package managers, such as the RPM package manager. To install the Commvault software in this type of environment, the
custom package must be created with the necessary native packages.
Use this procedure to install UNIX native packages that were distributed with the custom package. By default, native packagers are installed in silent mode.

Before You Begin


Obtain the custom package from the location specified by the user who created it.
If the package is in the Download Center, see Downloading a Software Package in Download Center - Web Console .
Based on the agents that are included in the custom package, verify that the computer on which you want to install the package satisfies the minimum requirements
specified in System Requirements .
Ensure that the /etc/hosts file on the computer has proper IP addresses for the hostname and the fully qualified domain name (FQDN).

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 .

5/6/2017 Commvault Systems Page 217 of 587


Setting Up Packages for Active Directory GPO Installations
If you use Active Directory Group Policy Objects (GPO) to automatically distribute software packages in a domain, you must create and configure a custom package for the
GPO to install the Commvault software.
Use this method if remote installations from the CommCell Console do not meet your needs and if you prefer to use Active Directory GPO installations.

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.

5/6/2017 Commvault Systems Page 218 of 587


Solaris IPS Packages
You can create IPS packages for UNIX Agents by using the Solaris IPS Packager provided with the installation package.
The Solaris IPS Packager is an image packaging solution which allows you to create and publish IPS packages to a File System or HTTP repository. After an IPS package is
published, Solaris end-users can retrieve the package from the repository and then proceed to install it.
To create and publish the IPS package, see Creating a Solaris IPS Package .
If the IPS package is already available in the repository, see Installing a Solaris IPS Package .

Process for Packaging the Software


During the creation of an IPS package, a Commvault instance is installed on the computer where the Solaris IPS Packager is running. This is also referred to as staging
Commvault binaries, which provides full support for package customization. After the package is created and published, the Solaris IPS Packager uninstalls the instance
from the Solaris computer.
For greater detail, the following steps describe the process used by the Solaris IPS Packager to create and publish a package:
1. Prepare the IPS Packaging Environment
Determines the target instance where you want to install the IPS package.
2. Target the IPS Package Repository
Determines the name and type of the repository to host the software package.
3. Stage Commvault Binaries and Customize the Package
Determines the location of the installation directory and IPS staging directory. Also customizes the package with common installation options, such as configuring
firewall settings.
4. Publish and Archive the Package
Generates the manifest file, and then publishes the IPS package to the repository. The package is later archived for offline usage.

Supported Solaris Versions


The Solaris IPS Packager is supported on computers running Solaris 11.1 or higher.

Supported Agents
The package created from the Solaris IPS Packager includes the following UNIX agents:
File System
Oracle
Sybase

5/6/2017 Commvault Systems Page 219 of 587


Creating a Solaris IPS Package
Use the Solaris IPS Packager to create and publish an IPS package to a File System or HTTP repository.

Before You Begin


Obtain the installation package that was created from the Download Manager and distributed across your organization. You need the installation package to launch the
Solaris IPS Packager.
Collect the information required during the IPS package creation, such as the repository on which you want to host the package. For more information, see Planning for
the Solaris IPS Package Creation .

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:

mount -r -F hsfs /dev/sr0 /cdrom

Run the following command from the installation package or mount point:
./cvpkgmake

3. On the Welcome dialog, press Enter.


4. On the Selecting Native Package Type dialog, type 3 to create the Solaris IPS package and press Enter.
5. On the Welcome to Solaris IPS Packager dialog, press Enter.
Follow the instructions in the Solaris IPS Packager.
6. On the Summary dialog, record the package name as well as the repository where the package resides.
The IPS package is created.
7. Set the publisher name for the package using the following command:
pkg set-publisher -g PathToRepository PublisherName

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

Step 2: Verifying the Package


1. Check the state of the IPS package using the following command:
svcs -xv svc:/application/PackageName/cvpkgcfg:default

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.

Step 3: Notifying the Users


Notify Solaris users that a new IPS package is available for download, and provide the repository details.

5/6/2017 Commvault Systems Page 220 of 587


Installing a Solaris IPS Package
When an IPS package is available for download, the user who created the package notifies Solaris users of the package details, which include the following:
Package name.
Location of the repository where the package is published.
Install the IPS package on a computer that resides in a Solaris IPS environment.

Before You Begin


Download the IPS package. If you have problems accessing the repository or not seeing the package, contact the user who created the package.

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.

5/6/2017 Commvault Systems Page 221 of 587


Unattended Installation
You can install Commvault on one or more computers in silent mode. This type of installation is called unattended.
Unattended installations are useful in the following scenarios:
Users want to install the software without any interaction.
Users have a batch script to run administrative tasks on their computers. They want to configure the batch script to run the installation.
You want to deploy Commvault on multiple computers by using a third-party software, such as the Microsoft System Center Configuration Manager (SCCM). The third-
party software installs Commvault silently without user intervention.
To perform unattended installations, you must have an answer file. During the creation of a custom package, you can generate an answer file by recording the options you
select from the installation wizard. Use the answer file as a template for unattended installations across multiple computers.
To install the software in silent mode (without being prompted for information), you must specify all the installation preferences that your environment requires during the
package creation.

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
.

5/6/2017 Commvault Systems Page 222 of 587


Preinstall Commvault as a Software Image
In cases where you want to install the Commvault software on computers that will be distributed to different organizations or CommCell environments, you can preinstall
the Commvault software as a software image. This operation does not involve any communication with a CommServe computer.
This is useful in the following scenarios:
You are a computer vendor.
You have a CommCell environment that is managed by one or more CommServe computers.
After the software is preinstalled, you can distribute the computers to the respective organizations or CommCell environments. When received, users can register the
computers at any time.

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.

5/6/2017 Commvault Systems Page 223 of 587


Preinstall Commvault as a Software Image: Setting Up Computers at the Factory
Setting up the computers at the factory represents the operation where you preinstall the Commvault software as a software image. To accomplish this operation, you
must perform the following steps:
Create a custom package that will install the software in decoupled mode.
Note: In a decoupled installation, the computer does not establish connections with the CommServe.
Install the custom package on all the computers where you want to preinstall the software.

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.

5/6/2017 Commvault Systems Page 224 of 587


Preinstall Commvault as a Software Image: Registering the Clients
After you receive the computers that were preinstalled with the Commvault software, you can proceed to register the computers with the respective CommServe
computer.

Before You Begin


The Commvault software must be preinstalled on the computers that you want to register.

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.

Method 2: Register Using the Command Line on the Client


Open the command line prompt, go to the Installation_Directory_Path/Base directory, and run the command applicable to the operating system of your computer:
On Windows Computers
SIMCallWrapper.exe -OpType 1000 -CSName CommServe_Name -CSHost CommServe_hostname -clientHostName client_hostname -clientName client_name -Instance InstanceNNN -output
XML_file_location

On UNIX, Linux, and Macintosh Computers


./SIMCallWrapper -OpType 1000 -CSName CommServe_Name -CSHost CommServe_hostname -clientHostName client_hostname -clientName client_name -Instance InstanceNNN -output
XML_file_location

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.

5/6/2017 Commvault Systems Page 225 of 587


Installations Using the Download Manager
The Download Manager is an application that runs as an interactive wizard, similar to the installation package that was created from the application.
You can use the Download Manager to perform the following installation tasks:
Install Locally on a Windows Computer
Interactively install agents and other Commvault software on a computer. For instructions, see Installing Commvault Locally on Windows Computers .
Create a Custom Package for Windows Computers
Create a custom installation package with the agents and configurations that your environment needs. For instructions, see Creating a Custom Package for Windows
Computers .
The Download Manager is not supported on UNIX, Linux, and Macintosh computers.

5/6/2017 Commvault Systems Page 226 of 587


Installing Commvault Locally on Windows Computers Using the Download
Manager
You can install the Commvault software locally on Windows computers by using the Download Manager application.

Before You Begin


Obtain the latest Download Manager from the Cloud Services website or the Maintenance Advantage website. For instructions, see Downloading Installation Media .
Make sure that the computer where the software will be installed meets the following requirements:
The computer must have Internet connectivity so that the Download Manager can retrieve the Commvault software.
The system time of the computer must be synchronized with the time zone of your region. If the system time is ahead of or behind the time zone of your region,
then the installation will fail.
If you install Commvault on a computer that has a firewall enabled, the firewall settings might prevent some of the files from being downloaded, resulting in
download and installation failures. To avoid this issue, configure your firewall to allow executable files to be downloaded (such as batch files), or contact your
software provider for assistance.
Prepare your environment and gather the information that you must provide during the installation:
For server packages, go to Other Server Packages , select the package that you want to install, and on the installation procedure, see the Before You Begin
section.
For MediaAgents, see Plan the MediaAgent Installation and Preinstallation Checklist for the MediaAgent on Windows .
For agents, see Plan the Installation on Windows Computers and Preinstallation Checklist for Clients .
For tools, see the Before You Begin section in Installing Commvault Tools .

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.

5/6/2017 Commvault Systems Page 227 of 587


Creating a Custom Package for Windows Computers Using the Download
Manager
You can use the Download Manager to create a custom package with the agents and options required for your Windows computers.
Custom packages are commonly created from the installation package that is generated when you download software from the Download Manager. Creating a custom
package directly from the Download Manager removes the prerequisite to download the software.

Before You Begin


Obtain the latest Download Manager from the Cloud Services website or the Maintenance Advantage website. The application is supported on 32-bit and 64-bit
Windows computers.
For instructions, see Downloading Installation Media .
Collect the information required during the custom package creation.
You can refer to the Planning for the Custom Package Creation on Windows Computers document. This is the same planning document used during thee custom
package creation from the installation package.

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 .

5/6/2017 Commvault Systems Page 228 of 587


Installation Support
Refer to the following sections to verify the support information for each installation method and configuration.

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

5/6/2017 Commvault Systems Page 229 of 587


Reinstalling Agents
Agents can be uninstalled from a client computer for various reasons. After an agent is uninstalled, the agent icon is displayed as unavailable (grayed out) in the CommCell
Browser pane of the CommCell Console. You can continue to browse the backed up data and perform out-of-place restores while the agent icon exists under the client
node.
If you need to protect the client data again, you can reinstall the agents that you uninstalled. The agent settings you previously configured are re-established after the
reinstallation.
To reinstall agents on a client computer, the icons of the uninstalled agents must exist in the CommCell Browser. If all agents were uninstalled from a client computer, the
client icon is also displayed as unavailable, as shown in the following image:

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

5/6/2017 Commvault Systems Page 230 of 587


Reinstalling the Laptop Package
Use this procedure to reinstall the laptop package in one of the following scenarios:
The laptop computer undergoes a hardware failure and crashes.
The operating system of the laptop computer undergoes a major upgrade. For example, upgrading from a Windows XP to a Windows 7 software.
Your organization provides new laptops to replace old ones.
The laptop package can be reinstalled by the CommCell administrator or by the laptop owner. The CommCell administrator should make this decision based on current
environment conditions. For example, the administrator might want to deploy the laptop packages silently using a third-party software.

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.

5/6/2017 Commvault Systems Page 231 of 587


Client Registrations
Clients must be registered with the CommServe computer to start protecting their data.
By default, when you install the Commvault software on a computer, the computer registers with the CommServe computer and becomes a client in your CommCell
environment.
Refer to the registration topic that addresses your current organization's needs:
If you installed the Commvault software in decoupled mode, you must register the client manually by using one of the following procedures:
Registering the Client Using the CommCell Console
Registering the Client Using the Command Line
Registering the Client Using the Process Manager
If you want to monitor clients that want to join your CommCell environment, see Creating Workflows for Monitoring Client Registrations .
If you have multiple CommServe computers in your CommCell environment, and you want to configure clients to register with their respective CommServe computer
automatically, see Multi-CommCell Routing for Client Registrations .

5/6/2017 Commvault Systems Page 232 of 587


Registering the Client Using the CommCell Console
When you install Commvault in decoupled mode, the client does not establish connections with the CommServe computer. You must register the client to complete the
installation.
You can register the client by manually adding the client to the CommCell Console. In this registration method, the client is added as a File System client, regardless of the
agents that were installed. That is because the File System Agent is a dependency for most agents.
Note: If you do not have access to the CommCell Console, a user with administrative rights in the CommCell must perform the registration for you.

Before You Begin


The Commvault software must be already installed on the 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.

5/6/2017 Commvault Systems Page 233 of 587


Registering the Client Using the Command Line
When you install Commvault in decoupled mode, the client does not establish connections with the CommServe computer. You must register the client to complete the
installation.
You can register the client by running a command from the command-line interface.

Before You Begin


The Commvault software must be already installed on the client.
If you installed a laptop package on Linux or Macintosh computers as a non-root user, you must run the following commands before registering the client.
The cvprofile command:
. /opt/commvault/Base/cvprofile

The galaxy_vm command:


. /opt/commvault/galaxy_vm

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

On UNIX, Linux, and Macintosh Computers


Go to the Installation_Directory_Path/Base directory and run the following command after substituting the parameter values:
./SIMCallWrapper -OpType 1000 -CSHost CommServe_hostname -clientname client_name -output XML_file_location

The SIMCallWrapper command supports a variety of parameters:


SIMCallWrapper -OpType 1000 [-instance instance_name] [-user user_name] [-password password] [-passwordEncrypted] [-CSName CommServe_name] [-CSHost CommServe_hostname] [-
ClientName client_name] [-ClientHostName client_hostname] [-ClientGroup client_group] [-subclientPolicy subclient_policy] [-StoragePolicy storage_policy] [-overwriteClientInfo] [-
resetNetworkPassword] [-regPath alternate_registry_path] [-instanceFor1Touch instance_name] -output XML_file_location [-skipCertificateRevoke] [-restartServices]

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.

5/6/2017 Commvault Systems Page 234 of 587


Registering the Client Using the Process Manager
When you install Commvault in decoupled mode, the client does not establish connections with the CommServe computer. You must register the client to complete the
installation.
You can register the client by using the Process Manager application. This registration method applies only to decoupled installations of custom packages on the following
operating systems:
Windows
Macintosh (only for laptop packages)

Before You Begin


The Commvault software must be already installed on the client.
At the end of the custom package installation, the Process Manager application is automatically opened. If the application is not opened, use the following steps to
open the application:
On Windows 8 or higher, click the Windows Start menu, and from the list of apps, under Commvault, click Process Manager.
On computers older than Windows 8, click the Windows Start menu, click All Programs, and from the list of programs, click Commvault > Process Manager.
On Macintosh computers, from the Applications window, click the Process Manager application.
If you installed the Commvault software on a Macintosh client, and there is an existing client with the same name, the registration might fail when your user account
tries to re-register the client.
Use the following table to determine whether your user account has the required properties to re-register the client:
Types of User Account Registration Capability
CommCell administrator Allowed to re-register client with same name and host name
User is not the client owner but has installation permissions Not allowed to register
User is the client owner and has installation permissions Allowed to re-register client with same name and host name
User is the client owner but does not have installation Not allowed to register
permissions
User without installation permissions Not allowed to register

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.

5/6/2017 Commvault Systems Page 235 of 587


Creating Workflows for Monitoring Client Registrations
You can create a workflow to monitor clients that want to join your CommCell environment. This is useful if you want to perform client management operations before the
client registers with the CommServe computer. For example:
You might want to rename a new client because it has the name of an existing client.
You might want to limit the number of laptop clients that a user can register.
To manage and monitor the client registration process, you must create a business logic workflow.

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 .

Sample XML Request


CVInstallManager_ClientSetup is the XML request in charge of providing information to the CommServe database about the client to be registered. The request helps you
identify the response from the CommServe database as well as the actions to be performed based on the response.
The following XML content is a sample of the CVInstallManager_ClientSetup XML request. The sample displays the XML attributes that are defined in the request.
Note: To manage and monitor the client registration, you can configure the workflow to check some attribute values against specific conditions. For example, if the
bLaptopBackup attribute is 1, the request detects whether the client has the Commvault laptop package installed.
<?xml version="1.0" encoding="UTF-8"?>
<CVInstallManager_ClientSetup Focus="Instance002" Operationtype="0" RemoteClient="1" requestFlags="4096" requestType="1">
<ClientAuthentication>
<userAccountToLogin domainName="" password="*******" userName="user" />
</ClientAuthentication>
<CommServeInfo>
<CommserveHostInfo _type_="3" clientName="" hostName="" />
</CommServeInfo>
<clientComposition activateClient="1" packageDeliveryOption="0">
<clientInfo>
<client clientPassword="********" cvdPort="8405" installDirectory="C:\Program Files\Commvault\ContentStore2">
<clientEntity _type_="3" clientName="vmtest1_2" hostName="vmtest1.domain.company.com" />
<jobResulsDir path="C:\Program Files\Company\Software\iDataAgent\JobResults" />
<osInfo PlatformType="X64" SubType="Server" Type="Windows" Version="6.2">
<OsDisplayInfo OSBuild="9200" OSName="Windows Server 2012 R2 Datacenter" ProcessorType="WinX64" /></osInfo>
<versionInfo GalaxyBuildNumber="BUILD80"> <GalaxyRelease ReleaseString="11.0" _type_="58" /> </versionInfo>
</client>
<clientProps BinarySetID="3" ClientInterface="" byteOrder="Little-endian" />
</clientInfo>
<clientRoles bLaptopBackup="1" bNetworkProxy="0" />
<components>
<commonInfo> <storagePolicyToUse _type_="17" storagePolicyId="1" storagePolicyName="CV_DEFAULT" /> </commonInfo>
<componentInfo ComponentId="1" ComponentName="File System Core" _type_="60" clientSidePackage="1" consumeLicense="1" /> <fileSystem />
</components>
<patchInformation spVersion="4.1"> <packagePatches pkgId="1" /> </patchInformation>
</clientComposition>
<installFlags activateAllUserProfiles="0" />
</CVInstallManager_ClientSetup>

5/6/2017 Commvault Systems Page 236 of 587


Multi-CommCell Routing for Client Registrations
If you have multiple client computers and more than one CommServe computer running in your CommCell environment, you can simplify the installation process by
configuring clients to automatically register with their respective CommServe computer.
The following diagram describes the events that occur when you configure the clients to register automatically in a multi-CommCell environment.

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.

5/6/2017 Commvault Systems Page 237 of 587


Setting Up a Master CommServe for Multi-CommCell Routing
You must set up a master CommServe to manage the list of CommServe computers that are available in your CommCell environment. Each CommServe computer must be
registered with the master CommServe.
The master CommServe can be one of your existing CommServe computers, or you can choose to install a new CommServe computer (if needed).

Before You Begin


The designated master CommServe must have the Workflow Engine installed. If not installed, see Installing the Workflow Engine .

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 .

5/6/2017 Commvault Systems Page 238 of 587


Configuring Client Registration Rules for Multi-CommCell Routing
You must define the registration rules that clients must follow during the installation. Registration rules consists of CommCell properties that you want clients to have. For
example, you can define a registration rule to associate clients with CommServe A, client group B, and storage policy C.
When end-users install the laptop package on their clients, the package uses the registration rules that you configured.
As part of this configuration, you will need to obtain and set up the following workflows:
AutoRegisterClientSavePatterns: Saves the client registration rules in the master CommServe database. This workflow must be ran manually.
AutoRegisterClient: Applies the registration rules on each computer where the laptop package is installed. This workflow runs automatically every time the package is
installed on a computer.

Before You Begin


The laptop package must be created and configured to support multi-CommCell routing. For instructions, see Creating a Laptop Backup Installation Package .

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.

5/6/2017 Commvault Systems Page 239 of 587


Troubleshooting Installations
CommCell Console
INS0016: Connection Error: Connection to CommServe is lost
Download Manager
INS0002: Download Manager Window Does Not Properly Render the Text Size
File System Agent Installations
INS0007: Macintosh Error: Starting BackupUninstall.app, LSOpenURLsWithRole() failed with error -10810
INS0010: Windows Error Code [68:174] Failed to install File System Core Package
INS0011: Windows Error Code [68:184] Failed to install File System Core Package on client
INS0013: UNIX Error Code [68:184] Failed to install File System Core Package on client
Remote Installations
INS0009: Error Code [61:2578] Install Software Failed
Server Package Installations
INS0021: The CommServe Database, or Another Server Package Database, is Marked as Read-Only
Third-Party Software
INS0003: Microsoft .NET Framework 3.5 failed to install server features on Windows Server 2012 or Windows 8.1 computers
INS0006: Setup failed to locate the log file associated with the silent install of SQL Server
INS0008: Failed to install Microsoft Visual C++ Runtime Libraries
INS0014: Setup failed to install Microsoft .NET Framework v4.0.030319.1
INS0015: Failed to install Microsoft .NET Framework
INS0018: Microsoft SQL Server: Error 1619 installing sqlncli.dll
INS0032: Microsoft .NET Framework 3.5 failed to install server roles on Windows computers
UNIX Installations
INS0019: UNIX Error Code [72:57] [Volume/Path] does not have required minimum space of [number] MB

5/6/2017 Commvault Systems Page 240 of 587


Installer Error Codes
The following table lists the error codes that you might see during unattended (silent) installations on Windows computers:
Code Description
0 Installation was successful.
1 Installation Failed
2 Installation was cancelled
3 Requires a reboot for completing the installation
4 Required to log off from the client
5 Required to reboot the client computer and resume the installation
6 Conflict with the client name
8 License is not available
9 Unable to resolve the CommServe host name
10 Install folder is not empty
11 The specified client name is in use
12 The specified host name is in use
13 Detected an unfinished interactive install
14 The selected platform is not allowed
15 Detected an unfinished install
16 The specified port is in use
17 The selected platforms are already installed
18 Available disk space is low
19 Client authentication failed
20 Cluster Virtual machine has been detected
21 Failed to stop Oracle services
22 Oracle services are running
23 No installed instance has been detected
24 SIM Operation failed
25 Jobs are in progress
26 It is not allowed to upgrade the selected package
27 The required service pack is missing
28 Failed to create the application
29 Failed to enable web alias authentication
30 The client is part of search engine cloud

Related Topics
System Messages, Event Strings and Error Codes

5/6/2017 Commvault Systems Page 241 of 587


Install/Upgrade/Remove/Repair Software Job Summary Report
Table of Contents
About this Report
When to use this Report
What this Report Contains
How to Generate the Report
Scheduling the Report
Customizations That You Can Perform With This Report
Additional Options

About this Report


The Install/Upgrade/Remove/Repair Software Job Summary Report displays information about all install, upgrade, and remove software jobs that run in the CommCell.
When to use this Report
You can use the Install/Upgrade/Remove/Repair Software Job Summary Report to review information related to all install, upgrade, and remove update jobs that ran in the
CommCell during the specified time period. This report is useful if you need to know:
Install, upgrade, and remove software job statuses
Job details including machine name and reason for failure, if applicable
The start, end, and elapsed time of each job

What this Report Contains


This report presents the data in the following sections:
Sections Description
Jobs This table provides information about install, upgrade, and remove software jobs that run in the CommCell.
Information displayed in the table includes:
The ID, status, and type of each job
The start and end time, or current phase of each job
The elapsed time for each job
The name of the client and task status
The details for each job
Descriptions of each failure and error code, if applicable

How to Generate the Report


You can generate the default version of any CommCell Report on demand in the CommCell Console.
Before You Begin
Your CommCell user account requires a role with the Report Management permission.
To view report data for an entity, your CommCell user account must have an association with that entity.
For more information on users, permissions, and associations, see User Administration and Security - Overview .
Procedure
1. On the CommCell Console ribbon, select the Reports tab, and then click Summary.
2. In the Report Selection dialog box, on the General tab, click Administrative Jobs > Install/Upgrade/Remove/Repair Software.
3. Click Run.
The report appears in your default Web browser.

Scheduling the Report


1. In the CommCell Console, select the Reports tab, and then on the ribbon, click the button for the report that you want to schedule.
The Report Selection dialog box appears.
2. Configure the report as needed.
3. In the Report Selection dialog box, click Schedule.
4. On the Schedule Pattern tab, in the Schedule Name box, enter a name for the schedule.
5. Select the interval at which you want the report to run: One Time, Daily, Weekly, Monthly, or Yearly.
6. In the Start Time box, type the time of day when you want the report generation to begin.
7. Under Repeat, specify the exact times and days that you want the report to run.
8. Click Ok.

Customizations That You Can Perform With This Report


You can further customize the report by using the tabs that are available in the Report Selection dialog box. The following table describes the available report options for
this report.
Options Description
General You can generate any of the Job Summary reports from this tab, including the Install/Upgrade/Remove Software Job
Summary Report. You can also filter the jobs that appear in the report by entering a job description.
Selection On this tab, you can set the report to include information regarding diagnostics and other job details. Set any of the
following options:
Include failure reason and associated events
Include job options, job description, and client description
Allow dynamic content for associated events and job options

5/6/2017 Commvault Systems Page 242 of 587


Options On this tab, you can set the report to include information regarding job status, throughput unit, and set the job time.
Set any of the following options:
Include jobs that are in active, completed, delayed, failed, killed, completed with errors, and completed with
warnings status
Show throughput unit in GB/hour or MB/second
Show data size in GB or MB
Time Range You can choose to include information from a specific time range in the report.
Choose a number of hours, days, or weeks from the list. The report information ends at the time that you
generate the report.
Select a time zone, and then enter a range of time from a specific date and time to another specific date and time.
Set the report to start at the first job that occurred in the CommCell, or enter a specific date and time in the Jobs
On section.
Set the report to end at the last job that occurs in the CommCell before you run the report, or enter a specific date
and time in the Jobs On section.
Output You can set the report output to appear in one of several formats and save it to a variety of locations. All options for
the output format are not available for all report types. Set any of the following options:
Generate the report in an available format.
HTML: Full version, the shorter Summary version, or Mobile Device Format
Text separated by commas or tabs
PDF
XML
Enter a location to save the report in one of these locations:
A client computer in the CommCell
A shared network drive
An FTP Location. Click Settings to specify an FTP location that is different than the default.
Choose a language from the Choose Locale list to set the report to appear in that language.
Select Date and Time, and then select a format from the list to set the format in which the date and time appears
in the report.

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.

5/6/2017 Commvault Systems Page 243 of 587


Modifying a Report Template 1. In the CommCell Browser, go to Reports | My Reports | 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 change, and then select
Edit.
The Saved Reports dialog box appears.
3. Select the Report Details tab, and then make changes on any of the available tabs.
4. Click OK to save your settings.
Cloning a Report Template 1. In the CommCell Browser, go to Reports | My Reports | 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 clone, and then select Edit.
The Saved Reports dialog box appears.
3. Select the Job Initiation tab, and then select Saved Report.
4. Select Clone this report as, and then enter a name in the box.
5. Click OK.
The cloned report appears in the General tab.

Deleting a Report Template 1. In the CommCell Browser, go to Reports | My Reports | 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 delete, and then select
Delete.
A message appears that asks if you are sure that you want to delete the selected Report
Template.
3. Click Yes.
The report is removed from the General tab.

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

5/6/2017 Commvault Systems Page 246 of 587


Installations - FAQ
Can I install an older Commvault version on a Windows or UNIX client computer?
Yes. You can install up to the last two previous Commvault versions. For more information, see Installing Clients from Older Commvault Versions .
Commvault Version 8 can be installed on selected UNIX operating systems and only provides backup and restore functionalities. For more information, see Installing
Version 8 UNIX Clients on a Version 11 CommCell Environment .

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.

Packages Third-Party Applications That Might Require a Description


Reboot
CommServe Microsoft SQL Server The installation program prompts for a reboot during the installation.
Microsoft .Net Framework 3.5 Reboot your computer so that the changes can take effect, and then resume the
installation.
CommCell Console Microsoft .Net Framework 4.0 The installation program prompts for a reboot during the installation.
Reboot your computer so that the changes can take effect, and then resume the
installation.
Compliance Search Microsoft .Net Framework 3.5 The installation program prompts for a reboot during the installation.
Reboot your computer so that the changes can take effect, and then resume the
installation.
Metrics Reporting Microsoft SQL Server The installation program prompts for a reboot during the installation.
Reboot your computer so that the changes can take effect, and then resume the
installation.
Web Server Microsoft ASP.NET The installation program prompts for a reboot during the installation.
AJAX Extensions Package Reboot your computer so that the changes can take effect, and then resume the
Microsoft .Net Framework 3.5 installation.
Microsoft SQL Server
Web Console Microsoft .Net 4.0 The installation program prompts for a reboot during the installation.
Reboot your computer so that the changes can take effect, and then resume the
installation.
Workflow Engine Microsoft .Net 3.5 The installation program prompts for a reboot during the installation.
Microsoft SQL Server Reboot your computer so that the changes can take effect, and then resume the
installation.
Active Directory Agent Active Directory Light Weight Directory Services The installation program prompts for a reboot during the installation.
Reboot your computer so that the changes can take effect, and then resume the
installation.
Exchange Offline Mining Tool Microsoft .Net Framework 3.5 The installation program prompts for a reboot during the installation.
Reboot your computer so that the changes can take effect, and then resume the
installation.
SQL Server Agent Microsoft .Net Framework 3.5 The installation program prompts for a reboot during the installation.
Microsoft SQL 2005 Native Client package Reboot your computer so that the changes can take effect, and then resume the
MSXML package installation.
SQL XMO Package
Windows File System Agent Microsoft .Net Framework 4.0 The installation program prompts for a reboot during the installation.
Reboot your computer so that the changes can take effect, and then resume the
installation.
The installation program might also prompt for a reboot in the following scenarios:
Scenarios which may lead to a computer reboot Description
If you choose to disable Firewall profiles during installation. While performing the installation, if you select 'Yes, disable Windows Firewall for
all profiles' option in the Firewall Configuration screen, then your computer will
prompt for a reboot.
This applies to all Commvault packages.
If there are any pending Commvault related files that need to be renamed. This might happen during the installation of any of the Commvault package.
When the Msiexec.exe utility prompts for a reboot to install MSI packages. This might happen during the installation of any of the Commvault package.
When a new path is added to the Environment variable. This might happen during the installation of the following agents:
DB2
Oracle
SAP for Oracle
Sybase
When the installer runs in the Upgrade Mode. The following packages might require a reboot during the upgrade:
File Share Archiver Client
Driver for File Archiver
Driver for Continuous Data Replicator
When the Virtual Disk Development Kit requires an upgrade. This might happen during the installation of the Virtual Server Agent.
During the installation of IntelliSnap agents.

5/6/2017 Commvault Systems Page 247 of 587


Upgrades
Before you begin to upgrade your CommCell environment, you must understand the upgrade process.
The following diagram illustrates the main steps of the upgrade process. For more information, click a step in the diagram.

Note: Step 1 applies only to V9 to V11 upgrades. V9 users have to manually generate the Preupgrade Readiness Report before requesting an upgrade.

5/6/2017 Commvault Systems Page 248 of 587


Generating the Preupgrade Readiness Report
Applies to: Upgrades from V9 to V11
If your CommServe computer is registered with the Cloud Services website, or if you plan to register it, we highly recommend that you generate the Preupgrade Readiness
Report to fix any issues before you send the upgrade request.
The report helps you determine whether your CommCell environment is ready to be upgraded to V11. When you generate the report, preupgrade checks run on your
CommServe database and indicate whether you must perform any corrective action. The report is available at the Cloud Services website.
For upgrades from V10 to V11, the report is automatically generated when you request 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

5/6/2017 Commvault Systems Page 249 of 587


Request an Upgrade
For a successful upgrade of your CommCell environment, you must perform the request an upgrade operation. During this operation, we run preupgrade checks on your
CommServe database and report issues that must be fixed prior to the upgrade.
When the CommServe database passes all preupgrade checks, an authorization code is applied to the database to approve the upgrade. You cannot upgrade the
CommServe without the authorization code.
To get started, select your current Commvault version:
Important: Request an upgrade at least two weeks before the planned upgrade date to resolve issues that could be found by the preupgrade checks.

For V10 Users


Preferred Method: Use the Request for Upgrade option on the Cloud Services website
(This method requires that your CommServe computer is registered with the Cloud Services website.)
When you submit the request, we automatically upload your CommServe database to run the preupgrade checks and report errors that might occur during the
upgrade.
Alternative Methods
If you do not want to register your CommServe computer, you can try one of the following methods to request an upgrade:
Alternative 1: 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 2: Test the upgrade by using the Database Upgrade tool
If your business does not allow you to submit the CommServe database due to strict security policies, you can use the Database Upgrade tool to test the
CommServe upgrade to detect possible issues during the upgrade process.
Note: If none of the alternative methods works for you, contact Customer Support for assistance.

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.

5/6/2017 Commvault Systems Page 250 of 587


Requesting an Upgrade through the Cloud Services Website: Using the Request
for Upgrade Option
Applies to: Upgrades from V10 to V11
You can request an upgrade by using the Request Upgrade to V11 option available on the Cloud Services website.
When you use the option, your CommServe database is automatically uploaded to the cloud, where we run the preupgrade checks and determine if you are ready for an
upgrade. The results are provided in the Preupgrade Readiness Report, which is emailed to you and is also available on the Cloud Services website.
If your CommServe database fails one or more preupgrade checks, the report provides a list of corrective actions. When the database passes all the preupgrade checks, an
authorization code is applied to the database to approve your upgrade to V11. The authorization code expires in 30 days.

Before You Begin


To see the Request Upgrade to V11 option, your CommServe must meet the following requirements:
The CommServe computer must be registered with the Cloud Services website.
If you have a Cloud Services account, the CommServe is already registered. If it is not registered, see Registering a CommServe Computer Through the Cloud
Services Website .
V10 Service pack 11 or later must be installed on the CommServe computer.
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. 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.

5/6/2017 Commvault Systems Page 252 of 587


Requesting an Upgrade through the Cloud Services Website: Submitting a Form
Applies to: Upgrades from V10 to V11, Upgrades from V9 to V11
You can request an upgrade by submitting an upgrade request form through the Cloud Services website. The form must include a copy of the CommServe database dump
from your most recent disaster recovery (DR) backup.
This method is useful if the CommServe computer is in a lock down environment with no Internet access. You can copy the database dump to a computer that can connect
to the Cloud Services website.
When you submit the form, the CommServe database is uploaded to the cloud, where we run the preupgrade checks and determine whether you are ready for an upgrade.
The results are provided in the Preupgrade Readiness report, which is sent to you in an email.
If your CommServe database fails one or more preupgrade checks, the report provides a list of corrective actions. When the database passes all the preupgrade checks, an
authorization code is sent to you to validate your upgrade to V11. The authorization code expires in 30 days.

Before You Begin


To provide the latest database dump, you must perform a disaster recovery backup:
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 a computer that can connect to the Cloud Services website.
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.

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.

5/6/2017 Commvault Systems Page 253 of 587


Testing the CommServe Upgrade Using the Database Upgrade Tool
Applies: Upgrades from V10 to V11, Upgrades from V9 to V11
You can test the CommServe upgrade to determine the state of your CommServe database and to fix any issues that are found during the upgrade. This method is useful if
your business does not allow you to submit the CommServe database to the Cloud Services website due to strict security policies.
To test the upgrade, you must install the V11 CommServe software on a separate computer (called standby CommServe), restore the CommServe database by using the
CommServe Recovery Assistant tool, and then run a test upgrade by using the Database Upgrade tool.

Before You Begin


Obtain a computer that you can use as the standby CommServe.
The computer must have a different name and IP address than the production CommServe computer.
Use the V11 Download Manager application to download the CommServe software. During the download, the application bundles an installation package. The V11
CommServe software includes the Database Upgrade tool.
To download the software, see Downloading Software for Windows Computers Using the Download Manager .

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"

4. Test the upgrade by running the Database Upgrade tool.


a. On the standby CommServe, go to the Software_Installation_Path\Base directory and double-click DBUpgradeUI.exe.
The DBUpgrade User Interface wizard opens.
b. On the first page, make the following selections:
i. Under the Product Type list, select CommServer. If you are testing other databases, like the Web Server (DM2), select the appropriate database.
ii. Under Upgrade Type, click Test Upgrade.
iii. Under Upgrade Phase, click All.
iv. Click Next.
c. On the second page, the hostname of the standby CommServe is automatically provided. Click Next to continue.
d. On the third page, under Database Information, the SQL Server database details are automatically provided. Click Next to continue.
e. On the fourth page, make the following selections:
i. In the Path to backup Database box, enter or browse for a folder where the CommServe database can be backed up during the test upgrade.
ii. In the DBUpgrade Log Location box, enter or browse for a folder to store the logs related to the test upgrade.
iii. Click Next.
f. On the fifth page, click Upgrade.
If the test upgrade is successful and reports no errors, continue with Step 5.
If the test upgrade finishes with errors, review the DatabaseUpgrade.log file that is located in the Software_Installation_Directory\Log Files directory. The log file includes
a workaround or advice for most error messages. For more information, see Troubleshooting Errors Found During a Request an Upgrade or Test Upgrade .
5. Send an email to [email protected] to request an authorization code to validate the upgrade. You must include the following information in the
email:
The DatabaseUpgrade.log file that you obtained during the test upgrade.
Your CommCell ID, registration code, and serial number. These CommCell details can be found in the License Administration dialog box of the CommCell Console
Control Panel.
When your request is approved, you will receive an email containing the authorization code and the instructions to apply the code to your database. The email will look
similar to this sample email . If you do not receive an email within 24 hours, contact [email protected].
Important: You have 30 days to upgrade the CommServe computer. If you do not upgrade within 30 days, you must repeat the test upgrade process.

What to Do Next
CommServe Upgrade

5/6/2017 Commvault Systems Page 254 of 587


CommServe Upgrade
The CommServe upgrade is the first crucial step for the successful upgrade of your CommCell environment.
Not every CommCell environment is the same. Read the following sections and select the upgrade procedure that closely matches your CommCell environment.

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 .

Upgrade with Hardware Refresh


If your CommServe computer is old or deprecated, you can move the CommServe database to a new hardware during the upgrade. For more information, see CommServe
Upgrade with Hardware Refresh .

Upgrade in a Disaster Recovery Environment


If your CommCell environment uses one of the following disaster recovery configurations, select the upgrade procedure for the respective configuration:
Upgrade CommCell Environment Configured with Database Mirroring
Upgrade CommCell Environment Configured with Log Shipping
Upgrade CommCell Environment where a Remote MediaAgent is Configured as Standby CommServe

5/6/2017 Commvault Systems Page 255 of 587


Standard CommServe Upgrade
Complete the following tasks to upgrade the CommServe computer:
1. Plan the upgrade.
Review general guidelines to prepare your environment for the upgrade. For more information, see Plan the CommServe Upgrade .
2. Perform preupgrade tasks.
Download the software, disable CommCell activities, and perform other preparation tasks to get started with the upgrade. For more information, see Preupgrade Tasks
for the CommServe .
3. Upgrade the software.
Upgrade the CommServe software by using the installation package that was created from the Download Manager. For instructions, see Upgrading the CommServe
Software .
4. Perform postupgrade tasks.
Review the tasks that you must perform after the installation in Postupgrade Tasks for the CommServe .

5/6/2017 Commvault Systems Page 256 of 587


Plan the CommServe Upgrade
The CommServe upgrade is the first crucial step for the successful upgrade of your CommCell environment.
Not every CommServe configuration is the same; therefore, use the following checklist to prepare for the upgrade:
 Verify Supported Commvault Versions
The version 9 CommServe must have service pack 14 or later.
The version 10 CommServe must have service pack 11 or later.
 Verify System Requirements
Make sure that the computer's operating system and hardware are supported by the new CommServe software. For more information, see System Requirements .
 Verify License Requirements
The CommServe does not require a license to upgrade to V11. The license currently used in your CommCell environment can be a permanent or evaluation license.
After the CommServe upgrade, you can continue to perform your day-to-day CommCell operations. Within 90 days of the upgrade, you will receive an email including
the V11 license.
 Verify Additional Requirements Based on CommServe Environment Types
Review the following requirements for the type of environment that you have:
CommServe in a Cluster Environment
If the Microsoft SQL Server version is older than SQL Server 2012, you must manually upgrade the software to Microsoft SQL Server 2012 SP2. For instructions, see
Upgrading Older SQL Server Versions to Microsoft SQL Server 2012 Enterprise Edition .
Review the requirements applicable to the type of cluster environment that you have:
Microsoft Cluster
You must upgrade the active nodes first, then the passive nodes. Each node must maintain its active or passive status throughout the upgrade process. For
example, if an active node requires a restart during the upgrade, make sure that the node maintains its status after the restart.
Veritas Cluster (VCS)
You must upgrade the passive nodes first, then the active nodes. Also, make sure that the cluster resources are offline.
HP Scalable NAS/PolyServer Cluster
You can initiate the upgrade from any physical node (active or passive). Also, make sure that the cluster resources are offline.
CommServe and Microsoft SQL Server on Different Computers
If the CommServe database and the Microsoft SQL Server are installed on different computers, you must move the CommServe database back to the CommServe
computer. This type of configuration is no longer supported.
For instructions, see Moving the Database Engine Back to the CommServe Computer .
 Prepare the Computer for Restart
During the CommServe upgrade, you might be required to restart the computer after the Microsoft .Net Framework and Microsoft SQL Server software are upgraded.
Therefore, plan the upgrade for a time when a restart can occur.
 Review Deprecated Products
Before you move to V11, it is important that you learn which products (such as agents) were deprecated in Commvault V11. Most deprecated products were either
replaced or merged with new products.
For more information, see End-of-Life, Deprecated and Extended Support - Products .
 Review Upgrade Considerations
The upgrade considerations include recommendations, notes, and other important information that you must consider before and after the upgrade.
Read the considerations applicable to your current Commvault version:
For V10 to V11
For V9 to V11

5/6/2017 Commvault Systems Page 257 of 587


Upgrade Considerations for the CommServe (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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 .

5/6/2017 Commvault Systems Page 259 of 587


Upgrade Considerations for the CommServe (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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 .

5/6/2017 Commvault Systems Page 261 of 587


Moving the Database Engine Back to the CommServe Computer
Applies to: Upgrades from V9 to V11
If your version 9 CommServe database and the Microsoft SQL Server are installed on different computers, you must move the CommServe database back to the
CommServe computer before the upgrade.

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 .

5/6/2017 Commvault Systems Page 262 of 587


Preupgrade Tasks for the CommServe
For a successful upgrade, you must perform the following preparation tasks to address any requirement or preconfiguration before the upgrade:
 Request an Upgrade
You must send a request for an upgrade to obtain an authorization code that validates your readiness for the upgrade. During this operation, the CommServe database
is checked for errors that might occur during the upgrade.
For more information, see Request an Upgrade .
Remember: When you receive the email indicating that your upgrade is approved, the email might include instructions to apply the authorization code to the
CommServe database. You must follow the instructions to validate the upgrade. If no instructions are provided, then the code was applied automatically.
 Download the Software
Use the Download Manager application to download the latest Commvault software. During the download, the application bundles an installation package with the
software you chose to download. You must use the installation package to upgrade the CommServe software.
To download the software, see Downloading Software for Windows Computers Using the Download Manager .
Note: For a successful upgrade, the installation package must include all the Commvault software that is installed on the CommServe computer. For example, if the SQL
Server Agent is installed, make sure to also download the agent software.
 Run a Disaster Recovery Backup
During the upgrade, irreversible changes are made to the CommServe database. Therefore, it is important to have a good and recent backup of the database before the
upgrade.
Use the following steps to run a disaster recovery (DR) backup:
1. From the CommCell Browser, right-click the CommServe and click All Tasks > Disaster Recovery Backup.
2. In the Disaster Recovery Options dialog box, click OK.

 Disable CommCell Activities


Jobs must not be running in your CommCell environment. Decide whether you want to wait for the jobs to finish or terminate the jobs.
After waiting or terminating the jobs, to make sure that no new jobs are performed, disable CommCell activities as follows:
1. From the CommCell Browser, right-click the CommServe and click Properties.
2. On the Activity Control tab of the CommCell Properties dialog box, clear the Enable Scheduler and Enable All Job Activity check boxes, and then click OK.

 Uninstall Older Deprecated Products


While you can continue to use products that were deprecated in version 11, you must uninstall products that were deprecated in older Commvault versions to prevent
upgrade errors. The report that you receive during the request for upgrade operation also covers this requirement.
To review the products that were deprecated in older versions, see the following information:
For products deprecated in V10, see End-of-Life, Deprecated and Extended Support - Products .
For products deprecated in V9, see the List of Deprecated Products section in Extended Support and Deprecated Products and Platforms .
 Uninstall the Resource Pack
If the Resource Pack is installed on the CommServe computer, failure errors will occur during the upgrade process. To uninstall the Resource Pack, use the option to
uninstall programs from your Windows Control Panel. The program is listed as Commvault Resource Pack.
Note: The Resource Pack is no longer available in version 11.

5/6/2017 Commvault Systems Page 263 of 587


Upgrading the CommServe Software
Upgrade the CommServe software by using the installation package that was created from the Download Manager application.
Note: You can also run unattended (silent) upgrades on the CommServe computer. For instructions, see Running Unattended Upgrades on Windows Computers Using the
Installation Package .

Before You Begin


Prepare your environment for the upgrade:
Plan the CommServe Upgrade
Preupgrade Tasks for the CommServe

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

5/6/2017 Commvault Systems Page 264 of 587


Postupgrade Tasks for the CommServe
You must perform a series of tasks to complete the CommServe upgrade.

Enable CommCell Activities


1. From the CommCell Browser, right-click the CommServe and click Properties.
2. In the CommCell Properties dialog box, click the Activity Control tab, select the Enable All Job Activity check box, and then click OK.

Run Test Backups and Restores


Verify that backup and restore operations run as expected in your CommCell environment.

Apply the New License


Within 90 days of the upgrade, you will receive an email that includes the V11 license required for your CommCell environment. If you do not receive the license file after 90
days, send an email to [email protected], including your CommCell ID.
To apply the license, see Applying a License .

Download the Software to the CommServe Cache


If you plan to perform upgrades from the CommCell Console, the Commvault software must be available in the CommServe cache directory.
If the CommServe computer has Internet connectivity, no action is required. The Commvault software is automatically downloaded to the CommServe cache as part of
the upgrade job.
If the CommServe computer has Internet connectivity with restrictions, or if there is no internet connectivity, you can adjust the download settings in the CommCell
Console. For more information, see Configure Download Settings in the CommCell Console .
If the CommServe computer does not have internet connectivity, and the download settings do not satisfy your requirements, create a new installation package with all
the software needed by your organization, and then copy the package to the CommServe cache. For instructions, see the download software procedure for Windows
and UNIX computers.

Review the Service Level Agreement (SLA) Value


When you sent a request for upgrade, the Preupgrade Readiness Report included the SLA value. Before the upgrade, you had to determine whether the jobs in the
CommCell met the SLA value for a specific number of days (for example, 83% for last 7 days).
After the upgrade, wait for the same number of days and then check the SLA value from the report.
If the new SLA meets or exceeds the previous level, continue with the MediaAgent and client upgrade.
If the SLA is not met, contact Product Support for assistance.

Log Off from the CommServe Database


Before you run command line operations in your CommCell environment, you must log off from the CommServe database by using the following command:
qlogout -cs CommserveName

Update the Installation Package


To continue using the installation package as a media resource, verify that the package contains all the software needed by your organization. If some software is missing,
you must create a new installation package with the required software.
The installation package is useful if you plan to upgrade the following server packages:
Metrics Reporting
Web Console
Web Server
Workflow Engine
To create the installation package, see Downloading Software for Windows Computers Using the Download Manager . If you need to create an installation package for
UNIX computers, see Downloading Software for UNIX, Linux, and Macintosh Computers Using the Download Manager .
Note: As a best practice, keep the installation package up-to-date, or at the same service pack level as that of the CommServe computer.

5/6/2017 Commvault Systems Page 265 of 587


CommServe Upgrade with Hardware Refresh: Overview
CommServe Hardware Refresh is the process of moving the CommServe database to a new hardware.
The following documentation provides information on how to migrate a CommServe database with Commvault version 9 or 10 to a new hardware, and also upgrade to
Commvault version 11 in the process. (If both the old and new hardware are in the same CommServe version, use the steps described in CommServe Hardware Refresh .)

Scenarios to Use Hardware Refresh


CommServe Hardware Refresh can be used when you want to:
Upgrade the CommServe software, and
Move the CommServe database to a new hardware during the upgrade.

Steps to Perform Hardware Refresh


This process involves the following steps:
1. Preparing the New Hardware
Set up and configure the new computer to be ready for migrating the CommServe database.
2. Migrating the CommServe to the New Hardware
Preparing the Old CommServe Computer for Shutdown
Perform a disaster recovery backup and other important operations before decommissioning the old hardware.
Setting Up the CommServe Database in the New Hardware
Install and set up the CommServe software using the disaster recovery backup from the old CommServe computer. During installation, the database is upgraded to
version 11.
3. Post Migration Operations
Fine tune the new computer to match the settings from the old CommServe computer.

5/6/2017 Commvault Systems Page 266 of 587


CommServe Upgrade with Hardware Refresh: Preparing the New Hardware
Use the following steps to prepare the new hardware:
Tip: To review upgrade recommendations based on your CommCell environment, see CommServe Upgrade with Hardware Refresh Use Cases .
1. Get the new hardware.
Ensure the hardware meets the specifications mentioned in Hardware Specifications . The new hardware must not be an existing client in your CommCell®
environment.
2. Determine the following:
Do you want to use the same computer host name and IP settings?
Using the same network details in the new CommServe® computer will simplify the process. For example, you may want to keep the same network details
if you have data interface pairs configured between the CommServe computer and other clients.
Do you want to use a different computer host name and IP settings?
Send an email to [email protected] to request a new CommServe license configured with the new IP address. On the email request, make sure to list the
old and new IP addresses. After the license is updated with the new IP, move the license file to a location accessible by the new CommServe computer.
Note: You can use a different host name and IP settings for the new CommServe computer, but the CommServe client name must remain the same.
3. Install the Operating System on the new computer.
For supported operating systems, see System Requirements - CommServe .

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.

4. Configure the Internet Information Services (IIS) on the new computer.


IIS is required for the following:
CommCell Console
Web Console
5. Ensure that you have the latest Commvault software accessible from the new CommServe computer.
To obtain the necessary software, create an installation package using the Download Manager application. For instructions, see Downloading Software for Windows
Computers Using the Download Manager .
6. Ensure that you have the latest Commvault Service Packs from version 9 or 10, or at least, the minimum Service Pack stated in the Plan the CommServe Upgrade .
7. Send a request for an upgrade to obtain an authorization code that validates your readiness for the upgrade. For more information, see Request an Upgrade .
8. If you have the File Archiver Agent for BlueArc, Celerra, or NetApp installed on your Version 9 CommServe computer, ensure that you recall the stubs.

5/6/2017 Commvault Systems Page 267 of 587


CommServe Upgrade with Hardware Refresh: Preparing the Old CommServe
Computer for Shutdown
To migrate the CommServe database to a new hardware, you must first prepare the old CommServe computer for shutdown.

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.

5/6/2017 Commvault Systems Page 268 of 587


10. From the list of programs in the Windows Control Panel, make a list of all the Commvault components installed on the CommServe computer.
11. If you plan to use different network details, do not shut down the CommServe computer yet. You will perform this operation after the CommServe database is restored
and upgraded on the new hardware.
12. If you plan to use the same network details, make a note of the IP settings (IP address and DNS) and the computer name, and then shut down the CommServe
computer.
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.

What to Do Next
Setting Up the CommServe Database in the New Hardware

5/6/2017 Commvault Systems Page 269 of 587


CommServe Upgrade with Hardware Refresh: Setting Up the CommServe
Database in a New Hardware
You can set up the database on the new hardware by using one of the following methods:
Preferred Method: Upgrade the database during the CommServe installation
This method requires that you provide the old database dump during the new CommServe installation. The CommServe database is upgraded as part of the
installation process.
Use this method if the new hardware uses the same IP and host name of the old CommServe computer. This method is the simplest way to set up the CommServe
database in the new hardware.
Alternative Method: Install the latest CommServe software, then restore and upgrade the database using the Recovery Assistant tool
This method requires that you install the latest CommServe software, and then restore and upgrade the old database by using the CommServe Recovery Assistant tool.
Use this method in the following scenarios:
The new hardware uses a different IP or host name than the old CommServe computer. (Remember that the CommServe client name must remain the same as the
old CommServe client)
The latest CommServe software is already installed on the new hardware.
If none of the methods work for your environment, contact Customer Support for assistance.

Before You Begin


You must perform the steps described in Preparing the Old CommServe Computer for Shutdown .
Remember: If the IP address of the new CommServe computer is different from the old CommServe computer, obtain a new CommServe license configured with the new IP
address from your software provider.

Procedure
Choose the method that better accommodates your requirements.

Preferred Method: Upgrade the Database During the CommServe Installation


1. Log on to the new computer and ensure that the network details (computer name and IP settings) are properly set.

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.

2. Copy the Disaster Recovery backup files to the local drive.


3. Install the CommServe software using the latest Commvault V11 installation package. During the installation, submit the database dump file from the old
CommServe computer.
For the installation instructions, see Installing the CommServe Software .
Make sure that you specify the following settings:
On the Select Packages page of the installation wizard, select CommServe and any other package that you had in your old CommServe computer. You can later
uninstall the packages that you do not want on the new computer.
Later on the installation, on the Client Computer Information page, make sure that you provide the name of the old CommServe 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.

5/6/2017 Commvault Systems Page 271 of 587


What to Do Next
Post-Migration Operations
Note: If you moved the CommServe database to or from a cluster environment, make sure to perform the Configure Cluster Environment steps in the Post-Migration
Operations page.

5/6/2017 Commvault Systems Page 272 of 587


CommServe Upgrade with Hardware Refresh: Post Migration Operations
The following operations are recommended on the new CommServe® computer after the hardware refresh.
Access the CommCell Console Remotely
Configure Cluster Environment
Configure the File Archiver Agent
Tune the SQL Server Memory Usage
Verify Commvault Network Components (If CommServe Name Changed)

Access the CommCell Console Remotely


You can access the CommCell Console remotely from any computer using a Java-enabled web browser. The default URL to access the console is the following:
http://<cshostname>:81/console
Where:
cshostname is the hostname of the CommServe computer (where the CommCell Console component was installed).
81 is the default port number used to connect with the CommCell Console. The port number may be different if you modified the IIS port in the IIS Server Manager.

Configure Cluster Environment


If you moved the CommServe database from a cluster to a cluster environment, you need to perform additional steps to configure the database in the new environment.
Note: If you moved the CommServe from a cluster environment to a non-cluster environment or from a non-cluster environment to a cluster environment, then no
additional action is needed. The CommServe Recovery Assistant tool automatically detects the change in the cluster environment and performs the cluster migration as
part of the recovery process.
Cluster to Cluster Configuration
Use the CommServe Recovery Assistant tool to configure the database when it is moved from a cluster to a cluster environment.
Step 1: Apply the Options to Migrate the CommServe Database from a Clustered Environment to a Non-Clustered Environment
a. On the active node (where the CommServe software is installed), go to the Software_Installation_Path/Base folder.
b. Double-click CSRecoveryAssistant.exe and follow the steps provided in Recovering the CommServe Database .
Step 2: Apply the Options to Migrate the CommServe Database from a Non-Clustered Environment to a Clustered Environment
a. On the Cluster/Non-Cluster CommServe DB Migration tab, select the Cluster/Non-Cluster CommServe DB Migration check box.
b. Under Migration Options, click Setup CommServe DB to Cluster.
c. Under CommServe Physical Nodes, type the name of the physical CommServe nodes as they appear in the Microsoft Failover Cluster Manager.
Do not copy and paste the physical node name from the registry, or add the characters "_node" to the node name. The characters "_node" are automatically
added to the physical node name during the database restore operation.

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 .

Configure the File Archiver Agent


If you had the File Archiver Agent for BlueArc, Celerra, or NetApp installed on your old hardware, then make sure to install and configure OnePass on your new
hardware. See File Archive Agents for more information.
If you had the File Archiver Agent for Windows installed on your old hardware, then make sure to install and configure OnePass on your new hardware. See OnePass for
Windows File System for more information.
After configuring OnePass, create the following registry key to recall the File Archiver stubs.
a. From the CommCell Browser, right click the CommServe computer and then click Properties.
The CommCell Properties dialog box appears.
b. On the Additional Settings tab, click Add.
The Add Additional Settings on Windows Client dialog box appears.
c. In the Name box, type GXHSM_USE_FSAppType_ForFSDMRecalls.
d. In the Value box, type 1.
e. Click OK.

Tune the SQL Server Memory Usage


If you pre-installed the SQL Server on the new hardware before the CommServe software was installed, we recommend you to verify the SQL memory usage for the
5/6/2017 Commvault Systems Page 273 of 587
Commvault components. The maximum memory used by the SQL Server should be 50% of the physical memory available in the new computer.
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.

Verify Commvault Network Components (If CommServe Name Changed)


If the new CommServe computer has a different name and IP address than the old computer, reconfigure each data interface pair (DIP) that exists between the CommServe
computer and other clients. See Data Interface Pairs - Advanced for information on adding, editing or deleting DIPs.

5/6/2017 Commvault Systems Page 274 of 587


Upgrade CommCell Environment Configured with Database Mirroring
Use this procedure to upgrade a CommCell environment where you have a production and standby CommServe computer using the SQL Server Database Mirroring
feature to synchronize their databases.
In Version 11, the Commvault software provides the Standard Edition of the Microsoft SQL Server software. To continue using the Database Mirroring feature, you must
have the Enterprise Edition.
Tip: We recommend that you use the CommServe failover solution on your standby CommServe computer. To set up the failover solution, upgrade the production
computer by using the CommServe Upgrade with Hardware Refresh procedure, and then configure the failover solution as described in Building a Standby CommServe
Host for Disaster Recovery .

Before You Begin


Obtain the Microsoft SQL Server 2012 Enterprise Edition software and license from Microsoft.
Remember: The production and standby CommServe computers must use the same Microsoft SQL Server version.

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.

5/6/2017 Commvault Systems Page 275 of 587


Upgrade CommCell Environment Configured with Log Shipping
Use this procedure to upgrade a CommCell environment where a SQL Server Agent is used to perform the following tasks:
Back up the database and transaction logs from the production CommServe computer.
Restore the data to the standby CommServe computer.

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.

5/6/2017 Commvault Systems Page 276 of 587


Upgrade CommCell Environment Where a Remote MediaAgent is Configured as
Standby CommServe
Use this procedure to upgrade a CommCell environment where a remote MediaAgent (or File System Agent) client computer is used as a Standby CommServe for disaster
recovery. The MediaAgent and the Standby CommServe database are installed on two separate instances.

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

Setup.exe /donotpatchdb /nostartsvc

5/6/2017 Commvault Systems Page 277 of 587


MediaAgent Upgrade
After the CommServe upgrade, the next step is to upgrade the MediaAgents in your CommCell environment.
Read the following sections and select the upgrade procedure that closely matches your environment needs.

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 .

Upgrade with Hardware Refresh


If your MediaAgent computer is old or deprecated, you can move the MediaAgent to a new hardware during the upgrade. For more information, see MediaAgent Upgrade
with Hardware Refresh .

5/6/2017 Commvault Systems Page 278 of 587


Standard MediaAgent Upgrade
Complete the following tasks to upgrade the MediaAgents in your environment:
1. Plan the upgrade.
Review general guidelines to prepare your environment for the upgrade. For more information, see Plan the MediaAgent Upgrade .
2. Perform preupgrade tasks.
Download the software, stop running jobs, and perform other preparation tasks to get started with the upgrade. For more information, see Preupgrade Tasks for
MediaAgents .
3. Upgrade the software.
Upgrade the MediaAgent by using either the CommCell Console or the installation package that was created from the Download Manager. For instructions, see
Upgrading MediaAgents .

5/6/2017 Commvault Systems Page 279 of 587


Plan the MediaAgent Upgrade
After the CommServe upgrade, the next step is to upgrade the MediaAgents in your CommCell environment.
Use the following checklist to prepare for the upgrade:
 Verify Supported Commvault Versions
Version 9 MediaAgents must have service pack 14 or later.
Version 10 MediaAgents must have service pack 11 or later.
Note: For any of the Commvault versions, we recommend that you always install the latest service pack.
 Verify System Requirements
Make sure that the computer's operating system and hardware are supported by the new MediaAgent software. For more information, see System Requirements .
 Verify License Requirements
You do not need a license to upgrade MediaAgents to V11. After the upgrade, you can continue to perform your day-to-day MediaAgent operations.
In V10, several licenses were renamed and deprecated. If you are a V9 user and a MediaAgent feature was deprecated in V10, the feature will be unavailable after the
upgrade.
For more information, review the following V10 documentation topics:
Renamed Licenses
Deprecated Licenses
 Decide Which MediaAgents To Upgrade
You can choose not to upgrade all the MediaAgents in your CommCell environment. However, you will not benefit from new features in the current Commvault version.
For more information on how new features work on MediaAgents from previous software version, see Managing Features on MediaAgents from Previous Versions .
To help you identify which MediaAgents to upgrade, you must upgrade the MediaAgents associated with the clients that you plan to upgrade. If a client is upgraded and
its associated MediaAgent is not, new features will not be available for the client. For more information, see Support for Mixed MediaAgent and Client Versions .
Important:
You must upgrade the MediaAgent used for disaster recovery backups. If the MediaAgent is not upgraded, disaster recovery backups will fail.
For optimal and reliable performance, the CommServe and MediaAgents should always operate at the same version and service pack level.
 Review Deprecated Products
If other products are installed on the MediaAgent computer, note that some products were deprecated in V11.
Most deprecated products are either replaced or merged with new products. For more information, see End-of-Life, Deprecated and Extended Support - Products .
 Review Upgrade Considerations
The upgrade considerations include recommendations, notes, and other important information that you must consider before and after the upgrade.
Read the considerations applicable to your current Commvault version:
For V10 to V11
For V9 to V11
Note: Review general client considerations, such as cluster requirements. Client considerations also apply to MediaAgents. For more information, see the upgrade
considerations for clients (V10 to V11 | V9 to V11 ).

5/6/2017 Commvault Systems Page 280 of 587


Upgrade Considerations for the MediaAgent (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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 .

5/6/2017 Commvault Systems Page 281 of 587


Upgrade Considerations for the MediaAgent (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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 .

5/6/2017 Commvault Systems Page 282 of 587


Managing Features on MediaAgents from Previous Versions
Use the following table to check the supported combinations of features on MediaAgents from previous software versions when the CommServe is upgraded to V11.
New Features Description
Enhanced Encryption Options The Store plain text and Encrypt on network using selected cipher options are not available on the storage policy copy when the
for Auxiliary Copy associated MediaAgent is from an older version.
Transactional Deduplication If the MediaAgent is hosting the DDB, after MediaAgent upgrade, you can convert the v10 DDB to transactional DDB using memdb tool.
Database (DDB)
Increased Number of Partitions You can create a partitioned DDB storage policy with up to four partitions only if the MediaAgent is in V11.
for Partitioned DDB
Incremental Deduplication Data You can run incremental deduplicated data verification jobs on V9 or V10 DDBs only if the MediaAgent that hosts the DDB is upgraded
Verification to V11.
If the MediaAgent is in V10, incremental deduplicated data verification jobs are ignored, and a full data verification job is run.
Disabling jobs for an Auxiliary To disable the copy of jobs that meets the retention criteria set on the destination copy, you must enable the Disable jobs for Auxiliary
Copy that met its retention Copy that met its retention parameter.
Macintosh Support for Source- Macintosh File System Agent backups supports source-side deduplication when the client is in V10 or V11.
Side Deduplication
DDB Verification Schedule Policy After CommServe upgrade, by default, the System Created DDB Verification schedule policy is created and no DDBs are associated
with the schedule policy.
To take the advantage of the system created schedule policy, you need to manually associate the DDBs to the schedule policy. For more
information on how to associate the DDBs, see Modifying a Schedule Policy .

5/6/2017 Commvault Systems Page 283 of 587


Support for Mixed MediaAgent and Client Versions
Use the following table to review the supported combinations of client-to-MediaAgent software version for backups, and MediaAgent-to-MediaAgent software version for
Auxiliary Copy operations.
Notes:
Backups are not supported on a client that is upgraded to a version higher than its associated MediaAgent.
Auxiliary Copy operations are not supported if the source MediaAgent is upgraded to a version higher than its associated destination MediaAgent.

Backups or Auxiliary Copy


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

5/6/2017 Commvault Systems Page 284 of 587


Preupgrade Tasks for MediaAgents
For a successful upgrade, you must perform the following preparation tasks to address any requirement or preconfiguration before the upgrade:
 Download the Software
Choose one of the following methods to download the software:
If you plan to upgrade from the CommCell Console, no action is required. The Commvault software is automatically downloaded during the upgrade.
Note: If you have V9 MediaAgents associated with a remote cache, remove the MediaAgent associations. For a successful upgrade, V9 MediaAgents must retrieve
the software from the CommServe cache, not from the remote cache.
If you plan to use the installation package, make sure that the package includes the MediaAgent software. If missing, create a new installation package and include
the software. For instructions, see Downloading Software for Windows Computers Using the Download Manager .
Note: The installation package that was used to upgrade the CommServe software is Windows based. If you need to upgrade UNIX computers, see Downloading
Software for UNIX, Linux, and Macintosh Computers Using the Download Manager .
 Stop Running Jobs
Jobs must not be running for the MediaAgent that you want to upgrade. Decide whether you want to wait for the jobs to finish or terminate the jobs.
 Prepare the DDB MediaAgent for an Upgrade
If you have a V10 DDB MediaAgent, disable the DDB activity. For instructions, see Enabling or Disabling Activities .
If you have a V9 DDB MediaAgent, stop the services on the MediaAgent computer. For instructions, see Stopping a Service .
 Uninstall Older Deprecated Products
If products that were deprecated in older Commvault versions are installed on the MediaAgent computer, you must uninstall the deprecated products and delete them
from the CommCell Browser to prevent upgrade errors.
To review the products that were deprecated in older versions, see the following information:
For products deprecated in V10, see End-of-Life, Deprecated and Extended Support - Products .
For products deprecated in V9, see the List of Deprecated Products section in Extended Support and Deprecated Products and Platforms .
Important: When you delete an agent from the CommCell Browser, the backup data is irretrievably lost. If you want to keep the backup data from the deprecated
product, do not upgrade the MediaAgent.

5/6/2017 Commvault Systems Page 285 of 587


Upgrading MediaAgents
Upgrade MediaAgents by using either the CommCell Console or the installation package that was created from the Download Manager application.

Before You Begin


Prepare your environment for the upgrade as described in the following topics:
Plan the MediaAgent Upgrade
Preupgrade Tasks for MediaAgents

Choose the Upgrade Method


Use one of the following methods to upgrade the MediaAgent:
Remote upgrades, where you use the CommCell Console to upgrade the software remotely on one or more computers.
For instructions, see Upgrading Commvault Remotely Using the CommCell Console .
Local upgrades, where you use the installation package to upgrade the software locally on a computer.
Based on your computer's operating system, see Windows or UNIX .
Unattended upgrades, where you use the installation package to upgrade the software silently on a computer.
Based on your computer's operating system, see Windows or UNIX .

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

5/6/2017 Commvault Systems Page 286 of 587


MediaAgent Upgrade with Hardware Refresh
Complete the following tasks to upgrade the MediaAgent hardware during a MediaAgent upgrade:
1. Upgrade the MediaAgent.
The MediaAgent software must be upgraded before it is moved to the new hardware. For instructions, see Standard MediaAgent Upgrade .
2. Move the MediaAgent to the new hardware.
After the MediaAgent is upgraded, you can start the hardware refresh process. For instructions, see MediaAgent Hardware Refresh .

5/6/2017 Commvault Systems Page 287 of 587


Client Upgrade
After the CommServe and MediaAgent upgrade, you can upgrade the clients in your CommCell environment. Client computers include software such as agents, tools, and
server packages.
Complete the following tasks to upgrade the clients in your environment:
1. Plan the upgrade.
Review general guidelines to prepare your environment for the upgrade. For more information, see Plan the Client Upgrade .
2. Perform preupgrade tasks.
Download the software, stop running jobs, and perform other preparation tasks to get started with the upgrade. For more information, see Preupgrade Tasks for
Clients .
3. Upgrade the software.
Upgrade the software by using either the CommCell Console or the installation package that was created from the Download Manager. For instructions, see Upgrading
Clients .

5/6/2017 Commvault Systems Page 288 of 587


Plan the Client Upgrade
After the CommServe and MediaAgent upgrade, you can upgrade the clients in your CommCell environment.
We recommend that MediaAgents are already upgraded before the client upgrade. However, clients and MediaAgents can be upgraded at the same time.
Use the following checklist to prepare for the upgrade:
 Verify Supported Commvault Versions
Version 9 clients must have service pack 3 or later.
Version 10 clients do not have a service pack requirement.
Note: For any of the Commvault versions, we recommend that you always install the latest service pack.
 Verify System Requirements
Make sure that the clients satisfy the minimum requirements for the new Commvault software.
From the System Requirements home page, select the agent or other software that is installed on the client to review its system requirements.
 Verify License Requirements
You do not need a license to upgrade clients to V11. After the upgrade, you can continue to perform your day-to-day CommCell operations.
In V10, several licenses were renamed and deprecated. If you are V9 user and a CommCell feature was deprecated in V10, the feature will be unavailable after the
upgrade.
For more information, review the following V10 documentation topics:
Renamed Licenses
Deprecated Licenses
 Decide Which Clients To Upgrade
You can choose not to upgrade all the clients in your CommCell environment. However, you will not benefit from the new features in the current Commvault version.
We recommend that you schedule the client upgrade based on geographic locations and importance of applications.
Important:
If MediaAgents are associated with the clients that you plan to upgrade, make sure that the MediaAgents are also upgraded. If a client is upgraded and its associated
MediaAgent is not, new features will not be available for the client.
To review the supported MediaAgent and client mixed versions, see Support for Mixed MediaAgent and Client Versions .
For optimal and reliable performance, the CommServe and clients should always operate at the same version and service pack level.
 Determine Whether You Have Version 8 Clients Running UNIX and NetWare File System
Agents
V8 clients cannot be upgraded to V11. However, you can continue to protect the file system data of UNIX and NetWare V8 clients in your V11 CommCell environment.
To benefit from this extended support, the V8 clients must run one of the following operating systems:
AIX 5.2
NetWare
Red Hat Linux 3.8
SuSE Linux 9.x
Ubuntu 7.x
Important: You can only perform basic backup and restore operations for UNIX and NetWare File System Agents. Other agents, including driver-based agents, and
advanced features, such as firewall configurations, are not supported. Make sure that the CommServe computer and MediaAgents have open ports for V8 clients so
that the clients can establish direct connections.
 Review the Restart Requirements for Database Agents
Certain database agents require that you restart the database services during the upgrade process.
If the client has database agents installed, refer to the following topics to determine whether the agents require a database restart:
For Windows Agents
For UNIX Agents
 Review Deprecated Products
Some products were deprecated in V11. Most deprecated products are either replaced or merged with new products.
For more information, see End-of-Life, Deprecated and Extended Support - Products .
 Review Upgrade Considerations
The upgrade considerations include recommendations, notes, and other important information that you must consider before and after the upgrade.
Read the considerations for the Commvault software that is installed on your clients. If you do not see an 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 requirements. For more information, see the upgrade 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 )

5/6/2017 Commvault Systems Page 290 of 587


General Upgrade Considerations for Clients (V10 to V11)
There are some upgrade considerations that apply to most clients, regardless of the agents or other software that is installed on them. Some general considerations are
related to:
Cluster environments
Third-party applications
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 291 of 587


Upgrade Considerations for the CommCell Console (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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 .

5/6/2017 Commvault Systems Page 292 of 587


Upgrade Considerations for Compliance Search (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 293 of 587


Upgrade Considerations for the DB2 Agent (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:
Note: Based on your client's operating system, also review the upgrade considerations for the Windows and UNIX File System agents. The File System Agent is a
dependency for most agents.

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.

5/6/2017 Commvault Systems Page 294 of 587


Upgrade Considerations for the Documentum Agent (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:
Note: Based on your client's operating system, also review the upgrade considerations for the Windows and UNIX File System agents. The File System Agent is a
dependency for most agents.

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.

5/6/2017 Commvault Systems Page 295 of 587


Upgrade Considerations for Exchange Server Agents (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning.

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 .

5/6/2017 Commvault Systems Page 296 of 587


Upgrade Considerations for the IBM i File System Agent (V10 to V11)
Upgrades for IBM i are supported from Commvault Version 10 Service Pack 14 to Commvault Version 11 Service Pack 5 or later.

5/6/2017 Commvault Systems Page 297 of 587


Upgrade Considerations for IBM Agents (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 298 of 587


Upgrade Considerations for the Informix Agent (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 299 of 587


Upgrade Considerations for the Macintosh File System Agent (V10 to V11)
To ensure a successful upgrade from V10 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:
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.

5/6/2017 Commvault Systems Page 300 of 587


Upgrade Considerations for the Private Metrics Reporting Server (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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 .

5/6/2017 Commvault Systems Page 301 of 587


Upgrade Considerations for the MySQL Agent (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:
Note: Based on your client's operating system, also review the upgrade considerations for the Windows and UNIX File System agents. The File System Agent is a
dependency for most agents.

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.

5/6/2017 Commvault Systems Page 302 of 587


Upgrade Considerations for OnePass for UNIX File System (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 303 of 587


Upgrade Considerations for OnePass for Windows File System and NAS Clients
(V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 304 of 587


Upgrade Considerations for the OpenVMS File System Agent (V10 to V11)
Upgrades for OpenVMS are supported from Commvault Version 10 Service Pack 14 to Commvault Version 11 Service Pack 5 or later.

5/6/2017 Commvault Systems Page 305 of 587


Upgrade Considerations for the Oracle Agent (V10 to V11)
To ensure a successful upgrade from V10 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:
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 .

5/6/2017 Commvault Systems Page 306 of 587


Upgrade Considerations for the Oracle RAC Agent (V10 to V11)
To ensure a successful upgrade from V10 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
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.

5/6/2017 Commvault Systems Page 307 of 587


Upgrade Considerations for SAP HANA Agents (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:
Note: Based on your client's operating system, also review the upgrade considerations for the UNIX File System agent. The File System Agent is a dependency for most
agents.

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 .

5/6/2017 Commvault Systems Page 308 of 587


Upgrade Considerations for SAP for Oracle Agent (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:
Note: Based on your client's operating system, also review the upgrade considerations for the Windows and UNIX File System agents. The File System Agent is a
dependency for most agents.

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 .

5/6/2017 Commvault Systems Page 309 of 587


Upgrade Considerations for SAP for MaxDB Agents (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:
Note: Based on your client's operating system, also review the upgrade considerations for the Windows and UNIX File System agents. The File System Agent is a
dependency for most agents.

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.

5/6/2017 Commvault Systems Page 310 of 587


Upgrade Considerations for the Search Engine (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 311 of 587


Upgrade Considerations for the UNIX File System Agent (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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

5/6/2017 Commvault Systems Page 312 of 587


Upgrade Considerations for the Virtual Server Agent for Amazon (V10 to V11)
To ensure a successful upgrade from V10 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:
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.

5/6/2017 Commvault Systems Page 313 of 587


Upgrade Considerations for the Virtual Server Agent for Citrix Xen (V10 to V11)
To ensure a successful upgrade from V10 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:
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.

5/6/2017 Commvault Systems Page 314 of 587


Upgrade Considerations for the Virtual Server Agent for Microsoft Azure (V10 to
V11)
To ensure a successful upgrade from V10 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:
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.

5/6/2017 Commvault Systems Page 315 of 587


Upgrade Considerations for the Virtual Server Agent for Microsoft Hyper-V (V10
to V11)
To ensure a successful upgrade from V10 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:
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.

5/6/2017 Commvault Systems Page 316 of 587


Upgrade Considerations for the Virtual Server Agent for VMware (V10 to V11)
To ensure a successful upgrade from V10 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:
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.

5/6/2017 Commvault Systems Page 317 of 587


Upgrade Considerations for the Web Console (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 318 of 587


Upgrade Considerations for the Web Server (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 319 of 587


Upgrade Considerations for the Windows File System Agent (V10 to V11)
To ensure a successful upgrade from V10 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:
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.

5/6/2017 Commvault Systems Page 320 of 587


Upgrade Considerations for 1-Touch for UNIX (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:

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 .

5/6/2017 Commvault Systems Page 321 of 587


Upgrade Considerations for 1-Touch for Windows (V10 to V11)
To ensure a successful upgrade from V10 to V11, review the following considerations as part of your upgrade planning:
Important: You must uninstall the 1-Touch server software from your client. In V11, you do not require the 1-Touch Server to obtain the ISO file for recovery operations.
You can directly download the ISO file from the Cloud Services web site. For instructions, see Preparing for Recovery - 1-Touch for Windows.

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.

5/6/2017 Commvault Systems Page 323 of 587


General Upgrade Considerations for Clients (V9 to V11)
There are some upgrade considerations that apply to most clients, regardless of the agents or other software that is installed on them. Some general considerations are
related to:
Cluster environments
Third-party applications
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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.

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.

5/6/2017 Commvault Systems Page 325 of 587


Upgrade Considerations for the CommCell Console (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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 .

5/6/2017 Commvault Systems Page 326 of 587


Upgrade Considerations for Compliance Search (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 327 of 587


Upgrade Considerations for ContinuousDataReplicator (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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 .

5/6/2017 Commvault Systems Page 328 of 587


Upgrade Considerations for Data Classification for UNIX (V9 to V11)
Upgrades are not supported from V9 to V11. In V10, Data Classification was replaced by the Optimized Scan feature. This feature is not supported on clients upgraded
from V9.
You can upgrade V10 clients that use the Optimized Scan feature. There are no upgrade considerations for V10 to V11 upgrades.

5/6/2017 Commvault Systems Page 329 of 587


Upgrade Considerations for the DB2 Agent (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:
Note: Based on your client's operating system, also review the upgrade considerations for the Windows and UNIX File System agents. The File System Agent is a
dependency for most agents.

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.

5/6/2017 Commvault Systems Page 330 of 587


Upgrade Considerations for the Documentum Agent (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:
Note: Based on your client's operating system, also review the upgrade considerations for the Windows and UNIX File System agents. The File System Agent is a
dependency for most agents.

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.

5/6/2017 Commvault Systems Page 331 of 587


Upgrade Considerations for Exchange Server Agents (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning.

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 .

5/6/2017 Commvault Systems Page 332 of 587


Upgrade Considerations for IBM Agents (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 333 of 587


Upgrade Considerations for the Informix 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
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.

5/6/2017 Commvault Systems Page 334 of 587


Upgrade Considerations for the MySQL Agent (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:
Note: Based on your client's operating system, also review the upgrade considerations for the Windows and UNIX File System agents. The File System Agent is a
dependency for most agents.

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.

5/6/2017 Commvault Systems Page 335 of 587


Upgrade Considerations for OnePass for UNIX File System (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 336 of 587


Upgrade Considerations for OnePass for Windows File System and NAS File
Archiver Clients (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 337 of 587


Upgrade Considerations for the Oracle 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:
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.

5/6/2017 Commvault Systems Page 340 of 587


Upgrade Considerations for SAP for Oracle (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:
Note: Based on your client's operating system, also review the upgrade considerations for the Windows and UNIX File System agents. The File System Agent is a
dependency for most agents.

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 .

5/6/2017 Commvault Systems Page 341 of 587


Upgrade Considerations for SAP for MaxDB Agents (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:
Note: Based on your client's operating system, also review the upgrade considerations for the Windows and UNIX File System agents. The File System Agent is a
dependency for most agents.

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.

5/6/2017 Commvault Systems Page 342 of 587


Upgrade Considerations for the Search Engine (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 343 of 587


Upgrade Considerations for the SharePoint Server 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:
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 .

5/6/2017 Commvault Systems Page 344 of 587


Upgrade Considerations for the UNIX File System 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
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

5/6/2017 Commvault Systems Page 345 of 587


Upgrade Considerations for the Virtual Server Agent for VMware (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:
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.

5/6/2017 Commvault Systems Page 346 of 587


Upgrade Considerations for the Virtual Server Agent for Microsoft Hyper-V (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:
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.?

5/6/2017 Commvault Systems Page 347 of 587


Upgrade Considerations for the Web Console (V9 to V11)
The Web Client has been renamed to Web Console. During the upgrade, the Web Console and Compliance Search packages replace the Web Client software.
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 348 of 587


Upgrade Considerations for the Web Server (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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.

5/6/2017 Commvault Systems Page 349 of 587


Upgrade Considerations for the Windows File System 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
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 .

5/6/2017 Commvault Systems Page 350 of 587


Upgrade Considerations for 1-Touch for UNIX (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:

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 .

5/6/2017 Commvault Systems Page 351 of 587


Upgrade Considerations for 1-Touch for Windows (V9 to V11)
To ensure a successful upgrade from V9 to V11, review the following considerations as part of your upgrade planning:
Important: You must uninstall the 1-Touch server software from your client. In V11, you do not require the 1-Touch Server to obtain the ISO file for recovery operations.
You can directly download the ISO file from the Cloud Services web site. For instructions, see Preparing for Recovery - 1-Touch for Windows.

Preupgrade Considerations
There is no additional information to consider before the upgrade.

Postupgrade Considerations
There is no additional information to consider after the upgrade.

5/6/2017 Commvault Systems Page 352 of 587


Preupgrade Tasks for Clients
For a successful upgrade, you must perform the following preparation tasks to address any requirement or preconfiguration before the upgrade:
 Download the Software
Choose one of the following methods to download the software:
If you plan to upgrade from the CommCell Console, no action is required. The Commvault software is automatically downloaded during the upgrade.
Note: If you have V9 clients associated with a remote cache, remove the client associations. For a successful upgrade, V9 clients must retrieve the software from the
CommServe cache, not from the remote cache.
If you plan to use the installation package, make sure that the package includes the required software. If a particular agent is missing, create a new installation
package and include the required software. For instructions, see Downloading Software for Windows Computers Using the Download Manager .
Note: The installation package that was used to upgrade the CommServe software is Windows based. If you need to upgrade UNIX computers, see Downloading
Software for UNIX, Linux, and Macintosh Computers Using the Download Manager .
 Stop Running Jobs
Jobs must not be running for the clients that you want to upgrade. Decide whether you want to wait for the jobs to finish or terminate the jobs.
 Uninstall Older Deprecated Products
If products that were deprecated in older Commvault versions are installed on the client computer, you must uninstall the deprecated products and delete them from
the CommCell Browser to prevent upgrade errors.
To review the products that were deprecated in older versions, see the following information:
For products deprecated in V10, see End-of-Life, Deprecated and Extended Support - Products .
For products deprecated in V9, see the List of Deprecated Products section in Extended Support and Deprecated Products and Platforms .
Important: When you delete an agent from the CommCell Browser, the backup data is irretrievably lost. If you want to keep the backup data from the deprecated
product, do not upgrade the client.
 Uninstall the Resource Pack
If the Resource Pack is installed on the client, failure errors will occur during the upgrade process. Based on the operating system of the client, uninstall the Resource
Pack as follows:
On Windows clients, use the option to uninstall programs from your Windows Control Panel. The program is listed as Commvault Resource Pack.
On UNIX clients, use the cvpkgrm command. In the uninstallation wizard, the Resource Pack is listed as CVGxRP.
Note: The Resource Pack is no longer available in version 11.

5/6/2017 Commvault Systems Page 353 of 587


Upgrading Clients
Upgrade clients by using either the CommCell Console or the installation package that was created from the Download Manager application.

Before You Begin


Prepare your environment for the upgrade as described in the following topics:
Plan the Client Upgrade
Preupgrade Tasks for Clients

Choose the Upgrade Method


Use one of the following methods to upgrade clients:
Remote upgrades, where you use the CommCell Console to upgrade the software remotely on one or more computers.
For instructions, see Upgrading Commvault Remotely Using the CommCell Console .
Local upgrades, where you use the installation package to upgrade the software locally on a computer.
Based on your computer's operating system, see Windows or UNIX .
Unattended upgrades, where you use the installation package to upgrade the software silently on a computer.
Based on your computer's operating system, see Windows or UNIX .

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 )

5/6/2017 Commvault Systems Page 354 of 587


Upgrade Methods
You can upgrade the Commvault software in your CommCell environment by using one of the following methods:
Using the CommCell Console
This method is available if the CommServe computer was already upgraded and if the CommServe cache directory has the required Commvault software.
This method, also known as remote upgrade, is one of the commonly used methods to upgrade the software. For instructions, see Upgrading Commvault Remotely
Using the CommCell Console .
Using the Installation Package
This method is available if an installation package was created from the Download Manager and published through a network share or DVD.
Upgrading Commvault locally on a client or MediaAgent computer is one of the most common ways to upgrade the software by using the installation package. For
instructions, see the upgrade steps on Windows or UNIX computers.
For more information on the ways you can use the installation package, see Upgrades Using the Installation Package .
Using the Download Manager (Windows Only)
This method is available if you have access to the latest Download Manager application. For instructions, see Upgrading Commvault on Windows Computers Using the
Download Manager .

5/6/2017 Commvault Systems Page 355 of 587


Upgrades Using the CommCell Console (Remote Upgrades)
Use the CommCell Console to remotely upgrade the Commvault software on client and MediaAgent computers. Upgrades from the CommCell Console are known as
remote upgrades.
When you perform a remote upgrade, the CommServe sends the binaries of the new Commvault software to each of the selected computers, and then silently upgrades
the software in parallel. The computers are upgraded to the same version that is installed on the CommServe computer (including service pack updates). For example, if the
CommServe computer is on service pack 3 (SP3), then the upgrade will include SP3.
To perform remote upgrades, the Commvault software must be available in the CommServe cache directory. If the software is not available, the software version that is
installed on the CommServe computer is automatically downloaded during the remote upgrade.
Remote upgrades are useful in the following scenarios:
You want to upgrade the software simultaneously on multiple computers without the need to physically log on to the computers. This applies to large data centers or
distributed WAN environments.
You want to schedule the upgrade to run at a specified date and time.
For instructions, see Upgrading Commvault Remotely Using the CommCell Console .

5/6/2017 Commvault Systems Page 356 of 587


Prerequisites for Upgrades Using the CommCell Console
Before you perform a remote upgrade, you must ensure that you meet certain upgrade requirements.
Important: The CommServe computer must be already upgraded.

Download the Software


To perform remote upgrades, the Commvault software must be available in the CommServe cache directory.
If the CommServe computer has Internet connectivity, no action is required. The Commvault software is automatically downloaded to the CommServe cache as part of
the upgrade job.
If the CommServe computer has Internet connectivity with restrictions, or if there is no internet connectivity, you can adjust the download settings in the CommCell
Console. For more information, see Configure Download Settings in the CommCell Console .
If the CommServe computer does not have internet connectivity, and the download settings do not satisfy your requirements, create a new installation package with all
the software needed by your organization, and then copy the package to the CommServe cache. For instructions, see the download software procedure for Windows
and UNIX computers.

Verify User Permissions


To perform remote upgrades, you must be a CommCell user with Install Package/Update permissions on the clients that you want to upgrade.
For information on assigning user permissions, see Associating Entities and Roles to a User .

Review Space Requirements for Client Computers


During the upgrade, the disk space used on the client computers might vary depending on the agents that you plan to upgrade.
The following table displays the approximate disk space required to install or upgrade agents on Windows and UNIX client computers.
Important: The space values provided in the table do not include the disk space used by the installation files that are copied to the client. Therefore, make sure to always
have additional disk space available on the client.
Package Windows UNIX
File System Core (Laptop package) 500 MB 500 MB
File System Agent 1250 MB 1050 MB
MediaAgent 1350 MB 1250 MB
Other Agents 1550 MB 1550 MB

5/6/2017 Commvault Systems Page 357 of 587


Upgrading Commvault Remotely Using the CommCell Console
You can upgrade the Commvault software on remote client and MediaAgent computers by using the CommCell Console.
If the Commvault software is not available in the CommServe cache directory, the software is automatically downloaded during the remote upgrade job.
Important: If you have V9 clients associated with a remote cache, remove the V9 client associations. For a successful upgrade, V9 clients must retrieve the software from
the CommServe cache, not from the remote cache.

Before You Begin


Review the Upgrade Support page to verify whether the software can be upgraded from the CommCell Console.
Review the prerequisites to enable upgrades from the CommCell Console. For more information, see Prerequisites for Upgrades Using the CommCell Console .
Determine whether you want to save the selections you make during the upgrade in a script so that you can run it later from the command-line interface.

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.

To save the upgrade 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 plan to upgrade.
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 Upgrade Script from the Command Line .
5. Verify the new software version on the upgraded clients or MediaAgents.
a. From the CommCell Browser, expand the Client Computers node, right-click one of the Clients that you upgraded, and then click Properties.
b. In the Client Computer Properties dialog box, click the Version tab and verify the following information:
The Version Information area must display the latest Commvault version.
The Update Status area must display the Up To Date status.
c. Click OK.

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 .

5/6/2017 Commvault Systems Page 358 of 587


Running the Remote Upgrade Script from the Command Line
You can run remote upgrades from the command line by using the .xml file that was created when you saved the upgrade in a script. The .xml file contains the selections
you made in the Upgrade Software Options dialog box of the CommCell Console.
Saving the remote upgrade in a script is useful in the following scenarios:
You want to run upgrades at a later time.
You might have a batch script with a set of administrative tasks, and you want to define the upgrade task in the batch script (by calling the .xml).

Before You Begin


You must have saved the upgrade as a script. For instructions, see Upgrading Commvault Remotely Using the CommCell Console .

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

3. To run the script (.xml file), type the following command:


qoperation execute -af Path_to_XML_File

4. To log off of the CommServe database, type the following command:


qlogout

5/6/2017 Commvault Systems Page 359 of 587


Upgrades Using the Installation Package
The installation package offers a variety of ways to upgrade the Commvault software on client and MediaAgent computers.
The following list describes the tasks you can perform using the installation package. Each of the items in the list provide a link to instructions.
Upgrade Locally on a Computer
You can upgrade the software interactively on a computer. This type of upgrade is known as local upgrade, because you upgrade the software directly on a computer.
Based on your computer's operating system, see the instructions for Windows or UNIX computers.
Run Unattended Upgrades
You can upgrade the software silently on a computer from the command line. This type of upgrade is useful if you want to use the upgrade command in a script or a
scheduling program.
Based on your computer's operating system, see the instructions for Windows or UNIX computers.

5/6/2017 Commvault Systems Page 360 of 587


Upgrading Commvault Locally on Windows Computers Using the Installation
Package
You can upgrade client and MediaAgent computers by using the installation package that was created from the Download Manager application.
Note: For the CommServe upgrade, see Upgrading the CommServe Software .

Before You Begin


Verify that the installation package that was created from the Download Manager includes the software that you want to upgrade. If some of the software is missing, create
a new installation package and include the required software. For instructions, see Downloading Software for Windows Computers Using the Download Manager .

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.

5/6/2017 Commvault Systems Page 361 of 587


Upgrading Commvault Locally on UNIX, Linux, and Macintosh Computers Using
the Installation Package
You can upgrade client and MediaAgent computers by using the installation package that was created from the Download Manager application.

Before You Begin


Verify that the installation package that was created from the Download Manager includes the software that you want to upgrade. If some of the software is missing,
create a new installation package and include the required software. For instructions, see Downloading Software for UNIX, Linux, and Macintosh Computers Using the
Download Manager .
If the installation package was distributed as a DVD, mount the DVD.
Important: On AIX 6.1 (or later) computers, if the installation package was converted to an ISO image file, do not use the loopmount command to mount the ISO.
Instead, use one of the following solutions:
Upgrade the software by using the CommCell Console .
Mount the ISO on a Linux computer and then export the NFS share to the AIX computer.

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

3. On the welcome page, click Next.


4. On the Install Task page, select Install packages on this machine and click Next.
5. On the Instance Page page, select the instance that you want to upgrade.
Remember: Instances operate independently of each other. Every instance has its own set of software binaries and services.
When you proceed to the next dialog, the upgrade process starts.
6. On the Upgrade Complete page, click Finish.
Note: If you are upgrading the software in a cluster environment, repeat the upgrade procedure for each physical node on the cluster.

5/6/2017 Commvault Systems Page 362 of 587


Running Unattended Upgrades on Windows Computers Using the Installation
Package
You can run unattended (silent) upgrades on CommServe, MediaAgent, and client computers by using the installation package that was created from the Download
Manager application.
Unattended upgrades are run from the command prompt. You can also use the upgrade command in a script or a scheduling program.
Remember: You must run the command on the computer that you want to upgrade. It cannot be used to upgrade other computers remotely. If you want to upgrade
multiple remote computers, see Running the Remote Upgrade Script from the Command Line .

Before You Begin


Verify that the installation package that was created from the Download Manager includes the software that you want to upgrade. If some of the software is missing, create
a new installation package and include the required software. For instructions, see Downloading Software for Windows Computers Using the Download Manager .

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:

Setup.exe /upgrade /silent

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

5/6/2017 Commvault Systems Page 363 of 587


Running Unattended Upgrades on UNIX, Linux, and Macintosh Computers Using
the Installation Package
You can run unattended (silent) upgrades on client and MediaAgent computers by using the installation package that was created from the Download Manager application.
Unattended upgrades are run from the command line. You can also use the upgrade command in a script or a scheduling program.
Remember: You must run the command on the computer that you want to upgrade. It cannot be used to upgrade other computers remotely. If you want to upgrade
multiple remote computers, see Running the Remote Upgrade Script from the Command Line .

Before You Begin


Verify that the installation package that was created from the Download Manager includes the software that you want to upgrade. If some of the software is missing,
create a new installation package and include the required software. For instructions, see Downloading Software for UNIX, Linux, and Macintosh Computers Using the
Download Manager .
If the installation package was distributed as a DVD, mount the DVD.
Important: On AIX 6.1 (or later) computers, if the installation package was converted to an ISO image file, do not use the loopmount command to mount the ISO.
Instead, use one of the following solutions:
Upgrade the software by using the CommCell Console .
Mount the ISO on a Linux computer and then export the NFS share to the AIX computer.

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.

5/6/2017 Commvault Systems Page 364 of 587


Upgrading Commvault on Windows Computers Using the Download Manager
You can upgrade the CommServe computer as well as Windows-based client and MediaAgent computers by using the Download Manager application.

Before You Begin


Obtain the latest Download Manager from the Cloud Services website or the Maintenance Advantage website. For instructions, see Downloading Installation Media .
Make sure that the computer where the software will be installed meets the following requirements:
The computer must have Internet connectivity so that the Download Manager can retrieve the Commvault software.
The system time of the computer must be synchronized with the time zone of your region. If the system time is ahead of or behind the real time, the upgrade will
fail.
If you upgrade a computer that has a firewall enabled, the firewall settings might prevent some of the files from being downloaded, resulting in download and
upgrade failures. To avoid this issue, configure your firewall to allow executable files to be downloaded (such as batch files), or contact your software provider for
assistance.

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.

5/6/2017 Commvault Systems Page 365 of 587


Upgrade - Support
The following table lists the available upgrade methods for each Commvault package.
Remember: Upgrades using the Download Manager are only supported on Windows computers.

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

File Archiver for Windows **


Generic File Archiver for NAS **
Virtualization UNIX / Linux / UNIX / Linux / Upgrade using the Upgrade using the Windows Windows -
Macintosh - Local Macintosh - Silent CommCell Console Download Manager - Local Silent
Virtual Server Agent for
Microsoft Hyper-V VMware
Virtual Server Agent for
VMware
Virtual Server Agent for Xen
5/6/2017 Commvault Systems Page 366 of 587
Search UNIX / Linux / UNIX / Linux / Upgrade using the Upgrade using the Windows Windows -
Macintosh - Local Macintosh - Silent CommCell Console Download Manager - Local Silent
Compliance Search
Search Engine
Laptops UNIX / Linux / UNIX / Linux / Upgrade using the Upgrade using the Windows Windows -
Macintosh - Local Macintosh - Silent CommCell Console Download Manager - Local Silent
Linux
Macintosh
Windows
Replication UNIX / Linux / UNIX / Linux / Upgrade using the Upgrade using the Windows Windows -
Macintosh - Local Macintosh - Silent CommCell Console Download Manager - Local Silent
ContinuousDataReplicator (Only Windows)
Additional UNIX / Linux / UNIX / Linux / Upgrade using the Upgrade using the Windows Windows -
Components Macintosh - Local Macintosh - Silent CommCell Console Download Manager - Local Silent

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 .

5/6/2017 Commvault Systems Page 367 of 587


Upgrades - Troubleshooting
Table of Contents
DB2 and Oracle
Failed to rename the Oracle DLL file
Upgrade failed due to running Oracle services in the remote client
UPG0004: DB2 Online Backup Fails with SQL2428N error After Upgrading Commvault
CommServe
Upgrade failed due to CommServe database files residing in the software installation path
General
Error removing the software installation directory
In a cluster, upgrade failed to retrieve the instance name of the active node
Reboot or log off requirements during the upgrade
Upgrade failed due to insufficient disk space
Upgrade failed due to insufficient privileges
Upgrade failed due to VC++ Runtime Library version
Upgrade fails when performed from mapped network drives
UPG0005: Upgrade fails with an invalid drive error
Archiving Agents
UPG0002: Error Code: [68:390] Client has one or more packages that cannot be upgraded currently.
Media Management
IND0003: Browsing Shows Incorrect Folder Sizes
Microsoft SQL Server
SQL Server services fail to start
SQL Server service pack upgrade failed
SQL Server upgrade fails due to Security Policy settings
Upgrade failed due to incorrect password for SQL Server SA user
UPG0003: Upgrade may fail with Microsoft SQL Server installation error (Unable to locate log file)
Remote Upgrade
Common Remote Upgrade Failures on UNIX Clients
Common Remote Upgrade Failures on Windows Clients
Detecting failed component installations during a Remote upgrade
Unfinished upgrade on a remote client
Upgrade failed due to communication problems between the CommServe and remote client
Upgrade failed due to running an application on a remote client
Upgrade failed due to an open software file or folder on the remote client

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.

UPG0005: Upgrade fails with an invalid drive error


Symptom
You may receive the following error message while upgrading the clients to the current version:
5/6/2017 Commvault Systems Page 368 of 587
Error 1327. Invalid Drive: <Drive>

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 .

Common Remote Upgrade Failures on UNIX Clients


Use the following steps to troubleshoot remote upgrade failures:
1. View the logs in the following location:
If the upgrade was stopped forcefully, the logs are located in /tmp/.gxsetup
Otherwise the logs are normally located at /var/log/ContentStore/Log_Files/
2. Determine the problem, such as:
Issue Resolution
Client could not connect to the CommServe Check the network connectivity between CommServe and the client computer.
Login into client computer.
Navigate to /opt/ContentStore/Base
Run the following command:
# ./cvping CommServe_host_name port_number

If you are unable to connect:


Login to CommServe computer
Navigate to C:\WINDOWS\system32\drivers\etc folder
Add IP address and Fully Qualified Domain name of client computer in the hosts file.
After resolving the above issue, ensure that the client is registered in the CommCell Console.
If the client failed halfway through and you need to restart Navigate to /opt/CVPackages/10/Unix directory and launch silent install by running the
the upgrade following command:
./silent_install -upgrade Instance###

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

Kill Commvault processes. For example CVD and cvmountd processes


Remove port allocation in /etc/services. For example, search for CVD or 8400, 8402
Install the software. If the client hostname is not modified the client will be reinstalled or
upgraded in the Console
After resolving the above issue, ensure that the client is registered in the CommCell Console.

Common Remote Upgrade Failures on Windows Clients


Symptom
An automatic upgrade of a client can fail for several reasons. If a client's status is listed as Failed, the Reason for Job Delay field and/or Event Viewer will display the reason
for failure.
If the reason for failure is one of the following, automatic upgrade can be rescheduled after resolving the error.
cache directory is corrupt
network failure
reboot option was not selected
client does not have the required updates
job is pending
All other failures indicate that the upgrade must be manually completed via the client.
Resolution
Log on to the client and manually resume the upgrade.
1. From the client machine, open the Command Line Interface, go to the directory where the Commvault software is installed, and then go to the Base folder.
2. Run the following command:
Qinstaller.exe /setup
3. Follow the prompts to resume the upgrade.

5/6/2017 Commvault Systems Page 369 of 587


Detecting failed component installations during a Remote upgrade
Symptom
The upgrade succeeds with following error message:
Commvault software was upgraded to (<version number>) on the following computer(s).
Upgrade failed. Prior <software> installation has not fully completed on this remote computer.

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.

Error removing the software installation directory


Symptom
The upgrade fails with the following error message:
Setup could not remove the <Software Installation Directory> folder: <Software Installation Path>. Please manually remove this folder.

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.

Failed to rename the Oracle DLL file


Symptom
The upgrade fails with following error message:
Setup failed to rename ORASBT.DLL on remote client.

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.

Reboot or log off requirements during the upgrade


During the upgrade process, you may be asked to reboot or log off the computer. Identify the prompt in the list below, and see its corresponding resolution:
Prompt 1
<Software> Setup has detected that a reboot is required before continuing this installation.
Would you like Setup to reboot your computer now?

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.

SQL Server services fail to start


Symptom
The upgrade fails with the following error message:
MSSQLServer service failed to start. You can continue with the installation by starting the service manually from the control panel and then pressing Yes. Otherwise, press No to exit the installation.

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.

SQL Server service pack upgrade failed


Symptom
The upgrade fails with following error message:
Silent install of Microsoft SQL Server Service Pack 2 for the Software Database Engine failed. Please read the SQL log file located under the Windows folder 'Hotfix\Hotfix log' for more information.
Setup requires that Microsoft SQL Server Service Pack 2 be installed.
If the problem persists, try installing it independently or contact your software provider for assistance.

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.

SQL Server upgrade fails due to Security Policy settings


Symptom
The SQL Server upgrade fails with following error message:
The current Security Policy setting for 'Minimum password length' is greater than 8 characters. The upgrade program for SQL Server 2005 requires this to be 8 characters or less, otherwise it will fail. Please
temporarily lower 'Minimum password length' to 8 characters, then resume the upgrade. After the SQL is upgraded, you can change the setting back to the original value.

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.

Unfinished upgrade on a remote client


Symptom
The upgrade fails with the following error message:
Prior Commvault installation has not fully completed on this remote client. Please resume installation locally on this remote client.

5/6/2017 Commvault Systems Page 371 of 587


Cause
File(s) or folder(s) within the Commvault installation directory may be open on the remote client computer.
Resolution
Verify that all the file(s)/folder(s) are closed in the software installation directory and then re-run the upgrade (locally or remotely).

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.

Upgrade failed due to running an application on a remote client


Symptom
The upgrade fails with the following error message:
Setup detected that <application name> is running.
To continue with this installation session, Setup requires this application be closed.
Close <application name> and click YES to continue or click NO to exit.

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.

5/6/2017 Commvault Systems Page 372 of 587


Resolution
Close the application window and then re-run the upgrade (remotely or locally).

Upgrade failed due to incorrect password for SQL Server SA user


Symptom
During the CommServe upgrade, the software asks for the password of the 'sa' SQL Server user in order to proceed with the upgrade. If you provide an invalid password,
the upgrade fails with the following error message:
The installation could not verify the password of the SQL user.

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.

Upgrade failed due to insufficient disk space


Symptom
The upgrade fails with the following error message:
There is not enough space on the disk.

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.

Upgrade failed due to insufficient privileges


Symptom
The upgrade fails with the following error message:
Error 1303. The installer has insufficient privileges to access this directory: <Software Install path>. The installation cannot continue. Log on as administrator or contact your system administrator.

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.

Upgrade failed due to VC++ Runtime Library version


Symptom
Following error message appears while upgrading the software:
The following applications should be closed before continuing the install.

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.

Upgrade failed due to running Oracle services in the remote client


Symptom
5/6/2017 Commvault Systems Page 373 of 587
The upgrade of the Oracle agent fails with following error message:
Setup failed to stop Oracle Services.

Cause
Oracle services could not be automatically stopped by the upgrade program.
Resolution
Stop the Oracle services manually and continue the upgrade locally.

Upgrade fails when performed from mapped network drives


Symptom
The upgrade fails with following error message:
Setup failed to copy the specified upgrade script files to the install location. Refer to CommvaultInstallerLog.txt for more information.

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.

5/6/2017 Commvault Systems Page 374 of 587


Troubleshooting Errors Found During a Request an Upgrade or Test Upgrade
When you perform a request an upgrade or test upgrade operation, preupgrade checks run on your CommServe database to determine your readiness for an upgrade. If a
preupgrade check fails, the error message also displays a workaround or recommendation to fix the error.
The following table displays the most common error messages found in the Preupgrade Readiness Report or in the log generated during a test upgrade:
Note: The table does not include all the errors. If you do not find a particular error in the table, refer to the report or log file.
Error Message Workaround
Current Release ?13' is not supported for upgrade to 11.0. The CommServe computer is from Commvault V8.
Supported versions are 14 and 15 You must upgrade the CommServe computer to V9 or V10 before you can upgrade
to V11.
If you are upgrading an V9 CommServe: Install V9 Service Pack 14 or later on the production CommServe, and repeat the
Current service pack level ?SP XX? is not supported for upgrade to version 11. request for upgrade (or test upgrade) operation.
You must install service pack ?SP 14 or later? before upgrading to version 11.
If you are upgrading an v10 CommServe: Install V10 Service Pack 9 or later on the production CommServe, and repeat the
Current service pack level ?SP XX? is not supported for upgrade to version 11. request for upgrade (or test upgrade) operation.
Please install Service Pack ?SP 11 or higher? before upgrading to version 11.
#### ERROR : Duplicate client names found. Rename the clients that have duplicate names, and repeat the request for upgrade
#### Please resolve the following client name conflicts. (or test upgrade) operation.
To rename a client, see Changing the Client Computer Name .
#### ERROR : Duplicate client host names found. Rename the clients that have duplicate host names in the network, and repeat the
#### Please resolve the following host name conflicts. request for upgrade (or test upgrade) operation.
#### ERROR : Spaces are not allowed in client names. Remove the spaces from the client names and repeat the request for upgrade (or
#### Please rename the following client names. test upgrade) operation.
To rename a client, see Changing the Client Computer Name .
Note: For client names associated with discovered virtual machines, the spaces are
ignored.
There are clients with older software versions (more than two versions old). You must upgrade or de- Upgrade older clients to the same version as the production CommServe, and
configure the following clients. repeat the request for upgrade (or test upgrade) operation.
Following list may not be the complete list Clients older than Commvault V9 are not supported.
Note: Commvault V8 clients (running the UNIX File System Agent) are supported on
the following operating systems: AIX 5.2, Red Hat Linux 3.8, SuSE Linux 9.x, and
Ubuntu 7.x. If you want to continue to protect your V8 clients, contact
[email protected].
Error for deprecated products that cannot be upgraded: Some products (such as agents and tools) were deprecated in Commvault V11. Most
The following clients have deprecated packages installed and cannot be upgraded. deprecated products are either replaced or merged with new products.
Error for deprecated products that can be upgraded: For more information, see End-of-Life, Deprecated and Extended Support - Products
The following clients have deprecated packages installed. After upgrading to version 11, you can use this .
agent to recover data, but you cannot use it to archive data. To archive data, use the OnePass feature.
For more information about OnePass, refer to the Documentation site.
The CommServe database is partially upgraded from a previous attempt. Retry to restore the database dump and repeat the test upgrade operation.
You must roll back the database and resume the upgrade.
Space available on disk [x] where log files of database [x] exist is less than 3 times the size of database.
Verify that the computer hosting the standby CommServe has sufficient disk space.
You must have at least [x] free space available on disk [x]. The CommServe upgrade might require at least three times the size of the current
database.
The following MediaAgent is used for DR backup and need to be upgraded immediately after CS Informational message - No action required.
upgrade: Remember to upgrade the MediaAgent that is used for disaster recovery backups as
soon as the CommServe is upgraded.
The following clients have Web Server or Web Client installed and need to be upgraded immediately after Informational message - No action required.
the CommServe upgrade: Remember to upgrade the Web Server and Web Client as soon as the CommServe is
upgraded.
The following clients have delay upgraded packages installed and can only be upgraded later. Please refer Some of your clients contain Commvault packages that currently do not support
to the documentation for details. upgrades. Upgrades will be available in a future service pack.
For more information, see Upgrade Support .
The following clients have deprecated packages installed and cannot be upgraded Uninstall deprecated packages, and repeat the request for upgrade (or test
upgrade) operation.
For more information on deprecated products, see End-of-Life, Deprecated and
Extended Support - Products .
The following clients which need to be upgraded immediately also have deprecated or delay upgraded Make sure to uninstall deprecated packages, or delayed upgrade packages, and
packages installed upgrade the client as soon as the CommServe is upgraded.
CS cannot be upgraded with the following deprecated or delay upgraded packages installed Make sure to uninstall deprecated packages, or the delayed upgrade packages, from
the production CommServe, and repeat the request for upgrade (or test upgrade)
operation.
The following version 9 clients have a service pack level lower than service pack 3. Install V9 Service Pack 14 or later on all of the clients in your CommCell
Before you retry the upgrade, make sure that these version 9 clients have service pack 3 or later. environment. Then, repeat the request for upgrade (or test upgrade) operation.
Please convert the database to SIMPLE from FULL before performing upgrade for DM2 Open the Web Server (DM2) database in the Microsoft SQL Server Management
Studio and change the recovery model to simple.
For instructions, see the Microsoft SQL Server Management Studio documentation.
The following version 10 MediaAgents hosting the DDB have a low service pack level. For MediaAgents that are hosting the deduplication database (DDB), make sure to
Before you retry the upgrade, make sure these MediaAgents have a minimum of Service Pack 11. install the following service packs:
For V10, install service pack 11.
For V9, install service pack 14.
The following MediaAgents might be hosting more than one active DDB on the same File system volume. Informational message - No action required.
This could cause severe performance issues with Deduplication based backups and pruning. If the deduplication databases (DDB) reside on the same volume, move the DDBs to
separate volumes.
5/6/2017 Commvault Systems Page 375 of 587
Found one or more disk libraries that use Dynamic or DRU Mount paths, which are no longer supported Deconfigure the Data Retention Utility (DRU) and the dynamic mount paths before
in Version 11. you upgrade to V11.
The following libraries are configured with DRU or Dynamic Mount paths. The upgrade process to
Version 11 will fail if this is not corrected.
The CommServe has both [Protected Virtual Machines] and [CPU Sockets on Hypervisor Hosts] Contact your Software Provider and acquire a new license file with only one of the
licenses, which are mutually exclusive starting from version 11. virtual machine licenses.
The following clients have database versions that are no longer supported in the latest software version. Informational message - No action required.
The clients will continue to operate in V11, but in backward compatibility mode.

5/6/2017 Commvault Systems Page 376 of 587


Upgrades - FAQ
This page includes frequently asked questions about the upgrade process.

How can I request an upgrade?


You can request an upgrade by using the Request Upgrade to V11 option on the Cloud Services website. For instructions, see Requesting an Upgrade through the Cloud
Services Website .
If you have problems requesting an upgrade, review the following list and find the appropriate resolution for your problem.
I do not see the option in my dashboard.
When your CommServe computer is eligible for upgrade, the Request Upgrade to V11 option appears in your dashboard. If the option is not available, your
CommServe might not be enabled for upgrade yet. Send an email to [email protected] to add the Operational Intelligence Foundation Package (OIFP) SKU to
your CommServe.
I do not have a Cloud Services account to access the dashboard.
Creating a Cloud Services account involves registering your CommServe computer.
For V10 users, see Registering a CommServe Computer Through the Cloud Services Website .
For V9 users, see Registering a v9 CommServe Computer Through the CommCell Console .
I have a Cloud Services account but cannot see my dashboard.
Your CommServe computer might not be sending diagnostic data to the cloud. Make sure that the CommCell Diagnostics and Usage check box is enabled on the
CommCell Console. For instructions, see Activating Cloud Metrics Reports .
My CommServe computer is not connected to the Internet.
You can try the alternative methods described in Request an Upgrade .
I do not want to upload my CommServe database to the cloud.
You can use the Database Upgrade tool to test the CommServe upgrade and detect possible issues during the upgrade process. For instructions, see Testing the
CommServe Upgrade Using the Database Upgrade Tool .
If you have any questions about the upgrade process, contact your Account Team Representative or send an email to [email protected] including your
CommCell ID. You can find the ID in the License Administration dialog box of the CommCell Console's Control Panel.

5/6/2017 Commvault Systems Page 377 of 587


Service Packs
A service pack is a collection of updates released on a periodic basis to resolve software issues and to enhance software performance. Each service pack contains a
cumulative set of hotfixes that were released since the product was released. Each service pack might also contain additional updates that are installed automatically with
the Service Pack. These updates do not require a separate installation.
We recommend that you install the latest service pack to remain current with all fixes and enhancements. However, we fully support customers on the three most recent
service packs. For more information on the service pack lifecycle support policy, see End-of-Life, Deprecated and Extended Support - Obsolescence Policy .
You are not required to have the latest service pack installed in order to raise or escalate a Ticket Request (TR) with Customer Support. In some cases, Customer Support
might request that you install the latest service pack if the service pack contains a fix or helps in the diagnostic process.

Service Pack Release Cycle


Service packs are available in a 90-day cycle. Every service pack undergoes full regression testing prior to release.
In addition, the Documentation web site is updated with every service pack release. The updates to the web site include revisions, corrections, and new feature
documentation.

Service Pack Installation


Service packs must be installed in the following sequence: first on the CommServe computer, then on MediaAgent and client computers.
Choose how you want to install the service pack in your CommCell environment:
Configure Automatic Service Pack Installations
Set up a schedule to automatically run the service pack installation at specific times. For example, you can set it up to run every 90 days.
Run Manual Service Pack Installations
Select a method to install the service pack manually in your CommCell environment.
Note: If you already installed the service pack in your CommCell environment, see Managing Service Packs .

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 .

5/6/2017 Commvault Systems Page 378 of 587


Available Service Packs in Version 11
This page contains links to information about the most recent service packs for V11.

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

5/6/2017 Commvault Systems Page 379 of 587


Plan the Service Pack Installation
For a successful installation, perform the following preparation tasks before you install the service pack.
Important: After the installation, the service pack cannot be uninstalled (that is, rolling back to the previous service pack version). Make sure that you plan the installation
accordingly.
 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. On the CommServe computer
2. On the MediaAgents and client computers
Tip: 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 on the 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 Multiple Packages
MediaAgent
Windows 700 MB 750 MB 800 MB
UNIX 750 MB 1 GB 1.5 GB
Linux 500 MB 700 MB 1 GB
Macintosh 450 MB N/A 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 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
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 .
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.
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. 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.
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 see Manually Discovering SAP HANA Databases .

5/6/2017 Commvault Systems Page 380 of 587


Configuring Automatic Service Pack Installations
By default, the System Created Install Software schedule installs service pack updates and hotfixes on all of your clients.
If you do not want to install the service pack on all of your clients at the same time, you can disable the system created schedule and set up your own schedules. For
example, you could set up a schedule that updates the CommServe computer along with important MediaAgents and clients, and another schedule for the remaining
clients.
A new service pack is released every 90 days. To keep your CommCell environment up to date, we recommend that the automatic service pack installations run every three
or four months.

Before You Begin


Review general guidelines that you must consider when a service pack is installed in your CommCell environment. For more information, see Plan the Service Pack
Installation .
Schedule the software download.
When you set up a schedule to install the latest service pack version of the Commvault software, you must also set up a schedule to download the software. Make sure
that the software download is scheduled at an earlier time than the installation schedule.
For instructions, see Downloading Software Using the CommCell Console .

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

5/6/2017 Commvault Systems Page 381 of 587


Run Manual Service Pack Installations
You can install the service pack manually on the CommServe, MediaAgents, and client computers by using one of the following methods.
Using the CommCell Console
This method is available if the CommServe cache directory has the required Commvault software.
This is the most commonly used method to install service packs. For instructions, see Installing the Service Pack Remotely Using the CommCell Console .
Tip: You can also use this method to save the installation task in a script which you can run silently from the command line.
Using the Installation Package
This method is available if an installation package was created from the Download Manager and published through a network share or DVD.
Based on your computer's operating system, see installing service packs locally on Windows or UNIX .
Using the Download Manager (Windows Only)
This method is available if you have access to the Download Manager application. For instructions, see Installing the Service Pack Using the Download Manager .
Some clients in your CommCell environment might require specific instructions to install the service pack. Refer to the topics that apply to your environment:
If you have clients that have RPM package installed, see Installing the Service Pack on RPM Package Clients .
If you have clients with only the CommCell Console installed, see Installing the Service Pack on a Standalone CommCell Console .

5/6/2017 Commvault Systems Page 382 of 587


Installing the Service Pack Remotely Using the CommCell Console
You can install the service pack on the CommServe, MediaAgents, and client computers by using the CommCell Console.
If you choose to install the service pack on the CommServe computer and on other computers in your CommCell environment, the CommCell Console installs the service
pack on the CommServe computer first, and then on the MediaAgents and the clients that you selected.
Note: Clients from older Commvault versions are also updated with their respective service pack version, except for Version 9 clients. If you have V9 clients, you must install
V9 service pack and updates locally on the clients.

Before You Begin


Review general guidelines to prepare your environment for the installation as described in Plan the Service Pack Installation .
Download the Commvault software and review other requirements to enable installations from the CommCell Console. For more information, see Prerequisites for
Service Pack Installations Using the CommCell Console .
Determine whether you want to save the selections that you make during the installation in a script so that you can run it later from the command-line interface.

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

5/6/2017 Commvault Systems Page 383 of 587


Prerequisites for Service Pack Installations Using the CommCell Console
Before you perform a remote installation, make sure to address the following prerequisites and requirements.
 Download the Software
Use the CommCell Console to download the Commvault software from the latest service pack version (or from any other version available in the Commvault FTP site).
The software includes the required service pack updates.
For instructions, see Downloading Software Using the CommCell Console .
Notes:
If the service pack version that you want to download is already installed on the CommServe computer, no action is required. When you perform a remote
installation, the software is downloaded automatically in the following scenarios:
The software version in the CommServe cache directory is lower than the version installed on the CommServe computer.
There is no software in the CommServe cache directory.
If you want to install updates for Version 10 clients and the CommServe computer does not have Internet connectivity, see Copying Version 10 Updates to a Version
11 CommServe Cache .
 Verify User Permissions
To perform remote installations, you must be a CommCell user with the right set of permissions, as follows:
To install on the CommServe computer, you must be a user with Administrative Management permissions at the CommCell level.
To install on any other client in the CommCell environment, you must be a CommCell user with Install Package/Update permissions on the client where you want
to install the service pack.
For information on assigning user permissions, see Associating Entities and Roles to a User .
 Review Space Requirements for Client Computers
The space required to install a service pack is calculated as follows: space required for service pack files + space required for hotfixes.
The following tables display the approximate disk space required to install a service pack for agents on Windows and UNIX client computers.
Note: If the installation files are already present in the client, the disk space required to install a service pack will be lower than the space values provided in the tables.
Space requirement for Windows Clients
Package Space Requirement
File System Core (Laptop package) 600 MB
File System Agent 1500 MB
MediaAgent 1620 MB
Other Agents 1860 MB
Space requirement for UNIX Clients
Package Space Requirement
File System Core (Laptop package) 600 MB
File System Agent 1260 MB
MediaAgent 1500 MB
Other Agents 1860 MB

 Enable Client Readiness Validation During the Service Pack Installation


By default, client readiness checks are disabled during the service pack installation. If you want to enable the readiness checks, see Enabling Client Readiness Validation
During Service Pack Installations .

5/6/2017 Commvault Systems Page 384 of 587


Running the Remote Service Pack Installation Script from the Command Line
You can run remote service pack installations from the command line by using the .xml file that was created when you saved the installation in a script. The .xml file
contains the selections you made during the installation.
Saving the remote installation in a script is useful in the following scenarios:
You want to run the installation at a later time.
You want to save your installation selections if you plan to reuse the script to install the service pack on the same clients.
You might have a batch script with a set of administrative tasks, and you want to define the installation task in the batch script (by calling the .xml).

Before You Begin


You must have saved the installation as a script. For instructions, see Installing the Service Pack Remotely Using the CommCell Console .

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

3. To run the script (.xml file), type the following command:


qoperation execute -af Path_to_XML_File

4. To log off of the CommServe database, type the following command:


qlogout

5/6/2017 Commvault Systems Page 385 of 587


Copying Version 10 Updates to a Version 11 CommServe Cache
By default, when you download the Commvault software from the CommCell Console, updates are also downloaded for your Version 10 clients.
If the CommServe computer does not have Internet connectivity, you can copy Version 10 updates to the CommServe cache manually.

Before You Begin


Download the V10 Service Pack software and extract its contents to a location that is accessible by the CommServe computer.
If hotfixes are available for the service pack, complete the following steps:
1. Download the hotfixes to the same location where you downloaded the V10 Service Pack.
2. Extract each hotfix to a folder that has the same name as the hotfix.
3. For each hotfix folder, keep the BinaryPayload and Config folders, and delete the rest of the files.

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:

4. If you also downloaded hotfixes, complete the following steps:


a. Create the Updates folder in the OS_Name folder.
b. Copy the hotfix folders to the Updates folder.
For example, if you copied a hotfix for Windows x64 computers, the WinX64 folder (which represents the OS_Name folder) 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.

5/6/2017 Commvault Systems Page 386 of 587


Enabling Client Readiness Validation During Service Pack Installations
By default, the CommServe optimizes the service pack installation by skipping a set of readiness checks, which evaluate the client readiness before the service pack is
installed.
Note: When you enable the readiness checks, the service pack installation time might increase.
The readiness checks are as follows:
Client connectivity check
Verifies whether the client can communicate with the CommServe computer.
Disk space check
Verifies whether the client has sufficient disk space for the updates to be installed.
Package synchronization
Verifies whether the updates are already installed on the client.

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.

5/6/2017 Commvault Systems Page 387 of 587


Installing the Service Pack Locally on Windows Computers Using the Installation
Package
You can install the service pack on the CommServe computer, MediaAgents, and client computers by using the installation package that was created from the Download
Manager application.

Before You Begin


Review general guidelines to prepare your environment for the installation as described in Plan the Service Pack Installation .
Obtain the latest service pack version of the Download Manager application and use it to download the Commvault software. For instructions, see Downloading
Software for Windows Computers .
The installation package that is created during the download includes the required service pack updates. Make sure to download the software that you want to update,
such as agents, tools, and so on.

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

5/6/2017 Commvault Systems Page 388 of 587


Installing the Service Pack Locally on UNIX, Linux, or Macintosh Computers Using
the Installation Package
You can install the service pack on MediaAgents and client computers by using the installation package that was created from the Download Manager application.

Before You Begin


Review general guidelines to prepare your environment for the installation as described in Plan the Service Pack Installation .
Obtain the latest service pack version of the Download Manager application and use it to download the Commvault software. For instructions, see Downloading
Software for UNIX, Linux, and Macintosh Computers .
The installation package that is created during the download includes the required service pack updates. Make sure to download the software that you want to update,
such as agents, tools, and so on.

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 welcome dialog, click Next.


4. On the Install Task dialog, click Install packages on this machine, and then click Next.
5. On the Instance Page dialog, select the instance where you want to install the service pack, and then click Next.
6. On the Install Task dialog, click Install service pack, and then click Next.
7. On the Summary dialog, click Next.
The service pack installation starts.
8. On the Installation Status dialog, 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 .

Related Tasks
Managing Service Packs

5/6/2017 Commvault Systems Page 389 of 587


Installing the Service Pack on Windows Computers Using the Download Manager
You can install the service pack locally on Windows computers by using the Download Manager application.

Before You Begin


Obtain the latest Download Manager application from the Cloud Services website or the Maintenance Advantage website. For instructions, see Downloading Installation
Media .
Note: The application is available for the last three service pack versions of the Commvault software. Although we recommend that you obtain the application with the
latest service pack version, you can obtain any version. Remember that the version must be higher than the one that is installed in your environment (you cannot roll
back to a previous version).
Make sure that the computer where the software will be installed meets the following requirements:
The computer must have Internet connectivity so that the Download Manager can retrieve the Commvault software.
The system time of the computer must be synchronized with the time zone of your region. If the system time is ahead of or behind the time zone of your region,
then the installation will fail.
If you install Commvault on a computer that has a firewall enabled, the firewall settings might prevent some of the files from being downloaded, resulting in
download and installation failures. To avoid this issue, configure your firewall to allow executable files to be downloaded (such as batch files), or contact your
software provider for assistance.

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

5/6/2017 Commvault Systems Page 390 of 587


Installing the Service Pack on RPM Package Clients
To install the service pack on clients that have the RPM package installed, you must run the RPM upgrade command from a new RPM package. The new package must
contain the latest service pack version.
Hotfixes are installed along with the service pack. If you only want to install hotfixes, you can run the installation from the CommCell Console. For instructions, see Installing
Hotfixes .
Important: Service pack installations are supported on clients that were created using an RPM package from Service Pack 7 or a later version.

Before You Begin


Create a new RPM package using the latest installation media (such as the Download Manager). For instructions, see Creating a Custom Package for UNIX, Linux, and
Macintosh Computers .
Make sure to consider the following requirements for the new RPM package:
During the creation of the new RPM package, use the same installation directory that you configured for the old package.
The package name and instance number of the new RPM package file name must have the same name as the old package. In an RPM package file name, such as custom-
Linux.Instance001.CVGxBase0-11.0.0-80.80.0.539846.0.0.el6.centos.x86_64.rpm, the package name is custom-Linux and the instance number is Instance001.

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 .

5/6/2017 Commvault Systems Page 391 of 587


Installing the Service Pack on a Standalone CommCell Console
Applies to: CommCell Console on Windows clients
A standalone CommCell Console is a client computer with only the CommCell Console installed.
To update the CommCell Console client, you can run the service pack installation from the CommCell Console itself. You must update each CommCell Console client
individually.
You can also use the installation package to update the CommCell Console client. For instructions, see Installing the Service Pack Locally on Windows Computers .

Before You Begin


The service pack must be installed on the CommServe computer.
The CommServe cache directory must contain the Commvault software, and the software version must be the same as the one installed on the CommServe computer.
If the software is not available, see Downloading Software Using the CommCell Console .

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.

5/6/2017 Commvault Systems Page 392 of 587


Managing Service Packs
Refer to the following procedures to control and manage the service pack that is installed in your CommCell environment.
Set Up Alerts
You can set up alerts to receive notifications whenever a service pack is installed on a client. For more information, see Creating an Alert from the Alert Wizard .
To review the alert types that are available for updates, see Available Alert Criteria - Software Updates .
View the Service Pack Version Details for One or More Clients
Before or after the service pack installation, you can review the version details of the clients that you plan to update or that you updated. For more information, see
Viewing the Service Pack Details for One or More Clients .
Uninstall the Service Pack (Not Supported)
Uninstalling the current service pack (that is, rolling back to a previous service pack) is not supported.
Service packs include software changes that might be irreversible and that are not compatible with the previous service pack. Therefore, rolling back to a previous
service pack might cause unpredictable results in your CommCell environment. If you encounter a problem after installing a service pack, contact Customer Support.

5/6/2017 Commvault Systems Page 393 of 587


Viewing the Service Pack Details for One or More Clients
You can see the service pack information of your clients from the CommCell Console.

Procedure
Choose whether you want to view the service pack details for a specific client or for multiple clients.

Quick View for One or More Clients


Use this method if you want to check only the client status and its service pack version.
1. From the CommCell Browser, click the Client Computers node.
2. In the Client Computers window, verify the following columns for the clients that you want to check:
Product Version: Displays the Commvault version and the service pack version that is installed on the client. For example, 11 SP2.
Client Status: Specifies whether the client is up to date with the software version that is available in the CommServe cache. For more information, see the
Update Status section in Version .

Detailed View for One Client


Use this method if you want to see the service pack version, additional updates installed on the client, client status, and the update status of each package installed on
the client.
1. From the CommCell Browser, expand Client Computers, right-click the Client that you want to verify, and then click Properties.
2. In the Client Computer Properties dialog box, click the Version tab.
Under the Version information area, you can see the service pack version and additional updates installed on the client (if any).
Under the Update Status area, you can see the client status as well as the status of each package installed on the client. For more information, see the Update
Status section in Version .

5/6/2017 Commvault Systems Page 394 of 587


Installing Hotfixes
If the service pack is already installed, and hotfixes are made available after the service pack release, you can download and install the hotfixes on your clients.
Commvault groups hotfixes in two categories: cumulative and critical.
Cumulative hotfixes are all the hotfixes that are available for a service pack, which include critical hotfixes and optional updates. You can download cumulative hotfixes
from the Cloud Services website.
Critical hotfixes are important updates for your CommCell environment. You can download critical hotfixes from the CommCell Console.

Before You Begin


Download the hotfixes by selecting the scenario that applies to your CommCell environment:
Note: If you need to download cumulative hotfixes, follow the download steps that correspond to the CommServe computer without Internet connectivity.

CommServe computer has Internet connectivity


You must download the hotfixes using the CommCell Console.
1. From the Tools tab in the CommCell Console ribbon, click Add/Remove Software > Download Software.
2. In the Download and Sync Cache Options dialog box, click Latest Hotfixes for the installed service pack.
For complete instructions, see Downloading Software Using the CommCell Console .

CommServe computer does NOT have Internet connectivity


Cumulative hotfixes are bundled in a hotfix package that uses the following naming convention: SP n Available Hotfix Pack ( date).
You must download the hotfix package from the Cloud Services website and then copy the package to the CommServe cache.
1. On the Download Center page of the Cloud Services Web site, click the v11 Hotfix category filter and then download the hotifx package that you need.
For more information about downloading software from the cloud, see Downloading Installation Media .
Tip: Download the package to a dedicated folder. The package for Windows clients is an EXE file, and for UNIX is a TAR file.
2. After the download, copy the hotfixes to the CommServe cache.
a. From the CommCell Console ribbon, click the Tools tab and then click Add/Remove Software > Copy Software.
The Copy Software Options dialog box appears.
b. In the Copy Software From Location box, specify the path of the folder where you downloaded the package.
Note: If the package is in a network share, use the Impersonate User option to specify a user account with sufficient permissions to access the share.
c. Click OK.

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.

5/6/2017 Commvault Systems Page 395 of 587


Troubleshooting Service Pack Installations
USP0001: Installation of Updates Fail on Client Computers
Symptom 1
The installation of an update on a client fails with the following error message:
Client was skipped because updates for this client require a reboot. Re-submit the job and check the Reboot Client checkbox.

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.

5/6/2017 Commvault Systems Page 396 of 587


Download the Commvault Software
The Commvault software consists of agents, server packages, and tools, as well as updates from the current service pack.
When you download the software needed by your environment, Commvault bundles the necessary software files in an installation package (also called installation media),
which allows you to perform the following tasks:
Install agents, tools, or other Commvault software on new computers.
Install service pack updates on computers that have the Commvault software installed.
Upgrade computers that have previous versions of the software.
You can download the software by using the Download Manager or the CommCell Console.

Download Using the Download Manager


Use this download method if you want to run installations or upgrades from an installation package. The Download Manager application bundles an installation package
with the software you choose to download.
You can download software for Windows and UNIX computers. For instructions, choose the appropriate download procedure:
For Windows Computers
For UNIX, Linux, and Macintosh Computers

Download Using the CommCell Console


Use this download method if you want to run installations or upgrades from the CommCell Console. The software is downloaded to the CommServe cache directory.
For more information, see Downloading Software Using the CommCell Console .
Remember: The CommServe software and CommCell Console must be already installed in your environment.

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 .

5/6/2017 Commvault Systems Page 397 of 587


Downloading Software for Windows Computers Using the Download Manager
You can download the latest Commvault software by using the Download Manager application. During the download, the application bundles an installation package with
the agents, tools, and other Commvault software that you choose to download. The download operation is also referred to as creating an installation package.
The installation package is useful in the following scenarios:
You are setting up your CommCell environment for the first time.
You cannot download the software using the CommCell Console because the CommServe computer does not have Internet connectivity.
You want to physically install or upgrade the software on a computer. For example, the CommServe, Web Server, and other server packages must be installed by using
the installation package.
You want to perform advanced operations, such as recording your installation to perform unattended installations.

Before You Begin


Obtain the latest Download Manager application from the Cloud Services website or the Maintenance Advantage website. For instructions, see Downloading Installation
Media .
Note: The application is available for the last three service pack versions of the Commvault software. Although we recommend that you obtain the application with the
latest service pack version, you can obtain any version. Remember that the version must be higher than the one that is installed in your environment (you cannot roll back
to a previous version).

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:

Method 1: Creating a DVD


Use this method if you want to provide the installation package on a DVD.

5/6/2017 Commvault Systems Page 398 of 587


Method 2: Copying the Package to a Network Share
Use this method if you want users to retrieve the package from a network share. You can also use this method to copy the installation package directly to a client
computer.
Method 3: Copying the Package to the CommServe Cache
Use this method if you want users to install or upgrade the software using the CommCell Console. Remember that the CommServe software must be already
installed or upgraded.

Method 1: Creating a DVD


Locate the package contents and perform one of the following steps:
Write the package contents directly to a DVD.
Create an ISO image file using third-party tools.
Method 2: Copying the Package to a Network Share
Copy and paste the package contents to a network share or to a specific Windows computer.
After the package is transferred, check if the version file was copied. If it was not copied, make sure to copy the version file to the network share.
Method 3: Copying the Package to the CommServe Cache
You can copy the package to the CommServe cache by using the CommCell Console. If the CommServe cache already has the Commvault software, the copy operation will
replace old software files with new ones.
Before the copy, you must review the following requirements:
The package must contain all the Commvault software. The copy operation does not support packages that include only selected software.
The CommServe cache directory only supports packages from the current Commvault version. If you have packages from older versions, do not copy them.
Use the following steps to copy the package by using the CommCell Console:
1. From the CommCell Console ribbon, click the Tools tab and then click Add/Remove Software > Copy Software.
2. In the Copy Software Options dialog box, complete the following steps:
a. In the Copy Software From Location box, specify the path to the directory where the package contents are located.
Note: If the package is in a network or NFS share, use the Impersonate User option to specify a user account with sufficient permissions to access the share.
b. By default, the CommCell Console copies the package to the CommServe cache and synchronizes the remote cache directories with the CommServe cache.
If you only want to copy the package and not synchronize the remote cache directories, click the Options tab and click Copy.
c. Click OK.
You can track the copy operation from the Job Controller window.

5/6/2017 Commvault Systems Page 399 of 587


Downloading Software for UNIX, Linux, and Macintosh Computers Using the
Download Manager
You can download the latest Commvault software by using the Download Manager application. During the download, the application bundles an installation package with
all the available UNIX agents and tools. The download operation is also referred to as creating an installation package.
The installation package is useful in the following scenarios:
You cannot download the software using the CommCell Console because the CommServe computer does not have Internet connectivity.
You want to physically install or upgrade the software on a computer.
You want to perform advanced operations, such as recording your installation to perform unattended installations.

Before You Begin


Obtain the latest Download Manager application from the Cloud Services website or the Maintenance Advantage website. For instructions, see Downloading Installation
Media .
Note: The application is available for the last three service pack versions of the Commvault software. Although we recommend that you obtain the application with the
latest service pack version, you can obtain any version. Remember that the version must be higher than the one that is installed in your environment (you cannot roll back
to a previous version).

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:

Method 1: Creating a DVD


Use this method if you want to provide the installation package on a DVD.
Method 2: Copying the Package to an NFS Share
Use this method if you want users to retrieve the package from an NFS share. You can also use this method to copy the installation package directly to a client
computer.
Method 3: Copying the Package to the CommServe Cache
Use this method if you want users to install or upgrade the software using the CommCell Console. Remember that the CommServe software must be already
installed or upgraded.

Method 1: Creating a DVD


Locate the package contents and perform one of the following steps:
Write the package contents directly to a DVD.
Create an ISO image file using third-party tools.
Method 2: Copying the Package to an NFS Share
Use third-party tools (for example, WinSCP) to copy the package from the Windows computer to an NFS share or to a specific UNIX computer.
We recommend that you copy the installation package, rather than the .tar file, in the following scenarios:
If you want to copy the package to a specific UNIX computer that does not have the GNU TAR utility (gtar) installed.
Note: By default, Linux includes the gtar utility, but AIX, HP-UX, and Solaris do not.
If the NFS share is used by a UNIX computer that does not have the GNU TAR utility (gtar) installed.
Copying the Package
Keep in mind the following requirements when you copy the package:
Use the SFTP or SCP transfer protocols.
Use the Binary transfer mode.
At minimum, set the 755 permissions ('rwxr-xr-x') for the package files and directories.
5/6/2017 Commvault Systems Page 400 of 587
Copying the TAR File
After the .tar file is copied to the destination computer, extract the .tar file contents by using the gtar utility.
Method 3: Copying the Package to the CommServe Cache
You can copy the package to the CommServe cache by using the CommCell Console. If the CommServe cache already has the Commvault software, the copy operation will
replace old software files with new ones.
Before the copy, you must review the following requirements:
If the package is compressed in a .tar file, use the uncompressed package, not the .tar file.
The CommServe cache directory only supports packages from the current Commvault version. If you have packages from older versions, do not copy them.
Use the following steps to copy the package by using the CommCell Console:
1. From the CommCell Console ribbon, click the Tools tab and then click Add/Remove Software > Copy Software.
2. In the Copy Software Options dialog box, complete the following steps:
a. In the Copy Software From Location box, specify the path to the directory where the package contents are located.
Note: If the package is in a network or NFS share, use the Impersonate User option to specify a user account with sufficient permissions to access the share.
b. By default, the CommCell Console copies the package to the CommServe cache and synchronizes the remote cache directories with the CommServe cache.
If you only want to copy the package and not synchronize the remote cache directories, click the Options tab and click Copy.
c. Click OK.
You can track the copy operation from the Job Controller window.

5/6/2017 Commvault Systems Page 401 of 587


Downloading Software Using the CommCell Console
When you download the Commvault software by using the CommCell Console, the software is downloaded from our FTP site to the CommServe cache directory.
By default, the System Created Download Software schedule downloads the latest service pack and synchronizes remote cache locations with the CommServe cache. You
can edit or disable the system-created schedule, but we recommend that you download the software every time a new service pack becomes available. It is a best practice
to keep the CommServe cache directory up to date or at the same service pack level as that of the CommServe computer.

Before You Begin


Review the following preparation tasks before you download the software:
Configure download options
If the CommServe computer has Internet connectivity and no restrictions on incoming or outgoing communications, no action is required.
If the CommServe computer has Internet connectivity with restrictions, or if there is no Internet connectivity, or if you want to review additional download
configurations, see Configure Download Settings in the CommCell Console .
Tip: If the CommServe computer does not have Internet connectivity, and none of the download options satisfy your requirements, create an installation package by
using the Download Manager, and then you can copy the package to the CommServe cache. Refer to the Windows or UNIX steps to download the software using the
Download Manager.
Also, if you have Version 10 clients in your CommCell environment, see Copying Version 10 Updates to a Version 11 CommServe Cache .
Verify the CommServe Cache
If you plan to change the CommServe cache location, see Changing the Location of the CommServe Cache Directory .
Determine if you need a Remote Cache
If you have a group of clients that reside in a remote location, the network traffic (and download time) might increase when the remote clients retrieve the software
from the CommServe cache. You can reduce the network traffic by configuring a remote cache directory on one of the remote clients. For more information, see Setting
Up a Remote Cache on a Client Computer .

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

5/6/2017 Commvault Systems Page 402 of 587


Configure Download Settings in the CommCell Console
By default, when you download the Commvault software by using the CommCell Console, the software is downloaded from the Commvault FTP site to the CommServe
cache directory.
If you need to adjust the default download settings, refer to the following configurations:
Configure the download options based on the Internet connectivity of your CommServe
If the CommServe computer has Internet connectivity but has restrictions on incoming or outgoing communications, you can configure an HTTP proxy to connect
to the Commvault FTP site. For instructions, see Configuring an HTTP Proxy Server .
If the CommServe computer does not have Internet connectivity, you can configure a client computer with Internet connectivity as a gateway to connect to the
Commvault FTP site. For instructions, see Configuring the CommCell Console to Download Software Using an Internet Gateway .
If you want to download the software from your own FTP site, you can configure your FTP site to retrieve the software from the Commvault FTP site. For
instructions, see Changing the FTP Site Used to Download Software .
Configure downloads to use a different network protocol
By default, download operations use the HTTPS protocol. If you want to use a different network protocol, see Changing the Network Protocol Used for Downloading
Software from the CommCell Console .
Skip the download for deconfigured clients
If you do not want to download packages and updates for deconfigured clients, you can configure an additional setting on the CommServe computer. For instructions,
see Skipping the Download of Software for Deconfigured Clients .

5/6/2017 Commvault Systems Page 403 of 587


Changing the FTP Site Used to Download Software
By default, when you install or upgrade the Commvault software by using the CommCell Console, the software is retrieved from the Commvault FTP site. If your
organization's policies prevent you from accessing an external FTP site, you can host the software in your own FTP site.
Your FTP site must be on a designated computer with access to the Commvault FTP site. Every time you download the software from the CommCell Console, the software
will be copied from the Commvault FTP site to your FTP site.
By default, the FTP configuration options are not displayed in the CommCell Console. You must configure an additional setting to display the options.

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.

5/6/2017 Commvault Systems Page 404 of 587


Changing the Network Protocol Used for Downloading Software from the
CommCell Console
By default, when you download the Commvault software by using the CommCell Console, the software is downloaded from the Commvault FTP site to the CommServe
cache directory. By default, the download operation uses the HTTPS protocol to retrieve the software.
Note: HTTPS is the default protocol for those who installed the CommServe software on or after Version 11 Service Pack 5. If your CommServe computer was upgraded
from a previous Commvault version, then the FTP protocol is your default network protocol.
Based on your organization's network requirements, you can configure download operations to use any of the following network protocols:
HTTPS and HTTP
Use the HTTPS or HTTP protocols to enforce secure communications.
When you use HTTPS or HTTP, the software is downloaded from the following software repositories: downloadcenter.commvault.com and cloud.commvault.com.
FTP
If you have clients from previous Commvault versions, you must use the FTP protocol to obtain the necessary updates for your older clients. The HTTP and HTTPS
protocols do not support the download of older updates.
When you use FTP, the software is downloaded from the following software repository: autoupdate.commvault.com.

Before You Begin


For the network protocol that you want to use, make sure that the CommServe computer has open connections to the respective software repository.

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.

5/6/2017 Commvault Systems Page 405 of 587


Configuring the CommCell Console to Download Software Using an Internet
Gateway
If the CommServe computer has no Internet connectivity, you can use a client computer as an Internet gateway to download the Commvault software from the FTP site. The
Internet gateway computer downloads the software locally, and then transfers the software to the CommServe cache. The software files are removed from the Internet
gateway computer after the transfer.
Note: The Internet gateway computer downloads software from the FTP site using direct connections. HTTP proxy connections are currently not supported.

Before You Begin


The Internet gateway computer must be a Windows client with the following properties:
V11 Service Pack 7 or a later version installed
File System Agent installed (if not installed, see Getting Started with the Windows File System )
Sufficient disk space
Internet connectivity

About This Task


When you specify a client as the Internet gateway, the following services will use the Internet gateway:
Cloud Metrics Reporting
Private Metrics Reporting
Download Software

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.

5/6/2017 Commvault Systems Page 406 of 587


Skipping the Download of Software for Deconfigured Clients
By default, when you download the software by using the CommCell Console, packages and updates are downloaded for all the clients in your CommCell environment.
If you want to reduce the size and time of the software download, you can create an additional setting to skip the software used by deconfigured clients.
This configuration prevents the download from retrieving the Commvault software for specific operating systems. For example, if you have AIX, HP-UX, Linux, and Solaris
clients in your CommCell environment, and the AIX clients are deconfigured, then the download operation will not retrieve the software for AIX operating systems.

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.

5/6/2017 Commvault Systems Page 407 of 587


Manage the CommServe Cache
The CommServe cache directory holds the Commvault software needed to perform installations and upgrades from the CommCell Console.
Based on your needs, you can perform the following tasks to manage the CommServe cache:
Change the CommServe Cache Location
If you want to change the location of the CommServe cache directory, see Changing the Location of the CommServe Cache Directory .
Synchronize the CommServe Cache Contents with the CommServe Database
If you changed the CommServe cache location or if the software was manually copied to the CommServe cache, see Committing the CommServe Cache .
View the CommServe Cache Details
If you want to see the service pack and updates that are available in the CommServe cache, see Viewing the CommServe Cache Details .
Delete the CommServe Cache Contents
To delete the contents from the CommServe cache, see Deleting the CommServe Cache Contents .

5/6/2017 Commvault Systems Page 408 of 587


Changing the Location of the CommServe Cache Directory
You can change the location of the CommServe cache directory. This operation is useful when the current location does not have sufficient disk space.
Ensure that the new directory is always located in the CommServe computer. For example, the new directory can be in a different drive.

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.

5/6/2017 Commvault Systems Page 409 of 587


Committing the CommServe Cache
When you commit the cache, the CommServe database is updated with the current configuration and contents of the CommServe cache directory.
The commit operation is useful in the following scenarios:
When you manually copy software to the CommServe cache.
When you change the location of the CommServe cache.

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.

5/6/2017 Commvault Systems Page 410 of 587


Viewing the CommServe Cache Details
You can check the contents of your CommServe cache from the CommCell Console. This operation is useful if you need to check whether the Commvault software is
available for the operating system of your client computers.
You can also check if there are additional updates available for a specific operating system.

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.

5/6/2017 Commvault Systems Page 411 of 587


Deleting the CommServe Cache Contents
You can delete the Commvault software that was downloaded to the CommServe cache. The software includes packages and update files.

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.

5/6/2017 Commvault Systems Page 412 of 587


Manage the Remote Cache
By default, when you install the Commvault software on remote clients, the clients retrieve the software from the CommServe cache. To minimize the network traffic for
remote clients on different regions or time zones, you can configure a remote cache directory on one of the remote clients. The clients associated with the remote cache
will retrieve the software from the remote cache.
To set up a remote cache, see Setting Up a Remote Cache on a Client Computer . You can set up more than one remote cache location.
If you already have a remote cache configured, you can perform the following tasks to manage the remote cache:
Manually Synchronizing the Remote Cache
If you changed or removed the contents from a remote cache accidentally, see Synchronizing the Remote Cache Contents with the CommServe Cache .
Configure the Package Synchronization Settings of a Remote Cache
If you want to adjust the amount of software that is transferred from the CommServe cache, see Configuring the Package Synchronization Settings of a Remote Cache .
Delete the Remote Cache Contents
To delete the contents from a remote cache, see Deleting the Remote Cache Contents .
Delete a Remote Cache Location
To delete the remote cache directory that you configured in a client, see Deleting a Remote Cache Location .

5/6/2017 Commvault Systems Page 413 of 587


Setting Up a Remote Cache on a Client Computer
By default, when you install the Commvault software on client computers, the clients retrieve the software from the CommServe cache.
If you have a group of clients that reside in a remote location, the network traffic and download time might increase when the clients retrieve the software from the
CommServe cache. You can minimize the network traffic by configuring a remote cache directory on one of the remote clients. The clients associated with the remote cache
will retrieve the software from the remote cache.
You can set up more than one remote cache 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 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.

5/6/2017 Commvault Systems Page 414 of 587


Configuring the Package Synchronization Settings of a Remote Cache
By default, the remote cache synchronizes specific software to reduce the amount of packages and updates that are transferred from the CommServe cache. The remote
cache synchronizes the following software:
Updates required for all the clients associated with the remote cache.
Packages required to upgrade associated clients that are from older Commvault versions.
For example, if you have a V10 client, then the remote cache retrieves V10 updates along with V11 packages and updates needed to upgrade the client.
You can adjust the synchronization settings of a remote cache to perform one of the following operations:
Synchronize additional packages for specific operating systems, in addition to the packages that are automatically synchronized. This is useful if you plan to install new
packages in the near future.
Synchronize all packages and updates that reside in the CommServe cache.

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.

5/6/2017 Commvault Systems Page 415 of 587


Synchronizing the Remote Cache Contents with the CommServe Cache
By default, the remote cache automatically synchronizes with the CommServe cache when the Commvault software is downloaded to the CommServe cache. If the software
is copied to the CommServe cache by using the CommCell Console, the remote cache is also synchronized.
You can manually synchronize the remote cache with the CommServe cache in case the remote cache contents are changed or deleted accidentally.

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.

5/6/2017 Commvault Systems Page 416 of 587


Deleting the Remote Cache Contents
You can delete the Commvault software that was downloaded to a remote cache location. The software includes packages and update files.

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.

5/6/2017 Commvault Systems Page 417 of 587


Deleting a Remote Cache Location
If you no longer need a remote cache location, you can delete the remote cache directory that you configured in your client.
During the deletion process, you must also delete the contents of the remote cache. If you only remove the remote cache directory, the cache contents will remain in the
client.

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.

5/6/2017 Commvault Systems Page 418 of 587


Installation Media List
The Commvault software can be installed in your environment by using the following media:

Media Name Media Content


Download Manager* Application supported on 32-bit and 64-bit Windows computers that allows you to download Commvault
packages.
Packages available only on 64-bit computers:
CommServe
Other server packages, such as Metrics Reporting, Web Server, and Workflow Engine.
Microsoft SQL 2012 software for the CommServe and other server packages.
Packages available on 32-bit and 64-bit computers:
MediaAgent (AIX, HP-UX, Linux, Solaris, and Windows)
CommCell Console (Linux, Macintosh, and Windows)
All Agents supported on AIX, FreeBSD, HP-UX, Linux, Macintosh, Solaris, and Windows
1-Touch Server (UNIX)
Note: The application downloads critical hotfixes along with the Commvault packages that you choose to
download. If you want to download all available hotfixes, obtain the latest hotfix package from the Cloud
Services website. For instructions, see Downloading Installation Media .
DVD04 1-Touch Linux Live DVD, also called Live Boot Disc or Disc 4.

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 .

Limited Distribution Tools


Limited distribution tools are available upon request. Contact your Software Provider to obtain the tools you need.

5/6/2017 Commvault Systems Page 419 of 587


Downloading Installation Media
You can download the latest media kit from the Cloud Services or Maintenance Advantage Web site. Always use the latest media to install the Commvault software.

Before You Begin


If you plan to download software form the Cloud Services Website, you must have a valid user account. To create an account, see Getting Access to the Cloud Services Web
Site .

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.

5/6/2017 Commvault Systems Page 420 of 587


Uninstallations
When you uninstall the Commvault software from a client computer, you can no longer perform data protection operations on the client. However, the backed up data
remains available on the media for the length of time specified in the storage policy's retention policy. Uninstalling Commvault will not delete the backed up data.
You can continue to browse the backed up data and perform out-of-place restores, which involves restoring the data to a different (active) client in the CommCell
environment. In-place restores are not supported because the client no longer has the software to handle the operation.
If you uninstall all Commvault packages from a client, the CommCell Browser displays the client as unavailable, as shown in the following illustration:

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.

5/6/2017 Commvault Systems Page 421 of 587


Uninstall Commvault from Client and MediaAgent Computers
You can use one of several methods to uninstall Commvault packages, such as agents, MediaAgents, tools, and server packages:
Uninstall remotely using the CommCell Console (Preferred Method)
You can uninstall packages remotely from one or more clients by using the CommCell Console. This method is the most commonly used method to uninstall the
software.
For instructions, see Uninstalling Commvault Remotely Using the CommCell Console .
Note: If you want to save the uninstallation task in a script so that you can run it from the command line at a later time, see Running the Remote Uninstallation Script
from the Command Line .
Uninstall locally from a client
Use the procedure that is appropriate for your client's operating system:
Uninstalling Commvault Locally from Windows Clients .
Uninstalling Commvault Locally from UNIX and Linux Clients .
Uninstalling Commvault Locally from a Macintosh Client .
Other Commvault Software
If you have UNIX native packages installed in your environment, see Uninstalling UNIX Native Packages .
If you installed the Outlook Add-In, see Uninstalling the Outlook Add-In .
If you installed the Version 8 software to protect the file system data of deprecated UNIX computers, see Uninstalling Version 8 UNIX Clients .

5/6/2017 Commvault Systems Page 422 of 587


Prepare to Uninstall Commvault from Client and MediaAgent Computers
For a successful uninstallation, you must review the following general considerations as well as the considerations for the package that you want to uninstall:

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.

Considerations for Specific Commvault Packages


If you plan to uninstall any of the following packages, review the considerations listed in the appropriate section:
Server Packages in a Cluster Environment
Server packages are those Commvault packages that are installed along with the SQL Server software, such as the Web Server, and Workflow Engine.
If you plan to uninstall a server package from a cluster environment, you must uninstall the package from all the cluster nodes before the next failover occurs.
MediaAgent
When you uninstall the MediaAgent package, the uninstallation program performs the following tasks:
Removes all the information about the MediaAgent from the CommServe database.
Deconfigures all the libraries and drives that are associated with the MediaAgent.
Releases the licenses used by the libraries and stand-alone drives that will be deconfigured.
Removes the files and registry entries from the computer hosting the MediaAgent.
Review the following considerations to prepare for the uninstallation:
If you plan to move the deduplication database to a new MediaAgent computer, you must copy the database content manually. For more information, see
Deduplication Database Move .
If you uninstall the MediaAgent from a Solaris computer, make sure to uninstall the SCSI Driver package along with the MediaAgent package.
Reassociate the storage policies that use the MediaAgent with a different MediaAgent, or delete the policies if you no longer need them. For more information, see
Deleting a Backup or Archive Storage Policy .
ContinuousDataReplicator
The ContinuousDataReplicator must be uninstalled from at least two computers:
The server from where you replicated data (source computer).
The computer where the replicated data is stored (destination computer).
For more information on the different scenarios for data replication, see Supported Configuration .
Before you uninstall the ContinuousDataReplicator from the source and destination computers, you must delete all replication sets used in your replication scenario. You
can delete replication sets if the replication pairs are in the Stopped or New Pair state. For instructions, see Delete a Replication Set .
NAS Clients
NAS components are installed automatically with the MediaAgent software. To uninstall NAS components, you must perform the following tasks on the MediaAgent
computer:
1. Deconfigure the NAS client. For instructions, see Releasing a License (Deconfiguration) .
2. If you no longer need the MediaAgent computer, uninstall the MediaAgent and other Commvault packages installed on the computer.

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.

File Share Archiver Client


If the File Share Archiver Client and the Driver for File Archiver packages are installed on the same client computer, and if you uninstall one of the packages, then:
The driver binaries are removed from the client computer.
The driver binaries from the package that is not uninstalled are also removed.

5/6/2017 Commvault Systems Page 423 of 587


Uninstalling Commvault Remotely Using the CommCell Console
You can uninstall Commvault packages from remote client or MediaAgent computers by using the CommCell Console.
Note: The CommServe package cannot be uninstalled remotely. To uninstall the CommServe package, see Uninstalling the CommServe Software .

Before You Begin


Verify user permissions:
To uninstall from the CommCell Console, you must be a CommCell user with Install Package/Update permissions on the clients where the software will be
uninstalled.
For information on assigning user permissions, see Associating Entities and Roles to a User .
If the Authentication for Agent Installs feature is enabled, users must have Install Client permissions at the CommCell level. During the uninstallation, the
program prompts for the user account credentials to validate the operation.
For a successful uninstallation, you must review some preparation tasks for the software package that you want to uninstall. For more information, see Prepare to
Uninstall Commvault from Client and MediaAgent Computers .
Determine whether you want to save the selections you make during the uninstallation in a script so that you can run it later from the command-line interface.

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 .

5/6/2017 Commvault Systems Page 424 of 587


Running the Remote Uninstallation Script from the Command Line
You can run remote uninstallations from the command line by using the .xml file that was created at the time you saved the uninstallation in a script. The .xml file contains
the selections you made in the uninstallation dialog box of the CommCell Console.
Saving the uninstallation in a script is useful in the following scenarios:
You want to uninstall the software at a later time.
You might have a batch script with a set of administrative tasks, and you want to define the uninstallation task in the batch script (by calling the .xml).

Before You Begin


You must have saved the uninstallation as a script. For instructions, see Uninstalling Commvault Remotely Using the CommCell Console .

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

3. To run the script (.xml file), type the following command:


qoperation execute -af Path_to_XML_File

4. To log off the CommServe, type the following command:


qlogout

5/6/2017 Commvault Systems Page 425 of 587


Uninstalling Commvault Locally from Windows Clients
You can uninstall Commvault packages from a client or MediaAgent computer by using one of the following methods:
Interactive uninstallation using the Windows Control Panel.
Unattended (silent) uninstallation by running a command from the command line.
Note: To uninstall the CommServe package, see Uninstalling the CommServe Software .

Before You Begin


For a successful uninstallation, you must review some preparation tasks for the software package that you want to uninstall. For more information, see Prepare to Uninstall
Commvault from Client and MediaAgent Computers .

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

To uninstall specific packages, run the following command:


Setup.exe /uninstall /silent /instance InstanceNNN /packagelist ID_list

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 .

5/6/2017 Commvault Systems Page 426 of 587


Uninstalling Commvault Locally from UNIX and Linux Clients
You can uninstall Commvault packages from a client or MediaAgent computer by using the Commvault uninstallation command.
Note: To uninstall UNIX native packages, you must use the steps described in Uninstalling UNIX Native Packages .

Before You Begin


For a successful uninstallation, you must review some preparation tasks for the software package that you want to uninstall. For more information, see Prepare to Uninstall
Commvault from Client and MediaAgent Computers .

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 .

5/6/2017 Commvault Systems Page 427 of 587


Uninstalling Commvault Locally from a Macintosh Client
You can uninstall Commvault packages from a client computer by using the BackupUninstall application.
Note: If you want to uninstall packages from the command line, use the steps described in Uninstalling Commvault Locally from UNIX and Linux Clients .

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 .

5/6/2017 Commvault Systems Page 428 of 587


Uninstalling UNIX Native Packages
If you installed Commvault by using a UNIX native package manager, such as RPM, you must run the uninstallation command that is appropriate for the package manager.
When you run the command, the native package is uninstalled in silent mode.

Before You Begin


Retrieve the name of the native packages that you installed. Run the appropriate command to obtain the package name:
For APT packages:
dpkg -L

For HP-UX packages:


swlist

For RPM packages:


rpm -qa

For Solaris packages:


pkginfo

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

For HP-UX packages:


swremove package_name

For RPM packages:


rpm -e package_name.rpm

For Solaris packages:


pkgrm package_name.pkg

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 .

5/6/2017 Commvault Systems Page 429 of 587


Uninstalling the Outlook Add-In
You can uninstall the Outlook Add-In from a Windows computer by using the uninstallation option in the Windows Control Panel.

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.

5/6/2017 Commvault Systems Page 430 of 587


Uninstalling Version 8 UNIX Clients
You can uninstall the Commvault Version 8 software that you installed on deprecated UNIX computers.

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

4. Uninstall the software by running the following command:


./cvpkgrm

Make sure to force the uninstallation.

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 .

5/6/2017 Commvault Systems Page 431 of 587


Uninstall Third-Party Software Workflow
Uninstall Third-Party Software is a predefined workflow that uninstalls third-party software from all Windows clients in your CommCell environment.
By default, the workflow uninstalls third-party software that was installed by Commvault and that is no longer used. However, you can edit the list of software to be
uninstalled by adding other software to the list.
This workflow is useful when you want to clean up your Windows clients from unused third-party software.
Download this workflow from Commvault Store. For instructions, see Download Workflows from Commvault Store .

How Does It Work?


This predefined workflow automates the following operations:
1. Logs on to the CommServe database and retrieves all Windows client computers, except for laptop clients.
2. Gets the list of third-party software that is no longer required by Commvault.
3. Performs the connectivity check operation for each client.
Note: If a client is offline, the workflow sets the client as unreachable. The software will not be uninstalled from the client.
4. Runs the uninstallation script on the clients that passed the connectivity check.
5. Sends an email report to the recipients specified in the workflow options indicating whether the operation on each client succeeded or failed.

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.

5/6/2017 Commvault Systems Page 432 of 587


Uninstalling Commvault Packages from Cluster Group Clients
If you installed agents and other Commvault software in a cluster environment, you might have one or more cluster group clients configured in the CommCell Console.
Each cluster group client can have two or more physical nodes associated with it.
To uninstall Commvault from a cluster group client, you must remove the associations that you made in the client and then uninstall the software from the physical nodes
that were part of the cluster group client.

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

5/6/2017 Commvault Systems Page 433 of 587


Uninstalling the CommServe Software
You can uninstall the CommServe software from your server computer by using the uninstallation option from the Windows Control Panel. Uninstalling the CommServe in
silent mode is not supported.
If uninstalling from a clustered environment, uninstall the CommServe from all the physical nodes (active and passive) of the cluster.
Important: Do not remove the CommServe software unless you have decided to remove Commvault data management solutions from your organization. After the
CommServe software is uninstalled, you can no longer protect and manage the data in your organization.

Before You Begin


MediaAgents, agents, and other Commvault software must be already uninstalled from all client computers in your CommCell environment. For more information, see
Uninstall Commvault from Client and MediaAgent Computers .
If you configured firewall settings between the CommServe and other clients, make sure to close the ports that you designated for firewall use.
Close any open user connections to the CommServe database and to any other Commvault database, such as the Workflow database.
For example, if a user is querying the database by using the SQL Server Management Studio, the uninstallation program will fail to remove the database.

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.

5/6/2017 Commvault Systems Page 434 of 587


System Requirements
The system requirements pages provide detailed hardware and software requirements for each Commvault agent, tool, and server module. They document what has been
tested and is supported; they do not attempt to document what is not supported. The requirements for operating systems include all of the editions and installation
options for that operating system with any exceptions noted.

Commvault Platform Support Policy


Review the Commvault Platform Support Policy document for support information regarding new versions of operating systems, file systems, applications, and virtual
hypervisor environments within the Commvault integration portfolio.

5/6/2017 Commvault Systems Page 435 of 587


System Requirements - CommServe
The following requirements are for the CommServe:

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.

Microsoft Windows Server 2012 Editions


See Considerations for Microsoft Windows Server 2012, 2012 R2, and Windows 8.x for more information.

Microsoft Windows Server 2012 R2 Editions


See Considerations for Microsoft Windows Server 2012, 2012 R2, and Windows 8.x for more information.

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 .

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

Hardware Validation for CommServe Database


The CommServe database needs to be on a fast disk for optimal backup performance. Before setting up the CommServe, the storage volumes must be validated for high
performance. This can be done using IO meter tool which measures the IOPs (Input Output Operations per second). For more information, see IOPs for CommServe
Database Volumes .
Miscellaneous
Internet Explorer
Microsoft Internet Explorer (IE) version 8.0, 9.0
5/6/2017 Commvault Systems Page 436 of 587
.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.
IIS
By default, the Web Server and Web Console packages are installed with the CommServe. To install this software, IIS must be enabled on the CommServe computer and
meet the following requirements:
Microsoft Internet Information Services (IIS) Manager version 8.0 or 8.5 (on Windows 2012 only)
Microsoft Internet Information Services (IIS) Manager version 7.0 (on Windows 2008 only)
Microsoft Internet Information Services (IIS) Manager version 7.5
All components of Microsoft Internet Information Services (IIS) Manager version 7.0 should be installed on Windows 2008
CommServe Name
By default, the Commvault software uses the name of the server computer (where the CommServe component is being installed) as the CommServe name. During the
installation of the CommServe component, the software also allows you to specify a different CommServe name.
Note: The CommServe name cannot be "CommCell". If you change the CommServe name during installation, do not change it to "CommCell".
CommServe Database on CIFS
The CommServe's SQL database is not supported on a CIFS share.
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.

Notes on Combined Installations


Installing more than one Commvault package on a single computer is a common practice. For example, if the computer has an Exchange and an Oracle database, you will
install the Exchange Database Agent and the Oracle Agent to protect the data from both databases.
When you combine multiple functions on a single computer, the storage resources required to support the software for that computer are not essentially cumulative. This
is because Commvault packages share some of the same software. As a result, combined installations require about 30 MB less disk space than installations where the
software resides on separate 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.

5/6/2017 Commvault Systems Page 437 of 587


System Requirements - MediaAgent
The following requirements are for the MediaAgent:

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.

Operating System Architecture


AIX AIX 7.2 64-bit Power PC (Includes IBM System p)

AIX 7.1 64-bit Power PC (Includes IBM System p)


AIX 6.1 64-bit Power PC (Includes IBM System p)
HP-UX HP-UX 11i v3 (11.31) 64-bit Itanium

HP-UX 11i v2 (11.23) 64-bit Itanium


Linux OpenSuSE
OpenSuSE 13.2 with glibc 2.19 x64
Oracle Linux
Oracle Linux 7.x with glibc 2.17.x x86, x64 or compatible processors
Oracle Linux 6.x with glibc 2.12.x x86, x64 or compatible processors
Oracle Linux 6.x with glibc 2.12.x x86, x64 or compatible processors
Oracle Linux 5.x with glibc 2.5.x Intel Pentium, x64 or compatible processors
Red Flag Linux
Red Flag Linux AS 4.1 32-bit with glibc 2.3.x Intel Pentium or compatible 650 MHz processor minimum recommended; Dual 1 GHz or higher
processors recommended
Red Hat Enterprise Linux AS/ES
Red Hat Linux AS 4.0 with glibc 2.3.x Power PC (Includes IBM System p)
Red Hat Enterprise Linux AS/ES 4.0 with glibc 2.3.x Intel Pentium or compatible 650 MHz processor minimum recommended; Dual 1 GHz or higher
processors recommended
Red Hat Enterprise Linux AS/ES 4.0 with glibc 2.3.x x64
Red Hat Enterprise Linux AS 5.x with glibc 2.5 x64
Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS Server 5 with glibc 2.5.x Power PC (Includes IBM System p)
Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x x86, x64, Power PC or compatible processors
Red Hat Enterprise Linux/CentOS 6.x with glibc 2.12.x Intel Pentium, Power PC (Includes IBM System p) or compatible processors
Red Hat Enterprise Linux/CentOS 6.x with a minimum of x64
glibc 2.12-1.25.x
Red Hat Enterprise Linux/CentOS 5.x with glibc 2.5.x Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
Red Hat Enterprise Linux/CentOS 5 Advanced Platform x64
with glibc 2.5.x
Red Hat Enterprise Linux/CentOS 5 Advanced Platform Intel Pentium or compatible 650 MHz processor minimum recommended; Dual 1 GHz or higher
with glibc 2.5.x processors recommended
SuSE Linux (SLES)
SuSE Linux 9.x Enterprise Server x64
SuSE Linux 9.x Enterprise Server Power PC (Includes IBM System p)
SuSE Linux 9.x Enterprise Server Intel Pentium or compatible 650 MHz processor minimum recommended; Dual 1 GHz or higher
processors recommended
SuSE Linux 12.x with glibc 3.x x86, x64, Power PC or compatible processors
SuSE Linux 12.x with glibc 2.19.x Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
SuSE Linux 11.x with glibc 3.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
SuSE Linux 11.x with glibc 2.11.x Intel Pentium, x64 or compatible processors
SuSE Linux 10 Enterprise Server Edition with glibc 2.6.x x86, x64, Power PC or compatible processors
SuSE Linux 10 Enterprise Server Edition with glibc 2.4.x x86, x64, Power PC or compatible processors
Ubuntu
Ubuntu 16.04 LTS AMD64, Intel 64, or compatible processors
Ubuntu 14.04 LTS Intel Pentium, Itanium, x64 or compatible processors
5/6/2017 Commvault Systems Page 438 of 587
Ubuntu 12.04 LTS x86, x64 or compatible processors
Ubuntu 10.04 LTS Intel Pentium, x64 or compatible processors
Solaris Solaris 11.x Ultra5 station or higher; Dual Processors recommended

Solaris 11.x x64


Solaris 10 Update 6 or equivalent* x64
*sol-10-encrypt-GA-iso.zip package is required on Solaris 10.

Solaris 10 Update 6 or equivalent* Ultra5 station or higher; Dual Processors recommended


*sol-10-encrypt-GA-iso.zip package is required on Solaris 10.

Windows Windows 2012


Microsoft Windows Server 2012 R2 Editions
See Considerations for Microsoft Windows Server 2012, 2012 R2, and Windows 8 for
more information.

Microsoft Windows Server 2012 Editions All Windows-compatible processors supported


See Considerations for Microsoft Windows Server 2012, 2012 R2, and Windows 8 for
more information.

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.

Microsoft Windows 8 Editions* All Windows-compatible processors supported


*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

AIX LPAR Support


Data protection on Logical Partitioning (LPAR) is 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
Cloud Server Support
The MediaAgent can be installed on a Virtual Server in a Cloud. For example, Virtual Server in Amazon EC2.
After the installation, make sure that the remote clients can access this MediaAgent.
.NET Framework
.NET Framework 4.5 is automatically installed. Note that .NET Framework 4.5 can co-exist with other versions of this software.

Hardware Compatibility List


For information on Tape Hardware/Driver support, see Hardware Matrix .
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.

5/6/2017 Commvault Systems Page 439 of 587


Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.

5/6/2017 Commvault Systems Page 440 of 587


System Requirement - Analytics Engine
The following requirements are for the MediaAgent configured as the Analytics Engine:
System Minimum Requirements
Components
Operating Microsoft Windows Server 2012 R2 x64 Editions
System Microsoft Windows Server 2012 x64 Editions
Microsoft Windows Server 2008 R2 x64 Editions
CPU Multi-Core Xeon Class 2
Memory 16 GB RAM
Available local 20 GB for the installation directory
hard disk 1 TB of 10K SCSI disk for the Analytics Engine Index Directory
space Warning: Do not put the index directory and the Web Server (DM2) cache directory in the same location, because data loss might occur. The location
of the Web Server cache is stored on the Web Server client in the following registry key: HKEY_LOCAL_MACHINE/SOFTWARE/CommVault
Systems/Galaxy/InstanceNumber/DM2WebSearchServer/szCacheDataFilesPath.
Configurations Clustered MediaAgents are not supported

Ports If you have a firewall setup, make sure that port 20000 is open for connections within the network.

5/6/2017 Commvault Systems Page 441 of 587


System Requirements - Web Server
The following requirements are for the Web Server:

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.

Restore Cache Directory


Minimum of 500GB. The exact requirements may vary depending on the number of users accessing the Web Console to download files or perform Export/Legal Hold
operations by the compliance officer.
Hardware Specifications
The hardware requirements for Web Server installed on either physical or virtual machines is explained in Hardware Specifications for Web Server .
Notes:
The software installation requires 30 GB of disk space for Microsoft SQL Server application and database and 20 GB of temp space on the drive where the temp
directory resides.
The job results directory for the File System iDataAgent that is installed on the Web Server should have enough space to cache the search restores from users. This
depends on the number of files that may be restored, disk quota, and the retention period configured by the administrator.
In time, you may need to provide additional space (several GB) to allow for growth in the Web Server database. The size of the metadata depends on the search
operation performed and quantity of data stored.

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.

5/6/2017 Commvault Systems Page 443 of 587


System Requirements for the Admin Console
The following requirements are for the Admin Console:

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

Supported Web Browsers


You can run the Admin Console on the following browsers:
Google Chrome v5 or later
Microsoft Internet Explorer (IE) v10 or later
Mozilla Firefox v2.0.0.3 or later
Safari v2.0.4 or later

Additional Requirements
Internet Information Services (IIS) must be enabled on the computer on which you plan to install the Admin Console.

5/6/2017 Commvault Systems Page 444 of 587


System Requirements - CommCell Console as a Stand-Alone Application
The following requirements are for the CommCell Console as a Stand-Alone Application:

Operating System Architecture


Linux Debian
Debian 5.x and above Intel Pentium, x64 or compatible processors
Fedora
Fedora release 8 and above Intel Pentium, x64 or compatible processors
Red Flag Linux
Red Flag Linux AS 5.0 64-bit Intel Pentium, x64 or compatible processors
Red Flag Linux AS 4.1 32-bit Intel Pentium, x64 or compatible processors
Red Hat Linux/CentOS
Red Hat Enterprise Linux 4.0 and above Intel Pentium, x64 or compatible processors
SuSE Linux (SLES)
SuSE Linux 10.0 and above Intel Pentium, x64 or compatible processors
Ubuntu
Ubuntu 8.04 and above Intel Pentium, x64 or compatible processors
Mac OS X Mac OS X v10.9.x All Macintosh-compatible processors supported

Mac OS X v10.8.x All Macintosh-compatible processors supported


Mac OS X v10.7.x All Macintosh-compatible processors supported
Mac OS X v10.11.x All Macintosh-compatible processors supported
Mac OS X v10.10.x All Macintosh-compatible processors supported
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 Editions All Windows-compatible processors supported
Windows 8
Microsoft Windows 8 Editions All Windows-compatible processors supported
Windows 7
Microsoft Windows 7 32-bit and x64 Editions All Windows-compatible processors supported
Windows 2008
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 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]#

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


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.

5/6/2017 Commvault Systems Page 446 of 587


System Requirements - CommCell Console as a Remote Web-Based Application
The following requirements are for the CommCell Console as a Remote Web-Based Application:

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.

5/6/2017 Commvault Systems Page 447 of 587


System Requirements - Web Console
The following requirements are for Web Console:

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.

Windows Server 2016


Microsoft Windows Server 2016 Editions

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

Cluster Not Supported


The software is not supported on a cluster. For information on supported cluster types, see Clustering - Support .

Miscellaneous
The following is automatically installed during the installation of this software if it is not already installed:
Apache Tomcat Server

Manually upgrading the Apache Tomcat Server is not supported.

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.

5/6/2017 Commvault Systems Page 448 of 587


System Requirements - Active Directory iDataAgent
The following requirements are for the Active Directory iDataAgent:

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.

Windows Server 2016


Microsoft Windows Server 2016 Editions

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.

5/6/2017 Commvault Systems Page 449 of 587


System Requirements - DB2 iDataAgent
The following requirements are for the DB2 iDataAgent:

Application/Operating System Architecture


DB2 Database 11.1 64-bit on:
AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC
Linux NeoKylin Linux
NeoKylin Linux 6.5 x64
Red Hat Enterprise Linux
Red Hat Enterprise Linux 6 with glibc 2.12.x x64
Red Hat Enterprise Linux 5.x with libstdc++ version 4.2.4 or above Power PC
Red Hat Enterprise Linux 5.x with glibc 2.5.x x64
Red Hat Enterprise Linux 4.x with glibc 2.3.x x64
Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x x64
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 x64
SuSE Linux (SLES)
SuSE Linux 12.x with glibc 2.19.x x64
SuSE Linux 11.x with glibc 2.9.x and later x64
SuSE Linux 11 Enterprise Server with libstdc++ version 4.2.4 or above Power PC
SuSE Linux 11 Enterprise Server with libstdc++ version 4.2.4 or above Power PC
SuSE Linux 10.x with glibc 2.4.x x64
SuSE Linux 10 Enterprise Server with libstdc++ version 4.2.4 or above Power PC
Z-Linux Red Hat Enterprise Linux
Red Hat Enterprise Linux 6.x s390x 64-bit
Red Hat Enterprise Linux 5.x s390x 64-bit
SuSE Linux (SLES)
SuSE Linux 12.x Enterprise Server s390x 64-bit
SuSE Linux 10.x Enterprise Server s390x 64-bit
DB2 Universal Database 10.5/10.1/9.7/9.5 64-bit on:
AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC
HP-UX HP-UX 11i v3 (11.31) Itanium

HP-UX 11i v1 (11.23) Itanium


Linux NeoKylin Linux
NeoKylin Linux 6.5 x64
Red Hat Enterprise Linux
Red Hat Enterprise Linux 6 with glibc 2.12.x x64
Red Hat Enterprise Linux 5.x with libstdc++ version 4.2.4 or above Power PC
Red Hat Enterprise Linux 5.x with glibc 2.5.x x64
Red Hat Enterprise Linux 4.x with glibc 2.3.x x64
Supported only on version 9.5.

Red Hat Enterprise Linux/CentOS


Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x x64
Supported only on DB2 versions 10.5, 10.1, and 9.7.
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 x64
SuSE Linux (SLES)
5/6/2017 Commvault Systems Page 450 of 587
SuSE Linux 12.x with glibc 2.19.x x64
SuSE Linux 11.x with glibc 2.9.x and later x64
SuSE Linux 11 Enterprise Server with libstdc++ version 4.2.4 or above Power PC
SuSE Linux 10.x with glibc 2.4.x x64
SuSE Linux 10 Enterprise Server with libstdc++ version 4.2.4 or above Power PC
SuSE Linux 10 Enterprise Server s390x 64-bit
Z-Linux Red Hat Enterprise Linux
Red Hat Enterprise Linux 6.x s390x 64-bit
Red Hat Enterprise Linux 5.x s390x 64-bit
SuSE Linux (SLES)
SuSE Linux 12.x Enterprise Server s390x 64-bit
Solaris Solaris 11.x Ultra5 or higher recommended

Solaris 10 Update 6 or equivalent Ultra5 or higher recommended


Windows Windows 2012
Microsoft Windows Server 2012 x64 Edition
Microsoft Windows Server 2012 R2 Editions
Windows 2008
Microsoft Windows Server 2008 x64 Editions
Core Editions are not supported.

DB2 Universal Database 10.5/10.1/Express Server Edition on:


Linux Red Hat Enterprise Linux
Red Hat Enterprise Linux 6 with glibc 2.12.x x64
Red Hat Enterprise Linux 5.x with libstdc++ version 4.2.4 or above Power PC
Red Hat Enterprise Linux 5.x with glibc 2.5.x x64
Red Hat Enterprise Linux 4.x with glibc 2.3.x x64
Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x x64
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 x64
SuSE Linux (SLES)
SuSE Linux 12.x with glibc 2.19.x x64
SuSE Linux 11.x with glibc 2.9.x and later x64
SuSE Linux 11 Enterprise Server with libstdc++ version 4.2.4 or above Power PC
SuSE Linux 10.x with glibc 2.4.x x64
SuSE Linux 10 Enterprise Server with libstdc++ version 4.2.4 or above Power PC
SuSE Linux 10 Enterprise Server s390x 64-bit
Windows Windows 2012
Microsoft Windows Server 2012 x64 Edition
Microsoft Windows Server 2012 R2 Editions
Windows 2008
Microsoft Windows Server 2008 R2 x64 Editions
DB2 Universal Database 9.7/9.5 32-bit on:
Linux Red Hat Enterprise Linux
Red Hat Enterprise Linux 6.x with libstdc++ version 4.2.4 or above Power PC
Red Hat Enterprise Linux 6.x with glibc 2.12x x86 or compatible processors
Red Hat Enterprise Linux 5.x with libstdc++ version 4.2.4 or above Power PC
Red Hat Enterprise Linux 5.x with glibc 2.5.x x86 or compatible processors
Red Hat Enterprise Linux 4.x with glibc 2.3.x x86 or compatible processors
Support on version 9.5.
SuSE Linux (SLES)
SuSE Linux 11.x with glibc 2.9.x and later x86 or compatible processors
SuSE Linux 11 Enterprise Server with libstdc++ version 4.2.4 or above Power PC
SuSE Linux 10.x with glibc 2.4.x x86 or compatible processors
5/6/2017 Commvault Systems Page 451 of 587
SuSE Linux 10 Enterprise Server with libstdc++ version 4.2.4 or above Power PC
Windows 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.

For information on supported cluster types, see Clustering - Support .

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

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
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 - HP-UX File System iDataAgent
System Requirements - Linux File System iDataAgent
System Requirements - Solaris File System iDataAgent
On Solaris computers, 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 --
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)

5/6/2017 Commvault Systems Page 452 of 587


/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]#

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


.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

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.

5/6/2017 Commvault Systems Page 453 of 587


System Requirements - DB2 MultiNode iDataAgent (DB2 DPF)
The following requirements are for the DB2 MultiNode iDataAgent (DB2 DPF):

Application/Operating System Architecture


DB2 Universal Database 10.5/10.1/9.7/9.5 64-bit on:
AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC
HP-UX HP-UX 11i v3 (11.31) Itanium

HP-UX 11i v2 (11.23) Itanium


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x x64
Supported only on DB2 versions 10.5, 10.1, and 9.7.
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 x64
SuSE Linux (SLES)
SuSE Linux 12.x with glibc 2.19.x x64
SuSE Linux 11.x with glibc 2.9.x and later x64
SuSE Linux 11 with Service Pack 1 x64
SuSE Linux 10.x with glibc 2.4.x x64
SuSE Linux 10 with Service Pack 3 x64
Solaris Solaris 11.x Sparc T/M series

Solaris 10 Update 6 or equivalent Sparc T/M series


DB2 Universal Database 9.7/9.5 32-bit on:
AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC
Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 6.x with glibc 2.12.x x86 or compatible processors
Red Hat Enterprise Linux/CentOS 5.x with glibc 2.5.x x86 or compatible processors
Red Hat Enterprise Linux/CentOS 4.x with a minimum of glibc 2.3.4 x86 or compatible processors
SuSE Linux (SLES)
SuSE Linux 11.x with glibc 2.9.x and later x86 or compatible processors
SuSE Linux 11.x with glibc 2.9.x and later x86 or compatible processors
SuSE Linux 10.x with glibc 2.4.x x86 or compatible processors
SuSE Linux 10.x with glibc 2.4.x x86 or compatible processors
Solaris Solaris 10 Update 6 or equivalent Sparc T/M series

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:

File Name Content of the File


<directory>/<file_name>.te The content of the file should be as follows:
where: policy_module(<name>,<version>)
5/6/2017 Commvault Systems Page 454 of 587
<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]#

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


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.

5/6/2017 Commvault Systems Page 455 of 587


System Requirements - DB2 MultiNode iDataAgent (DB2 pureScale)
The following requirements are for the DB2 MultiNode iDataAgent (DB2 pureScale):

Application/Operating System Architecture


DB2 10.5 Universal database 64-bit on:
AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC
Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x x64
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 x64
SuSE Linux (SLES)
SuSE Linux 12.x with glibc 2.19.x x64
SuSE Linux 11 with Service Pack 1 x64
SuSE Linux 10 with Service Pack 3 x64
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.

5/6/2017 Commvault Systems Page 456 of 587


System Requirements - Documentum iDataAgent
The following requirements are for the Documentum iDataAgent:

Application/Operating System Architecture


Documentum Versions 6.5 SP1 (or later), 7.0, 7.1 and 7.2 on:
AIX AIX 6.1 TL 02 SP00 64-bit or higher Power PC

HP-UX HP-UX 11i v3 (11.31) Itanium

Linux Red Hat Enterprise Linux


Red Hat Enterprise Linux 6.x with glibc 2.12x x64
Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x x64
Red Hat Enterprise Linux/CentOS 5.x with glibc 2.5.x x64
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 x64 or compatible processors
SuSE Linux 10 SP2 Enterprise Server x64
Solaris Solaris 10 Update 6 or equivalent Sparc T/M series

Windows Windows 2012


Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 Editions All Windows-compatible processors supported
*Core Editions are not supported.

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 .

Solaris Zones/Containers Support


Data Protection of data residing on global and non-global zones is supported.
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
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

5/6/2017 Commvault Systems Page 457 of 587


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

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


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.

5/6/2017 Commvault Systems Page 458 of 587


System Requirements - Image Level iDataAgent
This product is deprecated in this release. This functionality is now available using block-level backup.
New installations for this product are not supported in this release. Upgrade is supported to perform restores only. For instructions on transitioning from
Image Level to block-level backups, see Transitioning from Image Level to Block-Level Backups .
See Deprecated Features, Products, and Platforms for information on deprecated products.

The following requirements are for the Image Level iDataAgent:


Note: For details about the operating systems and applications supported by the Image Level Agent, see Image Level - Application Support .

Operating System Architecture


AIX AIX 7.1 64-bit Power PC (Includes IBM System p)

AIX 6.1 TL 02 SP00 64-bit or higher Power PC (Includes IBM System p)


Linux Debian
Debian 5.x with kernel 2.6.26-2 Intel Pentium or compatible minimum required
Debian 5.x with kernel 2.6.26.19-2 x64
Debian 4.x with kernel 2.6.18-686 Intel Pentium or compatible minimum required
Debian 4.x with kernel 2.6.18-6 x64
Red Hat Enterprise Linux
Red Hat Enterprise Linux AS 4.0 with kernel 2.6.9-89 (Update 8) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux AS 4.0 with kernel 2.6.9-89 (Update 8) x64
Red Hat Enterprise Linux AS 4.0 with kernel 2.6.9-78 (Update 7) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux AS 4.0 with kernel 2.6.9-78 (Update 7) x64
Red Hat Enterprise Linux AS 4.0 with kernel 2.6.9-67 (Update 6) x64
Red Hat Enterprise Linux AS 4.0 with kernel 2.6.9-67 (Update 6) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux AS 4.0 with kernel 2.6.9-42 (Update 4) Intel Pentium or compatible minimum required
Red Hat Enterprise Linux AS 4.0 with kernel 2.6.9-42 (Update 4) x64
Red Hat Enterprise Linux AS 4.0 with kernel 2.6.9-34 (Update 3) x64
Red Hat Enterprise Linux AS 4.0 with kernel 2.6.9-34 (Update 3) Intel Pentium or compatible minimum required
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) 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-220 (Update 2) 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 5 Advanced Platform with kernel 2.6.18-92 (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-308 (Update 8) 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-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) 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-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) 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-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 9.x Enterprise Server x64
SuSE Linux 9.x Enterprise Server Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 2.6.32.12-0.7 (Update 1) x64
SuSE Linux 11 Enterprise Server with kernel 2.6.32.12-0.7 (Update 1) Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 2.6.27.19-5 x64
SuSE Linux 11 Enterprise Server with kernel 2.6.27.19-5 Intel Pentium or compatible minimum required
SuSE Linux 10 Enterprise Server with kernel 2.6.16.60-0.54.5 (Update 3) x64

5/6/2017 Commvault Systems Page 459 of 587


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.21 (Update 2) 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.46-0.12 (Update 1) Intel Pentium or compatible minimum required
SuSE Linux 10 Enterprise Server with kernel 2.6.16.46-0.12 (Update 1) x64
Solaris Solaris 10.x with a minimum of SunOS (Sparc) Patch 119963-14 and 119689-06 Ultra5 or higher recommended

Windows Windows 2012


Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 Editions All Windows-compatible processors supported
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 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.

For information on supported cluster types, see Clustering - Support .

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.

AIX LPAR/WPAR Support


Data protection on Logical Partitioning (LPAR) and Workload Partitioning (WPAR) is supported.
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
On Solaris computers, the operating system must have been installed with at least the user level software option selected.
.NET Framework
.NET Framework 4.0 is automatically installed. Note that .NET Framework 4.0 can co-exist with other versions of this software.
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,
5/6/2017 Commvault Systems Page 460 of 587
<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]#

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


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

Supported UNIX File Systems and Restore Types


The following table lists the file systems and restore types supported for each supported operating system:

Operating Back Up Data Volume File


File System System CXBF Checksum
Blocks Only Restore Restore
CXBF Checksum
Unix File System (UFS) Solaris X X X X
Includes read-only partitions on Unix, as long as the production server and backup
host are configured as the same computer
Extended 2 File System (ext2) Linux X X X X X
Extended 3 File System (ext3) Linux X X X X X
RAW volumes Linux X X
Solaris
Reiser File System (reiserfs) Linux X X X
VERITAS File System (VxFS) AIX X X
VERITAS File System (VxFS) Solaris X X
Veritas Volume Manager (VxVM) Solaris X X X X
Journal File System (JFS2) AIX X X X X X X
'X' File System (XFS) Linux X X X

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 .

Supported Windows File System Types


Backed up File System Type File-Level Restore Destination Volume-Level Restore Destination
RAW FAT NTFS RAW FAT NTFS ReFS
RAW
FAT
NTFS
5/6/2017 Commvault Systems Page 461 of 587
ReFS

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.

5/6/2017 Commvault Systems Page 462 of 587


System Requirements - Informix iDataAgent
The following requirements are for the Informix iDataAgent:

Application/Operating System Architecture


Informix 12.10 FCx on:
AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC
HP-UX HP-UX 11i v3 (11.31) Itanium

Linux Red Hat Enterprise Linux/CentOS


Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x x86 or compatible
processors
Red Hat Enterprise Linux/CentOS 6.x with glibc 2.12.x x64 or compatible
processors
Red Hat Enterprise Linux/CentOS 5.x with glibc 2.5.x x86, x64 or compatible
processors
SuSE Linux (SLES)
SuSE Linux 12.x with glibc 2.19.x x86, x64 or compatible
processors
SuSE Linux 11.x with glibc 2.9.x and later x86, x64 or compatible
processors
Solaris Solaris 11.x x64, Sparc T/M series

Solaris 10 Update 6 or equivalent Sparc T/M series


Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions
*Core Editions are not supported.

Microsoft Windows Server 2012 Editions


*Core Editions are not supported.

Windows 2008
Microsoft Windows Server 2008 x64 Editions
*Core Editions are not supported.

Informix 12.10 TCx on:


Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions
*Core Editions are not supported.

Microsoft Windows Server 2012 Editions


*Core Editions are not supported.

Windows 2008
Microsoft Windows Server 2008 x64 Editions
*Core Editions are not supported.

Informix 12.10 UCx on:


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x x86 or compatible
processors
Red Hat Enterprise Linux/CentOS 6.x with glibc 2.12.x x86 or compatible
processors
SuSE Linux (SLES)
SuSE Linux 12.x with glibc 2.19.x x86, x64 or compatible
processors
SuSE Linux 11.x with glibc 2.9.x and later x86 or compatible
processors
Informix 11.70 FCx on:
AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC

HP-UX HP-UX 11i v3 (11.31) Itanium and PA-RISC

5/6/2017 Commvault Systems Page 463 of 587


HP-UX 11i v2 (11.23) PA-RISC
HP-UX 11i v1 (11.11) 64-bit with a minimum of OS patch level of December 2008 patch bundle or higher (contact Hewlett PA-RISC
Packard to obtain the patch)
Linux Red Hat Enterprise Linux
Red Hat Enterprise Linux 6.x with glibc 2.12x x86, x64 or compatible
processors
Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 6.x with glibc 2.12.x x86, x64 or compatible
processors
Red Hat Enterprise Linux/CentOS 5.x with glibc 2.5.x x86, x64 or compatible
processors
SuSE Linux (SLES)
SuSE Linux 11.x with glibc 2.9.x and later x86, x64 or compatible
processors
Solaris Solaris 11.x x64, Sparc T/M series

Solaris 10 Update 6 or equivalent Sparc T/M series


Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions
*Core Editions are not supported.

Microsoft Windows Server 2012 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.

Microsoft Windows Server 2012 Editions


*Core Editions are not supported.

Windows 2008
Microsoft Windows Server 2008 32-bit Editions
*Core Editions are not supported.

Informix 11.50 FCx on:


AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC
HP-UX HP-UX 11i v3 (11.31) Itanium and PA-RISC

HP-UX 11i v2 (11.23) Itanium and PA-RISC


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 6.x with glibc 2.12.x x64
Informix FC(4) or higher
Red Hat Enterprise Linux/CentOS 5.x with glibc 2.5.x* x64
Informix FC(4) or higher
Red Hat Enterprise Linux/CentOS 4.x with a minimum of glibc 2.3.4* x64
Informix FC(4) or higher
SuSE Linux (SLES)

SuSE Linux 11.x with glibc 2.9.x and above* x64


Informix FC(4) or higher
Solaris Solaris 10 Update 6 or equivalent Sparc T/M series

Windows Windows 2008


5/6/2017 Commvault Systems Page 464 of 587
Microsoft Windows Server 2008 x64 Editions
*Core Editions are not supported.

Informix 11.50 UCx on:


AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC
Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 5.x with glibc 2.5.x* x86, x64 or compatible
Informix UC(4) or higher processors
Red Hat Enterprise Linux/CentOS 4.x with a minimum of glibc 2.3.4* x86, x64 or compatible
Informix UC(4) or higher processors
SuSE Linux (SLES)
SuSE Linux 11.x with glibc 2.9.x and above* x86, x64 or compatible
Informix UC(4) or higher processors
SuSE Linux 10.x with glibc 2.4.x* x86, x64 or compatible
Informix UC(4) or higher processors
Solaris Solaris 10 Update 6 or equivalent Sparc T/M series

Informix 11.50 HCx on:


HP-UX HP-UX 11i v3 (11.31) PA-RISC

HP-UX 11i v2 (11.23) PA-RISC


Informix 11.50 TCx on:
Windows Windows 2008
Microsoft Windows Server 2008 32-bit Editions
*Core Editions are not supported.

Informix XPS 8.51 FCx on:


AIX AIX 6.1 TL 02 SP00 64-bit or higher Power PC

Linux Red Hat Enterprise Linux


Red Hat Enterprise Linux 5.x with glibc 2.5.x x64
Red Hat Enterprise Linux 4.x with glibc 2.3.x x64
Solaris Solaris 10 Update 6 or equivalent Sparc T/M series

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

Solaris Zones/Containers Support


Data Protection of data residing on global and non-global zones is supported.
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
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
5/6/2017 Commvault Systems Page 465 of 587
System Requirements - Solaris File System iDataAgent
On Solaris computers, the operating system must have been installed with at least the user level software option selected.
Supported Libraries for CentOS v5.7 (or higher)
You should use the latest library versions for CentOS 5.7 (or higher) as the library provided by Commvault may not be the latest. Informix programs may require the latest
library versions. If not used, the Informix instance configuration will fail with errors such as showing the server status as UNKNOWN.
To use the latest libraries, rename the libgcc_s.so.1 library located in the Software_Installation_Directory>/Base folder to a different name. This will allow Informix programs to load
libraries available from the system.
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.

5/6/2017 Commvault Systems Page 466 of 587


System Requirements - Notes Database iDataAgent
The IBM Notes and IBM Domino iDataAgents support the following IBM Domino releases in a non-Domino cluster environment.
If you have Domino server running in a clustered environment, install the IBM Domino Agent on each Domino server. For more information, see Notes
Database Restore Consideration .
Multiple Domino versions (9.0 and 8.5) are supported on the same UNIX client.

Application/Operating System Architecture


IBM Domino 9.0.x Social Edition 32 bit on:
Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x Intel Pentium, x64 or compatible processors
Red Hat Enterprise Linux/CentOS 6.x with a minimum of glibc 2.12-1.25.x x64
SuSE Linux (SLES)
SuSE Linux 11.x Enterprise Server Intel Pentium, x64 or compatible processors
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 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.

IBM Domino 9.0.x Social Edition 64 bit on:


AIX AIX 7.1 64-bit Power PC (Includes IBM System p)

AIX 6.1 TL 02 SP00 64-bit or higher Power PC (Includes IBM System p)


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 6.x with a minimum of glibc 2.12-1.25.x x64
SuSE Linux (SLES)
SuSE Linux 11.x Enterprise Server x64
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 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.

Lotus Domino Server Release 8.5.x 32-bit on:


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 5.x or higher (with glibc 2.5.x) Intel Pentium, x64 or compatible processors
SuSE Linux (SLES)
SuSE Linux 11.x with glibc 2.9.x and later Intel Pentium, x64 or compatible processors
SuSE Linux 10.x with glibc 2.4.x Intel Pentium, x64 or compatible processors
Windows Windows 2008
Microsoft Windows Server 2008 32-bit and x64 Editions* All Windows-compatible processors supported
*Core Editions are not supported.
* Special configuration considerations apply. See Enabling 32-Bit Installations on 64-Bit Windows Computers for more information.

Lotus Domino Server Release 8.5.x 64-bit on:


AIX AIX 7.1 64-bit Power PC (Includes IBM System p)

AIX 6.1 TL 02 SP00 64-bit or higher Power PC (Includes IBM System p)


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 5.x or higher (with glibc 2.5.x) x64
SuSE Linux (SLES)
SuSE Linux 11.x with glibc 2.9.x and later x64
SuSE Linux 10.x with glibc 2.4.x x64

5/6/2017 Commvault Systems Page 467 of 587


Windows Windows 2008
Microsoft Windows Server 2008 x64 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:

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

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


.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

Notes on Domino 8.5.X on Windows 2012


For Domino 8.5.X on Windows 2012, ensure that the Domino Sever has 8.5.3 Fix Pack 4 and later installed on it.
5/6/2017 Commvault Systems Page 468 of 587
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.

5/6/2017 Commvault Systems Page 469 of 587


System Requirements - Notes Document iDataAgent
The IBM Notes and IBM Domino iDataAgents support the following IBM Domino releases in a non-Domino cluster environment.

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.

Application/Operating System Architecture


IBM Domino 9.0.x Social Edition 32 bit on:
Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x Intel Pentium, x64 or compatible processors
Red Hat Enterprise Linux/CentOS 6.x with a minimum of glibc 2.12-1.25.x x64
SuSE Linux (SLES)
SuSE Linux 11.x Enterprise Server Intel Pentium, x64 or compatible processors
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 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.

IBM Domino 9.0.x Social Edition 64 bit on:


AIX AIX 7.1 64-bit Power PC (Includes IBM System p)

AIX 6.1 TL 02 SP00 64-bit or higher Power PC (Includes IBM System p)


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 6.x with a minimum of glibc 2.12-1.25.x x64
SuSE Linux (SLES)
SuSE Linux 11.x Enterprise Server x64
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 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.

Lotus Domino Server Release 8.5.x 32-bit on:


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 5.x or higher (with glibc 2.5.x) Intel Pentium, x64 or compatible processors
SuSE Linux (SLES)
SuSE Linux 11.x with glibc 2.9.x and later Intel Pentium, x64 or compatible processors
SuSE Linux 10.x with glibc 2.4.x Intel Pentium, x64 or compatible processors
Windows Windows 2008
Microsoft Windows Server 2008 32-bit and x64 Editions* All Windows-compatible processors supported
*Core Editions are not supported.
* Special configuration considerations apply. See Enabling 32-Bit Installations on 64-Bit Windows Computers for more information.

Lotus Domino Server Release 8.5.x 64-bit on:


AIX AIX 7.1 64-bit Power PC (Includes IBM System p)

AIX 6.1 TL 02 SP00 64-bit or higher Power PC (Includes IBM System p)


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 5.x or higher (with glibc 2.5.x) x64
SuSE Linux (SLES)
SuSE Linux 11.x with glibc 2.9.x and later x64
SuSE Linux 10.x with glibc 2.4.x x64

5/6/2017 Commvault Systems Page 470 of 587


Windows Windows 2008
Microsoft Windows Server 2008 x64 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

Notes on Domino 8.5.X on Windows 2012


For Domino 8.5.X on Windows 2012, ensure that the Domino Sever has 8.5.3 Fix Pack 4 and later installed on it.
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.

5/6/2017 Commvault Systems Page 471 of 587


System Requirements - Macintosh File System iDataAgent
The following requirements are for the Macintosh File System iDataAgent:

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.

5/6/2017 Commvault Systems Page 472 of 587


System Requirements - Exchange Database Agent
The following requirements are for the Exchange Database Agent:

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.

Microsoft Windows Server 2012 R2 Editions*


*Core Editions are not supported.

Windows Server 2008


Microsoft Windows Server 2008 R2 x64 Editions*
*Core Editions are not supported.

Microsoft Windows Server 2008 x64 Editions*


*Core Editions are not supported.

Windows Server 2016


Microsoft Windows Server 2016 Editions

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.

5/6/2017 Commvault Systems Page 473 of 587


System Requirements - Exchange Mailbox (Classic) Agent
The following requirements are for the Exchange Mailbox (Classic) Agent:

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.

Microsoft Windows Server 2012 R2 Editions*


*Core Editions are not supported.

Windows Server 2008


Microsoft Windows Server 2008 R2 Editions*
*Core Editions are not supported.

Microsoft Windows Server 2008 x64 Editions*


*Core Editions are not supported.

Windows Server 2016


Microsoft Windows Server 2016 Editions

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.

5/6/2017 Commvault Systems Page 474 of 587


System Requirements - Exchange Public Folder Agent
The following requirements are for the Exchange Public Folder Agent:

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.

Microsoft Windows Server 2012 R2 Editions*


*Core Editions are not supported.

Windows Server 2008


Microsoft Windows Server 2008 R2 x64 Editions*
*Core Editions are not supported.

Microsoft Windows Server 2008 x64 Editions*


*Core Editions are not supported.

Windows Server 2016


Microsoft Windows Server 2016 Editions

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.

5/6/2017 Commvault Systems Page 475 of 587


System Requirements - SharePoint Server iDataAgent
The following requirements are for the SharePoint Server iDataAgent:

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.

Microsoft Windows Server 2012 R2 Editions


Windows Server 2008
Microsoft Windows Server 2008 32-bit and x64 Editions*
*Core Editions are not supported.

Windows Server 2003


Microsoft Windows Server 2003 32-bit and x64 Editions* with a minimum of Service Pack 2
* Special configuration considerations apply. For more information, see Enabling 32-Bit Installations on 64-Bit Windows Computers .

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.

Consideration for SharePoint Server 2016


For SharePoint Document backup set, we support only full backups. Incremental backups are not supported because incremental export of the site content is failing. We
have opened a ticket with Microsoft to get this issue fixed. Ticket number is 116050914143126.
If you have to run incremental backups, you can upgrade to the SharePoint Server 2016 September cumulative update version.
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.

5/6/2017 Commvault Systems Page 477 of 587


System Requirements - SQL Server Agent
The following requirements are for the SQL Server Agent:

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

Microsoft Windows Server 2012 R2 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

Microsoft Windows Server 2008 R2 Editions*


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

Considerations for SQL Server


If you are installing SQL Server 2012 or later on an AlwaysOn cluster, consider the best practices mentioned in Notes on AlwaysOn Provided by SQL 2012 or Later .
Backup and restore jobs will fail if you have installed SQL Agent on a server that has Microsoft SQL Server 2016 or its components installed. To resolve this issue, see
Article ID: SQL0019 .
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.

5/6/2017 Commvault Systems Page 478 of 587


Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.

5/6/2017 Commvault Systems Page 479 of 587


System Requirements - Windows File System Agent
The following requirements are for the Windows File System Agent.

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.

Microsoft Windows Client 8


Windows Server 2012
Microsoft Windows Server 2012 Editions
Microsoft Windows Server 2012 R2 Editions
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.

Microsoft Windows Server 2008 R2 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.

For information on supported cluster types, see Clustering - Support .

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.

5/6/2017 Commvault Systems Page 481 of 587


System Requirements - MySQL iDataAgent
The following requirements are for the MySQL iDataAgent:

Application/Operating System Architecture


MySQL Community Server Edition or Enterprise, Standard or Classic Edition - 5.1.x, 5.5.x, 5.6.x and 5.7.x on
MariaDB 5.5.x, 10.0.x and 10.1.x on:
FreeBSD FreeBSD 9.x x64 or compatible processors

FreeBSD 8.x x64 or compatible processors


FreeBSD 10.x x64 or compatible processors
HP-UX HP-UX 11i v3 (11.31) Itanium

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

Solaris 10 Update 6 or equivalent x64, Sparc T/M series


Windows Windows 2012
Microsoft Windows Server 2012 Editions
*Core Editions not supported

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

5/6/2017 Commvault Systems Page 482 of 587


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

Notes on Block-Level Backups


Block-level backups are supported only on Linux platforms.
For block-level backups, the supported Linux platforms must have kernel version 3.16, 3.12, 3.10, 3.8 or earlier and glibc 2.17 or earlier.
For supported kernel version details, see List of Supported Kernel Versions.
Network File System (NFS) is not supported for MySQL block-level backups.

Solaris Zones/Containers Support


Data Protection of data residing on global and non-global zones is supported.
For a comprehensive list of supported components, see Unix Virtualization .

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:

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

5/6/2017 Commvault Systems Page 483 of 587


/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]#

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


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.

5/6/2017 Commvault Systems Page 484 of 587


System Requirements - NAS iDataAgent
The following requirements are for the NAS iDataAgent:

File Server Operating System


The following table lists the supported File Server versions for each vendor:
Vendor Supported File Server
Dell Compellent FS 5.0

EMC Celerra DARTOS 5.5, 5.6, 6.0

EMC Unity 9.0

EMC VNX & VNX2 7.0, 7.1, 8.1, 8.2

EMC VNXe 2.0

Hitachi HNAS (BlueArc) Up to 12.7

Huawei OceanStor V3 Converged Storage 1.0


Huawei OceanStor 9000 Storage 1.0

IBM N-Series 7-Mode: 7.0 to 8.2


Clustered Data ONTAP: 7.0 to 9.1
*Visible as a NetApp client.
Isilon 7.0, 7.1, 7.2, 8.0
*The EMC Isilon Backup Accelerator is supported for NDMP backups.
NetApp 7-Mode: 7.0 to 8.2
Clustered Data ONTAP: 7.0 to 9.1
NextaStor Version 5.0

Nexsan UNITY 1.1

Oracle ZFS Storage Appliance ak-2009.09.01*


2010.02.09*
2010.08.17*
2011.04.24
2013.06.05*
Stratus 3.0

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.

MediaAgent Operating System


Only MediaAgents with the following operating systems can be used when performing data protection operations with NAS agent data:
AIX
HP-UX
Linux (except Itanium varieties)
Solaris
Windows
See System Requirements - MediaAgent for information on specific versions supported with these operating systems.
Miscellaneous
File Server
If media changers and/or tape drives are attached to the file server, all hardware (including the SAN networking hardware) must be of a type supported by the file server.
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.
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:

Operating System Architecture


OES Linux Novell OES2 Linux up to SP3 (SLES 10 SP4) Intel Pentium, x64 or compatible processors
Novell OES11 Linux up to SP2 (SLES 11 SP3) Intel Pentium, x64 or compatible processors
Novell OES Linux up to Support Pack 2 Intel Pentium or compatible minimum required
Novell OES 2015 Linux (SLES 11 SP3) 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.
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.

5/6/2017 Commvault Systems Page 487 of 587


System Requirements - Oracle iDataAgent
The following requirements are for the Oracle iDataAgent:

Application/Operating System Architecture


Oracle 12c, 11g/10.2.x (R2 or higher) Databases (Enterprise or Standard Edition) on:
AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC
HP-UX HP-UX 11i v3 (11.31) Itanium

HP-UX 11i v2 (11.23) Itanium


Linux NeoKylin Linux
NeoKylin Linux 6 x64
Oracle Linux
Oracle Linux 7.x with glibc 2.17.x x86, x64 or compatible processors
Oracle Linux 6.x x86, x64 or compatible processors
Oracle Linux 5.x with glibc 2.5.x x86, x64 or compatible processors
Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x x86, x64, Power PC or compatible processors
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
SuSE Linux 11.x Enterprise Server s390x 64-bit
SuSE Linux 10 Enterprise Server Edition with glibc 2.4.x x86, x64, Power PC or compatible processors
SuSE Linux 10 Enterprise Server s390x 64-bit
Z-Linux Red Hat Enterprise Linux
Red Hat Enterprise Linux 6.x s390x 64-bit
Red Hat Enterprise Linux 5.x s390x 64-bit
Red Hat Enterprise Linux 4.x s390x 64-bit
SuSE Linux (SLES)
SuSE Linux 12.x Enterprise Server s390x 64-bit
Solaris Solaris 11.x x64, Sparc T/M series

Solaris 10 Update 6 or equivalent x64


Solaris 10 Update 6 or equivalent Sparc T/M series
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions
Supported on Oracle version 11.2.0.4 and higher.

Microsoft Windows Server 2012 Editions


Supported on Oracle version 11.2.0.4 and higher.

Windows 2008
Microsoft Windows Server 2008 R2 Editions with a minimum of Service Pack 1
Core Editions are not supported.

Microsoft Windows Server 2008 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.

5/6/2017 Commvault Systems Page 488 of 587


256 MB of free disk space is required for the log directory.

Express Database Edition Support


Express Editions of Oracle 10g/11g (R2) Databases are supported on all operating systems supported by the Oracle application server.
Oracle Exadata Database Machine Support
Oracle Exadata Database Machine is supported on the following Oracle Database versions:
Oracle 11g (11.1.0.7)
Oracle 11g R2 (11.2.0.1 or higher)
Oracle 12c (12.0.1.0 or higher)

Solaris Zones/Containers Support


Data Protection of data residing on global and non-global zones is supported.
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
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 - HP-UX File System iDataAgent
System Requirements - Linux File System iDataAgent
System Requirements - Solaris File System iDataAgent
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 --
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]#

3. Execute the policy module. Use the following command:


5/6/2017 Commvault Systems Page 489 of 587
[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


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

5/6/2017 Commvault Systems Page 490 of 587


System Requirements - Oracle RAC iDataAgent
The following requirements are for the Oracle RAC iDataAgent:

Application/Operating System Architecture


Oracle 12c (12.0.1.0 or higher), 11g/10g (R2 or higher) RAC Databases on:
AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC
HP-UX HP-UX 11i v3 (11.31) Itanium

HP-UX 11i v2 (11.23) Itanium


Linux Oracle Linux
Oracle Linux 7.x with glibc 2.17.x Intel Pentium, x64 or compatible processors
Oracle Linux 6.x Intel Pentium, x64 or compatible processors
Oracle Linux 5.x with glibc 2.5.x Intel Pentium, x64 or compatible processors
Oracle Linux 4.x with a minimum of glibc 2.3.4 Intel Pentium, x64 or compatible processors
Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x Intel Pentium, Power PC (Includes IBM System p) or compatible processors
Red Hat Enterprise Linux/CentOS 6.x with glibc 2.12.x Intel Pentium, Power PC (Includes IBM System p) 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 Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
Red Hat Enterprise Linux/CentOS 4.x with a minimum of glibc 2.3.4 Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
SuSE Linux (SLES)
SuSE Linux 12.x with glibc 2.19.x Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
SuSE Linux 11.x with glibc 2.9.x and later Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
SuSE Linux 10.x with glibc 2.4.x Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
Solaris Solaris 11.x x64, Sparc T/M series

Solaris 10 Update 6 or equivalent x64


Solaris 10 Update 6 or equivalent Sparc T/M series
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions
Microsoft Windows Server 2012 Editions
Supported on Oracle version 11.2.0.4 and higher.

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

Oracle Exadata Database Machine Support


Oracle Exadata Database Machine is supported on the following Oracle Database versions:
Oracle 11g (11.1.0.7)
Oracle 11g R2 (11.2.0.1 or higher)
Oracle 12c (12.0.1.0 or higher)

Solaris Zones/Containers Support


Data Protection of data residing on global and non-global zones is supported.
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
The Oracle iDataAgent must be installed and configured prior to configuring the Oracle RAC iDataAgent. For System Requirements and install information specific to the
Oracle iDataAgent, refer to System Requirements - Oracle 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":

5/6/2017 Commvault Systems Page 491 of 587


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

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


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

5/6/2017 Commvault Systems Page 492 of 587


System Requirements - PostgreSQL iDataAgent
The following requirements are for the PostgreSQL iDataAgent:

Application/Operating System Architecture


PostgreSQL and Enterprise DB Version 9.2 (or later) on:
AIX AIX 7.1 64-bit Power PC

FreeBSD FreeBSD 9.x


*Supported for PostgreSQL Version 9.2 only
x64 or compatible processors

FreeBSD 10.x x64 or compatible processors


Linux Debian
Debian 8.x x86, x64 or compatible processors
Debian 7.x x86, x64 or compatible processors
Debian 6.x x86, x64 or compatible processors
Debian 5.x x86, x64 or compatible processors
Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 4.x with a minimum of glibc 2.3.4 Intel Pentium, x64 or compatible processors
Red Hat Enterprise Linux/Oracle Linux Enterprise/CentOS
Red Hat Enterprise Linux/Oracle Linux Enterprise/CentOS 7.x x64 or compatible processors
Red Hat Enterprise Linux/Oracle Linux Enterprise/CentOS 6.x with glibc 2.12.x Intel Pentium, x64 or compatible processors
Red Hat Enterprise Linux/Oracle Linux Enterprise/CentOS 5.x with glibc 2.5.x Intel Pentium, 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 Intel Pentium, x64 or compatible processors
SuSE Linux 10.x with glibc 2.4.x Intel Pentium, x64 or compatible processors
Ubuntu
Ubuntu 16.04 LTS Intel Pentium, x64 or compatible processors
Ubuntu 14.04 LTS Intel Pentium, x64 or compatible processors
Ubuntu 12.04 LTS Intel Pentium, x64 or compatible processors
Solaris Solaris 11.x x64, Sparc T/M series

Solaris 10 Update 6 or equivalent x64, Sparc T/M series


Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 Editions All Windows-compatible processors supported
*Install 32 bit version of the software if you have 32 bit PostgreSQL server on Windows 2008 x64 edition.
*Core Editions are not supported.

Windows 2008
Microsoft Windows Server 2008 R2 Editions* All Windows-compatible processors supported
*Core Editions are not supported.

Microsoft Windows Server 2008 Editions All Windows-compatible processors supported


*Install 32 bit version of the software if you have 32 bit PostgreSQL server on Windows 2008 x64 edition.
*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.

Notes on Block-Level Backups


Block-level backups are supported only on Linux platforms.
For block-level backups, the supported Linux platforms must have kernel version 3.16, 3.12, 3.10, 3.8 or earlier and glibc 2.17 or earlier.
For supported kernel version details, see List of Supported Kernel Versions.
Network File System (NFS) is not supported for PostgreSQL block-level backups.

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.

5/6/2017 Commvault Systems Page 494 of 587


System Requirements - SAP HANA iDataAgent
The Commvault software supports SAP HANA SPS09. You can perform a database copy with SAP HANA SPS09 Rev 94 or later. For information on the database copy in SAP
HANA SPS09, see SAP HANA SPS09 - What's New , Database Copy.
Beginning in Service Pack 7, Commvault supports the following SAP HANA Express Editions:
SAP HANA Express 1.0
SAP HANA Express 2.0
The following requirements are for the SAP HANA iDataAgent:

Application/Operating System Architecture


SAP HANA 1.0 SPS9/SPS10/SPS11/SPS12 on:
Linux Red Hat Enterprise Linux
Red Hat Enterprise Linux 7.2 x64
Red Hat Enterprise Linux 6.x with glibc 2.12x x64
SuSE Linux (SLES)
SuSE Linux 12.x with glibc 2.19.x x64
SuSE Linux 11.x with glibc 2.9.x and later x64
SuSE Linux 11 SP4 Enterprise Server Power PC
Download and install the mandatory patches from the SuSE site .

SAP HANA 2.0 SPS00 on:


Linux Red Hat Enterprise Linux
Red Hat Enterprise Linux 7.2 x64
Works with Single Container and Multitenant Database Container databases.

SuSE Linux (SLES)


SuSE Linux 12.x with glibc 2.19.x x64
Works with Single Container and Multitenant Database Container databases.

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.

5/6/2017 Commvault Systems Page 495 of 587


System Requirements - SAP MaxDB iDataAgent
The following requirements are for the SAP MaxDB iDataAgent:

Application/Operating System Architecture


SAP MaxDB 7.5, 7.6, 7.7, 7.8, 7.9 and SAP liveCache 7.6, 7.7 on:
AIX AIX 7.1 64-bit Power PC (Includes IBM System p)

AIX 6.1 TL 02 SP00 64-bit or higher Power PC (Includes IBM System p)


HP-UX HP-UX 11i v3 (11.31) Itanium

HP-UX 11i v2 (11.23) Itanium


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x Intel Pentium, Power PC (Includes IBM System p) or compatible processors
Red Hat Enterprise Linux/CentOS 6.x with glibc 2.12.x Intel Pentium, Power PC (Includes IBM System p) 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 Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
Red Hat Enterprise Linux/CentOS 4.x with a minimum of glibc 2.3.4 Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
SuSE Linux (SLES)
SuSE Linux 12.x with glibc 2.19.x Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
SuSE Linux 11.x with glibc 2.9.x and later Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
Solaris Solaris 11.x x64, Sparc T/M series

Solaris 10 Update 6 or equivalent x64


Solaris 10 Update 6 or equivalent Sparc T/M series
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 Editions All Windows-compatible processors supported
*Core Editions are not supported.

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.

For information on supported cluster types, see Clustering - Support .

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.

Solaris Zones/Containers Support


Data Protection of data residing on global and non-global zones is supported.
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
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
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>)
5/6/2017 Commvault Systems Page 496 of 587
<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]#

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


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

5/6/2017 Commvault Systems Page 497 of 587


System Requirements - SAP Oracle Agent
The following requirements are for the SAP Oracle Agent:

Application/Operating System Architecture


SAP BR*Tools 7.20(40), 7.4(14) for Oracle 12c (V12.1.0.2), 11g(R1, R2 or higher) on:
AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC
HP-UX HP-UX 11i v3 (11.31) Itanium

HP-UX 11i v2 (11.23) Itanium


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x x86, x64, Power PC or compatible processors
You must have Oracle v11.2.0.4 or higher with BR*Tools v7.20(40), v7.40(14).

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

Solaris 10 Update 6 or equivalent Sparc T/M series


Solaris 10 Update 6 or equivalent x64
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions
Microsoft Windows Server 2012 Editions
*Core Editions are not supported.

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

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC
HP-UX HP-UX 11i v3 (11.31) Itanium

HP-UX 11i v2 (11.23) Itanium


Linux Red Hat Enterprise Linux/CentOS
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
SuSE Linux 10.x with glibc 2.4.x x86, x64, Power PC or compatible processors
Solaris Solaris 11.x x64, Sparc T/M series

Solaris 10 Update 6 or equivalent x64


Solaris 10 Update 6 or equivalent Sparc T/M series
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions
5/6/2017 Commvault Systems Page 498 of 587
Microsoft Windows Server 2012 Editions
*Core Editions are not supported.

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.

Solaris Zones/Containers Support


Data Protection of data residing on global and non-global zones is supported.
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
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 - HP-UX File System iDataAgent
System Requirements - Linux File System iDataAgent
System Requirements - Solaris File System iDataAgent
On Solaris computers, 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 --
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
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]#

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


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

5/6/2017 Commvault Systems Page 500 of 587


System Requirements: SAP Archive Link Agent
The following requirements are for the SAP Archive Link agent:

Operating System Architecture


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 6.x with glibc 2.12.x x86, x64 or compatible processors
SuSE Linux (SLES)
SuSE Linux 11.x Enterprise Server x86, x64 or compatible processors

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

Manually upgrading the Apache Tomcat Server is not supported.

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, the latest Java version is automatically installed along with the 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.

5/6/2017 Commvault Systems Page 501 of 587


System Requirements - Sybase iDataAgent
The following requirements are for the Sybase iDataAgent:

Application/Operating System Architecture


SAP Adaptive Server Enterprise 16.0, Sybase ASE 15.7/15.5/15.0.3 64-bit on:
AIX AIX 7.1 64-bit Power PC (Includes IBM System p)

AIX 6.1 TL 02 SP00 64-bit or higher Power PC (Includes IBM System p)


HP-UX HP-UX 11i v3 (11.31) Itanium

Linux Red Hat Enterprise Linux


Red Hat Enterprise Linux 5.5, 5.6, 5.7 and 5.8
Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 6.x with a minimum of glibc 2.12-1.25.x x64
SuSE Linux (SLES)
SuSE Linux 12.x with glibc 2.19.x Intel Pentium, x64 or compatible processors
SuSE Linux 11.x with glibc 2.9.x and later Intel Pentium, x64 or compatible processors
SuSE Linux 11.x with glibc 2.6.x x64
Solaris Solaris 11.x x64, Sparc T/M series

Solaris 10 Update 6 or equivalent x64, Sparc T/M series


Windows Windows 2012
Microsoft Windows Server 2012 x64 Edition
Microsoft Windows Server 2012 R2 Editions
Windows 2008
Microsoft Windows Server 2008 x64 Editions* All Windows-compatible processors supported
*Core Editions are not supported.

Sybase ASE 15.7/15.5/15.0.X 32-bit on:


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 5.x Intel Pentium, x64 or compatible processors
Red Hat Enterprise Linux/CentOS 4.x Intel Pentium, x64 or compatible processors
SuSE Linux (SLES)
SuSE Linux 12.x with glibc 2.19.x Intel Pentium, x64 or compatible processors
SuSE Linux 11.x with glibc 2.6.x Intel Pentium, x64 or compatible processors
SuSE Linux 10.x with glibc 2.4.x Intel Pentium, x64 or compatible processors
Solaris Solaris 10 Update 6 or equivalent x64

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

Solaris Zones/Containers Support


Data Protection of data residing on global and non-global zones is supported.
For a comprehensive list of supported components, see Unix Virtualization .

5/6/2017 Commvault Systems Page 502 of 587


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

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


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

Operating System Architecture


AIX AIX 7.2 64-bit Power PC

AIX 7.1 64-bit Power PC


AIX 6.1 TL 02 SP00 64-bit or higher Power PC

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.

AIX LPAR/WPAR Support


Data protection on Logical Partitioning (LPAR) and Workload Partitioning (WPAR) is supported.
IBM Fileset Dependency
Ensure that the devices.common.IBM.fc.hba-api fileset exists on the AIX computer.
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
Enhanced Journal File System (JFS2)
General Parallel File System (GPFS)
Journal File System (JFS)
Oracle ASM Cluster File System (Oracle ACFS)
VERITAS File System (VxFS)
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
Raw device files
Files with Advisory locks
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
Shares with Macintosh File System data
Symbolic links that are browsed or manually added to the data contents
Files for which the file path or file name contains more than 1023 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.

5/6/2017 Commvault Systems Page 505 of 587


System Requirements - FreeBSD File System iDataAgent
The following are the requirements for FreeBSD File System iDataAgent:

Operating System Architecture


FreeBSD FreeBSD 9.x x86, x64 or compatible processors

FreeBSD 8.x x86, x64 or compatible processors


FreeBSD 7.3 (or higher) x86, x64 or compatible processors
FreeBSD 10.x x86, x64 or compatible processors

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.

5/6/2017 Commvault Systems Page 506 of 587


System Requirements - HP-UX File System iDataAgent
The following are the requirements for HP-UX File System iDataAgent:

Operating System Architecture


HP-UX HP-UX 11i v3 (11.31) Itanium

HP-UX 11i v2 (11.23) Itanium

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.

5/6/2017 Commvault Systems Page 507 of 587


System Requirements - Linux File System iDataAgent
The following are the requirements for Linux File System iDataAgent:

Operating System Architecture


Linux Asianux
Asianux 4 x64
Debian
Debian 8.x x86, x64 or compatible processors
Debian 7.x x86, x64 or compatible processors
Debian 6.x x86, x64 or compatible processors
Debian 5.x x86, x64 or compatible processors
Fedora
Fedora release 9 with glibc 2.8.x x86, x64 or compatible processors
Fedora release 8 with glibc 2.7.x x86, x64 or compatible processors
Fedora release 21 with glibc 2.20.x x86, x64 or compatible processors
Fedora release 20 with glibc 2.18.x x86, x64 or compatible processors
Fedora release 19 with glibc 2.17.x x86, x64 or compatible processors
Fedora release 18 with glibc 2.16.x x86, x64 or compatible processors
Fedora release 17 with glibc 2.15.x x86, x64 or compatible processors
Fedora release 16 with glibc 2.14.x x86, x64 or compatible processors
Fedora release 15 with glibc 2.13.x x86, x64 or compatible processors
Fedora release 14 with glibc 2.13.x x86, x64 or compatible processors
Fedora release 13 with glibc 2.12.x x86, x64 or compatible processors
Fedora release 12 with glibc 2.11.x x86, x64 or compatible processors
Fedora release 11 with glibc 2.10.x x86, x64 or compatible processors
Fedora release 10 with glibc 2.9.x x86, x64 or compatible processors
Gentoo
Gentoo release 11 with glibc 2.12.x x86, x64 or compatible processors
Gentoo release 10.1 with glibc 2.6.x x86, x64 or compatible processors
Gentoo release 10.0 with glibc 2.9.x x86, x64 or compatible processors
Mandriva
Mandriva Linux 2010 with glibc 2.10.x x86, x64 or compatible processors
Mandriva Linux 2009 with glibc 2.9.x x86, x64 or compatible processors
NeoKylin Linux
NeoKylin Linux 6.5 x64
OpenSuSE
OpenSuSE 13.2 with glibc 2.19 x64
OpenSuSE 13.1 with glibc 2.18 x86, x64 or compatible processors
OpenSuSE 12.x with glibc 2.14 or later x86, x64 or compatible processors
OpenSuSE 11.3 with glibc 2.11.x x86, x64 or compatible processors
OpenSuSE 11.2 with glibc 2.10.x x86, x64 or compatible processors
OpenSuSE 11.1 with glibc 2.9.x x86, x64 or compatible processors
OpenSuSE 11.0 with glibc 2.8.x x86, x64 or compatible processors
Oracle Linux
Oracle Linux 7.x with glibc 2.17.x x86, x64 or compatible processors
Oracle Linux 6.x with glibc 2.12.x x86, x64 or compatible processors
Oracle Linux 5.x with glibc 2.5.x x86, x64 or compatible processors
Oracle Linux 4.x with a minimum of glibc 2.3.4 x86, x64 or compatible processors
Red Flag Linux
Red Flag Linux 5.x with a minimum of glibc 2.3.4 x64
Red Flag Linux 4.x with a minimum of glibc 2.3.4 x86 or compatible processors
Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x x86, x64, Power PC or compatible processors
5/6/2017 Commvault Systems Page 508 of 587
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- x64
1.25.x
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
Scientific Linux
Scientific Linux SL 5.x with glibc 2.5.x x64
Scientific Linux 7.x x64
Scientific Linux 6.x x64
Slackware
Slackware 14.0 with glibc 2.15.x x86, x64 or compatible processors
Source Mage Linux
Source Mage 0.10 x86
SuSE Linux (SLES)
SuSE Linux 9.x Enterprise Server Intel Pentium, Itanium, x64, Power PC (Includes IBM System p) or compatible
processors
SuSE Linux 12.x with glibc 2.19.x and later 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
Download and install the mandatory patches from the SuSE site for SLES 11 SP4 running on Power PC.

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.

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

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

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


Supported File Systems
B-tree File System (Btrfs)
Extended 2 File System (ext2)
Extended 3 File System (ext3)
Extended 4 File System (ext4)
General Parallel File System (GPFS)
Global File System (GFS/GFS2)
GlusterFS File System (GlusterFS)*
Lustre File System (Clustered File System)
Moose File System (MooseFS)
5/6/2017 Commvault Systems Page 510 of 587
Oracle Cluster File System (OCFS2)
Oracle ASM Cluster File System (Oracle ACFS)
Panasas ActiveScale File System (PanFS)
Reiser File System (reiserfs)
VERITAS File System (VxFS)
VERITAS Cluster File System (VxCFS)
X9000 IBRIX File System (IBRIXFS) 6.x
'X' File System (XFS)
*Backups and restores run on the Gluster client
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.

5/6/2017 Commvault Systems Page 511 of 587


System Requirements - Solaris File System iDataAgent
The following are the requirements for Solaris File System iDataAgent:

Operating System Architecture


Solaris Solaris 11.x x64, Sparc T/M series

Solaris 10.x (Flying Zones supported) Ultra5 or higher recommended


Solaris 10 Update 6 or equivalent x64
Solaris 10 Update 6 or equivalent Ultra5 or higher recommended

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.

Solaris Zones/Containers Support


Data Protection of data residing on global and non-global zones is supported.
For a comprehensive list of supported components, see Unix Virtualization .

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.

5/6/2017 Commvault Systems Page 512 of 587


System Requirements - Oracle Archive
The following requirements are for Oracle Archiving:

Application/Operating System Architecture


Oracle 11g (R1, R2 or higher), 10g Databases (Enterprise Edition) on:
AIX AIX 7.1 64-bit Power PC

AIX 6.1 TL 02 SP00 64-bit or higher Power PC


HP-UX HP-UX 11i v3 (11.31) Itanium

HP-UX 11i v2 (11.23) Itanium


Linux Oracle Linux
Oracle Linux 6.x with glibc 2.12.x x86, x64 or compatible processors
Oracle Linux 5.x with glibc 2.5.x x86, x64 or compatible processors
Oracle Linux 4.x with a minimum of glibc 2.3.4 x86, x64 or compatible processors
Red Hat Enterprise Linux/CentOS
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.2 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 11.x with glibc 2.9.x and later x86, x64, Power PC or compatible processors
SuSE Linux 10.x with glibc 2.4.x x86, x64, Power PC or compatible processors
Solaris Solaris 11.x x64, Sparc T/M series

Solaris 10 Update 6 or equivalent x64


Solaris 10 Update 6 or equivalent Sparc T/M series

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.

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

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


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

5/6/2017 Commvault Systems Page 514 of 587


System Requirements - Exchange Mailbox Agent
The following requirements are for Exchange Mailbox Agent:

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.

Microsoft Windows Server 2012 R2 Editions*


*Core Editions are not supported.

Windows Server 2008


Microsoft Windows Server 2008 R2 x64 Editions*
*Core Editions are not supported.

Microsoft Windows Server 2008 x64 Editions*


*Core Editions are not supported.

Windows Server 2016


Microsoft Windows Server 2016 Editions

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.

5/6/2017 Commvault Systems Page 515 of 587


System Requirements - OnePass for Hitachi HNAS (BlueArc) and Isilon
The following requirements are for OnePass for Hitachi HNAS (BlueArc) and Isilon:

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.

5/6/2017 Commvault Systems Page 516 of 587


Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.

5/6/2017 Commvault Systems Page 517 of 587


System Requirements - OnePass for Celerra
The following requirements are for OnePass for Celerra:

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

Virtual Data Mover (VDM) on DART 5.5 and 5.6 is supported.

EMC VNX & VNX2 DART OS 7.0


DART OS 7.1
DART OS 7.1.47
DART OS 8.1

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.

5/6/2017 Commvault Systems Page 519 of 587


System Requirements - OnePass for Macintosh File System
The following requirements are for OnePass for Macintosh File System:

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.

5/6/2017 Commvault Systems Page 520 of 587


System Requirements - OnePass for Windows
The following requirements are for OnePass for Windows:

Operating System
Windows 8
Microsoft Windows Client 8.1
See Considerations for Microsoft Windows Server 2012, 2012 R2, and Windows 8 for more information.

Microsoft Windows Client 8


Windows Server 2012
Microsoft Windows Server 2012 Editions
Microsoft Windows Server 2012 R2 Editions
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.

5/6/2017 Commvault Systems Page 521 of 587


System Requirements - Driverless OnePass for Windows File System
The following requirements are for the Driverless OnePass for the Windows File System Agent:

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.

Microsoft Windows Client 8


Windows Server 2012
Microsoft Windows Server 2012 Editions
Microsoft Windows Server 2012 R2 Editions
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.

Microsoft Windows Server 2008 R2 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.

5/6/2017 Commvault Systems Page 522 of 587


System Requirements - OnePass for NetApp
The following requirements are for OnePass for NetApp:

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.

5/6/2017 Commvault Systems Page 524 of 587


System Requirements - OnePass for Exchange Mailbox (Classic)
The following requirements are for OnePass for Exchange Mailbox (Classic):

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.

Microsoft Windows Server 2012 R2 Editions*


*Core Editions are not supported.

Windows Server 2008


Microsoft Windows Server 2008 R2 x64 Editions*
*Core Editions are not supported.

Microsoft Windows Server 2008 x64 Editions*


*Core Editions are not supported.

Windows Server 2016


Microsoft Windows Server 2016 Editions

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.

5/6/2017 Commvault Systems Page 525 of 587


System Requirements - OnePass for UNIX File Systems
The following requirements are for OnePass for UNIX File Systems:

Operating System Architecture


AIX AIX 7.1 64-bit Power PC (Includes IBM System p)

AIX 6.1 TL 02 SP00 64-bit or higher Power PC (Includes IBM System p)


FreeBSD FreeBSD 9.x Intel Pentium, x64 or compatible processors

FreeBSD 8.x Intel Pentium, x64 or compatible processors


FreeBSD 7.3 (or higher) Intel Pentium, x64 or compatible processors
HP-UX HP-UX 11.31 64-bit Itanium

HP-UX 11.23 64-bit Itanium


Linux CentOS
CentOS 7.3 with kernel 3.10.0-514 Intel Pentium or compatible minimum required
CentOS 7.2 with kernel 3.10.0-327 Intel Pentium or compatible minimum required
CentOS 7.1 with kernel 3.10.0-229 Intel Pentium or compatible minimum required
CentOS 7.0 with kernel 3.10.0-123 Intel Pentium or compatible minimum required
CentOS 6.7 with kernel 2.6.32-573 Intel Pentium or compatible minimum required
CentOS 6.6 with kernel 2.6.32-504 Intel Pentium or compatible minimum required
CentOS 6.5 with kernel 2.6.32-431 Intel Pentium or compatible minimum required
CentOS 6.4 with kernel 2.6.32-358 Intel Pentium or compatible minimum required
CentOS 6.3 with kernel 2.6.32-279 Intel Pentium or compatible minimum required
CentOS 6.2 with kernel 2.6.32-220 Intel Pentium or compatible minimum required
CentOS 6.1 with kernel 2.6.32-131 Intel Pentium or compatible minimum required
CentOS 6.0 with kernel 2.6.32-71 Intel Pentium or compatible minimum required
CentOS 5.4 with kernel 2.6.18-164 Intel Pentium or compatible minimum required
CentOS 5.3 with kernel 2.6.18-128 Intel Pentium or compatible minimum required
Debian
Debian 8.x with kernel 3.16.0 x64
Debian 8.x with kernel 3.16.0 Intel Pentium or compatible minimum required
Debian 7.x with kernel 3.2.0 x64
Debian 7.x with kernel 3.2.0 Intel Pentium or compatible minimum required
Debian 6.x with kernel 2.6.32 x64
Debian 6.x with kernel 2.6.32 Intel Pentium or compatible minimum required
Debian 5.x with kernel 2.6.26-2 Intel Pentium or compatible minimum required
Debian 5.x with kernel 2.6.26.19-2 x64
OES Linux
Novell OES2 Linux up to SP2 (SLES 10 SP2) 64-bit x64
In order to performa stub recall fromLinux OES NSS volumes, Linux OES File SystemiDataAgent must be installed.

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

5/6/2017 Commvault Systems Page 526 of 587


Red Hat Enterprise Linux 7.0 Advanced Platform with kernel 3.10.0-123 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.7 Advanced Platform with kernel 2.6.32-573 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.6 Advanced Platform with kernel 2.6.32-504 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.6 Advanced Platform with kernel 2.6.32-504 x64
Red Hat Enterprise Linux 6.5 Advanced Platform with kernel 2.6.32-431 x64
Red Hat Enterprise Linux 6.5 Advanced Platform with kernel 2.6.32-431 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.4 Advanced Platform with kernel 2.6.32-358 x64
Red Hat Enterprise Linux 6.4 Advanced Platform with kernel 2.6.32-358 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.3 Advanced Platform with kernel 2.6.32-279 x64
Red Hat Enterprise Linux 6.3 Advanced Platform with kernel 2.6.32-279 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.2 Advanced Platform with kernel 2.6.32-220 x64
Red Hat Enterprise Linux 6.2 Advanced Platform with kernel 2.6.32-220 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.1 Advanced Platform with kernel 2.6.32-131 x64
Red Hat Enterprise Linux 6.1 Advanced Platform with kernel 2.6.32-131 Intel Pentium or compatible minimum required
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-131 (Update 1) x64
Red Hat Enterprise Linux 5.x Advanced Platform with kernel 2.6.18-x Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 5.x Advanced Platform with kernel 2.6.18-x x64
Red Hat Enterprise Linux 6.6 Advanced Platform with kernel 3.10.0-229 x64
Red Hat Enterprise Linux 6.6 Advanced Platform with kernel 3.10.0-229 Intel Pentium or compatible minimum required
SuSE Linux (SLES)
SuSE Linux 9.x Enterprise Server Intel Pentium or compatible minimum required
SuSE Linux 9.x Enterprise Server x64
SuSE Linux 12 Enterprise Server with kernel 3.12.28-4-default x64
SuSE Linux 12 Enterprise Server with kernel 3.12.28-4-default Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 3.0.76-0.11-default (Update 3) x64
SuSE Linux 11 Enterprise Server with kernel 3.0.76-0.11-default (Update 3) Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 3.0.13-0.27-default (Update 2) x64
SuSE Linux 11 Enterprise Server with kernel 3.0.13-0.27-default (Update 2) Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 3.0.101-0.15-default (Update 3 with Security Patch) x64
SuSE Linux 11 Enterprise Server with kernel 3.0.101-0.15-default (Update 3 with Security Patch) Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 2.6.32.12-0.7 (Update 1) x64
SuSE Linux 11 Enterprise Server with kernel 2.6.32.12-0.7 (Update 1) Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 2.6.27.19-5 x64
SuSE Linux 11 Enterprise Server with kernel 2.6.27.19-5 Intel Pentium or compatible processors
SuSE Linux 10 Enterprise Server with kernel 2.6.16.60-0.54.5 (Update 3) Intel Pentium or compatible processors
SuSE Linux 10 Enterprise Server with kernel 2.6.16.60-0.54 (Update 3) Intel Pentium or compatible processors
SuSE Linux 10 Enterprise Server with kernel 2.6.16.60-0.34 (Update 2) Intel Pentium or compatible processors
SuSE Linux 10 Enterprise Server with kernel 2.6.16.60-0.21 (Update 2) Intel Pentium or compatible processors
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 processors
Solaris Solaris 11.3 x64, Sparc T/M series

Solaris 11.2 x64, Sparc T/M series


Solaris 11.0 Sparc T/M series
Solaris 11.0 x64
Solaris 10.x with a minimum of SunOS (Sparc) Patch 119963-14 and 119689-06 Ultra5 or higher recommended
Solaris 10.x (6/06 and higher) 64-bit 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 .

5/6/2017 Commvault Systems Page 527 of 587


Solaris Zones/Containers Support
The File Archiver Agent should be installed on the global zone, and cannot be installed on a non-global zone.
The global instance of the File Archiver Agent can be used to archive data on a non-global zone.
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
Solaris - User Level
On Solaris computers, the operating system must have been installed with at least the user level software option selected.
Lustre File System
Lustre File System version 2.0.0.1 is supported on Red Hat Enterprise Linux 5.x computers with kernel 2.6.18-164.
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]#

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.


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.

5/6/2017 Commvault Systems Page 528 of 587


System Requirements - Generic File Archiver for NAS
This agent is deprecated in this release. You must transition to OnePass for Hitachi HNAS (BlueArc) and Isilon as described in Transitioning from a V9
Traditional Archiver Agent to V11 OnePass .
New installations of this agent are not supported in this release.
You must deconfigure this agent before you upgrade the client.
You can perform recovery operations only with the deconfigured agent.
You cannot perform archive jobs with this agent.
See End-of-Life, Deprecated and Extended Support - Products for information about deprecated products.
Note: If you want to continue to use the Hitachi HNAS (BlueArc) or Isilon File Archiver for archiving and recovery operations, you cannot upgrade the client.

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.

5/6/2017 Commvault Systems Page 529 of 587


System Requirements - Domino Mailbox Archiver Agent
The Domino Mailbox Archiver Agent supports the following IBM Domino releases in a non-Domino Cluster environment.
If you have Domino server running in a clustered environment, install the IBM Domino Agent on each Domino server. For more information, see Domino
Mailbox Restore Consideration .
Multiple Domino versions (9.0 and 8.5) are supported on the same UNIX client.

Application/Operating System Architecture


IBM Domino 9.0.x Social Edition 32 bit on:
Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.x Intel Pentium, x64 or compatible processors
Red Hat Enterprise Linux/CentOS 6.x with a minimum of glibc 2.12-1.25.x x64
SuSE Linux (SLES)
SuSE Linux 11.x Enterprise Server Intel Pentium, x64 or compatible processors
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 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.

IBM Domino 9.0.x Social Edition 64 bit on:


AIX AIX 7.1 64-bit Power PC (Includes IBM System p)

AIX 6.1 TL 02 SP00 64-bit or higher Power PC (Includes IBM System p)


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 6.x with a minimum of glibc 2.12-1.25.x x64
SuSE Linux (SLES)
SuSE Linux 11.x Enterprise Server x64
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 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.

Lotus Domino Server Release 8.5.x 32-bit on:


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 5.x or higher (with glibc 2.5.x) Intel Pentium, Itanium, x64 or compatible processors
SuSE Linux (SLES)
SuSE Linux 11.x with glibc 2.9.x and later Intel Pentium, Itanium, x64 or compatible processors
SuSE Linux 10.x with glibc 2.4.x Intel Pentium, Itanium, x64 or compatible processors
Windows Windows 2008
Microsoft Windows Server 2008 32-bit and x64 Editions* Intel Pentium, Itanium, x64 or compatible processors
*Core Editions are not supported.
* Special configuration considerations apply. See Enabling 32-Bit Installations on 64-Bit Windows Computers for more information.

Lotus Domino Server Release 8.5.x 64-bit on:


AIX AIX 7.1 64-bit Power PC (Includes IBM System p)

AIX 6.1 TL 02 SP00 64-bit or higher Power PC (Includes IBM System p)


Linux Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 5.x or higher (with glibc 2.5.x) x64
SuSE Linux (SLES)
SuSE Linux 11.x with glibc 2.9.x and later x64
SuSE Linux 10.x with glibc 2.4.x x64
5/6/2017 Commvault Systems Page 530 of 587
Windows Server 2008 Microsoft Windows Server 2008 x64 Editions*
*Core Editions are not supported.
All Windows-compatible processors 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

Notes on IBM Notes Add-In Installations


For Windows clients, JRE 1.7.0_17 is installed automatically with the IBM Notes Add-In software if it is not already installed.
For Macintosh clients, JRE 1.5.x must be installed manually prior to installing the IBM Notes Add-In software.
IBM Notes Add-In is supported only as 32-bit component on a Microsoft Windows x64 platform.
The IBM Notes Add-In can be installed on the following platforms:
Microsoft Windows Server 2008
Microsoft Windows 7 Editions
Microsoft Windows Vista Editions
Microsoft Windows XP Editions
*Server Editions are not commonly used for the Notes Add-In

Notes on Domino 8.5.X on Windows 2012


For Domino 8.5.X on Windows 2012, ensure that the Domino Sever has 8.5.3 Fix Pack 4 and later installed on it.
For 32-bit Domino Servers running on Windows Server 2003 and 2008 x64 platforms, special considerations apply. See Considerations for Installing 32-Bit Software on 64-bit
Windows Computers for more information.
For Windows Server 2008 platforms, Core Editions 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.

5/6/2017 Commvault Systems Page 531 of 587


System Requirements - Exchange Compliance Archiver Agent
The following requirements are for the Exchange Compliance Archiver Agent:

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.

Microsoft Windows Server 2012 R2 Editions*


*Core Editions are not supported.

Windows Server 2008


Microsoft Windows Server 2008 R2 x64 Editions*
*Core Editions are not supported.

Microsoft Windows Server 2008 x64 Editions*


*Core Editions are not supported.

Windows Server 2016


Microsoft Windows Server 2016 Editions

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.

5/6/2017 Commvault Systems Page 532 of 587


System Requirements - Exchange Public Folder Archiver Agent
The following requirements are for the Exchange Public Folder Archiver Agent:

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.

Microsoft Windows Server 2012 R2 Editions*


*Core Editions are not supported.

Windows Server 2008


Microsoft Windows Server 2008 R2 x64 Editions*
*Core Editions are not supported.

Microsoft Windows Server 2008 x64 Editions*


*Core Editions are not supported.

Windows Server 2016


Microsoft Windows Server 2016 Editions

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.

5/6/2017 Commvault Systems Page 533 of 587


System Requirements - Google Mail and Google Drive
The following requirements are for the physical client where Cloud Connector package is installed:

Operating System
Windows Server 2012
Microsoft Windows Server 2012 Editions*
*Core Editions not supported

Microsoft Windows Server 2012 R2 Editions*


*Core Editions not supported

Windows Server 2008


Microsoft Windows Server 2008 R2 Editions*
*Core Editions not supported

Microsoft Windows Server 2008 x64 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.

5/6/2017 Commvault Systems Page 534 of 587


System Requirements for Virtual Server Agent with Amazon
Amazon Version
Commvault software is supported with Amazon EC2 or VPC.

Virtual Server Agent Proxy Requirements


For backups, the Virtual Server Agent (VSA) should be installed on a Windows instance hosted in Amazon and must be located in the same region as the instances to be
backed up.
The proxy machine must be able to connect to ec2.amazonaws.com.
For restores, the VSA proxy can be an Amazon instance or an external machine.
For IntelliSnap backups and restores from IntelliSnap jobs, the VSA proxy can be an Amazon instance or an external machine.
The VSA proxy must meet the following requirements:
Operating system must be one of the following:
Windows Server 2008 R2
Windows Server 2012 R2
Windows Server 2016
Minimum of 100 GB disk space recommended.
Minimum of 4 GB RAM required beyond the requirements of the operating system and running applications.
For VSA proxies running on Amazon instances, the following additional requirements apply:
Windows Server 2012 R2 instances where the Virtual Server Agent is installed must upgrade to the latest paravirtual (PV) driver.
EBS optimized, high IOPS volume.
For streaming backups and backup copies, if the VSA proxy used for backups and restores is running on an Amazon instance, the proxy must be available in the same
user account as the instance being backed up or restored. This requirement does not apply to IntelliSnap backups.

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.

Guest Operating Systems


Instances being backed up can have any of the guest operating systems that are supported by the Amazon platform.

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.

5/6/2017 Commvault Systems Page 535 of 587


System Requirements for Virtual Server Agent with Citrix Xen
The following requirements are for the Virtual Server Agent:

Versions of XenServers Supported


Citrix XenServer 6.0, 6.1, 6.2, 6.5, and 7

Proxy Operating System


The Virtual Server Agent can be installed on the following operating systems:
Microsoft Windows Server 2008 x64 Edition
Microsoft Windows Server 2008 R2 x64 Edition
Microsoft Windows Server 2012
Microsoft Windows Server 2012 R2

Virtual Server Agent Installations for Citrix Xen


Xen Services and Tools
The following services must be running on the proxy virtual machine prior to performing backups:
COM+ System Application
COM+ Event System
Remote Procedure Call (RPC)
Virtual Disk Service
Citrix Xen tools for Virtual Machines (latest available version)
Verify that the Virtualization State of backed up VMs is set to Optimized. This state is visible in the XenCenter console, on the General tab of the VMs.
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.

5/6/2017 Commvault Systems Page 536 of 587


System Requirements - Virtual Sever Agent for Docker
Supported Docker Host Versions
Ubuntu 12.04
CentOS 7.2

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.

5/6/2017 Commvault Systems Page 537 of 587


System Requirements - Virtual Server Agent for Huawei FusionCompute
Supported FusionCompute Versions
V100R005C00SPC300
V100R005C10SPC700
V100R005C10U1

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.

5/6/2017 Commvault Systems Page 538 of 587


System Requirements for Virtual Server Agent with Microsoft Azure
Azure Version
Commvault software is supported for virtual machines deployed in Azure Classic or Azure Resource Manager (ARM).
For virtual machines deployed in Azure Classic, data recovery to Premium storage accounts is not supported. This restriction applies for Live Sync, VM conversion, and VM
restore jobs.

Virtual Server Agent Proxy Requirements


A physical machine or an Azure virtual machine with the Virtual Server Agent (VSA) installed can act as a VSA proxy to perform backups and restores.
For best results, deploy the VSA proxy and MediaAgent on virtual machines in the Azure cloud.
Deploying the VSA proxy on an Azure VM that is optimized for I/O intensive workloads will support faster backups. See Sizes for virtual machines in Azure for more
information.
A VSA proxy must meet the following requirements:
The VSA proxy machine must run one of the following operating systems:
Windows Server 2016
Windows Server 2012 R2 and later
Windows Server 2008 R2 SP1 and later (requires .NET Framework 4.5)
Minimum of 100 GB disk space.
Minimum of 4 GB RAM, beyond the requirements of the operating system and any other running applications.
If the CommServe software, MediaAgent, and VSA are all installed on the same Azure VM, provide a minimum of 10 GB RAM.
A VSA proxy deployed on a virtual machine in Azure must have a public IP address.
A VSA proxy for Azure Classic must have an Azure management certificate installed
If the Azure subscription includes multiple regions, deploy at least one VSA proxy per region.

Guest Operating Systems


Virtual machines being backed up can have any of the guest operating systems that are supported by the Azure platform.

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.

5/6/2017 Commvault Systems Page 539 of 587


System Requirements - Virtual Server Agent for Microsoft Hyper-V
The following requirements are for the Virtual Server Agent for Microsoft Hyper-V:

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.

Virtual Machine Operating Systems


All guest operating systems supported by Microsoft Hyper-V

Hyper-V Integration Services


To back up the virtual machines on a Hyper-V server or cluster, Hyper-V integration services must be installed and updated on the virtual machine.

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

Notes on Virtual Server Agent Installations for Hyper-V


The Virtual Server Agent is installed directly onto the Hyper-V Server.
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.

5/6/2017 Commvault Systems Page 540 of 587


System Requirements for Virtual Server Agent with Nutanix AHV
Nutanix AHV Requirements
Commvault software is supported with Nutanix AHV version 4.6, 4.7, or 5.0.
For Nutanix Controller VMs (CVMs), configure Cluster Virtual IP.
For application consistent backups of user VMs, ensure the following requirements are met:
Install Nutanix Guest Tools software on each VM.
Ensure that the CVM Virtual IP (port 2074) is accessible from user VMs.
Update cluster to Nutanix AHV version 4.6 or later.

Quiescing for Application Consistent Backups


Windows VMs take application consistent snapshots using the Volume Shadow Copy Service (VSS) framework.
Linux VMs use pre-freeze and post-thaw scripts instead of VSS:
Scripts are located in /sbin/pre_freeze and /sbin/post_thaw folders.
The user account that runs the scripts must have root:root access with 700 permissions.
Important: To perform application consistent backups, each virtual machine must be in a separate consistency group. If a subclient includes a consistency group with
multiple VMs, the backup for those VMs fails.

CommServe Requirements
See System Requirements - CommServe .

MediaAgent Requirements
See System Requirements - MediaAgent .

Virtual Server Agent (Proxy) Requirements


You must install the Virtual Server Agent (VSA) on at least one virtual machine in the Nutanix Acropolis Hypervisor (AHV) cluster. The VSA proxy can access virtual machines
and storage throughout the cluster. You can deploy additional VSA proxies as needed for load balancing.
The Virtual Server Agent should be installed on virtual machines that meet the following requirements.
Minimum of 100 GB disk space recommended.
Minimum of 4 GB RAM required beyond the requirements of the operating system and running applications.
Windows Proxies
The Virtual Server Agent can be deployed on VMs running either of the following operating systems:
Windows Server 2008 R2
Windows Server 2012 R2
Note: For Windows proxies, use the Windows diskpart command to disable automount and set the SAN policy to OfflineAll. If these features are enabled, they interfere with
disk HotAdd operations that are performed as part of backup and restore jobs.
Linux Proxies
The Virtual Server Agent can be deployed on VMs running the following operating systems:
CentOS 6.6, 7.1
RHEL 6.6, 7.1
Note: To use a Red Hat 7 proxy, use the following commands to disable lvmetad. Having lvmetad running interferes with HotAdd operations during backup and recovery.
1. Disable and stop the lvm2-lvmetad service by running the following commands:
systemctl disable lvm2-lvmetad
systemctl stop lvm2-lvmetad

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.

Guest Operating Systems


Virtual machines being backed up can have any of the guest operating systems that are supported by the Nutanix AHV platform.
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.

5/6/2017 Commvault Systems Page 541 of 587


System Requirements for OpenStack
Commvault provides support for the following OpenStack distributions:
Red Hat Enterprise Linux OpenStack Platform (RHEL-OP) with the following versions: Kilo (11), Liberty (12), Mitaka (13), Newton (14)
Mirantis with the following versions: Kilo (11), Liberty (12), Mitaka (13), Newton (14)
HPE Helion OpenStack 4.0.1 with the following version: Mitaka (13)
When creating a virtualization client, if there are multiple endpoints for the keystone URL, use the keystone URL for the public endpoint.

Virtual Server Agent (Proxy) Requirements


The Virtual Server Agent can be deployed on a Windows or Linux instance in the OpenStack environment.
Only instances that have the VSA installed can act as VSA proxies to perform backups and restores.
At least one proxy is needed for each region. You can deploy additional VSA proxies as needed for load balancing.
The following operating systems are supported for VSA proxies:
Windows 2012 R2
CentOS 7
RHEL 7.2
Note: Linux proxies must have the psmisc and lvm2 packages installed.
The Virtual Server Agent should be installed on instances that meet the following requirements:
Minimum of 100 GB disk space recommended
Minimum of 4 GB RAM required beyond the requirements of the operating system and running applications
For Windows proxies, VirtIO version 62.73.104.11800 is supported as a driver for OpenStack backup and restore operations.
Note: To use a Red Hat 7 proxy, use the following commands to disable lvmetad. Having lvmetad running interferes with HotAdd operations during backup and recovery.
1. Disable and stop the lvm2-lvmetad service by running the following commands:
systemctl disable lvm2-lvmetad
systemctl stop lvm2-lvmetad

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.

5/6/2017 Commvault Systems Page 542 of 587


System Requirements for Oracle VM
Commvault supports Oracle VM Manager 3.3.1.x or later.
Only Oracle VM Server for x86 is supported.

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.

5/6/2017 Commvault Systems Page 543 of 587


System Requirements - Virtual Server Agent (Red Hat Enterprise Virtualization)
The following requirements are for the Virtual Server Agent (VSA).

Red Hat Enterprise Virtualization Requirements


Versions Supported
RHEV Manager (RHEV-M or RHEV-H) 3.5.x, 3.6.x, 4.0
RHEV Hypervisor (RHEV-H or RHV-H) 7.1, 7.2 (based on the Host Compatibility Matrix for the RHEV-M version in Red Hat documentation)
Red Hat Enterprise Linux Host (RHEL-H) 7.1, 7.2
Hardware Requirements
Minimum required:
4 GB of memory
4 vCPUs
100 GB on hard disk drive
Recommended:
8 GB memory
8 vCPUs
200 GB on hard disk drive
SCSI Controllers
If you install a VirtIO SCSI driver, ensure that the installed driver is identified as a stable version.
Proxy Operating System
The Virtual Server Agent (VSA) can be installed on virtual machines with the following operating systems:
RHEL 6.5, RHEL 7.1, 7.2
Microsoft Windows Server 2008 R2
Microsoft Windows Server 2012 R2
Microsoft Windows Server 2016
Note: To use a Red Hat 7 proxy, use the following commands to disable lvmetad. Having lvmetad running interferes with HotAdd operations during backup and recovery.
1. Disable and stop the lvm2-lvmetad service by running the following commands:
systemctl disable lvm2-lvmetad
systemctl stop lvm2-lvmetad

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.

5/6/2017 Commvault Systems Page 544 of 587


System Requirements for Virtual Server Agent with VMware
The following requirements are for the Virtual Server Agent for VMware:

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.

vCenter, ESX, and VDDK Versions Required for Specific Features


Some features are supported only for more recent versions of vCenter, VDDK, and ESX or ESXi. The following table shows the required versions for features that are
dependent on the version of VMware software.
Feature Required Version of vCenter, VDDK, and ESX or ESXi Link
Agentless file restores 5.x, 6.0, 6.5 Agentless Restores
File Recovery Enabler for Linux 4.1.x, 5.x, 6.0, 6.5 Requirements for File Recovery Enabler
Live Mount 5.x, 6.0, 6.5 Running a Virtual Machine Using Live Mount
Live Recovery for Virtual Machines 5.x, 6.0, 6.5 Restoring Virtual Machines with Live Recovery
Live Sync 4.1.x, 5.x, 6.0, 6.5 or with VM hardware version 7 or Live Sync Replication
higher
VM Lifecycle Management 4.1 or later VM Lifecycle Management

VMware vCloud Director


vCloud Director 5.1.x, 5.5.x, 8.0
Virtual Machine Hardware
Version 4.0, 7.0, 8.0, 9.0, 10.0, 11.0, 13.0
Virtual Machine Operating Systems
All Guest Operating Systems supported by VADP
Datastore Support
Network File System (NFS)
Virtual Machine File System (VMFS)
Virtual storage area network (VSAN)
VMware Virtual Volume (VVol)
VMware Tools on Virtual Machines
The latest version of VMware Tools supported by the host should be installed on each virtual machine. At a minimum, the version of VMware tools on virtual machines
must be supported on the host; unsupported versions must be upgraded.
For guest VMs running the following operating system releases, open-vm-tools can be used:
Fedora 19 and later
Debian 7.x and later
openSUSE 11.x and later
Recent Ubuntu (12.04 LTS, 13.10 and later)
Red Hat Enterprise Linux 7.0 and later
CentOS 7.0 and later
Oracle Linux 7.0 and later
SUSE Linux Enterprise 12 and later
For more information, see VMware support for open-vm-tools (2073803) .
Port Requirements
In an environment with firewalls, the vCenter, ESX servers, and Virtual Server Agent must be able to communicate with each other. To ensure that all components can
communicate through the firewall, ensure that the ports for web services (default: 443) and TCP/IP (default: 902) are opened for communication on each of these machines.
Additional port requirements can apply for the MediaAgent when you use specific features such as Live Browse, Live File Recovery, and Live Mount. For more information,
see Entering Required Firewall Settings .
Prior to performing any backup or restore operations, ensure that the following port requirements are met.
Note: If a non-default port is used with VDDK 5.5, backup or restore operations can fail. See KB Article VMW0013 .
Virtual Center
Port for web service (default: 443) must be opened. If vCenter is configured to use non-default ports, the non-default ports must also be opened.
ESX Server
Ports for web service (default: 443) and TCP/IP (default: 902) must be opened for the vStorage APIs for Data Protection.
vCloud Director
5/6/2017 Commvault Systems Page 545 of 587
A port for the vCloud REST API (default: 443) must be opened.
Subclient with multiple proxies
If you are using multiple proxies in a single subclient, open the CVD port (by default 8400) for all proxies in the subclient, to enable the coordinator node and other
proxies to communicate. The CVD port is used to establish communication between proxies using a randomly selected port; to enable communication between proxies
you must configure the Commvault firewall .
Proxy Computer Operating Systems
Microsoft Windows Server 2016
Microsoft Windows Server 2012R2 x64 Editions
Microsoft Windows Server 2012 x64 Editions
Microsoft Windows Server 2008 R2 x64 Editions
Microsoft Windows Server 2008 x64 Editions

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.

5/6/2017 Commvault Systems Page 546 of 587


System Requirements - Search Engine
The following requirements are for the Search Engine:

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

Search-Only Search Engine VM Requirements


If a Search Engine node has reached the maximum number of content indexed objects in its index, you can move the content index to a virtual machine. (See Moving a
Search Engine Index to a Virtual Machine .) The virtual machine must be configured with the following minimum requirements:
An operating system supported by the Search Engine software.
Unique host name and IP address.
8 virtual CPU cores.
16 GB RAM Memory.
Disk space equal to 110% the size of the content index.

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.

5/6/2017 Commvault Systems Page 547 of 587


System Requirements - Compliance Search
The following requirements are for the Compliance Search:

Operating System Architecture


Windows Server 2008 Microsoft Windows Server 2008 x64 Editions* All Windows-compatible processors supported
*Core Editions are not supported.

Windows Server 2012 Microsoft Windows Server 2012 Editions All Windows-compatible processors supported

Web Server for Compliance Search


In order to provide reliable performance, a dedicated Web Server is recommended for Compliance Search users. Ensure that the Web Server used for Compliance Search
meets the following requirements:
System Components Minimum Requirements
Operating System Microsoft Windows Server 2008 R2 x64 Editions
CPU Multi-Core Xeon Class 2
Memory 16 GB RAM
Available local hard disk space 20 GB for the installation directory
1 TB of 10K SCSI disk for the Analytics Engine Index Directory
Software Java 8

Configurations Only one instance of Analytics Engine can be configured on a MediaAgent


Clustered MediaAgents are not supported

For additional hardware requirements, see Web Server Hardware Requirements


.
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

Manually upgrading the Apache Tomcat Server is not supported.

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.

5/6/2017 Commvault Systems Page 548 of 587


System Requirements - Laptop Backup (Macintosh)
The following requirements are for the Laptop Backup feature running on a Macintosh computer:

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.

5/6/2017 Commvault Systems Page 549 of 587


System Requirements - Laptop Backup (Linux)
The following requirements are for the Laptop Backup feature running on a Linux computer:
* Laptop Edge Monitor may not be fully functional on some Linux distributions.

Operating System Architecture


Linux Debian
Debian 6.x with glibc 2.11.x Intel Pentium, x64 or compatible processors
Debian 5.x with glibc 2.7.x Intel Pentium, x64 or compatible processors
Fedora
Fedora release 9 with glibc 2.8.x Intel Pentium, x64 or compatible processors
Fedora release 8 with glibc 2.7.x Intel Pentium, x64 or compatible processors
Fedora release 17 with glibc 2.15.x Intel Pentium, x64 or compatible processors
Fedora release 16 with glibc 2.14.x Intel Pentium, x64 or compatible processors
Fedora release 15 with glibc 2.13.x Intel Pentium, x64 or compatible processors
Fedora release 14 with glibc 2.13.x Intel Pentium, x64 or compatible processors
Fedora release 13 with glibc 2.12.x Intel Pentium, x64 or compatible processors
Fedora release 12 with glibc 2.11.x Intel Pentium, x64 or compatible processors
Fedora release 11 with glibc 2.10.x Intel Pentium, x64 or compatible processors
Fedora release 10 with glibc 2.9.x Intel Pentium, x64 or compatible processors
Gentoo
Gentoo release 11 with glibc 2.12.x Intel Pentium, x64 or compatible processors
Gentoo release 10.1 with glibc 2.6.x Intel Pentium, x64 or compatible processors
Mandriva
Mandriva Linux 2010 with glibc 2.10.x Intel Pentium, x64 or compatible processors
Mandriva Linux 2009 with glibc 2.9.x Intel Pentium, x64 or compatible processors
OpenSuSE
OpenSuSE 12.1 with glibc 2.14.x Intel Pentium, x64 or compatible processors
OpenSuSE 11.3 with glibc 2.11.x Intel Pentium, x64 or compatible processors
OpenSuSE 11.2 with glibc 2.10.x Intel Pentium, x64 or compatible processors
OpenSuSE 11.1 with glibc 2.9.x Intel Pentium, x64 or compatible processors
OpenSuSE 11.0 with glibc 2.8.x Intel Pentium, x64 or compatible processors
Oracle Linux
Oracle Linux 4.x with a minimum of glibc 2.3.4 Intel Pentium, x64 or compatible processors
Red Flag Linux
Red Flag Linux 5.x with a minimum of glibc 2.3.4 x64
Red Flag Linux 4.x with a minimum of glibc 2.3.4 Intel Pentium or compatible processors
Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 6.x with glibc 2.12.x Intel Pentium, Power PC (Includes IBM System p) 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 Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
Red Hat Enterprise Linux/CentOS 4.x with a minimum of glibc 2.3.4 Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
Scientific Linux
Scientific Linux SL 5.x with glibc 2.5.x x64
SuSE Linux (SLES)
SuSE Linux 11.x with glibc 2.9.x and later Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
SuSE Linux 10.x with glibc 2.4.x Intel Pentium, x64, Power PC (Includes IBM System p) or compatible processors
Ubuntu
Ubuntu 9.10 Intel Pentium, x64 or compatible processors
Ubuntu 9.04 Intel Pentium, x64 or compatible processors
Ubuntu 8.10 Intel Pentium, x64 or compatible processors
Ubuntu 8.04 Intel Pentium, x64 or compatible processors
Ubuntu 12.04 LTS Intel Pentium, x64 or compatible processors
Ubuntu 11.10 Intel Pentium, x64 or compatible processors
5/6/2017 Commvault Systems Page 550 of 587
Ubuntu 11.04 Intel Pentium, x64 or compatible processors
Ubuntu 10.04 LTS Intel Pentium, x64 or compatible processors

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:

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

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.

Supported File Systems


The Laptop Backup feature supports the following file systems:
B-tree File System (Btrfs)
Extended 2 File System (ext2)
Extended 3 File System (ext3)
Extended 4 File System (ext4)
General Parallel File System (GPFS)
Global File System (GFS/GFS2)
GlusterFS File System (GlusterFS)*
Lustre File System (Clustered File System)
5/6/2017 Commvault Systems Page 551 of 587
Moose File System (MooseFS)
Oracle Cluster File System (OCFS2)
Oracle ASM Cluster File System (Oracle ACFS)
Panasas ActiveScale File System (PanFS)
Reiser File System (reiserfs)
VERITAS File System (VxFS)
VERITAS Cluster File System (VxCFS)
X9000 IBRIX File System (IBRIXFS) 6.x
'X' File System (XFS)
*Backups and restores run on the Gluster client

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.

5/6/2017 Commvault Systems Page 552 of 587


System Requirements - Laptop Backup (Windows)
The following requirements are for the Laptop Backup feature running on a Windows computer:

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.

Microsoft Windows Client 8


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

5/6/2017 Commvault Systems Page 553 of 587


System Requirements - ContinuousDataReplicator
The following requirements are for the ContinuousDataReplicator:

Operating System Architecture


AIX AIX 7.1 64-bit Power PC (Includes IBM System p)

AIX 6.1 TL 02 SP00 64-bit or higher Power PC (Includes IBM System p)


HP-UX HP-UX 11i v3 (11.31) Itanium

HP-UX 11i v2 (11.23) Itanium


Linux CentOS
CentOS 7.3 with kernel 3.10.0-514 Intel Pentium or compatible minimum required
CentOS 7.2 with kernel 3.10.0-327 Intel Pentium or compatible minimum required
CentOS 7.1 with kernel 3.10.0-229 Intel Pentium or compatible minimum required
CentOS 7.0 with kernel 3.10.0-123 Intel Pentium or compatible minimum required
CentOS 6.7 with kernel 2.6.32-573 Intel Pentium or compatible minimum required
CentOS 6.6 with kernel 2.6.32-504 Intel Pentium or compatible minimum required
CentOS 6.5 with kernel 2.6.32-431 Intel Pentium or compatible minimum required
CentOS 6.4 with kernel 2.6.32-358 Intel Pentium or compatible minimum required
CentOS 6.3 with kernel 2.6.32-279 Intel Pentium or compatible minimum required
CentOS 6.2 with kernel 2.6.32-220 Intel Pentium or compatible minimum required
CentOS 6.1 with kernel 2.6.32-131 Intel Pentium or compatible minimum required
CentOS 6.0 with kernel 2.6.32-71 Intel Pentium or compatible minimum required
Debian
Debian 8.x with kernel 3.16.0 x64
Debian 8.x with kernel 3.16.0 Intel Pentium or compatible minimum required
Debian 7.x with kernel 3.2.0 x64
Debian 7.x with kernel 3.2.0 Intel Pentium or compatible minimum required
Debian 6.x with kernel 2.6.32 x64
Debian 6.x with kernel 2.6.32 Intel Pentium or compatible minimum required
Debian 5.x with kernel 2.6.26-2 Intel Pentium or compatible minimum required
Debian 5.x with kernel 2.6.26.19-2 x64
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
Red Hat Enterprise Linux 7.0 Advanced Platform with kernel 3.10.0-123 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.7 Advanced Platform with kernel 2.6.32-573 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.6 Advanced Platform with kernel 2.6.32-504 x64
Red Hat Enterprise Linux 6.6 Advanced Platform with kernel 2.6.32-504 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.5 Advanced Platform with kernel 2.6.32-431 x64
Red Hat Enterprise Linux 6.5 Advanced Platform with kernel 2.6.32-431 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.4 Advanced Platform with kernel 2.6.32-358 x64
Red Hat Enterprise Linux 6.4 Advanced Platform with kernel 2.6.32-358 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.3 Advanced Platform with kernel 2.6.32-279 x64
Red Hat Enterprise Linux 6.3 Advanced Platform with kernel 2.6.32-279 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.2 Advanced Platform with kernel 2.6.32-220 x64

5/6/2017 Commvault Systems Page 554 of 587


Red Hat Enterprise Linux 6.2 Advanced Platform with kernel 2.6.32-220 Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 6.1 Advanced Platform with kernel 2.6.32-131 x64
Red Hat Enterprise Linux 6.1 Advanced Platform with kernel 2.6.32-131 Intel Pentium or compatible minimum required
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-131 (Update 1) x64
Red Hat Enterprise Linux 5.x Advanced Platform with kernel 2.6.18-x Intel Pentium or compatible minimum required
Red Hat Enterprise Linux 5.x Advanced Platform with kernel 2.6.18-x x64
Red Hat Enterprise Linux 6.6 Advanced Platform with kernel 3.10.0-229 x64
Red Hat Enterprise Linux 6.6 Advanced Platform with kernel 3.10.0-229 Intel Pentium or compatible minimum required
SuSE Linux (SLES)
SuSE Linux 9.x Enterprise Server x64
SuSE Linux 9.x Enterprise Server Intel Pentium or compatible minimum required
SuSE Linux 12 Enterprise Server with kernel 3.12.28-4-default x64
SuSE Linux 12 Enterprise Server with kernel 3.12.28-4-default Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 3.0.76-0.11-default (Update 3) x64
SuSE Linux 11 Enterprise Server with kernel 3.0.76-0.11-default (Update 3) Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 3.0.13-0.27-default (Update 2) x64
SuSE Linux 11 Enterprise Server with kernel 3.0.13-0.27-default (Update 2) Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 3.0.101-0.15-default (Update 3 with Security Patch) x64
SuSE Linux 11 Enterprise Server with kernel 3.0.101-0.15-default (Update 3 with Security Patch) Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 2.6.32.12-0.7 (Update 1) x64
SuSE Linux 11 Enterprise Server with kernel 2.6.32.12-0.7 (Update 1) Intel Pentium or compatible minimum required
SuSE Linux 11 Enterprise Server with kernel 2.6.27.19-5 x64
SuSE Linux 11 Enterprise Server with kernel 2.6.27.19-5 Intel Pentium or compatible minimum required
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.34 (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.60-0.21 (Update 2) Intel Pentium or compatible minimum required
SuSE Linux 10 Enterprise Server with kernel 2.6.16.46-0.12 (Update 1) Intel Pentium or compatible minimum required
SuSE Linux 10 Enterprise Server with kernel 2.6.16.46-0.12 (Update 1) x64
Solaris Solaris 11.3 x64, Sparc T/M series

Solaris 11.2 x64, Sparc T/M series


Solaris 11.0 Sparc T/M series
Solaris 11.0 x64
Solaris 10.x with a minimum of SunOS (Sparc) Patch 119963-14 and 119689-06 Ultra5 or higher recommended
Solaris 10.x (6/06 and higher) 64-bit x64
Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 Editions All Windows-compatible processors supported
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 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.

For information on supported cluster types, see Clustering - Support .

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)

5/6/2017 Commvault Systems Page 555 of 587


1 GB minimum of additional hard disk space on the source computer for replication log file growth; more is recommended
1 GB of additional hard disk space on the destination computer for replication log file growth for each source computer (e.g., if five source computers are configured to
use the same destination computer, then 5 GB of additional hard drive space is required on the destination computer)
CDR on UNIX:
250 MB minimum of hard disk space for software
3 GB minimum of additional hard disk space on the source computer for replication log file growth; more is recommended. Maximum allowed is 80% of total space on
the file system.

Refer to Data Replication for important considerations when allocating replication log file space.

Solaris Zones/Containers Support


The ContinuousDataReplicator should be installed on the global zone. Installation on non-global zones is not supported.
On the source computer, the ContinuousDataReplicator can be used to replicate data from any non-global zone.
On the destination computer, data can be replicated to a non-global zone through a exporting device from the global zone. See Data Replication on Non-Global Zones for
more information.
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:
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]#

3. Execute the policy module. Use the following command:


[root]# restorecon -R /opt/<software installation directory>

SELinux is now configured to work with this application.

5/6/2017 Commvault Systems Page 556 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
UNIX and Linux
The source volume for a Replication Pair must be a local volume.

Notes on Windows Installation


Microsoft Windows XP is not supported as both source and destination for ContinuousDataReplicator.
When installing ContinuousDataReplicator client on a Microsoft Windows x64 platform, you must install Microsoft .NET Framework 4.0.

Notes on Linux Installation


A compiled version of the CDR driver is supplied only for the listed versions and kernels. If you perform online updates of Linux, you may encounter a situation where the
supplied CDR driver will not load after a reboot because the kernel has been updated to a new version.
If you are installing the software on a computer running Red Hat Linux 5 or above, the file system on the computer must be compiled as a kernel module.
For example: computers running Red Hat Linux 5 with the ext2 file system will not support the ContinuousDataReplicator software, as the ext2 file system is built into the
kernel. Conversely, computers running Red Hat Linux 5 with the ext3 file system compiled as a kernel module will support the ContinuousDataReplicator 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.

5/6/2017 Commvault Systems Page 557 of 587


System Requirements - 1-Touch for AIX
Operating System
The following are the requirements for 1-Touch on an AIX:
Server
AIX 7.2 64-bit with Technology Level 1 or higher (LPAR with shared fibre channel card NPIV supported)
AIX 7.1 64-bit with Technology Level 2 or higher (LPAR with shared fibre channel card NPIV supported)
AIX 6.1 64-bit with Technology Level 2 or higher (LPAR with shared fibre channel card NPIV supported)
Client
AIX 7.2 64-bit with Technology Level 1 or higher (LPAR with shared fibre channel card NPIV supported)
AIX 7.1 64-bit with Technology Level 2 or higher (LPAR with shared fibre channel card NPIV supported)
AIX 6.1 64-bit with Technology Level 2 or higher (LPAR with shared fibre channel card NPIV supported)

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

Supported File system and volume manager types


AIX logical Volume Manager for Root and Non- root Volumes (LVM)
VERITAS Volume Manager 5.0 or higher for Non root Volumes (VXVM)
Journal File System (JFS) (AIX)
Enhanced Journal File System (JFS2) (AIX)
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.

5/6/2017 Commvault Systems Page 558 of 587


System Requirements - 1-Touch for Linux
Operating System
The following are the requirements for 1-Touch on Linux:
Client
Debian
Debian 8.0 with kernel 3.16.0
Debian 7.3 with kernel 3.2.0
Oracle Linux
Oracle Linux 6.8 with glibc 2.12.x
Oracle Linux 6.5 with glibc 2.12.x
Oracle Linux 6.4 with glibc 2.12.x
Oracle Linux 6.3 with glibc 2.12.x
Oracle Linux 6.2 with glibc 2.12.x
Oracle Linux 6.1 with glibc 2.12.x
Oracle Linux 6.0 with glibc 2.12.x
Oracle Linux 5.x (Carthage) with glibc 2.5.x
Red Hat Enterprise Linux/CentOS
Red Hat Enterprise Linux/CentOS 7.2 with glibc 2.17.x
Red Hat Enterprise Linux/CentOS 7.1 with glibc 2.17.x
Red Hat Enterprise Linux/CentOS 6.6 with glibc 2.12.x
Red Hat Enterprise Linux/CentOS 6.5 with glibc 2.12.x
Red Hat Enterprise Linux/CentOS 6.4 with glibc 2.12.x
Red Hat Enterprise Linux/CentOS 6.1 with glibc 2.12.x
Red Hat Enterprise Linux/CentOS 6.0 with glibc 2.12.x
Red Hat Enterprise Linux/CentOS 5.x with glibc 2.5.x
Red Hat Enterprise Linux/CentOS 4.8 with glibc 2.3.x
SuSE Linux
SuSE Linux Enterprise Server 11 SP4 with glibc 2.11.3
SuSE Linux Enterprise Server 11 SP3 with glibc 2.11.3
SuSE Linux Enterprise Server 11 SP2 with glibc 2.11.3 and kernel 3.0.13-0.5
SuSE Linux Enterprise Server 11.x with glibc 2.9.x
SuSE Linux Enterprise Server 10.x with glibc 2.4.x
Ubuntu
Ubuntu 14.04 LTS with glibc 2.19
Ubuntu 12.04 LTS with glibc 2.15

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

Supported file system and volume manager types


Supported file system and Supported options
volume manager types
Linux Logical Volume Manager
(LVM) Version 2
Second Extended File System Block size, blocks per group, revision
(ext2)
Third Extended File System (ext3) Block size, blocks per group, revision
Fourth Extended File System Block size, blocks per group, revision
(ext4)

5/6/2017 Commvault Systems Page 559 of 587


Reiser File System (reiserfs) Block size, hash function, journaling device, uuid
XFS Block size, number of allocation groups, stripe unit, inode size, maximum percentage of file system space that can be allocated to
inodes, log device, lazy-count, log version, size of blocks in the real-time section

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.

5/6/2017 Commvault Systems Page 560 of 587


System Requirements - 1-Touch for Solaris 10
Operating System
The following are the requirements for 1-Touch on Solaris 10:
x64
JumpStart Server
Solaris 10 Update 7 or equivalent 64-bit
Client
Solaris 10 Update 6 or equivalent 64-bit
Sparc T/M Series
JumpStart Server
Solaris 10 Update 6 or equivalent*
*The operating systemsupports Sun Sparc5 or higher recommended processors.

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.

5/6/2017 Commvault Systems Page 561 of 587


System Requirements - 1-Touch for Windows
The following are the requirements for 1-Touch on Windows:
Client
Windows Server 2016
*Nano Servers are not supported.

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


Microsoft Windows Server 2008 32-bit and 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.

5/6/2017 Commvault Systems Page 563 of 587


System Requirements for Block-Level Backup for Windows
The following are the requirements for block-level backup for Windows.

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.

5/6/2017 Commvault Systems Page 564 of 587


System Requirements for Block-Level Backup for UNIX
The following are the requirements for block-level backup for UNIX.

Operating System Architecture


AIX AIX 7.1 TL 01 SP10 ("7100-01-10-1415") 64-bit, or higher Power PC (Includes IBM System p)

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

5/6/2017 Commvault Systems Page 565 of 587


SuSE Linux 10 Enterprise Server with kernel 2.6.16.46-0.12 (Update 1) x64
Solaris Solaris 11.0 x64, Sparc T/M series

Solaris 10 Update 7 or higher x64, Sparc T/M series

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

5/6/2017 Commvault Systems Page 566 of 587


External Data Connector - System Requirements
The following requirements are for External Data Connector:

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.

5/6/2017 Commvault Systems Page 567 of 587


External Data Connector - System Requirements
The following requirements are for External Data Connector:

Tivoli Storage Manager


After the first full discovery process is complete, each Tivoli Storage Manager component, such as client nodes, schedules, etc. is mapped to the appropriate CommCell
entity. The following versions of Tivoli Storage Manager are supported for these TSM components:
Tivoli Storage Manager Grouping Description Supported Tivoli Storage Manager Versions*
Configuration Client nodes, Client node schedules, Schedule repetitions, Client 5.4, 5.5, 6.1, 6.2, and 6.3
Node Platforms, Schedule Actions (Backup), Schedule
Expiration, Client node option sets (compression).
Jobs Job information is migrated for CommCell reporting purposes. 5.4, 5.5, 6.1, 6.2, and 6.3
*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.

5/6/2017 Commvault Systems Page 568 of 587


External Data Connector - System Requirements - EMC Networker
The following requirements are for External Data Connector:

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.

5/6/2017 Commvault Systems Page 569 of 587


System Requirements - Media Explorer
The following requirements are for the Media Explorer:

Operating System Architecture


Windows Windows 2012
Microsoft Windows Server 2012 32-bit and x64 Editions All Windows-compatible processors supported
Windows 2008
Microsoft Windows Server 2008 32-bit and x64 Editions All Windows-compatible processors supported

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.

5/6/2017 Commvault Systems Page 570 of 587


System Requirements - Private Metrics Reporting Server
The following requirements are for the Private Reporting Server package:

Operating System Architecture


Windows Windows 2012
Microsoft Windows Server 2012 R2 Editions All Windows-compatible processors supported
Microsoft Windows Server 2012 Editions All Windows-compatible processors supported
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

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
.

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
Apache Tomcat Server
The Apache Tomcat Server is automatically installed.

Manually upgrading the Apache Tomcat Server is not supported.

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.

5/6/2017 Commvault Systems Page 571 of 587


System Requirements - Workflow
By default, the Workflow engine is installed as part of the CommServe installation. If you plan to install the Workflow engine on a separate computer, review the following
requirements:

Operating System Architecture


Windows Windows 2012
Microsoft Windows Server 2012 Editions All Windows-compatible processors supported
Windows 2008
Microsoft Windows Server 2008 R2 Editions* All Windows-compatible processors supported
*Core Editions are not supported.

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.

5/6/2017 Commvault Systems Page 572 of 587


Considerations for Microsoft Windows Server 2016
Supported Components
Microsoft Windows Server 2016 is supported in this release for the following CommCell components:

Components Windows Supported Notes


Server 2016 Since
CommServe X Service Pack 6
Web Server X Service Pack 6
Web Console X Service Pack 6
MediaAgent X Service Pack 6
Microsoft Windows File Systems X Service Pack 5 Nano Servers are not supported.
1-Touch for Windows X Service Pack 6 Nano Servers are not supported.
Private Metrics Reporting Server X Service Pack 6

Block-Level Backups X Service Pack 5 Nano Servers are not supported.


Active Directory X Service Pack 6
Microsoft Exchange Database Agent X Service Pack 6
Microsoft Exchange Mailbox (Classic) Agent X Service Pack 6
Microsoft SQL Server Agent X Service Pack 6
OnePass for BlueArc X Service Pack 6
OnePass for Windows and Driverless OnePass for Windows X Service Pack 6
OnePass for Celerra X Service Pack 6
Virtual Server Agent for Amazon X Service Pack 7
Virtual Server Agent for Microsoft Azure X Service Pack 7
Virtual Server Agent for Microsoft Hyper-V X Service Pack 5
Virtual Server Agent for Red Hat Virtualization X Service Pack 7
Virtual Server Agent for VMware X Service Pack 7

Windows File System iDataAgent


Change Journal scan method is not supported on Resilient File System (ReFS) volumes on Windows Server 2016 computers. The Recursive Scan or Optimized Scan
method is used to backup data.
Restore from Deduplicated Volumes
Windows Server 2012 and Windows Server 2016 has a deduplication feature that can be enabled. Data from deduplicated volumes will be backed up in its original state
(uncompressed). Therefore, during a restore, ensure that you have enough storage space on the volume to restore the full data size.

5/6/2017 Commvault Systems Page 573 of 587


Considerations for Microsoft Windows Server 2012, 2012 R2, and Windows 8.x
Table of Contents
Supported Components
CommServe
Windows File System iDataAgent
OnePass for Windows
Additional Considerations
AlwaysOn Provided by SQL 2012 or Later
Installation
Virtual Server iDataAgent (Hyper-V)

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.

Windows File System iDataAgent


Change Journal scan method is not supported on Resilient File System (ReFS) volumes on Windows Server 2012, 2012 R2, and Windows 8.x computers. The Recursive Scan
or Optimized Scan method is used to backup data.
Restore from Deduplicated Volumes
Windows Server 2012 and Windows Server 2016 has a deduplication feature that can be enabled. Data from deduplicated volumes will be backed up in its original state
(uncompressed). Therefore, during a restore, ensure that you have enough storage space on the volume to restore the full data size.

OnePass for Windows


You cannot view the offline stub icon for offline stubs on the local disks using the Windows Explorer.

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:

5/6/2017 Commvault Systems Page 574 of 587


DISM.exe /Online /Enable-Feature /FeatureName:NetFx3 /All /LimitAccess /Source:x:\sources\sxs
Where x is the DVD drive (or mounted ISO), and the LimitAccess flag ensures Windows does not download files from the Internet.
Installing Windows File System iDataAgent from the CommCell Console
Remote installs from the CommCell Console on Windows 8 client fail when the client computer is not a part of a domain. To resolve this issue, enable User Account
Control: Admin Approval Mode for the Built-in Administrator account on the client's Local Security Policy dialog box.
Virtual Server iDataAgent (Hyper-V)
The Microsoft Hyper-V iDataAgent will back up all the data on a Windows Server 2012 or 2012 R2 computer.

5/6/2017 Commvault Systems Page 575 of 587


Considerations for SQL Server 2012
Table of Contents
Supported Packages
Supported Platforms
Installing CommServe Using an Existing Instance of SQL Server 2012
Upgrading from SQL 2008 to SQL 2012
Method 1: Upgrade to SQL 2012 without Uninstalling SQL 2008
Method 2: Uninstall SQL 2008 to Install SQL 2012
Notes on AlwaysOn Provided by SQL 2012 or Later

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.

Installing CommServe Using an Existing Instance of SQL Server 2012


You can install the CommServe using an existing SQL Server instance that was not installed by Commvault.
In order to do this, you are required to configure the szUserSQLInstanceName registry key on the computer on which you want to perform the installation.
Use the following steps to configure the szUserSQLInstanceName registry key:
1. Log on to the computer as an Administrator or as a member of the Administrator group.
2. Click the Windows Start button and then click Run.
3. Type regedit and then click OK to open the Registry Editor window.
4. Navigate to HKEY_LOCAL_MACHINE > SOFTWARE > GalaxyInstallerFlags.
5. Right-click the GalaxyInstallerFlags and select New > String Value.
6. Specify the Value name as szUserSQLInstanceName.
7. Double click szUserSQLInstanceName , in the Value data box, type the name of the SQL instance that you want to use and click OK.
8. Close the Registry Editor window.
After configuring the szUserSQLInstanceName registry key, you can install the CommServe using the existing instance of SQL Server 2012.

Upgrading from SQL 2008 to SQL 2012


The following sections describe the steps to upgrade the existing SQL Server 2008 database to SQL Server 2012 Enterprise Edition.
For SQL Server 2008 R2 versions, make sure that Service Pack 1 or later is installed for a successful upgrade to SQL Server 2012.
We recommend you to perform a disaster recovery backup before the upgrade steps described below. This will help you secure and maintain the data
required in case you need to recover the database. See Performing a Disaster Recovery Backup for more information.
If the SQL Server to be upgraded is part of a clustered CommServe environment (which you also plan to upgrade), see Upgrading Older SQL Server Versions to
Microsoft SQL Server 2012 Enterprise Edition .

Method 1: Upgrade to SQL 2012 without Uninstalling SQL 2008


1. Ensure your current SQL 2008 version is SP2 or higher for a successful upgrade.
2. Stop 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 Stop to stop all services.
3. Install the SQL Server 2012 software.
a. From the installation package that was created using the Download Manager, run the following program:
WinX64\ThirdParty\MSSQL\SQL_Standard_Edition\Setup.exe
The SQL Server Installation Center wizard is displayed.
b. In the left-hand navigation area, click Installation and then click Upgrade from SQL Server 2005, SQL Server 2008 or SQL Server 2008 R2.
Follow the instructions provided by the installation wizard. For more information, go to the Microsoft Web site.
4. After the upgrade completes, start all services on the SQL Server computer using the following steps:
5/6/2017 Commvault Systems Page 576 of 587
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.

Method 2: Uninstall SQL 2008 to Install SQL 2012


1. Stop 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 Stop to stop all services.
2. Using the SQL Server Management Studio, backup the server database and create a .dmp file.
Perform the following steps to back up the CommServe database to a full database backup:
Note: You can also use these steps to back up the Content Indexing database.
a. Open Microsoft SQL Server Management Studio.
b. Navigate to Server Instance | Database | CommServ.
c. Right-click the CommServ database, select Tasks and then click Backup. The Back Up Database dialog box appears.
d. In the Database, verify the database name.
e. In the Backup type, select Full.
f. In the Backup Component, select Database option.
g. Accept the default backup set name in the Name, or you can enter a different name for the backup set.
h. Specify when the Backup set will expire. By default After is selected with value 0.
i. In the Destination area select Disk option. To select the path, click Add. The selected path will be displayed in the Backup to list.
j. To remove backup destination, select the destination path and click Remove.
k. Click OK.
3. Uninstall SQL Server 2008.
4. Install the SQL Server 2012 using the steps from Pre-Install SQL Server for CommServe .
During installation, provide the name for the Commvault instance when prompted.
5. Once the installation completes, use the SQL Server Management Studio to restore the database dump file created in Step 2.
Perform the following steps to restore the full database to the SQL Server computer:
a. Open Microsoft SQL Server Management Studio.
b. Navigate to Server Instance | Database.
c. Right-click Database, select Restore Database. The Restore Database dialog box appears.
d. On the General page, do the following:
In the To Database, select or type the name of a database.
To specify the source and location of the backup sets to restore, select From device option.
Click the Browse button, Backup dialog box appears.
In the Backup media, select one of the device type.
Click Add to provide the path of dump file copied in the previous step. Click OK.
e. On the Options page, do the following:
In the Restore options, choose any of the options, appropriate for your situation.
The Recovery state determines the state of the database after the restore operation.
Choose Leave the database non-operational, and do not roll back the uncommitted transactions. Additional transaction logs can be restored.
(RESTORE WITH NORECOVERY) option.
f. Click OK.
6. Create the SQL Server user account for Commvault (sqladmin_cv) by using the DB Maintenance utility.
a. Open the command prompt and go to the Software_Installation_Directory/Base folder.
b. Run the following command:
DBMaintenance -S .\commvault -U SQLUser -P SQLUserPass -N CommServ -cslogin sqladmin_cv -cspwd CSDBPass -SetRegistry

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.

Notes on AlwaysOn Provided by SQL 2012 or Later


AlwaysOn is a new implementation on clusters. If you want to protect the AlwaysOn configuration, consider the following:
Install the SQL Agent on all the physical nodes of an AlwaysOn cluster, and then create a new MSSQL Availability Group (AG) client. For more details, see AlwaysOn
Availability Groups .
Install the SQL Agent on all physical nodes of the cluster to protect the SQL instances separately. For more details, see AlwaysOn Availability Groups - Best Practice .
If you want to restore any databases that are part of the availability group, you must remove the database from the availability group. Once the restore completes, you
can add the database back.

5/6/2017 Commvault Systems Page 577 of 587


End-of-Life, Deprecated and Extended Support - Obsolescence Policy
Commvault Products and Features
When a Commvault product or feature has reached End-of-Life (EOL) cycle, your software provider will issue several notices outlining the effective date of obsolescence. Full
or limited support for the product or feature will be provided from the date of announcement through the date of obsolescence.
When a feature is classified as Deprecated, it means it does not exist in the current media kit as an installation option. This functionality in many cases is available using a
different product set. In some cases you can use an install kit from a prior version to support the use-case in an ?as-is? support model
Visit the Commvault Systems, Inc. Product Support website at http://www.Commvault.com/support for more information on the EOL process.

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 .

Service Pack Lifecycle Support Policy


We recommend that you install the latest service pack to remain current with all fixes and enhancements, however we fully support customers on the three most recent
service packs. Thus, to remain fully supported, you must apply service packs at least every 6 months.
When support for a service pack ends, Commvault will no longer provide new updates and hotfixes for that service pack. For customers on supported products with service
pack versions that no longer have full support, Commvault offers limited support as follows:
Limited break/fix support incidents will be provided through Commvault Customer Service and Support.
If the support incident requires escalation to development for further guidance, requires a hotfix, or requires a security update, customers will be asked to upgrade to
a fully supported service pack.
Limited support does not include an option to engage Commvault?s product development resources; technical workarounds may be limited or not possible.
To review the EOL schedule for Version 11, see KB article CS0031 .

5/6/2017 Commvault Systems Page 578 of 587


End-of-Life, Deprecated and Extended Support - Platforms
Table of Contents
List of Deprecated Platforms and Applications
List of Deprecated Platforms Supported by Commvault Version 8
List of Platforms and Applications on Extended Support

List of Deprecated Platforms and Applications


If a third-party vendor discontinues support for a platform, that platform, as well as any products associated with it, is considered deprecated. While the product or
platform may continue to be used on an "as-is" basis, the following caveats will apply:
Fixes/updates will not be provided.
No new features will be supported.
The Installation Package Version column indicates the Commvault installation package version that last supported the deprecated platform or application. To install any
of the versions displayed in the Installation Package Version column, you must configure some additional settings on the CommServe and client computer. For more
information, see Installing Clients from Older Commvault Versions .
If you require support in Version 11 for platforms not covered in the list on this page, contact us at [email protected], and we will assist in providing the backup
solution for your environment. You can also provide feedback and suggestions for deprecated platforms by contacting us at [email protected].
The following applications and platforms are currently considered as deprecated:
Application/Platform Installation Package Version
AIX 5.3 Commvault 10.0
DB2 10.1 Universal Database 32-bit Commvault 10.0
DB2 10.1 Universal Database 64-bit Commvault 10.0
DB2 8.1 Universal Database 32-bit Commvault 9.0
DB2 8.1 Universal Database 64-bit Commvault 9.0
HP-UX 11i v1 (11.11) Commvault 9.0
HP-UX on PA-RISC Commvault 9.0
Informix 10.x Commvault 9.0
Informix 11.10x Commvault 9.0
Informix 9.20 Commvault 9.0
Informix 9.21 Commvault 9.0
Informix 9.30 Commvault 9.0
Informix 9.4 Commvault 9.0
Linux on Intel Itanium (IA64) Commvault 9.0
Lotus Domino Server Release 7.0.x 32-bit Commvault 9.0
Lotus Domino Server Release 8.0.2 Commvault 9.0
Lotus Domino Server Release 8.5 on AIX 32-bit Commvault 10.0
Lotus Domino Server Release 8.5 on Solaris Commvault 10.0
Mac OS X v10.4.x Commvault 9.0
Microsoft Exchange 2000 32-bit Server up to the latest service pack Commvault 9.0
Microsoft Exchange 2000 Server up to the latest service pack Commvault 9.0
Microsoft Exchange 2003 32-bit Server up to the latest service pack Commvault 10.0
Microsoft SharePoint Portal 2003 Server up to the latest Service Commvault 9.0
Pack
Microsoft SQL Server 2000 Editions up to the latest Service Pack Commvault 9.0
Microsoft Windows 2000 Server Commvault 9.0
To install a Version 9 client, see Installing Version 9 Windows Server 2000 Clients on a Version 11
CommCell Environment .
MySQL Community Server Edition or Enterprise, Standard or Commvault 10.0
Classic Edition - 5.0.x
MySQL on AIX Commvault 9.0
NetApp ONTAP version 6.5.5 Commvault 9.0
Oracle 10g (10.1.x) Database 32-bit (Enterprise or Standard Edition) Commvault 10.0
Oracle 10g (10.1.x) Database 64-bit (Enterprise or Standard Edition) Commvault 10.0
Oracle 9i (9.2) Database (Enterprise or Standard Edition) Commvault 10.0
For information on IntelliSnap backups, see Best Practices for Oracle 9i Configurations .
PostgreSQL Version 8.x Commvault 10.0
PostgreSQL Versions 9.0 and 9.1 Commvault 10.0
Solaris 8 Commvault 9.0
Solaris 9 Commvault 9.0
Sybase ASE 12.5.3 ESD#6 32-bit Commvault 9.0
Sybase ASE 12.5.3 ESD#6 64-bit Commvault 9.0
Sybase ASE 12.5.4 32-bit Commvault 9.0
5/6/2017 Commvault Systems Page 579 of 587
Sybase ASE 12.5.4 64-bit Commvault 9.0
Tru64 OSF 5.1A and 5.1B Commvault 9.0

List of Deprecated Platforms Supported by Commvault Version 8


You can use the Commvault Version 8 software to protect the file system data of the following deprecated platforms:
AIX 5.2
Red Hat Linux 3.8
SuSE Linux 9.x
Ubuntu 7.x
For more information, see Installing Version 8 UNIX Clients on a Version 11 CommCell Environment .

List of Platforms and Applications on Extended Support


The following applications and platforms are currently on Extended Support:
Application/Platform Installation Package Version
Microsoft Windows Server 2003 Editions Commvault 10.0, Commvault 11.0
Microsoft Windows XP Editions Commvault 10.0
Red Hat Enterprise Linux 5.0 (or higher) for Z-Linux Commvault 10.0

The Installation Package Version column indicates the Commvault installation package version that provides extended support for the platform or application.

5/6/2017 Commvault Systems Page 580 of 587


Installing Clients from Older Commvault Versions
If the operating system of a computer is no longer supported by the current Commvault version, you can install the Commvault version that last supported the operating
system and associate the computer with your current CommCell environment. For information on the operating systems that became deprecated in this version, see End-
of-Life, Deprecated and Extended Support - Platforms .
The current Commvault version supports up to the last two previous versions. For example, if you have a Version 11 CommCell environment, you can install a Version 10 or
Version 9 client.
To enable the installation of older Commvault versions, you must set some additional settings on the computers where you want to install the software, as well as the
CommServe computer.

Before You Begin


Obtain the software for the Commvault version that you want to install.
The nAllowOlderClients additional setting must be configured on the CommServe computer.
a. From the CommCell Browser, right-click the CommServe and then 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 nAllowOlderClients.
ii. In the Value box, type 1.
iii. Click OK.

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.

5/6/2017 Commvault Systems Page 581 of 587


Installing Version 8 UNIX Clients on a Version 11 CommCell Environment
If you want to protect the file system data of a UNIX operating system that is not supported anymore by the latest Commvault versions, you can install the Commvault
Version 8 software. You can use the UNIX computer with the V8 software only to perform basic backup and restore operations.
To use the V8 software, the UNIX computer must run one of the following operating systems:
AIX 5.2
Red Hat Linux 3.8
SuSE Linux 9.x
Ubuntu 7.x
Important: The UNIX File System Agent is the only V8 software supported in a V11 CommCell environment. Other V8 agents, including driver-based agents, and advanced
features, such as firewall configurations, are not supported.

Before You Begin


Download the following Version 8 software from the Maintenance Advantage website:
Installation DVD for UNIX, Linux, and Macintosh
Service Pack 6 for the required UNIX operating systems
You must download the software to a location that is accessible by the computer where you want to install the V8 software.
To support the Commvault V8 software, your CommCell environment must meet the following requirements:
The CommServe computer must have V11 Service Pack 4 installed.
The CommServe computer and the MediaAgents must have open ports for V8 clients so that the clients can establish direct connections.
If user authentication is enabled in your CommCell environment, you must provide your user credentials (user name and encrypted password) during the
installation.
To encrypt your password, complete the following steps:
1. Log on to the CommServe computer.
2. Create a folder to save the encrypted password in.
3. From the command prompt, go to the Installation_Directory_Path/Base directory and run the following command:
SIMCallWrapper.exe -optype 100 -enc password -output C:\Folder_Name\pass.txt

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

d. To update the password, run the following query:


Update App_Client set client_password=ClientPassword where id=IDNumber

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

5/6/2017 Commvault Systems Page 583 of 587


Installing Version 9 Windows Server 2000 Clients on a Version 11 CommCell
Environment
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.
Important: The Windows File System Agent is the only V9 software supported on Windows Server 2000 computers. Other V9 agents, including driver-based agents, are not
supported.

Before You Begin


Download the Media Kit for Windows 2000 Installation from the Cloud Services website.
Make sure to download the software to a location that is accessible by the Windows Server 2000 computer.
To enable the registration of a V9 client with a V11 CommCell environment, you must configure an additional setting on the V11 CommServe computer and on the
Windows Server 2000 computer. For instructions, see Installing Clients from Older Commvault Versions .

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.

5/6/2017 Commvault Systems Page 584 of 587


End-of-Life, Deprecated and Extended Support - Products
The products listed on this page are End-of-Life (EOL), Deprecated, or on Extended Support. For more information about the Obsolescence Policy, see End-of-Life,
Deprecated and Extended Support - Obsolescence Policy .
If you require support in version 11 for products that are not covered in the list on this page, contact us at [email protected], and we will assist in providing the
backup solution for your environment. You can also provide feedback and enhancement suggestions for deprecated products by contacting us at
[email protected].

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

5/6/2017 Commvault Systems Page 585 of 587


End-of-Life, Deprecated and Extended Support - Features
The features listed on this page are deprecated. For more information about the Obsolescence Policy, see End-of-Life, Deprecated and Extended Support - Obsolescence
Policy .
1-Touch Server
1-Touch for HP-UX
Nimble Storage CS-Series Snap
Passphrase Feature
Shared Network Index Cache and Index Cache Server
Third-Party Integration Feature
VMware Backups Using vcbMounter
CommServe Disaster Recovery Tool (DR Tool)

5/6/2017 Commvault Systems Page 586 of 587


Trademark Acknowledgment
Commvault, Commvault and logo, the "CV" logo, Commvault Systems, Solving Forward, SIM, Singular Information Management, Simpana, Commvault Galaxy, Unified Data
Management, QiNetix, Quick Recovery, QR, CommNet, GridStor, Vault Tracker, InnerVault, Quick Snap, QSnap, IntelliSnap, Recovery Director, CommServe, CommCell, ROMS,
Commvault Edge, Simpana OnePass, and CommValue are trademarks or registered trademarks of Commvault Systems, Inc. All other third party brands, products, service
names, trademarks, or registered service marks are the property of and used to identify the products or services of their respective owners. All specifications are subject to
change without notice.

Products in Germany are not distributed using the "QNet" brand.

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

5/6/2017 Commvault Systems Page 587 of 587

You might also like