Windows operating systems

Silent installation

The backup-archive client installation program supports silent, unattended installations.

If you plan to install the client on the same system as the IBM Spectrum Protect server V8.1.2 or later level, ensure that you halt the IBM Spectrum Protect server before you install the client. This action will prevent the client installation process from forcing the system to reboot. After you install the client, you can restart the IBM Spectrum Protect server.

Important: The Microsoft Visual C++ 2012 and 2017 redistributable packages and the IBM® Java™ Runtime Environment (JRE) package are required to use the backup-archive client. The graphical installation program installs these packages for you. However, if you are installing the client in silent mode by using MSIEXEC, you must install the Microsoft Visual C++ 2012 and 2017 redistributable packages and the IBM JRE package separately. The packages can be installed before or after the silent installation of the client is completed, but they must be installed before you use the backup-archive client.

Use the following executable files to install the C++ and IBM JRE redistributable packages. In the paths that are shown, the dir text string represents the drive and directory where you saved the files when you extracted them from the installation package.

Windows executable files for installing C++ redistributable packages
dir\ISSetupPrerequisites\{3A3AF437-A9CD-472f-9BC9-8EEDD7505A02} (contains MS 2012 x64 C++ Runtime - vcredist_x64.exe)
dir\ISSetupPrerequisites\{915387C3-E260-4985-861D-E7A891A4F74B} (contains MS 2017 x64 C++ Runtime - vc_redist.x64.exe)
Windows executable file for installing the IBM JRE redistributable package
dir\ISSetupPrerequisites\IBM Java(TM) 8 Runtime Environment\spinstall.exe (contains IBM JRE - spinstall.exe)

To install the backup-archive client in silent mode, complete the actions in the following sections.

Install a predefined dsm.opt file

To install a predefined (custom) dsm.opt file, use the following instructions before you begin the silent installation.

Place the customized copy of the dsm.opt file in the ...\CONFIG directory that is located within the installation image, for example:
C:\tsm_images\TSMClient\Program Files 64\Tivoli\TSM\config
The file must be named dsm.opt.
The installation program copies the predefined dsm.opt file to the ..\BACLIENT directory when BOTH of the following conditions are met:
  • The dsm.opt file does NOT exist in the ..\BACLIENT directory. The installation program does not copy over an existing dsm.opt file.
  • The dsm.opt file exists in the ..\CONFIG directory of the installation image, as described earlier.

Turn off User Account Control (UAC)

Before you can silently install the C++ and IBM JRE redistributable packages or the backup-archive client, you must turn off User Account Control (UAC).

To turn off UAC, use either the Windows Control Panel or the MSCONFIG utility:

  • To turn off UAC by using the Control Panel, go to the Control Panel and find User Account Control settings, then set the notification level to Never Notify.
  • To turn off UAC by using the MSCONFIG utility, open a command prompt window and enter msconfig. Select the User Account Control settings tool, and set the notification level to Never Notify.
Remember: After you install the redistributable packages and the Windows client, turn on UAC.

Open an administrator command prompt

Elevated privileges are required to install the C++ and IBM JRE redistributable packages. Complete the following steps to open a command prompt window as administrator:

  1. Click the Start Menu and type "command" to search for the Windows command prompt.
  2. In the search results, right-click the Command Prompt icon to view the properties.
  3. Click Run as administrator.
  4. Click Yes in the permission window.
  5. Start the product installation by using the command prompt window.

Install the C++ redistributable packages in silent mode

To install the C++ redistributable packages in silent mode, complete the following steps:
  1. From the dir\ISSetupPrerequisites\{3A3AF437-A9CD-472f-9BC9-8EEDD7505A02} directory, run the following command:
    vcredist_x64.exe /install /quiet /norestart /log logfilename
  2. From the dir\ISSetupPrerequisites\{915387C3-E260-4985-861D-E7A891A4F74B} directory, run the following command:
    vc_redist.x64.exe /install /quiet /norestart /log logfilename
For more information about the vcredist_x64.exe command, run the following command:
vcredist_x64.exe /?
For more information about the vc_redist.x64.exe command, run the following command:
vc_redist.x64.exe /?

Install the IBM JRE redistributable package in silent mode

The following example is a sample command that installs the IBM JRE package. To run the command correctly on your system, you might need to customize this example.

