Loading...

Customizing the Answer File of a Windows Custom Package

By default, the custom package includes an answer file (install.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 install.xml answer file.
  2. 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.
  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.

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 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: C:\Program Files\##_DOC_OEM_INSTALL_DESTINATION_COMPANY_FOLDER_##\SnapProtect.

clientName The name of the client 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.
jobResultDir
path The directory path where you want to store the job result files.

Default: C:\Program Files\##_DOC_OEM_INSTALL_DESTINATION_COMPANY_FOLDER_##\SnapProtect\iDataAgent\JobResults.

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.

installFlags
deletePackagesAfterInstall Specifies whether to delete the software installation files after the installation.
  • 0

    Disable file deletion.

  • 1

    Enable file deletion. (Default)

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.

killBrowserProcesses Specifies whether to close any browser running during the installation. Valid values are:
  • 0

    Ignore browser processes. (Default)

  • 1

    Close browser processes.

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

    Add the computer as a new client in the CommCell. (Default)

  • 1

    Override the details of an existing client.

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.

stopOracleServices Specifies whether to stop the Oracle services during the Oracle Agent installation.
  • 0

    Do not stop the services. (Default)

  • 1

    Stop the services.

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.