If, during the custom package creation, you chose to create an answer file (install.xml) containing the options that were selected during the package creation, you can customize the answer file with the installation parameters that your environment requires.
Note
There are two answer files (install.xml), as follows:
-
The install.xml file that you should customize is included in the custom package itself. For example, if you have a Windows x64 computer and the name of the package is CustomPackageName, then the install.xml file is located within the self-extracting executable (.exe) in the CustomPackageName\CustomPackageName_WinX64 folder.
-
There is another separate install.xml file that is located within that same folder. This file is intended to be used as a backup.
Procedure
-
Go to the location where you stored the custom package and then find the install.xml answer file.
-
Determine whether you want to update the install.xml file or create a separate answer file.
You can make changes directly to the install.xml file. However, if you want to keep its original contents, consider the following recommendations:
-
If you have minor changes, make a copy of the .xml file and then rename the file.
-
If you have major changes, download the sample_install_win.xml template answer file to the computer where you plan to run the installation and then rename the file.
-
-
Open the .xml file and then update the required parameters.
The following table describes the parameters that you can modify in the answer file. The required parameters have a Required tag in the description. Other parameters are optional.
Note
Blank parameter values are assigned default values during the installation.
Parameter Name |
Description |
|
---|---|---|
Focus |
Required. Instance number on which the software will be installed in a multi-instance environment.
|
|
ClientComposition |
||
storagePolicyToUse |
||
storagePolicyID |
The ID of the storage policy that you want to assign to the default subclient. |
|
storagePolicyName |
The name of the storage policy that you want to assign to the default subclient of your client. /CVInstallManager_ClientSetup/clientComposition/components/commonInfo/subclientPlanToUse/@planName |
|
subclientPlanToUse |
Provide either one, or both, of the following: |
|
planName |
Subclient plan name to use. |
|
planId |
Subclient plan ID to use. |
|
ClientAuthentication |
||
domainName |
Domain name of the CommServe computer. |
|
password |
Encrypted password that is generated during custom package creation. |
|
username |
Username for the CommServe computer. |
|
ClientInfo |
||
clientGroupName |
The name of the client group to which you want to associate the client. Multiple client group names can be provided by adding the following code to the sample_install_win.xml template answer file:
|
|
clientName |
The name of the client computer where the software will be installed. For example, client1. |
|
cvdPort |
TCP port number for the Communications Service (CVD). Default: 8400 |
|
hostName |
The host name of the computer where the software will be installed. For example, client1.domain.company.com. |
|
installDirectory |
The directory path where you want to install the Commvault software. Default: C:\Program Files\CommVault\ContentStore |
|
ClientRoles |
||
bLaptopBackup |
If configuring the client for laptop backup, set value to 1. |
|
bNetworkProxy |
If configuring the client as network proxy, set value to 1. |
|
CommServeInfo |
||
clientName |
The name of the CommServe computer as it appears in the CommCell Console. If you are running a decoupled installation, do not specify a value for this parameter. |
|
hostname |
The hostname of the CommServe computer (fully qualified domain name or IP address). For example, cscomputer.domain.company.com. If you are running a decoupled installation, do not specify a value for this parameter. |
|
componentInfo The componentInfo element specifies the agent to be installed. Multiple instances of this element means that multiple agents will be installed. If you downloaded the template answer file, copy the contents of the components element of the install.xml to your new answer file, and remove the componentInfo elements of the agents that you do not want to install. |
||
firewallInstall |
||
enableFirewallConfig |
Specifies whether to enable or disable firewall settings.
|
|
firewallInstall/proxyInfo/hostname |
The hostname or IP address of the proxy computer through which the CommServe computer can be reached. Use this parameter if you set value to 2 for the firewallConnectionType parameter. If the proxy is behind a port-forwarding gateway, specify the host name or the IP address of the port-forwarding gateway. |
|
firewallInstall/proxyInfo/portNumber |
HTTP or HTTPS tunnel port number on which the proxy expects connections. |
|
httpProxyConfigurationType |
If there an HTTP proxy between the client and the CommServe computer, one of the following configuration types should be specified:
|
|
httpProxyHostName |
If httpProxyConfigurationType is 1, the host name or IP address of the proxy computer through which the CommServe computer can be reached is required. |
|
httpProxyPortNumber |
If httpProxyConfigurationType is 1, the port number of the proxy machine is required (HTTP or HTTPS tunnel port number on which the proxy expects connections). |
|
portNumber |
The port number varies based on the type of firewall configuration that you specified in the firewallConnectionType parameter, as follows:
|
|
proxyClientName |
The name of the proxy computer that is used to reach the CommServe computer. Use this parameter if you specified 2 for the firewallConnectionType parameter. |
|
proxyHostName |
The host name or IP address of the proxy computer through which the CommServe computer can be reached. Use this parameter if you specified 2 for the firewallConnectionType parameter. If the proxy is behind a port-forwarding gateway, specify the host name or the IP address of the port-forwarding gateway. |
|
installFlags |
||
allowMultipleInstances |
Set value to 1 if this is a multi-instance environment. |
|
cleanupExistingInstance |
Set value to 1 to clean up any existing instance before the installation. |
|
decoupledInstall |
Specifies whether to register the client to the CommServe computer.
|
|
install32Base |
Installs 32-bit instead of default 64-bit packages (Linux_x86_64 and Windows X64 only).
|
|
launchConsole |
Set value to 1 to launch Command Center after installation completes. |
|
launchRegisterMe |
Launches RegisterMe.exe for de-coupled mode install. |
|
launchRolesManager |
Set value to 1 to launch Roles Manager after the installation completes. |
|
overrideClientInfo |
If the computer where you want to install the software is already a client in your CommCell, overrides the computer name or host name.
|
|
preferredIPFamily |
Sets the preferred IP family value during installation, as follows:
|
|
RepairMode |
Set this flag if it is a repair operation. |
|
restoreOnlyAgents |
Required. Specifies whether to install agents in restore-only mode (license is not consumed). Use this parameter if you plan to use the computer only as a destination for restoring backup data.
|
|
selectedRoles |
Provides the list of packages IDs for the agents to be installed using Roles Manager (if launchRolesManager parameter value is set to 1). (Usage: |
|
skipConfigureLaptopBackupMonitor |
Set value to 1 to skip the creation of the laptop backup monitor shortcut. |
|
skipConfigureMigrationAssistant |
Set value to 1 to skip the creation of Migration Assistant shortcut. |
|
skipConfigureProcessManager |
Set value to 1 to skip the creation of Process Manager shortcut. |
|
stopOracleServices |
Specifies whether to stop the Oracle services during the Oracle Agent installation.
|
|
useExistingDump |
Set value to 1 to use existing DB dumps. If the value is set to 1, the following tags should be specified:
|
|
jobResultDir |
||
path |
The directory path where you want to store the job result files. Default: C:\Program Files\CommVault\ContentStore\iDataAgent\JobResults. |
|
organizationProperties |
||
authcode |
A company authcode is required if you plan to mass distribute or run a silent installation of the installation package for end users. You can generate the authcode for a company from the Command Center. |