Although the command is physically spread across multiple lines in the following example, enter it on a single command line as administrator

spinstall /s /v"RebootYesNo=\"No\" Reboot=\"ReallySuppress\" ALLUSERS=1 /qn /l*v \"jre_log.txt\""

Install the backup-archive client in silent mode

Install the Windows backup-archive client. UAC must still be turned off. If it is not turned off, turn off UAC now.

To install the backup-archive client in silent mode, complete the following steps:
  1. Click the Start Menu and type "command" to search for the Windows command prompt.
  2. Right-click the Command Prompt icon to view the properties.
  3. Click Run as administrator.
  4. Click Yes in the permission window.
  5. Start the Windows backup-archive client silent installation by using the command prompt window.

    When you place a customized version of the msiexec command (which calls the Microsoft Software Installer) in a script or batch file, you can perform installations on multiple Windows systems. The following example is a sample command to install the backup-archive command-line client, client GUI, web client, API, and Administrative command-line client.

    You might need to customize this example to run correctly on your system. Although the command is physically spread across multiple lines in the following example, enter it on a single command line:

    msiexec /i "Z:\tsm_images\TSMClient\IBM Spectrum Protect Client.msi" RebootYesNo="No" REBOOT="Suppress" ALLUSERS=1 INSTALLDIR="C:\Program Files\Tivoli\Tsm" ADDLOCAL="BackupArchiveGUI,BackupArchiveWeb,Api64Runtime,AdministrativeCmd" TRANSFORMS=1033.mst /qn /l*v "C:\log.txt"

The descriptions of the silent installation parameters are as follows:
msiexec
Starts the Microsoft Software Installer (MSI) program.
/i
Installs the specified source package (replace with /x to uninstall the package).
"Z:\tsm_images\TSMClient\IBM Spectrum Protect Client.msi"
Specifies the complete path to the source package. The Z drive is shown in this example. Specify the drive letter for the disk drive, in your configuration, that contains the installation image.
RebootYesNo="No" REBOOT="Suppress"
Under certain conditions, a system reboot might be necessary for the installation to complete successfully. This option causes the installation program to not reboot the system if circumstances would otherwise cause the reboot to occur. While this option is convenient, use it with caution because suppressing the reboot might cause the program to behave in an unpredictable manner. The most common reason that a reboot is required is if the installation was an upgrade to an existing backup-archive client, and the installation was performed while the client programs were running. Therefore, shut down all backup-archive client programs and services before you begin the installation.
ALLUSERS=1
Specifies that the package is for all users. This option is required.
INSTALLDIR="C:\Program Files\Tivoli\TSM"
Specifies the destination path. If you already installed this product or a previous version of this product on your workstation, use the current installation directory as the destination path for this package.
ADDLOCAL="BackupArchiveGUI,BackupArchiveWeb,Api64Runtime"
Specifies the features to install. Specify all the components on a single line within quotation marks, which are separated by commas, with no spaces before or after the commas. The installable client features are shown in the following table:
Windows client features Feature description
BackupArchiveWeb Backup-archive web client (for connection to IBM Spectrum® Protect server Version 8.1.1 or earlier or V7.1.7 or earlier V7 levels)
BackupArchiveGUI Graphical user interface
AdministrativeCmd Administrative Command Line
ApiSdk API SDK
NetAppLibs NetApp API runtime files
Api64Runtime API Runtime
RemoteWebServices Client Web Server (for file-restore operations using the web user interface)
TRANSFORMS=1033.mst
Specifies which language transform to use. The following language transforms are available:
Transform Language
1028.mst CHT Traditional Chinese
1029.mst CSY Czech
1031.mst DEU German
1033.mst ENG English
1034.mst ESP Spanish
1036.mst FRA French
1038.mst HUN Hungarian
1040.mst ITA Italian
1041.mst JPN Japanese
1042.mst KOR Korean
1045.mst PLK Polish
1046.mst PTB Portuguese
1049.mst RUS Russian
2052.mst CHS Simplified Chinese
/qn
Specifies to install the product silently.
/l*v "C:\log.txt"
Specifies verbose logging and the name and location of the log file.

The installation process creates the IBM Spectrum Protect folder in the programs folder of the Windows Start menu. You can start the backup-archive client by clicking one of the icons in this folder.

Remember: Turn on UAC after the silent installation of the backup-archive client is completed.