Customizing the Answer File of a UNIX, Linux, and Macintosh Custom Package

By default, the custom package includes an answer file (default.xml), which contains the options that were selected during the package creation.

You can customize the answer file with the installation parameters that your environment requires.

Procedure

Go to the location where you stored the custom package and find the default.xml file.
Determine whether you want to update the default.xml file or create a separate answer file.

You can make changes directly to the default.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_unix.xml template answer file to the computer where you plan to run the installation, and then rename the file.
Open the .xml file and 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. If you want to set the instance number manually, use the InstanceXXX format. For example, if the computer has no Commvault software installed, set the parameter to Instance001. If you want the installation program to set the instance number automatically, set the parameter to New. For example, if the computer already has Instance001 of the software, the installation program installs the new software on Instance002. Note For a multi-instance environment, set the allowMultipleInstances parameter under installFlags (see below) to "1".
ClientAuthentication
domainName	Domain name of the CommServe computer.
encPassword	Encrypted password that is generated during custom package creation.
password	Encrypted password.
username	Username for the CommServe computer.
clientComposition
/CVInstallManager_ClientSetup/clientComposition/components/commonInfo/subclientPlanToUse/@planName
subclientPlanToUse	Provide the subclient plan name to use.

ClientInfo
clientCertificate	If per-client certificate based authentication is enabled on the CommServe computer, provide the location of the temporary certificate generated for the client.
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_unix.xml template answer file: `<clientGroups clientGroupName=""/>`
clientName	The name of the 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: /opt/commvault
jobResulsDir	The directory path where you want to store the job result files. Default: /opt/commvault
logFilesLocation	The directory path where you want to store the log files. Default: /var/log/commvault/Log_Files
ClientRoles
bLaptopBackup	If configuring the client for laptop backup, set this value to 1.
CommServeHostInfo
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 host name 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.
ContinuousDataReplicator
The following parameters apply only to ContinuousDataReplicator:
cdrDriver
logFileLocation	The directory path where you want to store the replication logs files. For example, /opt/flrcache.
RolCacheMaxDiskSize	Amount of log file space (in MB) required for caching purposes.
dataClassification
dcCacheLocation	The Data Classification cache directory path where you want to store the cache of file system changes.
db2
The following parameters apply only to DB2 Agent:
db2ArchivePath	The directory path where DB2 archive files are stored.
db2AuditErrorPath	The directory path where the DB2 audit error logs are stored.
db2RetrievePath	The directory path where the DB2 recovery process files are stored.
fileSystem
The following parameters apply only to File System Agent:
subclientPolicyID	The ID of the subclient policy that you want to assign to the default subclient of your client.
subclientPolicyName	The name of the subclient policy that you want to assign to the default subclient of your client.
firewallInstall
certificatePath	Provide the path of the temporary certificate of the client generated. When the CommServe instance is in "lockdown" mode, client certificates are validated when installing new clients. For information about generating a temporary client certificate, see Creating a Temporary Certificate for Client Installation.
enableFirewallConfig	Specifies whether to enable or disable firewall settings. 0 Disable firewall. 1 Enable firewall. (Default)
firewallConnectionType	Specifies the type of firewall configuration. 0 The client connects to the CommServe computer through a port forwarding gateway. (Default) 1 The CommServe computer connects to the client. 2 The CommServe computer can be reached only through a proxy.
httpProxyHostName	Required. The hostname or IP address of the proxy computer through which the CommServe computer can be reached.
httpProxyPortNumber	Required. The HTTP or HTTPS tunnel port number on which the proxy expects connections.
portNumber	HTTP or HTTPS tunnel port number on which the proxy expects connections. The port number varies based on the type of firewall configuration that you specified in the firewallConnectionType parameter: If you specified 0, provide the CommServe HTTP/HTTPS tunnel port number. If you specified 1, provide the local HTTP/HTTPS tunnel port number. If you specified 2, provide the proxy HTTP/HTTPS tunnel port number.
proxyInfo/hostname	The hostname 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.
proxyInfo/portNumber	HTTP or HTTPS tunnel port number on which the proxy expects connections.
installFlags
allowMultipleInstances	Set value to 1 if this is a multi-instance environment.
decoupledInstall	Specifies whether to register the client to the CommServe computer. 0 Register with CommServe computer. 1 Do not register with CommServe computer.
enableFileTypePermissions	If the value is set to 1, the permissions of the Commvault installation, log folders, and registry are set based on the file types. (Default is 0).
forceIPV4	If the value is set to 1, it forces an IPv4 installation.
install32Base	Required. Specifies whether to install 32-bit agents on a 64-bit computer. 0 Disable 32-bit installations. 1 Enable 32-bit installations.
launchRolesManager	Set value to 1 to launch Roles Manager after the installation completes.
overrideClientInfo	Overwrites the existing hostname of the client when the incoming client name matches the existing client name but the existing hostname does not match. 1 Overwrites existing hostname. 0 Errors out. (Default)
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. 0 Perform a traditional agent installation to allow backups and restores. 1 Install agents in restore-only mode.
unixGroup	Required. The name of a dedicated UNIX group to which you want to assign all the Commvault files, and on behalf of which all processes will run.
unixGroupAccess	Permission for the assigned UNIX group.
unixOtherAccess	Required. Provides full access rights to root users for all Commvault files and processes are assigned to the UNIX group you specified. Use this parameter to specify the access permission for other users. This is useful if you plan to install agents in a computer protected by third-party applications. Use values 0 to 7 to allow read, write, or execute permission to other users.
unixTempDirectory	Provide the temporary directory for the installer.
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.
lotusNotesDB, lotusNotesDoc, and lotusNotesDataArchiver
The following parameters apply only to the Domino Database, Domino Document, and Domino Mailbox Archiver Agent, respectively.
binaryPath	The home directory where the Domino software is installed. For example, /opt/ibm/lotus.
instanceName	The name of the Domino instance (partition).
path	The directory path where the Domino instance resides.
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.