Loading...

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

  1. Go to the location where you stored the custom package and find the default.xml file.
  2. 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.
  3. 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.

Notes:

  • Blank parameter values are assigned default values during the installation.
  • If you plan to install as a non-root user, you must add the registryDirectory parameter (described in the table below).
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 SnapProtect 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.

ClientInfo
cvdPort TCP port number for the Communications Service (CVD).

Default: 8400

installDirectory The directory path where you want to install the SnapProtect software.

Default: /opt/snapprotect.

clientName The name of the computer where the software will be installed. For example, client1.
hostName The host name of the computer where the software will be installed. For example, client1.domain.company.com.
physClientName If you plan to install in a cluster environment, use this parameter to specify the name of the computer where the software will be installed. For example, client1.
physHostName If you plan to install in a cluster environment, use this parameter to specify the hostname of the computer where the software will be installed. For example, client1.domain.company.com.
vcsServiceGroup If you plan to install in a Veritas cluster environment, use this parameter to specify the name of the Veritas Cluster Service Group.
jobResulsDir The directory path where you want to store the job result files.

Default: /opt/snapprotect

clientGroupName The name of the client group to which you want to associate the client.
logFilesLocation The directory path where you want to store the log files.

Default: /var/log/snapprotect/Log_Files

ContinuousDataReplicator
The following parameters pertain 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.
storagePolicyToUse
storagePolicyName The name of the storage policy that you want to assign to the default subclient of your client.
storagePolicyID The ID of the storage policy that you want to assign to the default subclient.
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 default.xml to your new answer file, and remove the componentInfo elements of the agents that you do not want to install.

dataClassification
dcCacheLocation The Data Classification cache directory path where you want to store the cache of file system changes.
db2
The following parameters pertain only to DB2 Agent
db2ArchivePath The directory path where DB2 archive files are stored.
db2RetrievePath The directory path where the DB2 recovery process files are stored.
db2AuditErrorPath The directory path where the DB2 audit error logs are stored.
fileSystem
The following parameters pertain only to File System Agent
configureForLaptopBackups Specifies whether to configure the File System Agent for laptop backups.
  • 0

    Disable laptop backup configuration. (Default)

  • 1

    Enable laptop backup configuration.

subclientPolicyName The name of the subclient policy that you want to assign to the default subclient of your client.
subclientPolicyID The ID of the subclient policy that you want to assign to the default subclient.
lotusNotesDB, lotusNotesDoc, and lotusNotesDataArchiver
The following parameters pertain 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.
mediaAgent
indexCacheDirectory path The path to the MediaAgent Index Cache directory.
oracleSAP
The following parameter pertain only to SAP for Oracle Agent
sapExeDirectory The path to the SAPEXE directory. For example, /usr/sap/SYS/exe.
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.

installFlags
install32Base Required. Specifies whether to install 32-bit agents on a 64-bit computer.
  • 0

    Disable 32-bit installations.

  • 1

    Enable 32-bit installations.

decoupledInstall Required. Specifies whether to install the software in decoupled mode, where the client does not establish connections with the CommServe computer.
  • 0

    Disable installations in decoupled mode.

  • 1

    Enable installations in decoupled mode.

allowNewerCommserve Required. Specifies whether to enable the installation of agents from older versions.
  • 0

    Disable installations of older SnapProtect versions.

  • 1

    Enable installations of older SnapProtect versions.

numberOfStreams Required only for Solaris computers. Specifies the number of streams that you want to allocate.
  • If you enter 0, the /etc/system configuration file is not updated.
  • If you enter a value greater than 0, the /etc/system configuration file is updated, and the original version of the file is copied to the /etc/system.gal.PID file (where PID is the installer process ID on the server).
unixGroup Required. The name of a dedicated UNIX group to which you want to assign all the SnapProtect files, and on behalf of which all processes will run.
unixOtherAccess Required. Provides full access rights to root users for all SnapProtect 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.

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.

singleInterfaceBinding Required. Specifies whether to bind all services to the client name or IP address.
  • 0

    Disable binding.

  • 1

    Enforce binding.

loadWAToKernel Required. Set this parameter to 1 to load the WA driver into the kernel and create the device nodes without rebooting the system. To disable this capability, set it to 0.
forceReboot Specifies whether to reboot the computer during the installation, when required. For example, the QSnap installation requires a reboot to initialize the QSnap driver.
  • 0

    Disable reboots. (Default)

  • 1

    Enable reboots.

firewallInstall
disableFirewall Specifies whether to enable or disable firewall settings.
  • 0

    Enable firewall.

  • 1

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

firewallConfigFile The path to the firewall configuration file.
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.

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.